[ISSUE #2857]♻️Refactor PutResultProcess

[mxsm]

Which Issue(s) This PR Fixes(Closes)

Fixes #2857

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

• Refactor
  • Streamlined the message result handling process by switching from asynchronous to a synchronous approach.
  • Simplified error management and result retrieval, reducing unnecessary complexity in the processing workflow.

[coderabbitai]

Walkthrough

The changes refactor the PutResultProcess in the RocketMQ broker scheduler. The asynchronous oneshot channel logic has been removed, eliminating the future and result_sender fields. The method formerly known as set_future is now renamed to set_put_message_result, and the get method now returns the message result synchronously rather than awaiting a future. In sync_deliver, the asynchronous result retrieval has been replaced with a direct call to the updated synchronous method.

Changes

File(s)	Summary of Changes
rocketmq-broker/src/.../schedule_message_service.rs	Removed asynchronous oneshot channel logic by eliminating future and result_sender fields from PutResultProcess; renamed set_future to set_put_message_result and updated get to return the result synchronously.

Sequence Diagram(s)

sequenceDiagram
    participant Broker
    participant PutResultProcess
    Broker->>PutResultProcess: sync_deliver()
    Note right of PutResultProcess: get() returns result synchronously
    PutResultProcess-->>Broker: Return PutMessageResult

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure the refactor does not introduce new bugs (#2857)	✅
Update unit tests if applicable (#2857)	❓	No test modifications mentioned in the changes.
Ensure the refactor does not negatively impact performance (#2857)	✅
Document any new patterns or architecture changes (#2857)	❌	Documentation for the new synchronous handling is missing.

Possibly related PRs

• [ISSUE #2808]⚡️Replace PutResultProcess attributes String with CheetahString🍻 #2809: Addresses modifications in field types of PutResultProcess, complementing the removal of asynchronous handling in this PR.
• [ISSUE #2755]♻️Refactor LocalFileMessage put message #2757: Aligns with changes in message result handling by eliminating asynchronous logic in related put_message methods.

Suggested labels

refactor♻️, auto merge, ready to review, waiting-review, AI review first

Suggested reviewers

• TeslaRustor
• SpaceXCN
• rocketmq-rust-bot

Poem

In the code garden, I hop with delight,
Synchronous paths now make things bright.
Old channels vanish—a silent goodbye,
New logic blooms beneath a clear sky.
With keen rabbit eyes, I cheer this art,
Hop along smoothly with a happy code heart! 🐇✨

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7faf5e0 and 14b09a6.

📒 Files selected for processing (1)

• rocketmq-broker/src/schedule/schedule_message_service.rs (5 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: build (ubuntu-latest, stable)
• GitHub Check: build (windows-latest, stable)
• GitHub Check: build (macos-latest, stable)
• GitHub Check: build (macos-latest, nightly)
• GitHub Check: build (windows-latest, nightly)
• GitHub Check: build (ubuntu-latest, nightly)
• GitHub Check: build
• GitHub Check: test
• GitHub Check: auto-approve

🔇 Additional comments (5)

rocketmq-broker/src/schedule/schedule_message_service.rs (5)

787-789: Synchronous operation improved performance.

The method call has been changed from awaiting result_process.get().await to using the synchronous result_process.get(), aligning with the removal of the oneshot channel and making this operation more direct and efficient.

---

899-900: Good simplification of the PutResultProcess structure.

Replacing the oneshot channel (removed future and result_sender fields) with a direct Option<PutMessageResult> simplifies the code by eliminating the async channel complexity.

---

966-968: Method name accurately reflects the new implementation.

The method has been renamed from set_future to set_put_message_result, which more accurately describes what it does - directly setting the result value rather than setting up a future.

---

1179-1184: Simplified result retrieval logic.

Converting the get method from async to sync is a good improvement. The implementation gracefully handles the case when no result has been set by returning a default error result.

---

1049-1057: Review handle_result method in context of refactoring.

The handle_result method expects to process a PutMessageResult, but with the refactoring of the then_process method, it's unclear if and how this method will be called.

Make sure to review how handle_result will be integrated with the new synchronous approach. If then_process previously handled the result asynchronously and called handle_result, you need to ensure this handling is preserved in the refactored code.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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]

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

[Copilot]

Pull Request Overview

This PR refactors the PutResultProcess to eliminate the asynchronous oneshot channel mechanism in favor of a synchronous result handling approach. Key changes include the removal of the oneshot channel, renaming the setter from set_future to set_put_message_result, and changing the get() method from an async to a synchronous call.

Comments suppressed due to low confidence (2)

rocketmq-broker/src/schedule/schedule_message_service.rs:1179

• Changing get() from asynchronous to synchronous may cause issues if put_message_result is accessed before it is set. Consider ensuring that the result is reliably set before calling get() or documenting the timing assumptions clearly.

pub fn get(&mut self) -> PutMessageResult {

rocketmq-broker/src/schedule/schedule_message_service.rs:966

• [nitpick] The new method name set_put_message_result clearly reflects its functionality. It would be beneficial to update the method documentation to mention that it replaces the previous asynchronous future mechanism.

pub fn set_put_message_result(mut self, put_result: PutMessageResult) -> Self {

[codecov]

Codecov Report

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

Project coverage is 27.55%. Comparing base (7faf5e0) to head (14b09a6).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...mq-broker/src/schedule/schedule_message_service.rs	0.00%	8 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2858   +/-   ##
=======================================
  Coverage   27.55%   27.55%           
=======================================
  Files         527      527           
  Lines       78054    78048    -6     
=======================================
  Hits        21504    21504           
+ Misses      56550    56544    -6     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[rocketmq-rust-bot]

LGTM