Enhance dashboard parameter handling: persist updated values and apply saved parameters #7570

denisov-vlad · 2025-11-12T11:05:20Z

What type of PR is this?

Description

Added support for saving dashboard parameters after clicking the Apply button. This is useful when using query templates and inserting them into different dashboards. Without this logic, there are two solutions: cloning queries or making parameters static.

Now they are used in the following order: url, dashboard parameters, query parameters.

Queue dashboard-level parameter edits while the dashboard is in edit mode.
Persist the queued values only when “Done Editing” is clicked, keeping Query and Dashboard editors aligned.
Surface any save failures via notifications and restore the queued values so nothing is lost silently.

How is this tested?

Unit tests (pytest, jest)
E2E Tests (Cypress)
Manually
N/A

Create query with params
Create dashboard and add query widget there
Check the default value and change it
Open new dashboard from dashboards list
You'll see changed value

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings (if there are UI changes)

…y saved parameters

…r notification

denisov-vlad · 2025-11-12T11:43:54Z

I skipped the Restyled check to give the reviewer a chance to look at the code that was changed.

I would recommend running yarn prettier separately to change all files in the repository.

yoshiokatsuneo · 2025-11-13T17:19:38Z

@denisov-vlad

Thank you for your PR !
I also see this issue, and feel annoying. It is cool that you are trying to fix the issue !

I think the parameters should be saved only when "Done Editing" button is clicked, as the "Done Editing" button is for saving, and it makes the behavior of the Query Editor and the Dashboard Editor consistent.

Copilot

Pull Request Overview

This PR implements the ability to persist dashboard parameter values when the Apply button is clicked. This addresses the need to maintain customized parameter values across dashboard sessions without requiring query cloning or static parameters. The implementation establishes a new parameter precedence order: URL parameters override dashboard-saved parameters, which in turn override query-defined default parameters.

Introduces parameter value persistence in dashboard.options.parameterValues
Implements persistParameterValues function to save parameter updates to the backend
Updates parameter loading to check for saved values before applying defaults

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
client/app/services/dashboard.js	Modified `getParametersDefs` to load saved parameter values from dashboard options and apply them before URL parameters
client/app/pages/dashboards/hooks/useDashboard.js	Added `persistParameterValues` function and integrated it into the `refreshDashboard` flow with error handling
client/app/pages/dashboards/DashboardPage.jsx	Fixed `onParametersEdit` to preserve existing dashboard options when updating parameter order

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-14T06:58:17Z

client/app/pages/dashboards/hooks/useDashboard.js

+        .catch(error => {
+          console.error("Failed to persist parameter values:", error);
+          notification.error("Parameter values could not be saved. Your changes may not be persisted.");
+        })
+        .then(() => loadDashboard(true, updatedParameters))


The error in persistParameterValues is caught but the promise chain continues to loadDashboard even if persistence fails. This means the dashboard will refresh with new values that haven't been saved. Consider returning early or skipping the refresh if persistence fails to prevent showing unsaved state.

Suggested change

.catch(error => {

console.error("Failed to persist parameter values:", error);

notification.error("Parameter values could not be saved. Your changes may not be persisted.");

})

.then(() => loadDashboard(true, updatedParameters))

.then(() => {

// Only refresh dashboard if persistence succeeded

loadDashboard(true, updatedParameters);

})

.catch(error => {

console.error("Failed to persist parameter values:", error);

notification.error("Parameter values could not be saved. Your changes may not be persisted.");

// Do not refresh dashboard if persistence failed

})

…iting and improve value update logic

Copilot

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-14T09:27:50Z

client/app/pages/dashboards/hooks/useDashboard.js

+        Promise.resolve(persistParameterValues(pendingValues)).catch(error => {
+          console.error("Failed to persist parameter values:", error);
+          notification.error("Parameter values could not be saved. Your changes may not be persisted.");
+          pendingParameterValuesRef.current = pendingValues;


The error handling here may not work as intended. The updateDashboard function (lines 68-96) catches errors but doesn't re-throw them, meaning the promise resolves successfully even when the save fails. As a result, this catch block will not execute for most failure scenarios (except for cases where Dashboard.save itself rejects), and users won't see the error message or have their pending values restored. Consider modifying the implementation to properly detect and handle save failures.

Suggested change

pendingParameterValuesRef.current = pendingValues;

pendingParameterValuesRef.current = pendingValues;

throw error;

Copilot · 2025-11-14T09:27:51Z

client/app/pages/dashboards/hooks/useDashboard.js

+        Promise.resolve(persistParameterValues(pendingValues)).catch(error => {
+          console.error("Failed to persist parameter values:", error);
+          notification.error("Parameter values could not be saved. Your changes may not be persisted.");
+          pendingParameterValuesRef.current = pendingValues;


There's a potential race condition if the user re-enters edit mode while a persist operation is still in flight. If the persist operation then fails and tries to restore values at line 271, it could overwrite the new edit session's (empty) pending values with old values from the previous session. Consider tracking an edit session ID or timestamp to ensure restored values belong to the current session.

yoshiokatsuneo · 2025-11-14T13:39:42Z

@denisov-vlad

Thank you for updating.
And again, I think the parameters should be saved only when "Done Editing" button(Not "Apply Changes" button) is clicked, as the "Done Editing" button is for saving, and it makes the behavior of the Query Editor and the Dashboard Editor consistent.

denisov-vlad · 2025-11-14T14:15:07Z

@denisov-vlad

Thank you for updating. And again, I think the parameters should be saved only when "Done Editing" button(Not "Apply Changes" button) is clicked, as the "Done Editing" button is for saving, and it makes the behavior of the Query Editor and the Dashboard Editor consistent.

Hi @yoshiokatsuneo

Have you tested it? It saves changes only after "Done editing" button click. I had tried to find any other option to save params, but the only way I found is with that button.

Also added some info to the PR message.

yoshiokatsuneo · 2025-11-14T15:55:05Z

@denisov-vlad

Thank you !
I'm sorry I was wrong. The PR is actually working as described.

And, I think refreshDashboard() function should just refresh dashboard as named. How about ?

…nce of current parameter values

denisov-vlad · 2025-11-17T08:58:04Z

@yoshiokatsuneo The logic is consistent with the queries. The parameters are updated in edit mode, but after clicking Apply Changes and then Done Editing.

I have now simplified the code a little and removed it from refreshDashboard.

yoshiokatsuneo · 2025-11-17T14:39:58Z

@denisov-vlad

Thank you for updating. The behavior looks good !
And for about the code, I think it is a bit unclear from the code when the parameters are saved.

How about making it easier to understand ?
For example, how about saving the parameter on onclick event handler of "Done Editing" button so that people can see the flow ?

…boardEditControl for improved parameter persistence

denisov-vlad · 2025-11-18T09:08:02Z

@yoshiokatsuneo I hope I understood you correctly. I'm not a developer and haven't explored the front-end code in depth, but I hope everything is okay now.

yoshiokatsuneo

Thank you for the update !
I added comments.

client/app/pages/dashboards/hooks/useDashboard.js

yoshiokatsuneo · 2025-11-18T15:48:55Z

client/app/pages/dashboards/hooks/useDashboard.js

  );

+  const persistParameterValues = useCallback(
+    parameterValues => {


Can't we just save parameterValues ?

I'm not sure that it's possible right now. We must update options and there could be globalParamOrder key. With my approach we will save all the keys in this field.

client/app/services/dashboard.js

client/app/pages/dashboards/components/DashboardHeader.jsx

…ters and merge parameter values for improved persistence

denisov-vlad · 2025-11-19T09:26:03Z

Thank you for the update ! I added comments.

@yoshiokatsuneo I´ve pushed some changes again. Could you check it please?

client/app/pages/dashboards/hooks/useDashboard.js

…d remove unnecessary checks for improved clarity

client/app/pages/dashboards/hooks/useDashboard.js

client/app/services/dashboard.js

client/app/pages/dashboards/hooks/useDashboard.js

client/app/pages/dashboards/DashboardPage.jsx

client/app/pages/dashboards/hooks/useDashboard.js

…s and streamline dashboard options merging

client/app/pages/dashboards/hooks/useDashboard.js

client/app/pages/dashboards/components/DashboardHeader.jsx

…g for improved clarity and functionality

denisov-vlad added 2 commits November 12, 2025 11:57

Enhance dashboard parameter handling: persist updated values and appl…

9de81de

…y saved parameters

Fix parameter value persistence: handle undefined values and add erro…

fd3eb53

…r notification

denisov-vlad marked this pull request as ready for review November 12, 2025 11:40

arikfr requested a review from Copilot November 14, 2025 06:55

Copilot started reviewing on behalf of arikfr November 14, 2025 06:56 View session

Copilot finished reviewing on behalf of arikfr November 14, 2025 06:57

Copilot AI reviewed Nov 14, 2025

View reviewed changes

Enhance parameter persistence: manage pending values during layout ed…

35b8970

…iting and improve value update logic

denisov-vlad requested a review from Copilot November 14, 2025 09:21

Copilot started reviewing on behalf of denisov-vlad November 14, 2025 09:21 View session

Copilot finished reviewing on behalf of denisov-vlad November 14, 2025 09:27

Copilot AI reviewed Nov 14, 2025

View reviewed changes

Refactor parameter value handling: streamline collection and persiste…

d25c4ee

…nce of current parameter values

Implement saveDashboardParameters function and integrate it into Dash…

e67a83a

…boardEditControl for improved parameter persistence

yoshiokatsuneo reviewed Nov 18, 2025

View reviewed changes

Refactor dashboard parameter handling: streamline saveDashboardParame…

d4ec1d3

…ters and merge parameter values for improved persistence

yoshiokatsuneo reviewed Nov 19, 2025

View reviewed changes

client/app/pages/dashboards/hooks/useDashboard.js Outdated Show resolved Hide resolved

client/app/pages/dashboards/hooks/useDashboard.js Outdated Show resolved Hide resolved

Refactor saveDashboardParameters: simplify parameter value updates an…

54b27e3

…d remove unnecessary checks for improved clarity

yoshiokatsuneo reviewed Nov 19, 2025

View reviewed changes

Refactor dashboard parameter handling: improve parameter value update…

13d5084

…s and streamline dashboard options merging

yoshiokatsuneo reviewed Nov 20, 2025

View reviewed changes

client/app/pages/dashboards/hooks/useDashboard.js Outdated Show resolved Hide resolved

client/app/pages/dashboards/hooks/useDashboard.js Outdated Show resolved Hide resolved

client/app/pages/dashboards/components/DashboardHeader.jsx Outdated Show resolved Hide resolved

Refactor DashboardEditControl: update saveDashboardParameters handlin…

6bff5be

…g for improved clarity and functionality

	pendingParameterValuesRef.current = pendingValues;
	pendingParameterValuesRef.current = pendingValues;
	throw error;

Enhance dashboard parameter handling: persist updated values and apply saved parameters #7570

Are you sure you want to change the base?

Enhance dashboard parameter handling: persist updated values and apply saved parameters #7570

Conversation

denisov-vlad commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

Description

How is this tested?

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings (if there are UI changes)

Uh oh!

denisov-vlad commented Nov 12, 2025

Uh oh!

yoshiokatsuneo commented Nov 13, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

yoshiokatsuneo commented Nov 14, 2025

Uh oh!

denisov-vlad commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoshiokatsuneo commented Nov 14, 2025

Uh oh!

denisov-vlad commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoshiokatsuneo commented Nov 17, 2025

Uh oh!

denisov-vlad commented Nov 18, 2025

Uh oh!

yoshiokatsuneo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yoshiokatsuneo Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

denisov-vlad Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

denisov-vlad commented Nov 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

denisov-vlad commented Nov 12, 2025 •

edited

Loading

denisov-vlad commented Nov 14, 2025 •

edited

Loading

denisov-vlad commented Nov 17, 2025 •

edited

Loading