feat: add utilities for streaming paths

[morgante]

We want to be able to chain different queries together, even across different enginers. This adds a basic pipe (unoptimized, single-threaded).

Greptile Summary

This is an auto-generated summary

• Added execute_streaming_child method for streaming paths
• Modified existing methods to support streaming functionality
• Introduced FlushableMessenger trait with async flush method
• Implemented FlushableMessenger for TestingMessenger
• Enhanced error handling and tracing capabilities

Summary by CodeRabbit

• New Features

  • Introduced new streaming capabilities for handling problem executions.
  • Added a new trait FlushableMessenger for asynchronous message flushing.
  • Extended MatchResult with a method to return the variant type.

• Improvements

  • Enhanced tool reliability and efficiency through refined message handling and streaming logic.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes introduce several new functionalities and improvements across the codebase. Key updates include new methods for streaming execution in the Problem struct, the addition of a FlushableMessenger trait for handling message flushing asynchronously, and enhancements to the MatchResult enum to expose its variant type. These updates enhance the codebase by improving messaging capabilities and adding new streaming execution methods, thereby enriching the functionality and maintainability of the system.

Changes

File Path	Summary
crates/core/src/problem.rs	Added streaming methods (execute_paths_streaming, execute_streaming_child, execute_streaming_relay) to Problem struct and necessary imports.
crates/marzano_messenger/src/emit.rs	Introduced FlushableMessenger trait with async flush method for message flushing.
crates/cli/src/commands/apply_migration.rs	Added import statement for FlushableMessenger trait.
crates/cli/src/commands/apply_pattern.rs	Added import statement for FlushableMessenger trait.
crates/cli/src/commands/check.rs	Added import statement for FlushableMessenger trait.
crates/cli/src/messenger_variant.rs	Implemented FlushableMessenger trait for MessengerVariant and reorganized flush method accordingly.
crates/core/src/api.rs	Extended MatchResult enum with a new method kind(&self) -> &'static str.

Sequence Diagrams

sequenceDiagram
    participant P as Problem
    participant CA as Caller (execute caller)
    participant M as MatchResult
    participant TX as Sender<Vec<MatchResult>>
    CA->>P: call execute_paths_streaming(files, context, tx, cache)
    activate P
    P-->>TX: sending Vec<MatchResult>
    deactivate P

Loading

sequenceDiagram
    participant P as Problem
    participant RX as Receiver<Vec<MatchResult>>
    participant TX as Sender<Vec<MatchResult>>
    RX->>P: receive Vec<MatchResult>
    activate P
    P-->>TX: send Vec<MatchResult>
    deactivate P

Loading

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1975e25 and 8d984d2.

Files selected for processing (7)

• crates/cli/src/commands/apply_migration.rs (1 hunks)
• crates/cli/src/commands/apply_pattern.rs (1 hunks)
• crates/cli/src/commands/check.rs (1 hunks)
• crates/cli/src/messenger_variant.rs (2 hunks)
• crates/core/src/api.rs (1 hunks)
• crates/core/src/problem.rs (4 hunks)
• crates/marzano_messenger/src/emit.rs (1 hunks)

Files skipped from review due to trivial changes (1)

• crates/cli/src/commands/apply_pattern.rs

Files skipped from review as they are similar to previous changes (2)

• crates/core/src/problem.rs
• crates/marzano_messenger/src/emit.rs

Additional context used

Learnings (1)

Common learnings

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.

Additional comments not posted (4)

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

3-3: Good import statement for FlushableMessenger.

This import is crucial for enabling the emitter.flush().await?; call in the run_apply_migration function. It ensures that the emitter conforms to the new FlushableMessenger trait, which is essential for proper message handling and resource cleanup.

crates/cli/src/messenger_variant.rs (1)

191-192: Implementation of FlushableMessenger for MessengerVariant.

The implementation of the flush method is well-structured, with appropriate feature-based conditional logic. It ensures that only the relevant messengers perform a flush operation, which is crucial for performance and resource management.

crates/cli/src/commands/check.rs (1)

16-16: Proper use of FlushableMessenger trait with as _.

The usage of as _ is appropriate here as it brings in the flush method without cluttering the namespace, which is particularly useful in a file with multiple trait imports and complex functionality.

crates/core/src/api.rs (1)

47-59: New method kind added to MatchResult.

The implementation of the kind method is concise and covers all variants of the MatchResult enum. This method enhances the usability of the MatchResult type by allowing easy access to type information, which can be particularly useful for logging or conditional processing based on the type of result.

---

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]

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

[coderabbitai]

Actionable comments posted: 1

[grit-app]

View earlier commits

On commit 1975e25, Grit tried to heal these tests:

Job	Original Status	Final Status
main / Rust wasm	❌ Failed	❗ Failed on attempt #2 after trying strategies ai, rerun
main / Test the standard library	❌ Failed	❗ Failed on attempt #2 after trying strategies ai, rerun
main / Rust tests (marzano) (nscloud-ubuntu-22.04-amd64-8x32)	❌ Failed	❗ Failed on attempt #2 after trying strategies ai, rerun
code quality / clippy_check	❌ Failed	❗ Failed on attempt #3 after trying strategies ai, rerun

On commit 0a3f056, Grit tried to heal these tests:

Job	Original Status	Final Status
main / Test the standard library	❌ Failed	❗ Failed on attempt #3 after trying strategies ai, rerun
main / Rust tests (marzano) (nscloud-ubuntu-22.04-amd64-8x32)	❌ Failed	❗ Failed on attempt #3 after trying strategies ai, rerun
main / clippy	❌ Failed	❗ Failed on attempt #3 after trying strategies ai, rerun
code quality / clippy_check	❌ Failed	❗ Failed on attempt #3 after trying strategies ai, rerun

Tip

You can view and edit CI healing settings on the Grit App.

[coderabbitai]

Actionable comments posted: 1