feat: refine region state checks and handle stalled requests

[WenyXu]

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

refine region state checks and handle stalled requests

Checklist

• I have written the necessary rustdoc comments.
• I have added the necessary unit tests and integration tests.
• This PR requires documentation updates.

Summary by CodeRabbit

• New Features

  • Introduced NotifyRegionChangeResultListener for enhanced region change notifications.
  • Added asynchronous test for handling concurrent alter requests.
  • New methods for improved error handling in region management, including get_region_or and writable_region_or.
  • Enhanced management of stalled requests with new methods for rejection and handling.

• Bug Fixes

  • Improved error handling and state management in region edit and change requests.

• Documentation

  • Updated method signatures to reflect new constraints and functionalities.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes in this pull request introduce a new listener, NotifyRegionChangeResultListener, and enhance the functionality of region alteration notifications. A new asynchronous test function is added to validate concurrent operations during region changes. Modifications are made to the EventListener trait and several methods in the RegionMap and StalledRequests structures to improve error handling and request management. The RegionWorkerLoop implementation is updated to enforce type constraints and enhance handling of region edits and write requests, ensuring better organization and management of stalled requests.

Changes

File Path	Change Summary
src/mito2/src/engine/alter_test.rs	- Added NotifyRegionChangeResultListener listener. - Introduced async test function test_write_stall_on_altering().
src/mito2/src/engine/listener.rs	- Added async method on_notify_region_change_result_begin to EventListener trait. - Added NotifyRegionChangeResultListener struct and its methods.
src/mito2/src/region.rs	- Added methods get_region_or and writable_region_or with callback functionality. - Updated flushable_region_or method to include callback handling.
src/mito2/src/worker.rs	- Updated StalledRequests struct to use HashMap<RegionId, Vec<SenderWriteRequest>>. - Added method remove for removing stalled requests by region ID.
src/mito2/src/worker/handle_alter.rs	- Updated RegionWorkerLoop<S> to require S: LogStore. - Maintained core logic in handle_alter_request method.
src/mito2/src/worker/handle_manifest.rs	- Updated RegionWorkerLoop<S> to require S: LogStore. - Enhanced error handling in handle_region_edit and handle_manifest_region_change methods.
src/mito2/src/worker/handle_write.rs	- Added methods for managing stalled requests: reject_stalled_requests, reject_region_stalled_requests, handle_region_stalled_requests. - Updated logic in handle_write_requests.

Possibly related PRs

• feat: migrate local WAL regions #4715: Involves region management and migration, potentially related to the new listener and test for region changes.
• feat: support to reject write after flushing #4759: Focuses on rejecting writes after flushing, relevant to control flow and notification handling during region changes.
• feat: add region_statistics table #4771: Introduces the region_statistics table, relating to overall management and notification of region states.

Suggested reviewers

• v0y4g3r
• evenyag
• MichaelScofield
• waynexia

Poem

In the land where regions dwell,
A listener rings a joyful bell.
With changes made and tests anew,
Stalled requests find paths to pursue.
Oh, hop along, let data flow,
In harmony, our regions grow! 🐇✨

---

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

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

[codecov]

Codecov Report

Attention: Patch coverage is 83.75635% with 32 lines in your changes missing coverage. Please review.

Project coverage is 83.82%. Comparing base (84aa5b7) to head (51e58e6).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4971      +/-   ##
==========================================
- Coverage   84.06%   83.82%   -0.25%     
==========================================
  Files        1143     1144       +1     
  Lines      212619   213296     +677     
==========================================
+ Hits       178743   178792      +49     
- Misses      33876    34504     +628     

[WenyXu]

@coderabbitai summary

[coderabbitai]

✅ Actions performed

Summary regeneration triggered.

[evenyag]

Others LGTM

[fengjiachun]

LGTM