search

Oxen-AI / Oxen

Oxen.ai's core rust library, server, and CLI
https://oxen.ai
Apache License 2.0
201 stars 12 forks source link

add async fork #469

Closed EloyMartinez closed 3 days ago

EloyMartinez commented 3 days ago

Description:

This pull request introduces a new asynchronous mechanism for forking repositories within the Oxen project. The implementation enhances the existing forking functionality by allowing operations to be performed in the background, thereby improving the user experience for large repositories by not blocking the user interface.

Key Changes:

Asynchronous Forking Process: The core addition is the asynchronous execution of the fork process. This is achieved by spawning a new thread to handle the copying of repository data to the new destination, allowing the main application flow to continue uninterrupted.

Fork Status Tracking: We've introduced a mechanism for tracking the status of ongoing fork operations. This includes states such as InProgress, Complete, and Failed, along with progress tracking for the copying process. This status can be queried through a new endpoint, providing real-time feedback on the operation's progress.

Error Handling Enhancements: The PR includes improved error handling, specifically for scenarios where the destination repository already exists or when an issue arises during the fork process. Error states are now more descriptive and include additional details to aid in troubleshooting.

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 3 days ago

Walkthrough

The changes in this pull request introduce enhancements to the error handling and forking processes within the codebase. A new error variant, RepoAlreadyExistsAtDestination, is added to the OxenError enum for better error reporting. The forking functionality is significantly restructured, with the introduction of asynchronous operations, new functions for managing fork statuses, and a new endpoint for retrieving fork status. Additionally, the fork function in the controller is updated to improve error handling and response management.

Changes

File Path Change Summary
src/lib/src/error.rs Added variant RepoAlreadyExistsAtDestination(Box<StringError>) to OxenError enum; added method repo_already_exists_at_destination(value: StringError) -> Self.
src/lib/src/repositories.rs Removed export of fork function (pub use fork::fork;).
src/lib/src/repositories/fork.rs Replaced fork function with start_fork; added functions get_fork_status, write_status, read_status; modified copy_dir_recursive to include additional parameters.
src/lib/src/view/fork.rs Updated ForkRequest to derive Serialize, added enum ForkStatus and structs ForkStatusFile, ForkStartResponse, ForkStatusResponse; added implementation for ForkStatus.
src/server/src/controllers/fork.rs Updated fork function to use repositories::fork::start_fork; added get_status function for retrieving fork status.
src/server/src/services/fork.rs Added new GET route /fork/status to retrieve fork operation status, alongside existing POST route.

Possibly related PRs

🐰 In the code where we play,
New errors come out to say,
"A repo's here, it can't be done!"
Forking now is so much fun!
With status checks and threads that race,
Our code hops to a better place! 🌟

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 , 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. ### CodeRabbit Configuration 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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.