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

refactor: add RemoteCompaction error #4251

Merged
merged 2 commits into from
Jul 2, 2024

Conversation

zyy17
Copy link
Collaborator

@zyy17 zyy17 commented Jul 2, 2024

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?

The RemoteCompaction will use for CompactionJobResult and sends the notification to Mito.

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 a new error handling mechanism for remote region compaction failures, providing detailed information about the region_id, job_id, reason, and location of the error.
  • Improvements

    • Enhanced the accessibility of error information by making the location field public in the remote job scheduler errors.

Copy link
Contributor

coderabbitai bot commented Jul 2, 2024

Walkthrough

The update introduces a RemoteCompaction error variant to handle remote region compaction failures, encapsulating details like region_id, job_id, reason, and location. Additionally, the location field in RemoteJobSchedulerError is made public to facilitate external access.

Changes

File Change Summary
src/mito2/src/error.rs Added RemoteCompaction variant to Error enum, modified ErrorExt implementation to handle the new variant.
src/mito2/src/schedule/... Made location field public in RemoteJobSchedulerError struct.

Poem

In code so vast, new errors bloom,
RemoteCompaction tales of gloom,
With region, job, and reasons clear,
And locations now are crystal near.
Compaction's path is smooth and new,
Here's to code—it grew, it flew!
🐇✨


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Jul 2, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e64379d and 4c52e29.

Files selected for processing (2)
  • src/mito2/src/error.rs (3 hunks)
  • src/mito2/src/schedule/remote_job_scheduler.rs (1 hunks)
Additional comments not posted (4)
src/mito2/src/schedule/remote_job_scheduler.rs (1)

69-69: Visibility of location field.

Making the location field public improves error handling and debugging by exposing location information associated with remote job scheduling errors. Ensure that this change does not inadvertently expose sensitive information.

src/mito2/src/error.rs (3)

36-36: New import: JobId.

The new JobId import is necessary for the RemoteCompaction error variant. Ensure that JobId is correctly defined and used elsewhere in the codebase.


772-785: New error variant: RemoteCompaction.

The new RemoteCompaction error variant is well-defined and provides detailed information about remote compaction failures, including region_id, job_id, reason, and location. This enhances error reporting and debugging capabilities.


906-906: Handle new error variant in status_code.

The new RemoteCompaction error variant is correctly mapped to StatusCode::Unexpected in the status_code method. This ensures consistent error handling.

Copy link

codecov bot commented Jul 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.69%. Comparing base (f2c08b8) to head (7883ffe).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4251      +/-   ##
==========================================
- Coverage   84.96%   84.69%   -0.27%     
==========================================
  Files        1052     1054       +2     
  Lines      186787   186950     +163     
==========================================
- Hits       158705   158342     -363     
- Misses      28082    28608     +526     

Copy link
Collaborator

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

src/mito2/src/error.rs Outdated Show resolved Hide resolved
@zyy17 zyy17 force-pushed the refactor/remote-compaction-error branch from 4c52e29 to 7883ffe Compare July 2, 2024 12:18
@zyy17 zyy17 enabled auto-merge July 2, 2024 12:18
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4c52e29 and 7883ffe.

Files selected for processing (1)
  • src/mito2/src/error.rs (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/mito2/src/error.rs

@zyy17 zyy17 added this pull request to the merge queue Jul 2, 2024
Merged via the queue into GreptimeTeam:main with commit fd4a928 Jul 2, 2024
52 checks passed
@zyy17 zyy17 deleted the refactor/remote-compaction-error branch July 2, 2024 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants