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

Implement fork a repo feature. #465

Closed EloyMartinez closed 1 week ago

EloyMartinez commented 1 week ago

Summary by CodeRabbit

Release Notes

These changes enhance the repository management experience by providing a straightforward method for users to create forks while ensuring data integrity.

coderabbitai[bot] commented 1 week ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new module named fork across multiple files, enhancing the repository management functionality. A function to create a fork of an existing repository is implemented, along with necessary error handling and directory management. Additionally, a new struct ForkRequest is introduced for handling HTTP requests related to forking. The routing and service layers are updated to accommodate these changes, including a new endpoint for handling fork operations. Overall, this update expands the capabilities of the repository management system.

Changes

File Path Change Summary
src/lib/src/repositories.rs Added new module pub mod fork; and exported pub use fork::fork;.
src/lib/src/repositories/fork.rs Introduced pub fn fork(original_repo_path: &Path, new_repo_path: &Path) -> Result<(), OxenError> and fn copy_dir_recursive(src: &Path, dst: &Path) -> Result<(), OxenError>.
src/lib/src/test.rs Added variable let new_repo_dir = repo_dir.parent().unwrap().join("forked"); in run_empty_local_repo_test.
src/lib/src/view.rs Added new module pub mod fork;.
src/lib/src/view/fork.rs Introduced struct ForkRequest with fields: pub namespace: String, pub new_repo_name: Option<String>.
src/server/src/controllers.rs Added new module pub mod fork;.
src/server/src/controllers/fork.rs Added pub async fn fork(req: HttpRequest, body: web::Json<ForkRequest>) -> Result<HttpResponse, OxenHttpError>.
src/server/src/routes.rs Added method services::fork().
src/server/src/services.rs Added new module pub mod fork; and public use declaration pub use fork::fork;.
src/server/src/services/fork.rs Added function fn fork() -> Scope to define routing for /fork with POST requests.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Controller
    participant Repository

    Client->>Server: POST /fork
    Server->>Controller: fork(req, body)
    Controller->>Repository: fork(original_repo_path, new_repo_path)
    Repository-->>Controller: Success/Failure
    Controller-->>Server: HTTP Response (201 Created/Error)
    Server-->>Client: Response

🐰 "In the burrow, a fork was made,
New paths to explore, no time to fade.
With hops and skips, we copy with care,
A repository fork, a joy to share!
So let us cheer for the code we write,
For every new feature brings pure delight!" 🐇


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.
gschoeni commented 1 week ago

@EloyMartinez my one thought is for large repos the recursive copy could take a long time - for the future we might want to kick off a background thread to do the copying and then have an api to get whether the fork had finished. I think we should ship this to let @Artforge start playing with it.

gschoeni commented 1 week ago

Also - is there any scenario in which we would want to be able to fork into the same namespace with a different name? That was my first intuition while testing locally - but not the use case from the hub.

gschoeni commented 1 week ago

I just realized the response doesn't actually return json either, just a 200, I'm going to return RepositoryCreationView just so it is easier to see success