feat: allow running workflows with input from stdin

[morgante]

Now input can be in a file, allowing arbitrarily large input params.

Greptile Summary

This is an auto-generated summary

• Made input and verbose fields of ApplyMigrationArgs public in /crates/cli/src/commands/apply_migration.rs
• Added new Run subcommand to PlumbingArgs enum in /crates/cli/src/commands/plumbing.rs
• Integrated new subcommand to read input from stdin and run workflows
• Utilized run_apply_migration function for executing workflows with stdin input
• Ensured compatibility with existing SharedPlumbingArgs for input handling

Summary by CodeRabbit

• New Features
  • Introduced a new command variant for executing workflows from a file, enhancing the flexibility of workflow management.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the visibility of certain fields within the ApplyMigrationArgs struct and introduce a new Run variant to the PlumbingArgs enum. This allows for the execution of migration workflows defined in files. Adjustments in the logic now handle reading inputs, locating workflow files, and executing corresponding migrations.

Changes

File Path	Change Summary
crates/cli/src/commands/apply_migration.rs	Changed visibility of input and verbose fields in ApplyMigrationArgs struct to pub(crate).
crates/cli/src/commands/plumbing.rs	Introduced a new Run variant to the PlumbingArgs enum. Updated run_plumbing function to handle the new variant by reading input, locating the workflow file, and applying migration accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant FileSystem
    participant MigrationExecutor
    
    User ->> CLI: Execute command with PlumbingArgs::Run
    CLI ->> FileSystem: Read input and locate workflow file
    FileSystem -->> CLI: Return workflow file path
    CLI ->> MigrationExecutor: Call run_apply_migration with workflow file and input
    MigrationExecutor ->> CLI: Execute migration
    CLI -->> User: Return migration result

Loading

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f1dedc0 and f0799ac.

Files selected for processing (2)

• crates/cli/src/commands/apply_migration.rs (2 hunks)
• crates/cli/src/commands/plumbing.rs (3 hunks)

Additional context used

Learnings (1)

Common learnings

Learnt from: morgante
URL: https://github.com/getgrit/gritql/pull/231

Timestamp: 2024-04-15T05:47:47.743Z
Learning: User morgante prefers not to be asked for documentation.

Additional comments not posted (4)

crates/cli/src/commands/apply_migration.rs (2)

25-25: Visibility change of input field is approved.

The change to pub(crate) visibility for the input field is appropriate for enabling broader usage within the crate while maintaining encapsulation from other crates.

---

34-34: Visibility change of verbose field is approved.

The change to pub(crate) visibility for the verbose field is appropriate for enabling broader usage within the crate while maintaining encapsulation from other crates.

crates/cli/src/commands/plumbing.rs (2)

96-103: Addition of Run variant to PlumbingArgs is approved.

The addition of the Run variant with the shared_args and definition fields aligns with the objective of enabling workflows to run with input from stdin.

---

293-321: Changes to run_plumbing function are approved, but handle potential errors.

The changes to handle the new Run variant are logically sound. However, ensure to handle the potential error from find_workflow_file_from instead of using unwrap().

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 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.

[greptile-apps]

_{2 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings}

[greptile-apps]

🧠 logic: Consider handling the potential error from find_workflow_file_from instead of using unwrap().