Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ISSUE #735] 🔥Optimize pull message logic #736

Merged
merged 2 commits into from
Jul 5, 2024
Merged

[ISSUE #735] 🔥Optimize pull message logic #736

merged 2 commits into from
Jul 5, 2024

Conversation

mxsm
Copy link
Owner

@mxsm mxsm commented Jul 5, 2024

Which Issue(s) This PR Fixes(Closes)

Fixes #735

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

  • New Features

    • Added Unknown variant to RequestSource enum, and updated variant mappings.
  • Improvements

    • Enhanced consumer information compensation handling.
    • Improved logic for retry and expression message filters.
    • Revised topic queue mapping for better accuracy.
    • Enhanced message store with new compaction store functionalities.
  • Bug Fixes

    • Fixed incorrect todo!() statements to return proper values in several modules.
    • Corrected method logic in ConsumeQueue.

Copy link
Contributor

coderabbitai bot commented Jul 5, 2024

Walkthrough

The changes focus on enhancing and optimizing various parts of the RocketMQ broker and store. Key updates include the addition of new methods and structs for handling consumer information, cold data flow control, and message filtering. Other modifications streamline the message pull logic and enhance the handling of topic queue mappings. Important updates also include the modernization of the RequestSource enum and improvements to the message store functionalities and compaction logic.

Changes

Files/Modules Change Summary
Cargo.toml Added cfg-if = "1.0.0" dependency to rocketmq-broker.
rocketmq-broker/src/client/manager/consumer_manager.rs Added a public method compensate_basic_consumer_info to ConsumerManager.
rocketmq-broker/src/coldctr/cold_data_cg_ctr_service.rs Changed ColdDataCgCtrService to a unit struct, and added is_cg_need_cold_data_flow_ctr method.
rocketmq-broker/src/filter/...retry_message_filter.rs, rocketmq-broker/src/filter/...rs Updated functions to return true instead of using todo!().
rocketmq-broker/src/processor/default_pull_message_result_handler.rs, pull_message_processor.rs Added imports and fields related to ColdDataCgCtrService, modified message handling logic, updated checks for broadcast and stream requests.
rocketmq-broker/src/topic/.../topic_queue_mapping_manager.rs Revised logic for handling topic queue mappings, ensuring correct retrieval and processing.
rocketmq-remoting/src/protocol/request_source.rs Updated RequestSource enum to include Unknown variant with value -2 and remapped SDK to Unknown. Implemented From<i32> for RequestSource.
rocketmq-store/src/base/store_stats_service.rs Added get_message_transferred_msg_count method to StoreStatsService.
rocketmq-store/src/kv.rs, rocketmq-store/src/kv/compaction_store.rs Added compaction_store module and CompactionStore struct with methods for creating instances and retrieving messages.
rocketmq-store/src/log_file.rs, rocketmq-store/src/message_store/default_message_store.rs Added find_consume_queue method to RocketMQMessageStore trait. Updated DefaultMessageStore to include compaction_store field and implemented related methods in MessageStore trait.
rocketmq-store/src/queue/single_consume_queue.rs Modified iterate_from_inner method to call self.iterate_from.

Sequence Diagram(s)

(Not applicable or too varied to generate meaningful sequence diagrams.)

Assessment against linked issues

Objective (Issues) Addressed Explanation
Optimize pull message logic (#735)
Add methods for consumer and compaction management (N/A)
Enhance message filtering and cold data handling (N/A)
Update RequestSource enum and store functionalities (N/A)

Poem

In the land of RocketMQ,
Changes flutter, fresh and new,
Pulls and filters, messages flow,
Cold data dances, in a rhythmic show.
Enum evolves, mappings bring cheer,
Swift and strong, enhancements here! 🚀🐇


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mxsm
Copy link
Owner Author

mxsm commented Jul 5, 2024

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range and nitpick comments (1)
rocketmq-store/src/message_store/default_message_store.rs (1)

121-121: Add documentation for the new field compaction_store.

Consider adding a comment to describe the purpose and usage of the compaction_store field for better maintainability and readability.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e5330d1 and f16c97c.

Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
Files selected for processing (16)
  • Cargo.toml (1 hunks)
  • rocketmq-broker/Cargo.toml (1 hunks)
  • rocketmq-broker/src/client/manager/consumer_manager.rs (1 hunks)
  • rocketmq-broker/src/coldctr/cold_data_cg_ctr_service.rs (1 hunks)
  • rocketmq-broker/src/filter/expression_for_retry_message_filter.rs (1 hunks)
  • rocketmq-broker/src/filter/expression_message_filter.rs (1 hunks)
  • rocketmq-broker/src/processor/default_pull_message_result_handler.rs (4 hunks)
  • rocketmq-broker/src/processor/pull_message_processor.rs (8 hunks)
  • rocketmq-broker/src/topic/manager/topic_queue_mapping_manager.rs (1 hunks)
  • rocketmq-remoting/src/protocol/request_source.rs (5 hunks)
  • rocketmq-store/src/base/store_stats_service.rs (1 hunks)
  • rocketmq-store/src/kv.rs (1 hunks)
  • rocketmq-store/src/kv/compaction_store.rs (1 hunks)
  • rocketmq-store/src/log_file.rs (2 hunks)
  • rocketmq-store/src/message_store/default_message_store.rs (8 hunks)
  • rocketmq-store/src/queue/single_consume_queue.rs (1 hunks)
Files skipped from review due to trivial changes (4)
  • Cargo.toml
  • rocketmq-broker/Cargo.toml
  • rocketmq-broker/src/filter/expression_for_retry_message_filter.rs
  • rocketmq-broker/src/filter/expression_message_filter.rs
Additional context used
Learnings (1)
rocketmq-broker/src/client/manager/consumer_manager.rs (1)
Learnt from: TeslaRustor
PR: mxsm/rocketmq-rust#652
File: rocketmq-broker/src/client/manager/consumer_manager.rs:23-25
Timestamp: 2024-06-17T07:05:52.260Z
Learning: TeslaRustor plans to implement the `find_subscription_data` method in the `ConsumerManager` class in a future version and has acknowledged the current placeholder implementation.
Additional comments not posted (26)
rocketmq-store/src/kv.rs (1)

19-19: LGTM!

The new module compaction_store is correctly defined.

rocketmq-broker/src/coldctr/cold_data_cg_ctr_service.rs (1)

19-25: LGTM!

The new struct ColdDataCgCtrService and its method is_cg_need_cold_data_flow_ctr are correctly defined.

rocketmq-store/src/kv/compaction_store.rs (1)

1-40: LGTM!

The new struct CompactionStore and its methods new and get_message are correctly defined.

rocketmq-store/src/log_file.rs (1)

115-119: LGTM!

The new method find_consume_queue is correctly defined in the RocketMQMessageStore trait.

rocketmq-remoting/src/protocol/request_source.rs (3)

20-20: Addition of Unknown variant is a good practice.

Adding the Unknown variant helps handle cases where the request source is not recognized.


36-36: Update to get_value method is correct.

The get_value method now correctly handles the Unknown variant.


68-72: Implementation of From<i32> for RequestSource improves usability.

This change allows for easy conversion from i32 to RequestSource.

rocketmq-store/src/base/store_stats_service.rs (1)

142-144: Addition of get_message_transferred_msg_count method improves encapsulation.

This method provides access to the get_message_transferred_msg_count field, enhancing usability.

rocketmq-broker/src/client/manager/consumer_manager.rs (1)

144-156: Addition of compensate_basic_consumer_info method is useful for maintaining consistency.

This method allows for compensation of basic consumer information, which helps maintain consistency in consumer data.

rocketmq-broker/src/topic/manager/topic_queue_mapping_manager.rs (2)

102-181: Improvements to build_topic_queue_mapping_context method enhance accuracy.

The changes improve the accuracy of topic queue mapping and context generation, which is essential for correct message routing.


116-124: Enhancements to rewrite_request_for_static_topic method improve handling of static topics.

The changes ensure that requests are correctly rewritten based on the topic's mapping context.

rocketmq-broker/src/processor/default_pull_message_result_handler.rs (4)

26-26: Import Approved.

The import of get_current_millis from TimeUtils is appropriate for obtaining the current time in milliseconds.


48-48: Import Approved.

The import of PullRequest is appropriate as it is used in the file.


171-184: Changes Approved.

The ctx.upgrade() call and the conditional logic for transfer_msg_by_heap are appropriate and improve the handling of the message body.


203-212: Changes Approved.

The instantiation of PullRequest with the new parameters is appropriate.

Ensure that the PullRequest struct and its new method are correctly defined.

Verification successful

Changes Approved.

The instantiation of PullRequest with the new parameters is appropriate and the new method is correctly defined in the impl PullRequest block.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the `PullRequest` struct definition and its `new` method.

# Test: Search for the `PullRequest` struct definition. Expect: Correct definition with a `new` method.
rg --type rust 'pub struct PullRequest' && rg --type rust 'impl PullRequest {'

Length of output: 376


Script:

#!/bin/bash
# Description: Verify the `PullRequest` struct definition and its `new` method.

# Corrected Test: Search for the `PullRequest` struct definition.
rg --type rust 'pub struct PullRequest'

# Corrected Test: Search for the `impl PullRequest` block to verify the `new` method.
rg --type rust 'impl PullRequest {'

Length of output: 376


Script:

#!/bin/bash
# Description: Verify the `PullRequest` struct definition and its `new` method.

# Simplified Test: Search for the `PullRequest` struct definition.
rg --type rust 'pub struct PullRequest'

# Simplified Test: Search for the `impl PullRequest` block to verify the `new` method.
rg --type rust 'impl PullRequest'

Length of output: 342


Script:

#!/bin/bash
# Description: Verify the `new` method in the `impl PullRequest` block.

# Search for the `new` method definition within the `impl PullRequest` block.
rg --type rust 'impl PullRequest' -A 20 rocketmq-broker/src/long_polling/pull_request.rs | rg 'fn new'

Length of output: 120

rocketmq-store/src/queue/single_consume_queue.rs (1)

812-814: Refactor Approved.

The iterate_from_inner method now calls self.iterate_from, improving code maintainability and readability.

rocketmq-broker/src/processor/pull_message_processor.rs (7)

53-53: Import Approved.

The import of ColdDataCgCtrService is appropriate as it is used in the file.


77-77: Struct Modification Approved.

The addition of the cold_data_cg_ctr_service field to the PullMessageProcessor struct is appropriate and integrates the cold data control service into the pull message processing logic.


104-104: Constructor Modification Approved.

The update to the PullMessageProcessor constructor to initialize the cold_data_cg_ctr_service field is appropriate and ensures proper initialization.


554-554: Broadcast Consumption Check Approved.

The check for consume_broadcast_enable ensures that the consumer group is allowed to consume messages in broadcast mode.


685-693: Conditional Cold Data Flow Control Approved.

The conditional compilation for cold data flow control using cfg_if is appropriate and ensures that the feature is only included when enabled.


777-778: Broadcast Pull Initialization Approved.

The handling of RequestSource::ProxyForBroadcast in the query_broadcast_pull_init_offset method is appropriate.


844-849: Function is_broadcast Approved.

The is_broadcast function correctly determines if the request is for broadcast consumption.

rocketmq-store/src/message_store/default_message_store.rs (3)

233-233: Ensure proper initialization of compaction_store.

The compaction_store field is initialized with Arc::new(CompactionStore). Ensure that this initialization is correct and that CompactionStore does not require any parameters or specific setup.


765-773: Verify the compaction_store integration logic.

The get_message function now includes logic for the compaction_store. Ensure that this integration is correct and does not introduce any potential issues.


1025-1034: Review the new find_consume_queue function.

The find_consume_queue function has been added to the DefaultMessageStore implementation. Ensure that this function is correctly implemented and follows best practices.

Comment on lines +468 to +478
RequestSource::ProxyForBroadcast => {
unimplemented!("ProxyForBroadcast not implement")
}
RequestSource::ProxyForStream => {
unimplemented!("ProxyForStream not implement")
}
_ => self.consumer_manager.compensate_basic_consumer_info(
request_header.consumer_group.as_str(),
ConsumeType::ConsumePassively,
MessageModel::Clustering,
),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

Unimplemented Feature Notice.

The RequestSource::ProxyForBroadcast and RequestSource::ProxyForStream are not implemented in the specified lines. Ensure that these features are implemented or handled appropriately in all relevant parts of the codebase.

  • rocketmq-broker/src/processor/pull_message_processor.rs:
    • Lines 468-478
Analysis chain

Unimplemented Feature Notice.

The RequestSource::ProxyForBroadcast and RequestSource::ProxyForStream are not implemented. Ensure that these features are implemented or handled appropriately.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the handling of `RequestSource::ProxyForBroadcast` and `RequestSource::ProxyForStream`.

# Test: Search for the usage of `RequestSource::ProxyForBroadcast` and `RequestSource::ProxyForStream`. Expect: Appropriate handling or implementation.
rg --type rust 'RequestSource::ProxyForBroadcast' && rg --type rust 'RequestSource::ProxyForStream'

Length of output: 1407

@mxsm
Copy link
Owner Author

mxsm commented Jul 5, 2024

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f16c97c and e4efa93.

Files selected for processing (1)
  • rocketmq-remoting/src/protocol/request_source.rs (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • rocketmq-remoting/src/protocol/request_source.rs

Copy link

codecov bot commented Jul 5, 2024

Codecov Report

Attention: Patch coverage is 22.74368% with 214 lines in your changes missing coverage. Please review.

Project coverage is 27.94%. Comparing base (e5330d1) to head (e4efa93).

Files Patch % Lines
...q-store/src/message_store/default_message_store.rs 0.00% 112 Missing ⚠️
...r/src/topic/manager/topic_queue_mapping_manager.rs 0.00% 55 Missing ⚠️
...tmq-broker/src/processor/pull_message_processor.rs 64.58% 17 Missing ⚠️
...etmq-broker/src/client/manager/consumer_manager.rs 0.00% 8 Missing ⚠️
...c/processor/default_pull_message_result_handler.rs 0.00% 8 Missing ⚠️
rocketmq-store/src/kv/compaction_store.rs 0.00% 5 Missing ⚠️
rocketmq-remoting/src/protocol/request_source.rs 91.42% 3 Missing ⚠️
rocketmq-store/src/base/store_stats_service.rs 0.00% 3 Missing ⚠️
...tmq-broker/src/coldctr/cold_data_cg_ctr_service.rs 0.00% 2 Missing ⚠️
rocketmq-store/src/queue/single_consume_queue.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #736      +/-   ##
==========================================
+ Coverage   27.90%   27.94%   +0.04%     
==========================================
  Files         268      269       +1     
  Lines       21225    21322      +97     
==========================================
+ Hits         5922     5958      +36     
- Misses      15303    15364      +61     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved PR has approved auto merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement⚡️] Optimize pull message logic
2 participants