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 #844]✨Add MQProducer trait for sdk clientπŸš€ #845

Closed mxsm closed 1 month ago

mxsm commented 1 month ago

Which Issue(s) This PR Fixes(Closes)

Fixes #844

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes to the rocketmq-client project introduce significant enhancements to the codebase, including new modules and traits for message production, improved error handling, and expanded utilities for name server address management. These modifications aim to bolster functionality, maintainability, and performance within the messaging system, providing a more structured and versatile architecture.

Changes

Files Change Summary
rocketmq-client/Cargo.toml Added dependencies: rocketmq-remoting, serde, serde_json, trait-variant, and specified num_cpus version.
rocketmq-client/src/base.rs Introduced modules: access_channel and client_config.
rocketmq-client/src/base/access_channel.rs Defined AccessChannel enum with serialization/deserialization.
rocketmq-client/src/base/client_config.rs Defined ClientConfig struct for client configuration settings with a new method.
rocketmq-client/src/error.rs Expanded MQClientError enum with multiple variants for detailed error reporting.
rocketmq-client/src/lib.rs Added new producer module to organize message production functionalities.
rocketmq-client/src/producer.rs Declared multiple public modules related to message production.
rocketmq-client/src/producer/local_transaction_state.rs Defined LocalTransactionState enum with Serde support.
rocketmq-client/src/producer/message_queue_selector.rs Defined MessageQueueSelector trait for queue selection.
rocketmq-client/src/producer/mq_producer.rs Defined MQProducerLocal trait outlining message production interface.
rocketmq-client/src/producer/send_result.rs Defined SendResult struct for encapsulating send operation results.
rocketmq-client/src/producer/send_status.rs Defined SendStatus enum for various message send statuses.
rocketmq-client/src/producer/transaction_send_result.rs Defined TransactionSendResult struct for transaction send operations.
rocketmq-common/src/utils.rs Added utilities: name_server_address_utils and network_util.
rocketmq-common/src/utils/name_server_address_utils.rs Defined NameServerAddressUtils struct for managing name server addresses.
rocketmq-common/src/utils/network_util.rs Defined NetworkUtil struct for retrieving local IP address.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Producer
    participant MessageQueue

    Client->>Producer: Send Message
    Producer->>MessageQueue: Select Queue
    MessageQueue-->>Producer: Return Selected Queue
    Producer->>MessageQueue: Send Message to Queue
    MessageQueue-->>Producer: Acknowledge Message Sent
    Producer-->>Client: Confirm Message Sent

Assessment against linked issues

Objective Addressed Explanation
Add MQProducer trait for sdk client (#844) βœ…
Improve message production interface βœ…
Enhance error handling capabilities βœ…

🐰 In a world of messages, swift and bright,
New traits and modules take flight.
With enums and structs, the code's a delight,
RocketMQ's journey reaches new height!
Let's hop along, with joy and cheer,
For every change, we hold so dear! 🌟


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% with 152 lines in your changes missing coverage. Please review.

Project coverage is 26.83%. Comparing base (7afc534) to head (5cdbfe4).

Files Patch % Lines
rocketmq-client/src/producer/send_result.rs 0.00% 66 Missing :warning:
rocketmq-client/src/base/client_config.rs 0.00% 31 Missing :warning:
...etmq-common/src/utils/name_server_address_utils.rs 0.00% 21 Missing :warning:
rocketmq-common/src/utils/network_util.rs 0.00% 12 Missing :warning:
rocketmq-client/src/error.rs 0.00% 8 Missing :warning:
...tmq-client/src/producer/local_transaction_state.rs 0.00% 5 Missing :warning:
rocketmq-client/src/producer/send_status.rs 0.00% 5 Missing :warning:
...tmq-client/src/producer/transaction_send_result.rs 0.00% 3 Missing :warning:
rocketmq-client/src/base/access_channel.rs 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #845 +/- ## ========================================== - Coverage 26.98% 26.83% -0.15% ========================================== Files 300 308 +8 Lines 25243 25393 +150 ========================================== + Hits 6811 6815 +4 - Misses 18432 18578 +146 ```

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