[Dashboard] Fix explicitInput removal by ThomThomson · Pull Request #215580 · elastic/kibana

ThomThomson · 2025-03-21T21:35:15Z

Summary

Temporary fix for #215429 to unblock #197716 before #215551 can be completed.

Warning

This fix works, but it introduces a duplication of information that should be immediately removed as soon as #215551 is solved.

Explanation
This PR fixes #215429 by making the Dashboard's serialize function fall back to whatever state was last saved to the Dashboard for that panel when a child API cannot be found.

Unfortunately, when attempting to serialize a newly added panel it's possible that the child API cannot be found and the panel hasn't been saved before. In this edge case the explicitInput would still be missing. Because of this, this PR adds another state backup which stores the result of serializing every panel with unsaved changes. This way in cases where the panel is new and the API is missing we're still able to serialize it.

ThomThomson · 2025-03-24T20:04:28Z

/ci

elasticmachine · 2025-03-25T15:30:42Z

Pinging @elastic/kibana-presentation (Team:Presentation)

ThomThomson · 2025-03-25T16:32:43Z

@elasticmachine merge upstream

nreese · 2025-03-26T14:20:22Z

src/platform/plugins/shared/dashboard/public/dashboard_api/panels_manager.ts

+        const getApiMissingFallback = (id: string): SerializedPanelState<object> => {
+          // If the Dashboard has been saved with this panel before, we should be able to grab it from the current value of panels$
+          if (Object.keys(panels$.value[id].explicitInput ?? {}).length > 0) {
+            return {


If a panel is not new so explicitInput is populated but has unsaved changes - Shouldn't unsaved changes version of explicitInput be used?

Yes I think you're right. We could confirm this by making a change to a panel, minimizing it with a collapsible section and then saving the Dashboard.

That change would be overwritten. It seems to me that we should only use the serializedPanelBackup here. I'll make that change.

nreese · 2025-03-27T17:40:31Z

src/platform/plugins/shared/dashboard/public/dashboard_api/panels_manager.ts

          const serializeResult = apiHasSerializableState(childApi)
            ? childApi.serializeState()
-            : { rawState: {} };
+            : getDashboardBackupService().getSerializedPanelBackup(id, dashboardId) ?? {


I still think we need to fallback to panels$.value[id].explicitInput but check for getSerializedPanelBackup first.

const serializeResult = apiHasSerializableState(childApi) ? childApi.serializeState() : getDashboardBackupService().getSerializedPanelBackup(id, dashboardId) ?? { rawState: panels$.value[id].explicitInput ?? {}, references: getReferencesForPanelId(id) };

Here is a use case. A dashboard is opened with a collapsable panel section that is closed on load and never opened. The dashboard title is changed and the dashboard is saved.

For embeddables in unopened collapsable section:

childApi will not be provided because the embeddable was never rendered

getSerializedPanelBackup will not be provided because the embeddable was never rendered and no unsaved changes where recorded. We can not count on the session state from when the panel was added because this dashboard may be opened on a different session.

fallback to panels$.value[id].explicitInput

Ugh. You're right again. Thanks Nathan. It's obvious I'm not using my whole brain power on this PR - the situation you describe was the one I had in mind when I made the first function.

This is another reason why this code needs to be removed ASAP. Implemented your suggestion in
d18d50e, thanks again!

nreese

LGTM. This is a good work around until the larger problem can be addressed.

ThomThomson · 2025-03-27T18:05:14Z

@elasticmachine merge upstream

elasticmachine · 2025-03-27T19:43:28Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 421fe4e

Failed CI Steps

Jest Tests #19

Test Failures

[job] [logs] Jest Tests #19 / useBulkFetchFleetIntegrationPolicies() should call the correct fleet api with the query data provided

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`dashboard`	542.9KB	544.0KB	+1.1KB

History

💚 Build #287771 succeeded 33916f3
💛 Build #287039 was flaky a2e1854

kibanamachine · 2025-03-27T20:02:41Z

Starting backport for target branches: 8.16, 8.17, 8.18, 8.x, 9.0

https://github.com/elastic/kibana/actions/runs/14115648062

Temporarily adds a serializedStateBackup to Dashboard (cherry picked from commit 62f2daf)

kibanamachine · 2025-03-27T20:09:03Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.16	Backport failed because of merge conflicts
❌	8.17	Backport failed because of merge conflicts
❌	8.18	Backport failed because of merge conflicts
✅	8.x
❌	9.0	Backport failed because of merge conflicts

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 215580

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2025-03-27T20:12:58Z

Starting backport for target branches: 9.0

https://github.com/elastic/kibana/actions/runs/14115827016

kibanamachine · 2025-03-27T20:13:29Z

💔 Backport failed

The pull request could not be backported due to the following error:
Git clone failed with exit code: 128

Manual backport

To create the backport manually run:

node scripts/backport --pr 215580

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2025-03-28T20:48:44Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

kibanamachine · 2025-03-31T21:49:19Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

Temporarily adds a serializedStateBackup to Dashboard

kibanamachine · 2025-04-01T22:48:36Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

kibanamachine · 2025-04-02T22:48:53Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

# Backport This will backport the following commits from `main` to `8.x`: - [[Dashboard] Fix explicitInput removal (#215580)](#215580)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Devon Thomson <devon.thomson@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Attempt to fix explicit input removal

9878827

ThomThomson marked this pull request as ready for review March 25, 2025 15:30

ThomThomson requested a review from a team as a code owner March 25, 2025 15:30

Merge branch 'main' into dashboard/fixExplicitInputRemoval

a2e1854

nreese reviewed Mar 26, 2025

View reviewed changes

ThomThomson added 2 commits March 27, 2025 11:31

always fall back to serialized state backup

535279b

fix type

33916f3

nreese reviewed Mar 27, 2025

View reviewed changes

fallback to existing panels state.

d18d50e

nreese approved these changes Mar 27, 2025

View reviewed changes

ThomThomson added backport:prev-minor labels Mar 27, 2025

Merge branch 'main' into dashboard/fixExplicitInputRemoval

421fe4e

ThomThomson merged commit 62f2daf into elastic:main Mar 27, 2025
9 checks passed

kibanamachine added the v9.1.0 label Mar 27, 2025

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 27, 2025

[Dashboard] Fix explicitInput removal (elastic#215580)

88de829

Temporarily adds a serializedStateBackup to Dashboard (cherry picked from commit 62f2daf)

kibanamachine mentioned this pull request Mar 27, 2025

[8.x] [Dashboard] Fix explicitInput removal (#215580) #216231

Merged

ThomThomson added backport:version Backport to applied version labels and removed backport:prev-major labels Mar 27, 2025

ThomThomson added v9.0.0 v8.19.0 labels Mar 27, 2025

kibanamachine mentioned this pull request Mar 28, 2025

[Dashboards] Fix panel actions hidden behind top nav in maximize mode #216290

Merged

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 28, 2025

ThomThomson removed the v9.0.0 label Mar 28, 2025

cqliu1 pushed a commit to cqliu1/kibana that referenced this pull request Mar 31, 2025

[Dashboard] Fix explicitInput removal (elastic#215580)

3d68211

Temporarily adds a serializedStateBackup to Dashboard

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 3, 2025

nreese mentioned this pull request May 14, 2025

[dashboard] panel state lost if dashboard saved and panel is not initialized #220799

Closed

Conversation

ThomThomson commented Mar 21, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

ThomThomson commented Mar 24, 2025

Uh oh!

elasticmachine commented Mar 25, 2025

Uh oh!

ThomThomson commented Mar 25, 2025

Uh oh!

nreese Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

ThomThomson Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

nreese Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

ThomThomson Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

nreese left a comment

Choose a reason for hiding this comment

Uh oh!

ThomThomson commented Mar 27, 2025

Uh oh!

elasticmachine commented Mar 27, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Async chunks

History

Uh oh!

Uh oh!

kibanamachine commented Mar 27, 2025

Uh oh!

kibanamachine commented Mar 27, 2025

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

kibanamachine commented Mar 27, 2025

Uh oh!

kibanamachine commented Mar 27, 2025

💔 Backport failed

Manual backport

Questions ?

Uh oh!

kibanamachine commented Mar 28, 2025

Uh oh!

kibanamachine commented Mar 31, 2025

Uh oh!

kibanamachine commented Apr 1, 2025

Uh oh!

kibanamachine commented Apr 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ThomThomson commented Mar 21, 2025 •

edited by kibanamachine

Loading