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: Auto Complete promql legend on select not getting proper value with { #3523

Merged
merged 4 commits into from
May 30, 2024

Conversation

ktx-vaidehi
Copy link
Collaborator

@ktx-vaidehi ktx-vaidehi commented May 15, 2024

When a user directly selects anything from the dropdown, it incorrectly puts the value in the Legend config in dashboard's add panel config for PromQL.

Summary by CodeRabbit

  • Bug Fixes
    • Improved input handling in the configuration panel to ensure proper formatting of values.

@github-actions github-actions bot added the ☢️ Bug Something isn't working label May 15, 2024
@ktx-vaidehi ktx-vaidehi force-pushed the fix/dashboard-promql-legend-issue branch 4 times, most recently from c88eebb to 5b076a3 Compare May 20, 2024 05:32
@ktx-abhay ktx-abhay force-pushed the fix/dashboard-promql-legend-issue branch from 5b076a3 to d2accf6 Compare May 20, 2024 09:36
@ktx-vaidehi ktx-vaidehi force-pushed the fix/dashboard-promql-legend-issue branch from d2accf6 to 11a816c Compare May 20, 2024 10:48
@ktx-kirtan ktx-kirtan self-requested a review May 20, 2024 12:40
@ktx-kirtan ktx-kirtan marked this pull request as ready for review May 20, 2024 12:42
@ktx-abhay ktx-abhay force-pushed the fix/dashboard-promql-legend-issue branch 4 times, most recently from b7fb4ed to b7ac470 Compare May 27, 2024 08:22
Copy link

coderabbitai bot commented May 27, 2024

Walkthrough

This change in ConfigPanel.vue ensures that when an inputValue lacks an opening brace '{', one is added before appending the option. This guarantees the newValue string is correctly formatted, preventing potential errors in later processing stages.

Changes

File Path Change Summary
web/src/components/dashboards/addPanel/ConfigPanel.vue Added a conditional check to insert an opening brace '{' if missing in the inputValue before appending the option.

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.

Copy link

@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: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between fa0233a and b7ac470.
Files selected for processing (1)
  • web/src/components/dashboards/addPanel/ConfigPanel.vue (1 hunks)

Comment on lines 931 to 944
// Find the index of the last opening brace '{'
const openingBraceIndex = inputValue.lastIndexOf("{");
const newValue =
inputValue.slice(0, openingBraceIndex + 1) + option + "}";
return newValue;

//if { is not present add it at the start and than return
if (openingBraceIndex === -1) {
const newValue =
"{" + inputValue.slice(0, openingBraceIndex + 1) + option + "}";
return newValue;
} else {
const newValue =
inputValue.slice(0, openingBraceIndex + 1) + option + "}";
return newValue;
}
Copy link

Choose a reason for hiding this comment

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

Ensure correct handling of the opening brace in PromQL legends.

The logic for appending the opening brace { seems incorrect. The inputValue.slice(0, openingBraceIndex + 1) will always result in { because openingBraceIndex is -1 when the brace is not present. This could lead to unexpected results. Consider simplifying the logic to ensure the brace is added only when missing.

- const newValue = "{" + inputValue.slice(0, openingBraceIndex + 1) + option + "}";
+ const newValue = openingBraceIndex === -1 ? "{" + option + "}" : inputValue.slice(0, openingBraceIndex + 1) + option + "}";

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
// Find the index of the last opening brace '{'
const openingBraceIndex = inputValue.lastIndexOf("{");
const newValue =
inputValue.slice(0, openingBraceIndex + 1) + option + "}";
return newValue;
//if { is not present add it at the start and than return
if (openingBraceIndex === -1) {
const newValue =
"{" + inputValue.slice(0, openingBraceIndex + 1) + option + "}";
return newValue;
} else {
const newValue =
inputValue.slice(0, openingBraceIndex + 1) + option + "}";
return newValue;
}
// Find the index of the last opening brace '{'
const openingBraceIndex = inputValue.lastIndexOf("{");
//if { is not present add it at the start and than return
if (openingBraceIndex === -1) {
const newValue = "{" + option + "}";
return newValue;
} else {
const newValue =
inputValue.slice(0, openingBraceIndex + 1) + option + "}";
return newValue;
}

@ktx-abhay ktx-abhay force-pushed the fix/dashboard-promql-legend-issue branch 2 times, most recently from 472d697 to 8abb74e Compare May 30, 2024 03:57
@ktx-vaidehi ktx-vaidehi force-pushed the fix/dashboard-promql-legend-issue branch 3 times, most recently from bce4679 to 3e42178 Compare May 30, 2024 13:31
@ktx-vaidehi ktx-vaidehi force-pushed the fix/dashboard-promql-legend-issue branch from 3e42178 to 5b58020 Compare May 30, 2024 14:58
@ktx-vaidehi ktx-vaidehi merged commit a4a48d6 into main May 30, 2024
20 checks passed
@ktx-vaidehi ktx-vaidehi deleted the fix/dashboard-promql-legend-issue branch May 30, 2024 15:17
taimingl pushed a commit that referenced this pull request May 30, 2024
…ith { (#3523)

When a user directly selects anything from the dropdown, it incorrectly
puts the value in the Legend config in dashboard's add panel config for
PromQL.

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

## Summary by CodeRabbit

- **Bug Fixes**
- Improved input handling in the configuration panel to ensure proper
formatting of values.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
☢️ Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants