Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: expose --remote flag to launch remote workflows on Grit Cloud #317

Merged
merged 9 commits into from
May 7, 2024

Conversation

morgante
Copy link
Contributor

@morgante morgante commented May 6, 2024

Summary by CodeRabbit

  • New Features

    • Introduced advanced workflow capabilities in the command-line interface, including support for remote workflows and enhanced migration application processes.
  • Enhancements

    • Improved user feedback by logging workflow start URLs, enhancing visibility and traceability of remote operations.
  • Refactor

    • Streamlined function calls and argument handling in CLI commands to improve performance and maintainability.
  • Style

    • Added colorized logging to enhance readability and user experience during CLI interactions.

@morgante morgante requested a review from a team as a code owner May 6, 2024 22:30
Copy link
Contributor

coderabbitai bot commented May 6, 2024

Walkthrough

Walkthrough

The recent updates focus on enhancing feature management and refining function implementations in the CLI tool. Key changes include the redistribution of the "remote_workflows" feature between feature flags, introduction of a new method for handling migration payloads, and improvements in remote workflow execution logging. These modifications aim to streamline feature access and improve the usability and maintainability of the code.

Changes

File Path Change Summary
.../cli/Cargo.toml Adjusted feature flags in default and grit_beta sections, adding "workflows_v2" and moving "remote_workflows".
.../src/commands/apply.rs Enhanced run_apply to accept additional arguments when the remote feature is enabled.
.../src/commands/apply_migration.rs Added get_payload method to ApplyMigrationArgs and refactored run_apply_migration to utilize it.
.../src/workflows.rs Updated run_remote_workflow to improve logging and simplify return statements. Added colored::Colorize for enhanced output.

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 927d23c and 2e1cb87.
Files selected for processing (1)
  • crates/cli/src/commands/apply_migration.rs (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • crates/cli/src/commands/apply_migration.rs
Additional Context Used
Learnings (1)
Common
User: 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.

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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

@@ -181,15 +180,32 @@

#[cfg(feature = "remote_workflows")]
pub async fn run_remote_workflow(workflow_name: String) -> Result<()> {
use colored::Colorize;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove unused import.

-    use colored::Colorize;

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
use colored::Colorize;

let outcome = grit_cloud_client::run_remote_workflow(settings, &auth).await?;
display_workflow_outcome(outcome)?;
return Ok(());
let url = grit_cloud_client::run_remote_workflow(settings, &auth).await?;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The function run_remote_workflow is not found in grit_cloud_client. Verify the correct import or function name.

-    let url = grit_cloud_client::run_remote_workflow(settings, &auth).await?;
+    let url = run_remote_workflow(settings, &auth).await?;

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
let url = grit_cloud_client::run_remote_workflow(settings, &auth).await?;
let url = run_remote_workflow(settings, &auth).await?;

let auth = updater.get_valid_auth()?;

pb.set_message("Launching workflow on Grit Cloud");

let repo = ModuleRepo::from_dir(&cwd).await;
let settings = grit_cloud_client::RemoteWorkflowSettings::new(workflow_name, &repo);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type RemoteWorkflowSettings is not found in grit_cloud_client. Verify the correct import or type name.

-    let settings = grit_cloud_client::RemoteWorkflowSettings::new(workflow_name, &repo);
+    let settings = RemoteWorkflowSettings::new(workflow_name, &repo);

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
let settings = grit_cloud_client::RemoteWorkflowSettings::new(workflow_name, &repo);
let settings = RemoteWorkflowSettings::new(workflow_name, &repo);

@morgante morgante merged commit 8ef68dd into main May 7, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants