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: handle AND/OR and priority in matches fn #4270

Merged
merged 5 commits into from
Jul 4, 2024

Conversation

waynexia
Copy link
Member

@waynexia waynexia commented Jul 3, 2024

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

The A in AST is for abstract. So does this patch

Checklist

  • I have written the necessary rustdoc comments.
  • I have added the necessary unit tests and integration tests.
  • This PR requires documentation updates.

Summary by CodeRabbit

  • New Features

    • Enhanced pattern matching functionality for more efficient and flexible pattern expressions.
  • Refactor

    • Restructured AST transformation process for improved code readability and maintainability.

@waynexia waynexia requested a review from a team as a code owner July 3, 2024 14:08
Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Note

Reviews paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

This update implements significant changes in the src/common/function directory. It activates the let_chains feature to utilize more complex control flows in Rust. The alterations in the src/common/function/src/scalars/matches.rs file include modifications to pattern matching and AST transformation processes, enhancing parsing, transforming, and evaluating pattern expressions.

Changes

Files Summary
src/common/function/src/lib.rs Added #![feature(let_chains)] to enable more advanced control flow features in Rust.
src/common/function/src/scalars/matches.rs Added new types and methods, restructured AST transformation, and modified pattern matching logic, including changes in public function declarations and implementation details.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant MatchesFunction as MatchesFunction
    participant PatternAst as PatternAst
    participant ASTTransformer as ASTTransformer

    User->>MatchesFunction: Execute match function
    MatchesFunction->>PatternAst: Parse Pattern Expression
    PatternAst->>ASTTransformer: Initiate transformation process
    ASTTransformer-->>PatternAst: Return transformed AST
    PatternAst-->>MatchesFunction: Transformed AST
    MatchesFunction-->>User: Evaluate and return results
Loading

Poem

In the realm of Rust, where logic entwines,
Let chains now enhance as the feature shines.
AST reformed, patterns refined,
Matching expressions, beautifully defined.
With every change, our code aligns.
A rabbit’s delight in improvements combined! 🐇✨


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

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Jul 3, 2024
Signed-off-by: Ruihang Xia <[email protected]>
@waynexia
Copy link
Member Author

waynexia commented Jul 3, 2024

@coderabbitai pause

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: 0

Outside diff range and nitpick comments (1)
src/common/function/src/scalars/matches.rs (1)

Line range hint 15-18: Potential issue with the recursive call in eval.

The recursive call to self.eval in the eval function might cause a stack overflow if the pattern is too complex. Consider refactoring this part to avoid deep recursion.

- self.eval(columns[0].clone(), pattern)
+ self.evaluate(columns[0].clone(), pattern)
fn evaluate(&self, data: VectorRef, pattern: String) -> Result<VectorRef> {
    // existing implementation
}
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 76fac35 and c32f812.

Files selected for processing (2)
  • src/common/function/src/lib.rs (1 hunks)
  • src/common/function/src/scalars/matches.rs (12 hunks)
Files skipped from review due to trivial changes (1)
  • src/common/function/src/lib.rs
Additional comments not posted (19)
src/common/function/src/scalars/matches.rs (19)

165-185: LGTM!

The function into_like_expr correctly handles the new AST structure and the use of the reduce method is appropriate.


209-219: LGTM!

The function transform_ast correctly applies the transformation rules and the use of the transform_up and transform_down methods is appropriate.


226-266: LGTM!

The function collapse_binary_branch_fn correctly collapses binary branches with the same operator and the use of the Transformed enum is appropriate.


273-339: LGTM!

The function eliminate_optional_fn correctly eliminates optional patterns based on the specified rules.


346-364: LGTM!

The function eliminate_single_child_fn correctly eliminates single child nodes.


369-384: LGTM!

The function apply_children correctly implements the apply_children method of the TreeNode trait for PatternAst.


387-402: LGTM!

The function map_children correctly implements the map_children method of the TreeNode trait for PatternAst.


Line range hint 424-435: LGTM!

The function parse_pattern correctly handles the new AST structure and the use of the to_rpn method is appropriate.


147-150: LGTM!

The enum variant PatternAst::Binary correctly includes children for binary operations.


151-157: LGTM!

The enum variant UnaryOp correctly represents unary operators.


158-164: LGTM!

The enum variant BinaryOp correctly represents binary operators.


Line range hint 784-805: LGTM!

The enum variant Token correctly includes new token types for the parser.


Line range hint 137-146: LGTM!

The enum variant PatternAst correctly includes new variants for pattern matching.


Line range hint 165-402: LGTM!

The struct implementation PatternAst correctly includes new methods for pattern matching.


Line range hint 424-435: LGTM!

The struct implementation ParserContext correctly handles the new AST structure.


Line range hint 784-805: LGTM!

The test function valid_matches_tokenizer correctly includes new test cases for the tokenizer.


Line range hint 784-805: LGTM!

The test function invalid_matches_tokenizer correctly includes new test cases for invalid patterns.


Line range hint 784-805: LGTM!

The test function valid_ast_transformer correctly tests the AST transformer with various cases.


Line range hint 784-805: LGTM!

The test function valid_matches_parser correctly includes new test cases for the parser.

Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Actions performed

Reviews paused.

Copy link

codecov bot commented Jul 3, 2024

Codecov Report

Attention: Patch coverage is 96.57702% with 14 lines in your changes missing coverage. Please review.

Project coverage is 84.68%. Comparing base (ee9a5d7) to head (6e810ac).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4270      +/-   ##
==========================================
- Coverage   84.94%   84.68%   -0.27%     
==========================================
  Files        1057     1057              
  Lines      187517   187814     +297     
==========================================
- Hits       159279   159041     -238     
- Misses      28238    28773     +535     

Copy link
Contributor

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

Looks good to me. I have a question: how can we match string literals that are keywords, such as AND and OR? Is there a way to escape them?

@waynexia
Copy link
Member Author

waynexia commented Jul 4, 2024

Looks good to me. I have a question: how can we match string literals that are keywords, such as AND and OR? Is there a way to escape them?

quote them should fine. I'll add a test case for this.

Copy link
Contributor

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@fengjiachun fengjiachun added this pull request to the merge queue Jul 4, 2024
Merged via the queue into GreptimeTeam:main with commit 03c933c Jul 4, 2024
51 checks passed
@waynexia waynexia deleted the matches-part-2 branch July 4, 2024 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants