search

mxsm / rocketmq-rust

🚀Apache RocketMQ Rust implementation. Faster, safer, and with lower memory usage.
https://docs.rs/rocketmq-rust
Apache License 2.0
538 stars 66 forks source link

[ISSUE #750]✨Add client meta data struct #758

Closed mxsm closed 2 months ago

mxsm commented 2 months ago

Which Issue(s) This PR Fixes(Closes)

Fixes #750

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

These changes enhance the functionality, flexibility, and usability of the RocketMQ client, providing more robust management of topic routes and RPC operations.

mxsm commented 2 months ago

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

coderabbitai[bot] commented 2 months ago

Walkthrough

The overall changes implement new functionalities and improvements across the RocketMQ project. Key additions include creating a ClientMetadata struct for managing client data, modifying existing structs for enhanced functionality, adding new modules for protocol headers, and extending traits for various structs. These changes aim to enhance code usability, visibility, and maintainability.

Changes

File/Directory Change Summary
rocketmq-common/src/common/message/message_queue.rs Implemented additional traits for MessageQueue, modified the new method, introduced new methods, and adjusted formatting.
rocketmq-remoting/Cargo.toml Added dependencies: log version 0.4.22 and bytes version 1.6.0.
rocketmq-remoting/src/protocol/body/broker_body/cluster_info.rs Made broker_addr_table and cluster_addr_table fields public.
rocketmq-remoting/src/protocol/header/... Added new modules for response headers: get_earliest_msg_storetime_response_header, get_max_offset_response_header, get_min_offset_response_header, and search_offset_response_header.
rocketmq-remoting/src/protocol/route/route_data_view.rs Added traits for BrokerData, QueueData, and TopicRouteData. Added new methods to TopicRouteData.
rocketmq-remoting/src/protocol/static_topic/... Changed scope field in TopicQueueMappingInfo to Option<String>. Added get_mock_broker_name function.
rocketmq-remoting/src/rpc.rs Added new modules: client_metadata, rpc_client, rpc_client_hook, and rpc_client_impl.
rocketmq-remoting/src/rpc/client_metadata.rs Introduced ClientMetadata struct with methods for managing topic routes and broker addresses.
rocketmq-remoting/src/rpc/rpc_client.rs Introduced RpcClientLocal trait with methods for handling RPC requests and message queue invocations.
rocketmq-remoting/src/rpc/rpc_client_hook.rs Introduced RpcClientHook trait with methods for handling RPC requests and responses.
rocketmq-remoting/src/rpc/rpc_client_impl.rs Added methods to RpcClientImpl for handling various RPC operations.
rocketmq-remoting/src/rpc/rpc_client_utils.rs Updated create_command_for_rpc_request to conditionally set the body of RemotingCommand.
rocketmq-remoting/src/rpc/rpc_request.rs Updated RpcRequest struct to include the Send trait in the body field.
rocketmq-remoting/src/rpc/rpc_response.rs Added new constructor methods to RpcResponse struct.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RpcClientImpl
    participant RocketmqDefaultClient

    Client->>RpcClientImpl: Request RPC operation
    RpcClientImpl->>RocketmqDefaultClient: Invoke remote method
    RocketmqDefaultClient-->>RpcClientImpl: Return response
    RpcClientImpl-->>Client: Return result

Assessment against linked issues

Objective (Issue #750) Addressed Explanation
Add client metadata struct ✅

Poem

In the land of RocketMQ so bright,
New traits and structs come to light.
With ClientMetadata we steer,
Routes and brokers now so clear.
To every queue and topic's might,
These changes bring us pure delight! 🌟

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 Configration 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.