fix: json_path_exists null results #4881

Kev1n8 · 2024-10-25T07:43:51Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

Closes #4865.

What's changed and what's your intention?

As explained in referred issue, the result should be null if any of the parameters is null .

Checklist

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

coderabbitai · 2024-10-25T07:43:58Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 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.

codecov · 2024-10-25T07:58:46Z

Codecov Report

Attention: Patch coverage is 93.97590% with 5 lines in your changes missing coverage. Please review.

Project coverage is 83.98%. Comparing base (4e9c251) to head (e62fcd3).
Report is 34 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4881      +/-   ##
==========================================
- Coverage   84.18%   83.98%   -0.20%     
==========================================
  Files        1136     1137       +1     
  Lines      208585   210255    +1670     
==========================================
+ Hits       175597   176592     +995     
- Misses      32988    33663     +675

WenyXu · 2024-10-28T03:07:29Z

Thanks @Kev1n8 ❤️

evenyag · 2024-10-28T08:15:38Z

src/common/function/src/scalars/json/json_path_exists.rs

+            match json.data_type() {
+                ConcreteDataType::Binary(_) => {


We should use jsons.data_type() because the data type of ValueRef::Null isn't Binary. But we can match json and handle ValueRef::Binary and ValueRef::Null.

I see your point, but I’m curious about how we would handle cases where some items in the array are ValueRef::Null while others are not. Or, all items' datatype are supposed to be the same?

Items in an array have the same data type. You can treat null as the same data type as other items in this array. Like None::<String>. But ValueRef itself doesn't carry the type information now.

Okay, I'll update the code.

tests/cases/standalone/common/function/json/json.result

Kev1n8 · 2024-10-28T09:05:58Z

To be clear, I'd like to specify the expected results of all SQLs below:

SELECT json_path_exists(NULL, '$.a');
NULL

SELECT json_path_exists(parse_json('{}'), NULL);
NULL

SELECT json_path_exists(parse_json('null'), '$.a');
false

SELECT json_path_exists(parse_json('{}'), 'null');
false

Please let me know if anything is incorrect.

WenyXu · 2024-10-28T09:07:36Z

To be clear, I'd like to specify the expected results of all SQLs below:
SELECT json_path_exists(NULL, '$.a');
NULL

SELECT json_path_exists(parse_json('{}'), NULL);
NULL

SELECT json_path_exists(parse_json('null'), '$.a');
false

SELECT json_path_exists(parse_json('{}'), 'null');
false
Please let me know if anything is incorrect.

looks good

src/common/function/src/scalars/json/json_path_exists.rs

…same.

WenyXu · 2024-10-29T11:54:04Z

src/common/function/src/scalars/json/json_path_exists.rs

+            // Any null args existence causes the result to be NULL.
+            (ConcreteDataType::Null(_), ConcreteDataType::String(_)) => results.push_nulls(size),
+            (ConcreteDataType::Binary(_), ConcreteDataType::Null(_)) => results.push_nulls(size),
+            (ConcreteDataType::Null(_), ConcreteDataType::Null(_)) => results.push_nulls(size),


According to the sqlness tests, this should be the only change that needs to be done?

There are 2 major changes: function signatures and datatype cases.

I believe function signature changes matter for accepting null type. I've tested if, with only Exact(vec![Json, String]), system will throw error when the signature does not match.

Apart from "this" change, I think the error handlers also make sense, while the original simply push a None into results when there's a parsing or casting error.

src/common/function/src/scalars/json/json_path_exists.rs

Kev1n8 · 2024-11-05T01:57:51Z

Reduced some unnecessary checks. Please check out.

Kev1n8 added 2 commits October 25, 2024 15:28

fix: result of nulls

30d894b

update test result

367c017

Kev1n8 requested a review from a team as a code owner October 25, 2024 07:43

github-actions bot added the docs-not-required This change does not impact docs. label Oct 25, 2024

WenyXu approved these changes Oct 28, 2024

View reviewed changes

WenyXu requested review from fengjiachun and CookiePieWw October 28, 2024 08:05

evenyag reviewed Oct 28, 2024

View reviewed changes

CookiePieWw reviewed Oct 28, 2024

View reviewed changes

tests/cases/standalone/common/function/json/json.result Show resolved Hide resolved

CookiePieWw mentioned this pull request Oct 29, 2024

docs: json_path_exists function GreptimeTeam/docs#1247

Draft

3 tasks

Kev1n8 added 2 commits October 29, 2024 16:13

fix null behaviors, add null tests

4b7ee25

update NULL tests

018ac22

WenyXu reviewed Oct 29, 2024

View reviewed changes

src/common/function/src/scalars/json/json_path_exists.rs Outdated Show resolved Hide resolved

Kev1n8 added 3 commits October 29, 2024 16:33

error handler when parsing json_path

363f0c2

change the logic to: items' datatype in the input arrays are all the …

cb9eb12

…same.

remove a comment

0e5de83

WenyXu reviewed Oct 29, 2024

View reviewed changes

WenyXu reviewed Nov 1, 2024

View reviewed changes

src/common/function/src/scalars/json/json_path_exists.rs Outdated Show resolved Hide resolved

refactor: better logic

da8bab7

WenyXu reviewed Nov 4, 2024

View reviewed changes

src/common/function/src/scalars/json/json_path_exists.rs Outdated Show resolved Hide resolved

src/common/function/src/scalars/json/json_path_exists.rs Outdated Show resolved Hide resolved

fengjiachun reviewed Nov 4, 2024

View reviewed changes

src/common/function/src/scalars/json/json_path_exists.rs Outdated Show resolved Hide resolved

drop unnecessary err check

e62fcd3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: json_path_exists null results #4881

fix: json_path_exists null results #4881

Kev1n8 commented Oct 25, 2024

coderabbitai bot commented Oct 25, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Oct 25, 2024 •

edited

Loading

WenyXu commented Oct 28, 2024

evenyag Oct 28, 2024

Kev1n8 Oct 28, 2024

evenyag Oct 29, 2024

Kev1n8 Oct 29, 2024

Kev1n8 commented Oct 28, 2024

WenyXu commented Oct 28, 2024

WenyXu Oct 29, 2024

Kev1n8 Oct 29, 2024

Kev1n8 commented Nov 5, 2024 •

edited

Loading

fix: json_path_exists null results #4881

Are you sure you want to change the base?

fix: json_path_exists null results #4881

Conversation

Kev1n8 commented Oct 25, 2024

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

coderabbitai bot commented Oct 25, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Oct 25, 2024 • edited Loading

Codecov Report

WenyXu commented Oct 28, 2024

evenyag Oct 28, 2024

Choose a reason for hiding this comment

Kev1n8 Oct 28, 2024

Choose a reason for hiding this comment

evenyag Oct 29, 2024

Choose a reason for hiding this comment

Kev1n8 Oct 29, 2024

Choose a reason for hiding this comment

Kev1n8 commented Oct 28, 2024

WenyXu commented Oct 28, 2024

WenyXu Oct 29, 2024

Choose a reason for hiding this comment

Kev1n8 Oct 29, 2024

Choose a reason for hiding this comment

Kev1n8 commented Nov 5, 2024 • edited Loading

coderabbitai bot commented Oct 25, 2024 •

edited

Loading

codecov bot commented Oct 25, 2024 •

edited

Loading

Kev1n8 commented Nov 5, 2024 •

edited

Loading