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(Dashboard): Sync color configuration via dedicated endpoint #31374

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

geido
Copy link
Member

@geido geido commented Dec 10, 2024

SUMMARY

This PR introduces a new endpoint which purpose is to store color configurations for a dashboard. Dashboard color configurations might need syncing and persistence in the backend even when the user takes no action. For instance, new data might appear on the dashboard that needs to be synced with the color maps and persisted. Previously, these changes would be saved using the dashboard PUT endpoint, causing that the dashboard last modified date would show up as updated even though no change was made from the user perspective, causing confusion. Also, issues have surfaced where metadata that wasn't meant to be persisted yet would go along with the updated color metadata, causing unexpected behaviors.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N.A.

TESTING INSTRUCTIONS

  1. Open a Dashboard
  2. Make sure new data appeared (new dimensions or metrics)
  3. Observe how a network request is made to store the color metadata when leaving the dashboard
  4. Make sure the last modified date of the Dashboard hasn't changed

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@github-actions github-actions bot added the api Related to the REST API label Dec 10, 2024
@geido geido force-pushed the fix/geido/store-color-configuration branch 2 times, most recently from 6ce4849 to bb1540b Compare December 10, 2024 16:16
@geido geido marked this pull request as ready for review December 12, 2024 15:01
@dosubot dosubot bot added api:dashboard Related to the REST endpoints of the Dashboard dashboard:colors Related to the color scheme of the Dashboard labels Dec 12, 2024
@geido geido force-pushed the fix/geido/store-color-configuration branch from bb1540b to 8d4d01d Compare December 12, 2024 15:46
@geido geido force-pushed the fix/geido/store-color-configuration branch from 8d4d01d to 5a9692f Compare December 12, 2024 16:03
Copy link
Member

@Antonio-RiveroMartnez Antonio-RiveroMartnez left a comment

Choose a reason for hiding this comment

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

lgmt after addressing the comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api:dashboard Related to the REST endpoints of the Dashboard api Related to the REST API dashboard:colors Related to the color scheme of the Dashboard size/XL
Projects
Status: New Issues
Development

Successfully merging this pull request may close these issues.

3 participants