Skip to content
New issue

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

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

Already on GitHub? # to your account

[ISSUE #2249]🚀AckMessageProcessor and BrokerStatsManager add shutdown method #2250

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

mxsm
Copy link
Owner

@mxsm mxsm commented Jan 15, 2025

Which Issue(s) This PR Fixes(Closes)

Fixes #2249

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

  • Chores
    • Added placeholder shutdown methods to AckMessageProcessor and BrokerStatsManager with warning logs
    • Prepared infrastructure for future shutdown functionality in broker and store components

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

This pull request adds a shutdown method to two different structs: AckMessageProcessor in the rocketmq-broker crate and BrokerStatsManager in the rocketmq-store crate. Both methods are currently placeholders that log a warning message indicating the shutdown functionality is not yet implemented. The changes are minimal and do not modify any existing functionality, serving as preparation for future shutdown mechanisms.

Changes

File Change Summary
rocketmq-broker/src/processor/ack_message_processor.rs Added pub fn shutdown(&mut self) method with warning log
rocketmq-store/src/stats/broker_stats_manager.rs Added pub fn shutdown(&self) method with warning log

Assessment against linked issues

Objective Addressed Explanation
Add shutdown method to AckMessageProcessor [#2249]
Add shutdown method to BrokerStatsManager [#2249]

Possibly related PRs

Suggested reviewers

  • TeslaRustor
  • SpaceXCN
  • rocketmq-rust-bot

Poem

🚀 Shutdown methods, a rabbit's delight,
Placeholders dancing in code so bright
Warning logs whisper of work to come
In RocketMQ's realm, where futures hum
A tiny step towards system's grace 🐰


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@rocketmq-rust-robot rocketmq-rust-robot added the feature🚀 Suggest an idea for this project. label Jan 15, 2025
@rocketmq-rust-robot rocketmq-rust-robot added this to the v0.4.0 milestone Jan 15, 2025
@rocketmq-rust-bot
Copy link
Collaborator

🔊@mxsm 🚀Thanks for your contribution🎉!

💡CodeRabbit(AI) will review your code first🔥!

Note

🚨The code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can decide whether to make changes based on their own judgment. Ultimately, the project management personnel will conduct the final code review💥.

@mxsm mxsm changed the title [ISSUE #2249]🚀AckMessageProcessor and BrokerStatsManager add shutdown… [ISSUE #2249]🚀AckMessageProcessor and BrokerStatsManager add shutdown method Jan 15, 2025
Copy link

codecov bot commented Jan 15, 2025

Codecov Report

Attention: Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.

Project coverage is 28.30%. Comparing base (681f0a8) to head (5247f6d).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...etmq-broker/src/processor/ack_message_processor.rs 0.00% 3 Missing ⚠️
rocketmq-store/src/stats/broker_stats_manager.rs 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2250      +/-   ##
==========================================
- Coverage   28.31%   28.30%   -0.01%     
==========================================
  Files         499      499              
  Lines       72187    72193       +6     
==========================================
  Hits        20437    20437              
- Misses      51750    51756       +6     

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

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: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 681f0a8 and 5247f6d.

📒 Files selected for processing (2)
  • rocketmq-broker/src/processor/ack_message_processor.rs (2 hunks)
  • rocketmq-store/src/stats/broker_stats_manager.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: build (windows-latest, nightly)
  • GitHub Check: build (windows-latest, stable)
  • GitHub Check: build (macos-latest, nightly)
  • GitHub Check: build (macos-latest, stable)
  • GitHub Check: test
  • GitHub Check: build (ubuntu-latest, nightly)
  • GitHub Check: build
  • GitHub Check: build (ubuntu-latest, stable)
  • GitHub Check: auto-approve
🔇 Additional comments (2)
rocketmq-store/src/stats/broker_stats_manager.rs (1)

33-33: LGTM!

The import is correctly placed and used by the new shutdown method.

rocketmq-broker/src/processor/ack_message_processor.rs (1)

49-49: LGTM!

The import is correctly placed and used by the new shutdown method.

Comment on lines +538 to +540
pub fn shutdown(&self) {
warn!("BrokerStatsManager shutdown unimplemented");
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Implement proper cleanup in the shutdown method.

The current implementation is a placeholder that only logs a warning. Consider implementing proper cleanup:

  • Clear stats tables to prevent memory leaks
  • Flush any pending stats to storage
  • Stop any background tasks or scheduled printers
  • Clean up any shared resources

Here's a suggested implementation:

 pub fn shutdown(&self) {
-    warn!("BrokerStatsManager shutdown unimplemented");
+    // Clear stats tables
+    self.stats_table.write().clear();
+    
+    // Stop scheduled printers
+    if let Some(broker_config) = &self.broker_config {
+        // Cleanup tasks specific to broker config
+    }
+    
+    // Clear moment stats
+    if let Some(stats) = &self.moment_stats_item_set_fall_size {
+        // Cleanup moment stats
+    }
+    if let Some(stats) = &self.moment_stats_item_set_fall_time {
+        // Cleanup moment stats
+    }
+    
+    // Shutdown account stat manager
+    self.account_stat_manager.shutdown();
+    
+    info!("BrokerStatsManager shutdown completed");
 }

Committable suggestion skipped: line range outside the PR's diff.

Comment on lines +578 to +580
pub fn shutdown(&mut self) {
warn!("AckMessageProcessor shutdown unimplemented, need to be implemented");
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Implement proper cleanup in the shutdown method.

The current implementation is a placeholder that only logs a warning. Consider implementing proper cleanup:

  • Wait for pending acks to complete
  • Handle in-flight messages
  • Clean up resources in the pop message processor
  • Ensure message delivery guarantees are maintained

Here's a suggested implementation:

 pub fn shutdown(&mut self) {
-    warn!("AckMessageProcessor shutdown unimplemented, need to be implemented");
+    // Wait for pending acks to complete
+    // TODO: Add timeout to prevent infinite wait
+    while self.has_pending_acks() {
+        tokio::time::sleep(Duration::from_millis(100)).await;
+    }
+    
+    // Clean up pop message processor
+    self.pop_message_processor.shutdown().await;
+    
+    // Clean up broker runtime
+    self.broker_runtime_inner.shutdown().await;
+    
+    info!("AckMessageProcessor shutdown completed");
 }
+
+fn has_pending_acks(&self) -> bool {
+    // Implement check for pending acks
+    false
+}

Committable suggestion skipped: line range outside the PR's diff.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
AI review first Ai review pr first approved PR has approved auto merge feature🚀 Suggest an idea for this project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature🚀]AckMessageProcessor and BrokerStatsManager add shutdown method
3 participants