getgrit / gritql

GritQL is a query language for searching, linting, and modifying code.
https://docs.grit.io/
MIT License
3.17k stars 82 forks source link

fix: refine some of the --remote workflow logic #507

Closed morgante closed 2 months ago

morgante commented 2 months ago
  1. Better messaging in logs
  2. Fix a bug with multi-line log processing

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough The changes in this pull request primarily involve renaming functions and structures related to workflow commands and uploads across several files in the codebase. Key modifications include renaming `run_upload_workflows` to `run_upload_workflow` and `WorkflowsUploadArgs` to `WorkflowUploadArgs`. Additionally, improvements were made to error handling and user feedback during workflow uploads. The `LogMessage` struct was updated to enhance string handling for serialization. Overall, the adjustments aim to clarify naming conventions and streamline the workflow upload process. ## Changes | Files | Change Summary | |------------------------------------------------|-------------------------------------------------------------------------------------------------| | `crates/cli/src/commands/mod.rs` | Renamed `run_upload_workflows` to `run_upload_workflow`. | | `crates/cli/src/commands/workflows.rs` | Renamed `WorkflowsUploadArgs` to `WorkflowUploadArgs`. | | `crates/cli/src/commands/workflows_upload.rs` | Renamed `WorkflowsUploadArgs` to `WorkflowUploadArgs`; renamed `run_upload_workflows` to `run_upload_workflow`; improved error handling and logic for workflow uploads. | | `crates/cli/src/workflows.rs` | Renamed imported functions and argument structures related to uploads; updated user feedback during upload. | | `crates/core/src/foreign_function_definition.rs` | Changed error handling return type from `Result` to `GritResult`. | | `crates/gritmodule/src/searcher.rs` | Added `absolute_path` method to `WorkflowInfo` struct for obtaining absolute workflow paths. | | `crates/marzano_messenger/src/logs.rs` | Modified `LogMessage` struct to use `Cow<'a, str>` for `message` field; updated related methods for serialization compatibility. | ## Possibly related PRs - **#332**: Involves workflow connectivity, potentially relevant to workflow command handling. - **#379**: Focuses on streaming workflow logs, related to workflow command modifications. - **#411**: Enhances reporting capabilities of workflows, aligning with workflow command changes. - **#493**: Directly relates to the addition of workflow upload functionality. - **#500**: Introduces the ability to upload and execute workflows with existing IDs, closely connected to workflow command modifications.

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 generate interesting stats about this repository and render them as a table.` -- `@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. ### 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.
Early access features: enabled We are currently testing the following features in early access: - **OpenAI `o1` for code reviews**: OpenAI's new o1 model is being tested for generating code suggestions in code reviews. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.