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 #2265]🚀ScheduleMessageService and TopicRouteInfoManager add shutdown method #2266

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 #2265

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

  • New Features
    • Added placeholder shutdown methods to ScheduleMessageService and TopicRouteInfoManager
  • Chores
    • Implemented warning logs for unfinished shutdown functionality

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

This pull request adds a shutdown method to two structs: ScheduleMessageService and TopicRouteInfoManager. Both methods are currently unimplemented and simply log a warning message indicating that the shutdown functionality is not yet developed. The changes are minimal and provide a placeholder for future implementation of shutdown logic in these components of the RocketMQ Rust broker.

Changes

File Change Summary
rocketmq-broker/src/schedule/schedule_message_service.rs Added pub fn shutdown(&mut self) method with warning log
rocketmq-broker/src/topic/manager/topic_route_info_manager.rs Added pub fn shutdown(&mut self) method with warning log

Assessment against linked issues

Objective Addressed Explanation
Add shutdown method to ScheduleMessageService
Add shutdown method to TopicRouteInfoManager

Possibly related PRs

Suggested labels

feature🚀, auto merge, ready to review, waiting-review, AI review first

Suggested reviewers

  • TeslaRustor
  • SpaceXCN
  • rocketmq-rust-bot

Poem

🚀 Shutdown methods, a rabbit's delight,
Placeholders waiting to take flight
Warning logs dancing with glee
Unimplemented, but soon to be free
A promise of future's bright design 🐰


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

@rocketmq-rust-robot rocketmq-rust-robot added this to the v0.4.0 milestone Jan 15, 2025
@rocketmq-rust-robot rocketmq-rust-robot added the feature🚀 Suggest an idea for this project. label Jan 15, 2025
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

🧹 Nitpick comments (1)
rocketmq-broker/src/schedule/schedule_message_service.rs (1)

44-46: Consider relationship between shutdown() and stop() methods

The struct already implements a stop() method from the ConfigManager trait. Consider:

  1. Implementing shutdown logic in stop() and having shutdown() call stop()
  2. Or document the difference between these methods if they serve different purposes

Additionally, consider implementing proper cleanup:

 pub fn shutdown(&mut self) {
-    warn!("ScheduleMessageService shutdown not implemented");
+    // Clean up broker config resources
+    // TODO: Add cleanup logic
+    warn!("ScheduleMessageService shutdown implementation pending");
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8e02a1d and 63de3a7.

📒 Files selected for processing (2)
  • rocketmq-broker/src/schedule/schedule_message_service.rs (2 hunks)
  • rocketmq-broker/src/topic/manager/topic_route_info_manager.rs (1 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: build (ubuntu-latest, nightly)
  • GitHub Check: test
  • GitHub Check: build (ubuntu-latest, stable)
  • GitHub Check: build
  • GitHub Check: auto-approve

Comment on lines +92 to +94
pub fn shutdown(&mut self) {
warn!("TopicRouteInfoManager shutdown not implemented");
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add shutdown state verification in public methods

To prevent usage after shutdown, add state checks in public methods:

fn verify_running(&self) -> Result<(), &'static str> {
    match *self.state.as_ref() {
        ServiceState::Running => Ok(()),
        ServiceState::Shutdown => Err("Service is shutdown"),
    }
}

This should be called at the start of methods like update_topic_route_info_from_name_server_ext, try_to_find_topic_publish_info, etc.


⚠️ Potential issue

Implement proper resource cleanup in shutdown

The current implementation lacks critical shutdown logic:

  1. The tokio task spawned in start() needs to be cancelled
  2. Shared resources (Arc/Mutex) should be properly cleaned up
  3. Consider adding shutdown synchronization

Here's a suggested implementation:

+#[derive(Default)]
+enum ServiceState {
+    #[default]
+    Running,
+    Shutdown,
+}

 pub struct TopicRouteInfoManager<MS> {
+    state: ArcMut<ServiceState>,
+    shutdown_complete: Option<tokio::sync::oneshot::Sender<()>>,
     // ... other fields ...
 }

 pub fn shutdown(&mut self) {
-    warn!("TopicRouteInfoManager shutdown not implemented");
+    // Set state to shutdown to stop the background task
+    *self.state.mut_from_ref() = ServiceState::Shutdown;
+    
+    // Signal shutdown
+    if let Some(shutdown) = self.shutdown_complete.take() {
+        let _ = shutdown.send(());
+    }
+    
+    // Clear tables
+    self.topic_route_table.mut_from_ref().clear();
+    self.broker_addr_table.mut_from_ref().clear();
+    self.topic_publish_info_table.mut_from_ref().clear();
+    self.topic_subscribe_info_table.mut_from_ref().clear();
+    
+    info!("TopicRouteInfoManager shutdown complete");
 }

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

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.29%. Comparing base (8e02a1d) to head (63de3a7).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
...mq-broker/src/schedule/schedule_message_service.rs 0.00% 3 Missing ⚠️
...oker/src/topic/manager/topic_route_info_manager.rs 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2266      +/-   ##
==========================================
- Coverage   28.30%   28.29%   -0.01%     
==========================================
  Files         503      503              
  Lines       72215    72221       +6     
==========================================
  Hits        20437    20437              
- Misses      51778    51784       +6     

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

@mxsm mxsm merged commit ede63cc into main Jan 15, 2025
23 of 26 checks passed
@mxsm mxsm deleted the feature-2265 branch January 15, 2025 07:52
@rocketmq-rust-bot rocketmq-rust-bot added approved PR has approved and removed ready to review waiting-review waiting review this PR labels Jan 15, 2025
# 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🚀]ScheduleMessageService and TopicRouteInfoManager add shutdown method
3 participants