Improvements around packaging

[jhaynie]

This was some code left over from a prototype i made last night around potentially bundling python. It has some good capabilities to allow us to inject additional data on-the-fly into the bundle before upload so I'm going to leave it in.

Summary by CodeRabbit

• Refactor

  • Improved deployment process with a preflight check wrapped in a spinner UI for better user feedback during bundling.
  • Updated spinner label to "Uploading ..." during the upload step for clearer status indication.

• Style

  • Enhanced progress feedback by refining spinner labels to more accurately describe deployment steps.

[coderabbitai]

Walkthrough

The deployment and bundling logic was refactored to introduce a zip archive mutator mechanism. The preflight check now returns a mutator callback, which is passed to the zip creation process, allowing post-processing of the archive. The zip utility was updated to support options for matchers and mutators. Spinner labels were clarified in the deployment workflow.

Changes

File(s)	Change Summary
cmd/cloud.go	Refactored deployment to use a preflight action with a spinner, capturing a zip mutator from preflight and passing it to the zip utility; updated spinner labels.
internal/bundler/bundler.go	Added CreateDeploymentMutator function (no-op for now); removed redundant log line; added (commented) helper for running Python in venv.
internal/deployer/deployer.go	Changed PreflightCheck to return a zip mutator and error; integrated mutator creation after bundling.
internal/util/io.go	Refactored ZipDir to accept option functions for matcher and mutator; added support for mutator callbacks; introduced related types and option constructors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Deployer
    participant Bundler
    participant Util

    User->>CLI: Initiate deployment
    CLI->>Deployer: PreflightCheck()
    Deployer->>Bundler: Bundle()
    Bundler-->>Deployer: Bundle result
    Deployer->>Bundler: CreateDeploymentMutator()
    Deployer-->>CLI: zipMutator, error
    CLI->>Util: ZipDir(..., WithMutator(zipMutator))
    Util-->>CLI: Deployment zip created
    CLI->>Server: Upload deployment zip
    Server-->>CLI: Upload response

Loading

Poem

In the meadow of code, a spinner spins bright,
Preflight checks ready us for a zippy new flight.
Mutators now hop in, with options in tow,
Bundles are crafted, then off they go!
“Uploading…” we cheer, as our archive ascends—
Another day’s work, as the deployment hop ends.
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65d3a41 and 60cc49a.

📒 Files selected for processing (4)

• cmd/cloud.go (3 hunks)
• internal/bundler/bundler.go (3 hunks)
• internal/deployer/deployer.go (1 hunks)
• internal/util/io.go (4 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

internal/bundler/bundler.go (1)

internal/util/io.go (1)

• ZipDirCallbackMutator (108-108)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Build and Test (macos-latest)
• GitHub Check: Test CLI Upgrade Path (windows-latest)

🔇 Additional comments (11)

cmd/cloud.go (3)

254-281: LGTM! Clean refactoring to support zip mutator mechanism.

The refactoring properly encapsulates the preflight logic into a separate action function while capturing the returned zipMutator. The logic flow remains unchanged, and the new mutator capability is seamlessly integrated.

---

481-489: Excellent integration of the new option-based ZipDir API.

The call correctly uses both WithMutator and WithMatcher options, maintaining the existing file filtering functionality while adding the new post-processing capability.

---

587-587: Good improvement in spinner label clarity.

Changing from "Deploying ..." to "Uploading ..." better reflects the actual operation being performed during the HTTP PUT request.

internal/deployer/deployer.go (1)

70-84: LGTM! Proper integration of zip mutator functionality.

The function signature change is well-implemented:

• Correctly returns the mutator type alongside the error
• Proper error handling: returns nil mutator on bundle failure
• Successfully creates and returns the deployment mutator using the bundle context
• Maintains all existing bundling logic and behavior

internal/bundler/bundler.go (3)

4-4: LGTM! Required import for zip mutator functionality.

The archive/zip import is necessary for the ZipDirCallbackMutator type used in the CreateDeploymentMutator function.

---

273-291: Well-documented placeholder code.

The commented-out runUVPython function is properly documented as being left for future use. This is a reasonable approach for code that may be needed later.

---

371-378: Perfect implementation of the deployment mutator hook.

The CreateDeploymentMutator function provides a clean no-op implementation that serves as a proper extensibility point for future zip archive modifications. The documentation clearly explains its intended purpose.

internal/util/io.go (4)

108-129: Excellent API design using the option pattern.

The introduction of ZipDirCallbackMutator, options struct, and option constructors provides a clean and extensible API. The WithMatcher and WithMutator functions follow Go's functional options pattern well.

---

132-149: Clean refactoring of function signature and option handling.

The change from variadic ZipDirCallbackMatcher to variadic Option is well-implemented. The option application logic is straightforward and properly handles the case where no options are provided.

---

163-167: Proper preservation of matcher functionality.

The matcher logic correctly uses the single matcher from the options struct while maintaining the same filtering behavior as the previous implementation.

---

184-188: Perfect timing and error handling for mutator execution.

The mutator is called at the right time (after all files are added but before zip finalization) with proper error handling and informative error messages.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.