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: old and new dashboards in sync with local storage #4520

Merged
merged 4 commits into from
Feb 13, 2024

Conversation

vikrantgupta25
Copy link
Collaborator

@vikrantgupta25 vikrantgupta25 commented Feb 9, 2024

Summary

  • updated the local storage key to be name instead of id as the older dashboard variables do not have ID in their response and since we are not updating the dashboard now for variable values the randomly generated ID doesn't work.

Related Issues / PR's

Screenshots

NA

Affected Areas and Manually Tested Areas

Summary by CodeRabbit

Summary of changes

  • New Features
    • Enhanced dashboard settings to include variable transformations for an improved user experience.
    • Improved dashboard variable selection by using names instead of IDs for better clarity and management.
  • Refactor
    • Updated the dashboard context to handle and update variables based on localStorage data, ensuring a smoother user experience.
  • Chores
    • Added a new function to the dashboard context interface to support variable transformations.

Copy link

github-actions bot commented Feb 9, 2024

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@github-actions github-actions bot added the bug Something isn't working label Feb 9, 2024
Copy link

coderabbitai bot commented Feb 9, 2024

Walkthrough

The updates focus on enhancing dashboard variable management across the frontend. A key addition is the transformDashboardVariables function, now integral in handling dashboard variables, ensuring they align with localStorage data and are correctly utilized across different components. Modifications include passing name instead of id for better variable identification and refining context to support the transformation and updating of dashboard variables.

Changes

File Path Change Summary
.../NewDashboard/DashboardSettings/Variables/index.tsx
.../DashboardVariablesSelection/DashboardVariableSelection.tsx
.../Dashboard/Dashboard.tsx
.../Dashboard/types.ts
Introduced transformDashboardVariables to manage and update dashboard variables. Adjusted function calls and context to support these changes, including passing name instead of id for variable identification and adding logging for debugging.

🐇✨
In the code where variables nest,
A rabbit worked, no time to rest.
With a hop and a skip, changes were made,
Now dashboards shine, in light, not shade.
🌟🌱

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

github-actions bot commented Feb 9, 2024

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c658178 and 3646e7d.
Files selected for processing (4)
  • frontend/src/container/NewDashboard/DashboardSettings/Variables/index.tsx (2 hunks)
  • frontend/src/container/NewDashboard/DashboardVariablesSelection/DashboardVariableSelection.tsx (2 hunks)
  • frontend/src/providers/Dashboard/Dashboard.tsx (3 hunks)
  • frontend/src/providers/Dashboard/types.ts (1 hunks)
Additional comments: 4
frontend/src/providers/Dashboard/types.ts (1)
  • 22-22: LGTM!
frontend/src/container/NewDashboard/DashboardVariablesSelection/DashboardVariableSelection.tsx (1)
  • 76-76: Changing the argument from id to name improves clarity and maintainability.
frontend/src/providers/Dashboard/Dashboard.tsx (1)
  • 55-55: Adding a default implementation for transformDashboardVariables is a good practice.
frontend/src/container/NewDashboard/DashboardSettings/Variables/index.tsx (1)
  • 80-84: Integrating transformDashboardVariables into the dashboard variable update flow enhances consistency and reliability.

Also applies to: 173-175

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3646e7d and cc4774c.
Files selected for processing (1)
  • frontend/src/providers/Dashboard/Dashboard.tsx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • frontend/src/providers/Dashboard/Dashboard.tsx

Copy link

github-actions bot commented Feb 9, 2024

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

1 similar comment
Copy link

github-actions bot commented Feb 9, 2024

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 02f83e4 and 7a192e8.
Files selected for processing (2)
  • frontend/src/container/NewDashboard/DashboardVariablesSelection/DashboardVariableSelection.tsx (1 hunks)
  • frontend/src/providers/Dashboard/Dashboard.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • frontend/src/container/NewDashboard/DashboardVariablesSelection/DashboardVariableSelection.tsx
  • frontend/src/providers/Dashboard/Dashboard.tsx

Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@YounixM YounixM merged commit cff0e1c into develop Feb 13, 2024
11 of 12 checks passed
@YounixM YounixM deleted the dashboard-variables branch February 13, 2024 08:27
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