feat: introduce the interface of `RemoteJobScheduler`

zyy17 commented 3 weeks ago

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?

`RemoteJobScheduler`

For the storage disaggregated system, we can always offload the CPU-intensive and IO-intensive tasks(for example, compaction and index) to the remote workers. For the above scenario, the PR introduces the abstraction.

RemoteJobScheduler is a trait that defines the API for scheduling remote jobs. Its implementation is in GreptimeDB Enterprise.

/// RemoteJobScheduler is a trait that defines the API to schedule remote jobs.
#[async_trait::async_trait]
pub trait RemoteJobScheduler: Send + Sync + 'static {
    /// Sends a job to the scheduler and returns a unique identifier for the job.
    async fn schedule(&self, job: RemoteJob, notifier: Arc<dyn Notifier>) -> Result<JobId>;
}

/// Notifier is used to notify the mito engine when a remote job is completed.
#[async_trait::async_trait]
pub trait Notifier: Send + Sync + 'static {
    /// Notify the mito engine that a remote job is completed.
    async fn notify(&self, result: RemoteJobResult);
}

The PR modify schedule_compaction_request() to support remote compaction:

If the compact request specifies the remote_compaction in region_options and the RemoteJobScheduler is initialized, the Mito will execute remote compaction;
If the remote compaction fails, fall back to local compaction;

Other changes

Add the async keyword for all the compaction-related functions because the schedule_compaction_request needs to be async;
Use Option type for senders in CompactionFinished because we don't need it in remote compaction scenario;
Add remote_compaction in compaction options;

TODOs

[x] Inject RemoteJobScheduler from the plugin system;
[ ] ~~Design the API to fetch the Jobs from the scheduler. When the datanode restarts, it can rebuild the context of the remote job~~;
[ ] ~~Add the unit tests for the RemoteJobScheduler~~;

Checklist

[x] 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 support for remote compaction scheduling.
- Added Plugins functionality to enhance compaction scheduling and handling.
- Enabled asynchronous operations for scheduling and finishing compaction tasks.
- Integrated remote job scheduling mechanics for compaction.
Enhancements
- Updated MitoEngine and EngineInner constructors to accept plugins parameters.
- Improved error handling with new RemoteJobScheduler and other error variants.
- Added checks for remote_compaction in compaction options.
Bug Fixes
- Improved test framework to handle new plugin arguments and asynchronous calls.

zyy17 commented 3 weeks ago

I make some stupid(git reflog save me again) git operations and suddenly can't reopen the original PR #4124. I had no choice but to create a new PR. I'm sorry for the confusion.

coderabbitai[bot] commented 3 weeks ago

[!NOTE]

Reviews paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.

@coderabbitai review to trigger a single review.

Walkthrough

The recent changes introduce asynchronous functionality and plugins to the compaction feature of the Mito engine. They include new structures for remote job scheduling and result handling, with alterations to various modules to support these features. The modifications enhance the flexibility of the compaction process, allowing for both local and remote task handling, and improve error management within the system.

Changes

Files/Modules	Change Summary
`src/mito2/src/compaction.rs`	Added `Plugins`, made some functions async, and handled remote compaction fallback to local compaction.
`src/mito2/src/engine.rs`	Added `plugins` parameter to `MitoEngine` and `EngineInner` constructors.
`src/mito2/src/error.rs`	Added `RemoteJobScheduler`, `OutputTx`, and `ParseJobId` to `Error` enum, and handled these variants in error extension implementation.
`src/mito2/src/region/options.rs`	Added `remote_compaction` function and `remote_compaction` field to `TwcsOptions` struct.
`src/datanode/src/datanode.rs`, `src/mito2/src/test_util.rs`	Modified functions to include `Plugins` parameters where applicable.
`src/mito2/src/compaction/compactor.rs`	Updated `open_compaction_region` function to use `ObjectStoreManagerRef`.
`src/store-api/src/mito_engine_options.rs`	Added `"compaction.twcs.remote_compaction"` to `is_mito_engine_option_key` function check list.
`src/mito2/src/schedule/remote_job_scheduler.rs`	Added remote job scheduling functionality, defining traits, job types, and notification mechanisms.

Sequence Diagram(s)

sequenceDiagram
    participant PluginManager
    participant CompactionScheduler
    participant RemoteJobScheduler
    participant Worker
    participant ErrorHandler

    PluginManager->>CompactionScheduler: Initialize with Plugins
    CompactionScheduler->>RemoteJobScheduler: Schedule Compaction (async)
    RemoteJobScheduler->>Worker: Execute Job
    Worker-->>RemoteJobScheduler: Job Result (async)
    RemoteJobScheduler->>CompactionScheduler: Job Finished Notification (async)
    CompactionScheduler->>ErrorHandler: Handle Errors (if any)

Poem

🐇 In lines of code, a tale unfolds, Of compaction tasks both brave and bold. With async calls and plugins near, Remote jobs now can interfere. Errors handled, smooth and bright, Our Mito engine takes new flight. 🚀

[!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](https://discord.com/invite/GsXnASn26c) 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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 59.27419% with 101 lines in your changes missing coverage. Please review.

Project coverage is 84.52%. Comparing base (e531326) to head (0f9335d).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #4181 +/- ## ========================================== - Coverage 84.84% 84.52% -0.32% ========================================== Files 1049 1050 +1 Lines 186267 186427 +160 ========================================== - Hits 158029 157585 -444 - Misses 28238 28842 +604 ```

sunng87 commented 3 weeks ago

Mostly LGTM. @fengjiachun @v0y4g3r @evenyag PTAL and add comments from your perspective

evenyag commented 2 weeks ago

@coderabbitai pause

coderabbitai[bot] commented 2 weeks ago

Actions performed

Reviews paused.

GreptimeTeam / greptimedb