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: add json format output for http interface #4797

Merged
merged 5 commits into from
Oct 9, 2024

Conversation

Kev1n8
Copy link
Contributor

@Kev1n8 Kev1n8 commented Oct 5, 2024

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

Closes #4764.

What's changed and what's your intention?

Some BI or visualization tools like PowerBI accepts json data from custom web apis.

As explained in #4764, it's better if the http service return a json format that is already supported by other products.

  • Added JsonResponse.
  • Placed relevant tests.

Checklist

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

@Kev1n8 Kev1n8 requested a review from a team as a code owner October 5, 2024 18:30
Copy link
Contributor

coderabbitai bot commented Oct 5, 2024

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.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Oct 5, 2024
@Kev1n8
Copy link
Contributor Author

Kev1n8 commented Oct 5, 2024

The branch includes commits from my last PR. Not sure what the cause is.

Copy link

codecov bot commented Oct 5, 2024

Codecov Report

Attention: Patch coverage is 78.70370% with 23 lines in your changes missing coverage. Please review.

Project coverage is 84.22%. Comparing base (a283e13) to head (95842da).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4797      +/-   ##
==========================================
- Coverage   84.45%   84.22%   -0.24%     
==========================================
  Files        1120     1121       +1     
  Lines      204139   204520     +381     
==========================================
- Hits       172414   172251     -163     
- Misses      31725    32269     +544     

@sunng87
Copy link
Member

sunng87 commented Oct 5, 2024

I think it's because you created this branch from your last feature branch. If your previous branch has been merged, you can rebase to main to fix that

@Kev1n8
Copy link
Contributor Author

Kev1n8 commented Oct 5, 2024

I think it's because you created this branch from your last feature branch. If your previous branch has been merged, you can rebase to main to fix that

I thought so too. thx

@sunng87
Copy link
Member

sunng87 commented Oct 5, 2024

Almost LGTM. It would be nice if we can add a test case in tests-integration/tests/http.rs

@Kev1n8
Copy link
Contributor Author

Kev1n8 commented Oct 6, 2024

Added a test case. Let me know if anything else is needed.

src/servers/src/http/json_result.rs Outdated Show resolved Hide resolved
src/servers/src/http/json_result.rs Outdated Show resolved Hide resolved
src/servers/src/http/json_result.rs Outdated Show resolved Hide resolved
src/servers/src/http/json_result.rs Outdated Show resolved Hide resolved
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. Thanks a lot.

Copy link
Contributor

@shuiyisong shuiyisong left a comment

Choose a reason for hiding this comment

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

LGTM

BTW: it would be nice to add more tests, such as affected_rows cases and select count(1) cases where the column name is not the schema column name.
Possible future works: add total_rows in metadata for queries.

@shuiyisong shuiyisong added this pull request to the merge queue Oct 9, 2024
Merged via the queue into GreptimeTeam:main with commit 0dd11f5 Oct 9, 2024
33 checks passed
@Kev1n8 Kev1n8 deleted the feat-better-json-reply branch October 14, 2024 14:47
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.

JSON format output for http query interface
4 participants