Skip to content

feat: variable to pass current query for dashboard drilldown #4553

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.

Sign up for GitHub

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

Jump to bottom
Merged
ktx-abhay merged 1 commit into from
Sep 16, 2024
Merged

feat: variable to pass current query for dashboard drilldown #4553

ktx-abhay merged 1 commit into from
Sep 16, 2024

Conversation

@ktx-abhay
Copy link
Collaborator

@ktx-abhay ktx-abhay commented Sep 16, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Introduced query and query_encoded properties for improved handling of drilldown variables.
    • Added a new section in the user guide detailing how to reference the current query.

  • Bug Fixes

    • Minor logic enhancements and formatting adjustments for better readability and consistency.

  • Documentation

    • Updated user guide to include instructions for using the current query formats.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 16, 2024 •
edited
Loading

Walkthrough

The changes introduce enhancements to the handling of query parameters for drilldown variables in the dashboard components. Key updates include the addition of query and query_encoded properties in the drilldownVariables object of PanelSchemaRenderer.vue, improvements to the visual styling of the URL input in DrilldownPopUp.vue, and new documentation in DrilldownUserGuide.vue detailing how to reference the current query.

Changes

File Change Summary
web/src/components/dashboards/PanelSchemaRenderer.vue Added query and query_encoded properties to drilldownVariables for improved query handling.
web/src/components/dashboards/addPanel/DrilldownPopUp.vue Made formatting adjustments and refined logic for fetching drilldown data, enhancing consistency without altering core functionality.
web/src/components/dashboards/addPanel/DrilldownUserGuide.vue Added a section on referencing the current query, including formats ${query} and ${query_encoded} to improve user guidance.

Possibly related PRs

Suggested labels

✏️ Feature

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 01d3142 and 95b74c0.

Files selected for processing (3)
  • web/src/components/dashboards/PanelSchemaRenderer.vue (4 hunks)
  • web/src/components/dashboards/addPanel/DrilldownPopUp.vue (10 hunks)
  • web/src/components/dashboards/addPanel/DrilldownUserGuide.vue (1 hunks)
Files skipped from review due to trivial changes (1)
  • web/src/components/dashboards/addPanel/DrilldownPopUp.vue
Additional comments not posted (4)
web/src/components/dashboards/addPanel/DrilldownUserGuide.vue (1)

54-61: Excellent addition to the user guide!

The new "Use current query" section provides clear instructions on referencing the current query within the application. The inclusion of both ${query} and ${query_encoded} formats offers flexibility to users and promotes consistency in how the current query is utilized across the application.

The use of <span class="bg-highlight"> to visually highlight the format examples is a nice touch that improves readability.

Overall, this change enhances the user experience by offering guidance on leveraging the current query in drilldown operations, reducing the likelihood of user errors in the process.

web/src/components/dashboards/PanelSchemaRenderer.vue (3)

167-167: LGTM!

The import statement for b64EncodeUnicode is correctly added.

Line range hint 661-670: LGTM!

Converting start_time and end_time to ISO string format before getting the timestamp is a good practice for consistent date handling.

674-678: Excellent work on passing the current query for drilldown!

The changes correctly:

  • Retrieve the current query from panelSchema
  • Assign the query to drilldownVariables.query
  • Base64 encode the query using b64EncodeUnicode and assign it to drilldownVariables.query_encoded

This fulfills the main objective of the PR. Great job!

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 generate interesting stats about this repository and render them as a table.
    -- @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.

CodeRabbit Configuration 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.

@ktx-abhay ktx-abhay changed the title feat: pass current query for drilldown feat: variable to pass current query for dashboard drilldown Sep 16, 2024
@ktx-abhay ktx-abhay merged commit 1397668 into main Sep 16, 2024
@ktx-abhay ktx-abhay deleted the feat/dashboard-drilldown-param-for-query branch September 16, 2024 06:37
hengfeiyang pushed a commit that referenced this pull request Sep 17, 2024
@ktx-abhay @hengfeiyang
feat: variable to pass current query for dashboard drilldown (#4553)
ef2acfc 
- #4552 

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced `query` and `query_encoded` properties for improved
handling of drilldown variables.
- Added a new section in the user guide detailing how to reference the
current query.

- **Bug Fixes**
- Minor logic enhancements and formatting adjustments for better
readability and consistency.

- **Documentation**
- Updated user guide to include instructions for using the current query
formats.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This was referenced Sep 17, 2024
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Sep 30, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ktx-kirtan ktx-kirtan ktx-kirtan approved these changes

Assignees

No one assigned

Labels

✏️ Feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ktx-abhay @ktx-kirtan