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

fix: call df_func with literal #4265

Merged
merged 2 commits into from
Jul 5, 2024
Merged

Conversation

discord9
Copy link
Contributor

@discord9 discord9 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?

fix a bug where calling datafusion function from flow with literal args will cause datafusion to throw error with unmatched type

Please explain IN DETAIL what the changes are in this PR and why they are needed:

  • add a check to not rewrite literal in df func's calling arguments
  • add sqlness test for that case

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 logging for scalar function evaluation, providing better insights during the debugging process.
  • Improvements

    • Improved handling of literals in scalar functions with the introduction of a new method.

@discord9 discord9 requested review from zhongzc, waynexia and a team as code owners July 3, 2024 09:39
Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Walkthrough

The latest modifications enhance the logging capabilities within the DfScalarFunction implementation and related processes. By adding detailed info and debug statements, these changes aim to give developers improved insights into function evaluations, making debugging more straightforward and improving overall visibility into the datafusion scalar function evaluations.

Changes

Files Change Summaries
src/flow/src/expr/scalar.rs Introduced info and debug logging, capturing important stages of function evaluation and record batch processing.
src/flow/src/transform/expr.rs Added info and debug logging, a new function is_proto_literal, and updated rewrite_scalar_function for handling literals.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant DfScalarFunction
    participant Logger
    Client->>DfScalarFunction: Evaluate function
    DfScalarFunction->>Logger: info!("Evaluating scalar function: {:?}", self)
    DfScalarFunction->>DfScalarFunction: Process function
    DfScalarFunction->>Logger: info!("Values: {:?}, Exprs: {:?}", values, exprs)
    DfScalarFunction->>Logger: info!("Evaluated values: {:?}", values)
    DfScalarFunction->>Logger: info!("Processed with record batch: {:?}", rb)
    DfScalarFunction-->>Client: Return result
Loading

Poem

In the code’s forest, logs now gleam and glow,
With info and debug, what insights they bestow.
Scalar functions speak, their secrets to the light,
Guiding devs in darkness, making wrongs go right.
🌟✨🐰


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.

src/flow/src/expr/scalar.rs Outdated Show resolved Hide resolved
src/flow/src/expr/scalar.rs Outdated Show resolved Hide resolved
src/flow/src/expr/scalar.rs Outdated Show resolved Hide resolved
@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Jul 3, 2024
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: 6

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ddf2e6a and 48e61eb.

Files selected for processing (4)
  • src/flow/src/expr/scalar.rs (4 hunks)
  • src/flow/src/transform/expr.rs (3 hunks)
  • tests/cases/standalone/flow/basic.result (1 hunks)
  • tests/cases/standalone/flow/basic.sql (1 hunks)
Additional comments not posted (11)
tests/cases/standalone/flow/basic.sql (1)

40-43: Update flow creation statement.

The CREATE FLOW statement should be updated to match the new logic for grouping by truncated timestamps.

tests/cases/standalone/flow/basic.result (1)

71-75: Update flow creation result.

The result of the CREATE FLOW statement should be updated to match the new logic for grouping by truncated timestamps.

src/flow/src/expr/scalar.rs (5)

23-23: Added logging import.

The common_telemetry::info import has been added to enable logging.


213-214: Added logging for scalar function evaluation.

Logging statements have been added to provide visibility into the evaluation process of DataFusion scalar functions.


217-217: Added logging for evaluated values.

A logging statement has been added to log the evaluated values.


248-251: Added logging for record batch evaluation.

Logging statements have been added to log the record batch used in the evaluation of DataFusion scalar functions.


306-306: Added logging for decoded scalar function.

A logging statement has been added to log the decoded scalar function.

src/flow/src/transform/expr.rs (4)

19-19: Added logging import.

The common_telemetry::info import has been added to enable logging.


131-139: New function is_proto_literal.

A new function is_proto_literal has been added to check if a function argument is a literal.


147-149: Added literal check in rewrite_scalar_function.

The rewrite_scalar_function function has been updated to include a check for literals using the is_proto_literal function.


162-164: Added logging for function rewrite.

Logging statements have been added to log the function before and after the rewrite.

tests/cases/standalone/flow/basic.sql Show resolved Hide resolved
tests/cases/standalone/flow/basic.sql Show resolved Hide resolved
tests/cases/standalone/flow/basic.sql Show resolved Hide resolved
tests/cases/standalone/flow/basic.result Show resolved Hide resolved
tests/cases/standalone/flow/basic.result Show resolved Hide resolved
tests/cases/standalone/flow/basic.result Show resolved Hide resolved
Copy link

codecov bot commented Jul 3, 2024

Codecov Report

Attention: Patch coverage is 90.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 84.66%. Comparing base (c4db9e8) to head (16c32c5).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4265      +/-   ##
==========================================
- Coverage   84.96%   84.66%   -0.31%     
==========================================
  Files        1054     1057       +3     
  Lines      187160   187523     +363     
==========================================
- Hits       159026   158769     -257     
- Misses      28134    28754     +620     

src/flow/src/expr/scalar.rs Outdated Show resolved Hide resolved
src/flow/src/transform/expr.rs Outdated Show resolved Hide resolved
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 48e61eb and 16c32c5.

Files selected for processing (2)
  • src/flow/src/expr/scalar.rs (4 hunks)
  • src/flow/src/transform/expr.rs (3 hunks)
Files skipped from review as they are similar to previous changes (2)
  • src/flow/src/expr/scalar.rs
  • src/flow/src/transform/expr.rs

@discord9 discord9 added this pull request to the merge queue Jul 5, 2024
Merged via the queue into GreptimeTeam:main with commit c21e969 Jul 5, 2024
53 checks passed
@discord9 discord9 deleted the flow_fix_df branch July 5, 2024 06:36
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.

4 participants