[ISSUE #823] Support AdminBrokerProcessor get_broker_config

847850277 commented 1 month ago

Which Issue(s) This PR Fixes(Closes)

Fix #823

Fixes #issue_id

Brief Description

Support AdminBrokerProcessor get_broker_config

How Did You Test This Change?

Summary by CodeRabbit

New Features
- Introduced functionalities for updating and retrieving broker configurations, enhancing broker management.
- Added methods to access configuration properties for both broker and message store settings, improving introspection capabilities.
- Enhanced enums with methods for obtaining string representations of broker roles and flush disk types.
- Provided access to message store configuration through a new method in the DefaultMessageStore.
Bug Fixes
- Adjusted control flows in request processing to accurately reflect new functionalities.
Documentation
- Updated comments for better clarity and readability across various components.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes significantly enhance the rocketmq broker's request processing capabilities, particularly through the AdminBrokerProcessor. A new focus on broker configuration management replaces the previous topic deletion functionality with methods for updating and retrieving broker configurations. Additionally, various structures now support serialization, improving data handling and introspection. These enhancements equip users with robust tools for effective broker management.

Changes

Files	Change Summary
`rocketmq-broker/src/.../admin_broker_processor.rs`	Updated request handling in `AdminBrokerProcessor`, removing `DeleteTopicInBroker` and adding `UpdateBrokerConfig` and `GetBrokerConfig`.
`rocketmq-broker/src/.../broker_config_request_handler.rs`	Introduced `BrokerConfigRequestHandler` to manage broker configurations, with methods for `update_broker_config` (unimplemented) and `get_broker_config`.
`rocketmq-common/src/.../broker/broker_config.rs`	Enhanced serialization for `BrokerIdentity`, `BrokerConfig`, `TopicQueueConfig`, and `TimerWheelConfig`. Added `get_properties` method in `BrokerConfig`.
`rocketmq-store/src/.../config/message_store_config.rs`	Added `get_properties` method to `MessageStoreConfig` for accessing configuration properties.
`rocketmq-store/src/.../message_store/default_message_store.rs`	Implemented `message_store_config` method in `DefaultMessageStore` to access configuration details.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Broker
    participant BrokerConfigHandler

    Client->>Broker: Send UpdateBrokerConfig Request
    Broker->>BrokerConfigHandler: Process UpdateBrokerConfig
    BrokerConfigHandler-->>Broker: Confirm Update
    Broker-->>Client: Acknowledge Update

sequenceDiagram
    participant Client
    participant Broker
    participant BrokerConfigHandler

    Client->>Broker: Send GetBrokerConfig Request
    Broker->>BrokerConfigHandler: Process GetBrokerConfig
    BrokerConfigHandler-->>Broker: Return Config Data
    Broker-->>Client: Send Config Response

Assessment against linked issues

Objective	Addressed	Explanation
Support `AdminBrokerProcessor get_broker_config` (#[823])	✅

Poem

🐰 In the meadow where the code does flow,
New features sprout and proudly grow.
Configs now dance in structured display,
With updates and queries, hip-hip-hooray!
A rabbit's joy in the code we share,
Enhancements make the broker fair! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

mxsm commented 1 month ago

🚀Thanks for your contribution🎉. CodeRabbit(AI) will review your code first🔥

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 0.10277% with 972 lines in your changes missing coverage. Please review.

Project coverage is 27.19%. Comparing base (bf04078) to head (2d5fc7f).

Files	Patch %	Lines
rocketmq-store/src/config/message_store_config.rs	0.00%	668 Missing :warning:
rocketmq-common/src/common/broker/broker_config.rs	0.41%	241 Missing :warning:
..._broker_processor/broker_config_request_handler.rs	0.00%	38 Missing :warning:
...tmq-broker/src/processor/admin_broker_processor.rs	0.00%	11 Missing :warning:
rocketmq-store/src/config/broker_role.rs	0.00%	6 Missing :warning:
rocketmq-store/src/config/flush_disk_type.rs	0.00%	5 Missing :warning:
...q-store/src/message_store/default_message_store.rs	0.00%	3 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #824 +/- ## ========================================== - Coverage 28.27% 27.19% -1.08% ========================================== Files 296 297 +1 Lines 24102 25069 +967 ========================================== + Hits 6815 6818 +3 - Misses 17287 18251 +964 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mxsm commented 1 month ago

🚀Thanks for your contribution🎉. CodeRabbit(AI) will review your code first🔥

847850277 commented 1 month ago

@847850277 I personally think this area can directly use HashMap<String, String>, with the key values keeping consistent with the Java version. This is necessary because the Rust version needs to be compatible with the Java version. Otherwise, the configuration retrieved using Java client commands will appear differently. Additionally, as you can see, in the Java version, BrokerConfig inherits from BrokerIdentity, so after serialization, they should be at the same level. The same should apply in Rust, so the key values should remain consistent.

correct.

mxsm commented 1 month ago

🚀Thanks for your contribution🎉. CodeRabbit(AI) will review your code first🔥

mxsm commented 1 month ago

🚀Thanks for your contribution🎉. CodeRabbit(AI) will review your code first🔥

mxsm commented 1 month ago

🚀Thanks for your contribution🎉. CodeRabbit(AI) will review your code first🔥

mxsm commented 1 month ago

🚀Thanks for your contribution🎉. CodeRabbit(AI) will review your code first🔥

mxsm / rocketmq-rust