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 #2314]Add License header for NotifyMinBrokerIdChangeRequestHeader #2315

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

flydream-ylgw
Copy link
Contributor

@flydream-ylgw flydream-ylgw commented Jan 17, 2025

Which Issue(s) This PR Fixes(Closes)

Fixes #2314

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

  • New Features

    • Added a new struct NotifyMinBrokerIdChangeRequestHeader for handling broker ID change notifications
    • Implemented serialization and deserialization methods for the new struct
  • Chores

    • Added placeholder for field validation method

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

Walkthrough

This pull request introduces a new file brokerid_change_request_header.rs in the RocketMQ Rust remoting protocol module. The file defines a new struct NotifyMinBrokerIdChangeRequestHeader with optional fields related to broker identification and address management. The struct implements serialization, deserialization, and custom header traits, providing methods to convert the header to and from a map representation.

Changes

File Change Summary
rocketmq-remoting/src/protocol/header/namesrv/brokerid_change_request_header.rs Added new struct NotifyMinBrokerIdChangeRequestHeader with Serde serialization, CommandCustomHeader trait implementation, and FromMap trait for map conversion

Assessment against linked issues

Objective Addressed Explanation
Add License Header [#2314]

Possibly related issues

Possibly related PRs

Suggested reviewers

  • TeslaRustor
  • SpaceXCN
  • rocketmq-rust-bot

Poem

🚀 A Broker's Tale of Change

In Rust's domain, a header springs to life,
With fields that dance, both gentle and rife
Optional addresses, broker IDs so bright
A serialized story of protocol's might!

🐰 Code hops forward, traits unfurled!


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

🔊@flydream-ylgw 🚀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💥.

@RocketmqRustBot RocketmqRustBot added the enhancement⚡️ New feature or request label Jan 17, 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: 0

🔭 Outside diff range comments (2)
rocketmq-remoting/src/protocol/header/namesrv/brokerid_change_request_header.rs (2)

Line range hint 102-104: Implement the required check_fields method.

The check_fields() method is currently marked with todo!(), which will panic at runtime. This method should validate the header fields according to the protocol requirements.

Would you like me to help implement the field validation logic for this method?


Line range hint 106-166: Fix duplicate insertion of ha_broker_addr in to_map method.

The ha_broker_addr field is being inserted into the map twice, which is redundant and could mask bugs. The second insertion should be removed.

Apply this fix:

         if let Some(ref ha_broker_addr) = self.ha_broker_addr {
             map.insert(
                 CheetahString::from_static_str(
                     NotifyMinBrokerIdChangeRequestHeader::HA_BROKER_ADDR,
                 ),
                 ha_broker_addr.clone(),
             );
         }
 
         if let Some(ref offline_broker_addr) = self.offline_broker_addr {
             map.insert(
                 CheetahString::from_static_str(
                     NotifyMinBrokerIdChangeRequestHeader::OFFLINE_BROKER_ADDR,
                 ),
                 offline_broker_addr.clone(),
             );
         }
 
-        if let Some(ref ha_broker_addr) = self.ha_broker_addr {
-            map.insert(
-                CheetahString::from_static_str(
-                    NotifyMinBrokerIdChangeRequestHeader::HA_BROKER_ADDR,
-                ),
-                ha_broker_addr.clone(),
-            );
-        }

Additionally, consider refactoring the repetitive map insertion code to reduce duplication:

impl NotifyMinBrokerIdChangeRequestHeader {
    fn insert_if_some<T: ToString>(
        map: &mut HashMap<CheetahString, CheetahString>,
        key: &'static str,
        value: &Option<T>,
    ) {
        if let Some(v) = value {
            map.insert(
                CheetahString::from_static_str(key),
                CheetahString::from_string(v.to_string()),
            );
        }
    }
}
🧹 Nitpick comments (1)
rocketmq-remoting/src/protocol/header/namesrv/brokerid_change_request_header.rs (1)

Line range hint 31-47: Add documentation for the struct and its fields.

While the struct definition is well-structured, it would benefit from documentation comments explaining:

  • The purpose of the struct
  • The significance of each field
  • Any constraints or valid value ranges for fields like min_broker_id

Add documentation like this:

+/// Represents a request header for notifying changes in minimum broker ID.
+/// This header is used in the RocketMQ namesrv protocol for broker management.
 #[derive(Debug, Clone, Serialize, Deserialize, Default)]
 pub struct NotifyMinBrokerIdChangeRequestHeader {
+    /// The minimum broker ID in the cluster
     #[serde(rename = "minBrokerId")]
     pub min_broker_id: Option<u64>,
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e06178f and 02b810d.

📒 Files selected for processing (1)
  • rocketmq-remoting/src/protocol/header/namesrv/brokerid_change_request_header.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: build
  • GitHub Check: build (ubuntu-latest, stable)
  • GitHub Check: test
  • GitHub Check: auto-approve
🔇 Additional comments (1)
rocketmq-remoting/src/protocol/header/namesrv/brokerid_change_request_header.rs (1)

1-16: LGTM! License header is properly added.

The Apache 2.0 license header is correctly formatted and included as required by the PR objectives.

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

@mxsm mxsm merged commit eb6d6b1 into mxsm:main Jan 17, 2025
22 of 25 checks passed
@rocketmq-rust-bot rocketmq-rust-bot added approved PR has approved and removed ready to review waiting-review waiting review this PR labels Jan 17, 2025
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.20%. Comparing base (e06178f) to head (02b810d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2315   +/-   ##
=======================================
  Coverage   28.20%   28.20%           
=======================================
  Files         504      504           
  Lines       72470    72470           
=======================================
  Hits        20440    20440           
  Misses      52030    52030           

☔ 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
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⚡️] Add License header for NotifyMinBrokerIdChangeRequestHeader
4 participants