bacalhau-project / bacalhau

Compute over Data framework for public, transparent, and optionally verifiable computation
https://docs.bacalhau.org
Apache License 2.0
643 stars 85 forks source link

refactor: migrate wasm CLI to v2 #4060

Closed frrist closed 3 weeks ago

frrist commented 3 weeks ago
coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes introduce new APIs for handling wasm run in the Bacalhau CLI. Key updates include modifications to the WasmRunOptions struct, refactoring of functions for job creation and execution, and the addition of a WasmEngineBuilder type for building wasm engine configurations. These changes aim to enhance the flexibility and maintainability of the codebase without altering user-visible CLI flags.

Changes

Files/Groups Change Summary
cmd/cli/wasm/wasm_run.go Updated WasmRunOptions struct, refactored runWasm to run, replaced CreateJob with build, modified parseWasmEntryModule.
cmd/cli/wasm/wasm_run_test.go Updated import paths and modified function calls to use updated client versions and data structures.
cmd/util/flags/types.go Refactored functions to return pointers to models.InputSource and updated logic for creating storage specs.
pkg/executor/wasm/models/types.go Introduced WasmEngineBuilder type with methods for building SpecConfig for wasm engines.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant CLI
    participant JobBuilder
    participant WasmEngineBuilder
    participant JobExecutor

    User->>CLI: Execute `wasm run`
    CLI->>JobBuilder: Build job with options
    JobBuilder->>WasmEngineBuilder: Configure wasm engine
    WasmEngineBuilder->>JobBuilder: Return SpecConfig
    JobBuilder->>JobExecutor: Submit job
    JobExecutor->>CLI: Return job result
    CLI->>User: Display result

Assessment against linked issues

Objective (Issue #4021) Addressed Explanation
Use new APIs for wasm run
Ensure no user-visible change and maintain CLI flags
Support old flag names while printing new ones in help

Poem

In the code where wasm runs, New APIs dance under the sun, With flags old and new, Jobs sail smoothly through, A rabbit's work is never done. 🐇✨

[!WARNING]

Review ran into problems

Problems (1) * Git: Failed to clone repository. Please contact CodeRabbit support.

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.
frrist commented 3 weeks ago

@coderabbitai /review

coderabbitai[bot] commented 3 weeks ago

@frrist, I will review the changes in the pull request.

Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.