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 #2223]💫Remove BrokerRuntime unused code and enhancement code🧑‍💻 #2224

Merged
merged 1 commit into from
Jan 12, 2025

Conversation

mxsm
Copy link
Owner

@mxsm mxsm commented Jan 12, 2025

Which Issue(s) This PR Fixes(Closes)

Fixes #2223

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

  • Refactor

    • Updated broker runtime structure to use optional broker stats manager
    • Removed custom cloning implementation for broker runtime
  • Changes

    • Broker stats manager can now be uninitialized or absent
    • Initialization logic modified to support optional stats manager

Copy link
Contributor

coderabbitai bot commented Jan 12, 2025

Walkthrough

The pull request modifies the BrokerRuntime structure in the rocketmq-broker/src/broker_runtime.rs file. The key changes include removing the custom Clone implementation and transforming the broker_stats_manager field from a non-optional Arc<BrokerStatsManager> to an optional Option<Arc<BrokerStatsManager>>. This modification allows for more flexible initialization and handling of the broker statistics manager, potentially simplifying the runtime's configuration and management.

Changes

File Change Summary
rocketmq-broker/src/broker_runtime.rs - Removed custom Clone implementation for BrokerRuntime
- Changed broker_stats_manager from Arc<BrokerStatsManager> to Option<Arc<BrokerStatsManager>>
- Updated initialization logic to set broker_stats_manager to None initially

Assessment against linked issues

Objective Addressed Explanation
Remove unused code [#2223]
Enhance BrokerRuntime code structure

Possibly related issues

Possibly related PRs

Suggested labels

refactor♻️, enhancement⚡️, auto merge, ready to review, waiting-review, AI review first, rocketmq-broker crate

Suggested reviewers

  • TeslaRustor
  • SpaceXCN
  • rocketmq-rust-bot

Poem

🚀 In the realm of RocketMQ's code,
A broker's runtime takes a new mode
Optional stats, no clone in sight
Refactoring brings a clearer light!
Simplicity dances, complexity fades
A rabbit's code review serenade 🐰


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 the enhancement⚡️ New feature or request label Jan 12, 2025
Copy link

codecov bot commented Jan 12, 2025

Codecov Report

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

Project coverage is 28.37%. Comparing base (50a3b55) to head (788bd38).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
rocketmq-broker/src/broker_runtime.rs 0.00% 14 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2224      +/-   ##
==========================================
+ Coverage   28.35%   28.37%   +0.01%     
==========================================
  Files         498      498              
  Lines       72058    72012      -46     
==========================================
  Hits        20435    20435              
+ Misses      51623    51577      -46     

☔ 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: 1

🔭 Outside diff range comments (1)
rocketmq-broker/src/broker_runtime.rs (1)

Line range hint 184-208: Assign the initialized should_start_time to inner to ensure consistency

At lines 184-208, you initialize should_start_time with Arc::new(AtomicU64::new(0)), but when constructing inner, you set should_start_time to Default::default() instead of the initialized value. This can lead to inconsistencies, especially since pop_inflight_message_counter relies on the initialized should_start_time. Consider assigning the initialized should_start_time to inner.should_start_time to maintain consistency.

Apply this diff to fix the issue:

 let should_start_time = Arc::new(AtomicU64::new(0));
 let pop_inflight_message_counter =
     PopInflightMessageCounter::new(should_start_time.clone());

 let mut inner = ArcMut::new(BrokerRuntimeInner::<DefaultMessageStore> {
     store_host,
     broker_config,
     message_store_config,
     server_config,
     topic_config_manager: None,
     topic_queue_mapping_manager,
     consumer_offset_manager: Default::default(),
     subscription_group_manager: None,
     consumer_filter_manager: Some(Default::default()),
     consumer_order_info_manager: None,
     message_store: None,
     broker_stats: None,
     schedule_message_service: Default::default(),
     timer_message_store: None,
     broker_outer_api,
     producer_manager,
     consumer_manager,
     broadcast_offset_manager: Default::default(),
-    broker_stats_manager: None,
-    topic_queue_mapping_clean_service: None,
-    update_master_haserver_addr_periodically: false,
-    should_start_time: Default::default(),
+    broker_stats_manager: None,
+    topic_queue_mapping_clean_service: None,
+    update_master_haserver_addr_periodically: false,
+    should_start_time: should_start_time.clone(),
     is_isolated: Default::default(),
     pull_request_hold_service: None,
     rebalance_lock_manager: Default::default(),
     broker_member_group,
     transactional_message_check_listener: None,
     transactional_message_check_service: None,
     transaction_metrics_flush_service: None,
     topic_route_info_manager: None,
     escape_bridge: None,
     pop_inflight_message_counter,
 });
🧹 Nitpick comments (1)
rocketmq-broker/src/broker_runtime.rs (1)

223-230: Avoid unnecessary cloning of inner to improve performance

In lines 224-229, inner is cloned multiple times when setting up stats_manager. Cloning inner can be expensive if it contains large data structures. Consider using references (&inner) or Arc to avoid unnecessary cloning and improve performance.

Apply this diff to optimize the code:

 let mut stats_manager = BrokerStatsManager::new(Arc::new(inner.broker_config.clone()));
 stats_manager.set_producer_state_getter(Arc::new(ProducerStateGetter {
-    broker_runtime_inner: inner.clone(),
+    broker_runtime_inner: inner.clone(), // Use Arc or reference if possible
 }));
 stats_manager.set_consumer_state_getter(Arc::new(ConsumerStateGetter {
-    broker_runtime_inner: inner.clone(),
+    broker_runtime_inner: inner.clone(), // Use Arc or reference if possible
 }));

Consider changing the ProducerStateGetter and ConsumerStateGetter to accept references or Arc to avoid cloning inner.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 50a3b55 and 788bd38.

📒 Files selected for processing (1)
  • rocketmq-broker/src/broker_runtime.rs (7 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: auto-approve
  • GitHub Check: build (ubuntu-latest, stable)
🔇 Additional comments (2)
rocketmq-broker/src/broker_runtime.rs (2)

329-329: ⚠️ Potential issue

Ensure broker_stats_manager is initialized before usage to prevent None errors

At line 329, self.inner.broker_stats_manager.clone() is used in initializing DefaultMessageStore. Since broker_stats_manager is an Option, there is a risk of it being None, which could lead to a runtime error. Ensure that broker_stats_manager is properly initialized before this point.


1291-1294: 🛠️ Refactor suggestion

⚠️ Potential issue

Implement or remove the unimplemented broker_stats_manager_mut method

The method broker_stats_manager_mut at lines 1291-1294 is currently unimplemented and will panic if called. If this method is intended for future use, provide an implementation. Otherwise, consider removing it to prevent accidental usage that could cause a panic.

 #[inline]
 pub fn broker_stats_manager_mut(&mut self) -> &mut BrokerStatsManager {
-    /* &mut self.broker_stats_manager */
-    unimplemented!("broker_stats_manager_mut")
+    self.broker_stats_manager.as_mut().expect("broker_stats_manager is not initialized")
 }

Alternatively, if broker_stats_manager should always be initialized, you can implement the method to return the mutable reference safely.

Likely invalid or redundant comment.

Comment on lines +1576 to 1579
self.broker_stats_manager.as_ref().unwrap()
}

#[inline]
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

Handle potential None value to prevent panic in broker_stats_manager method

In the accessor method at lines 1576-1579, broker_stats_manager unconditionally unwraps the Option without checking for None. This can cause a panic if broker_stats_manager is not initialized. Consider using expect with a descriptive message or handling the None case appropriately.

Apply this diff to improve the error handling:

 #[inline]
 pub fn broker_stats_manager(&self) -> &BrokerStatsManager {
-    self.broker_stats_manager.as_ref().unwrap()
+    self.broker_stats_manager.as_ref().expect("broker_stats_manager is not initialized")
 }

This provides a clearer message in case of a panic and helps with debugging.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
self.broker_stats_manager.as_ref().unwrap()
}
#[inline]
self.broker_stats_manager.as_ref().expect("broker_stats_manager is not initialized")
}
#[inline]

Copy link
Collaborator

@rocketmq-rust-bot rocketmq-rust-bot left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AI review first Ai review pr first approved PR has approved auto merge enhancement⚡️ New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement⚡️] Remove BrokerRuntime unused code and enhancement code
3 participants