[8.x] [dashboard] Do not reset panel to undefined or empty last saved state (#203158) (#203512)

# Backport This will backport the following commits from `main` to `8.x`: - [[dashboard] Do not reset panel to undefined or empty last saved state (#203158)](https://github.com/elastic/kibana/pull/203158)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Nathan Reese <reese.nathan@elastic.co>
2025-04-24 09:48:58 -04:00 · 2024-12-10 15:52:12 +11:00 · 2024-12-10 15:52:12 +11:00 · b935f644f1
commit b935f644f1
parent 58421bf361
7 changed files with 31 additions and 7 deletions
--- a/examples/embeddable_examples/public/app/presentation_container_example/page_api.ts
+++ b/examples/embeddable_examples/public/app/presentation_container_example/page_api.ts
@ -250,6 +250,7 @@ export function getPageApi() {
          children$.next(children);
        }
        newPanels = {};
+        return true;
      },
      timeRange$,
      unsavedChanges: unsavedChanges$ as PublishingSubject<object | undefined>,
--- a/packages/presentation/presentation_containers/interfaces/unsaved_changes/children_unsaved_changes.test.ts
+++ b/packages/presentation/presentation_containers/interfaces/unsaved_changes/children_unsaved_changes.test.ts
@ -14,11 +14,11 @@ import { waitFor } from '@testing-library/react';
 describe('childrenUnsavedChanges$', () => {
  const child1Api = {
    unsavedChanges: new BehaviorSubject<object | undefined>(undefined),
-    resetUnsavedChanges: () => undefined,
+    resetUnsavedChanges: () => true,
  };
  const child2Api = {
    unsavedChanges: new BehaviorSubject<object | undefined>(undefined),
-    resetUnsavedChanges: () => undefined,
+    resetUnsavedChanges: () => true,
  };
  const children$ = new BehaviorSubject<{ [key: string]: unknown }>({});
  const onFireMock = jest.fn();
@ -99,7 +99,7 @@ describe('childrenUnsavedChanges$', () => {
      ...children$.value,
      child3: {
        unsavedChanges: new BehaviorSubject<object | undefined>({ key1: 'modified value' }),
-        resetUnsavedChanges: () => undefined,
+        resetUnsavedChanges: () => true,
      },
    });

--- a/packages/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts
+++ b/packages/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts
@ -95,10 +95,19 @@ export const initializeUnsavedChanges = <RuntimeState extends {} = {}>(
      unsavedChanges,
      resetUnsavedChanges: () => {
        const lastSaved = lastSavedState$.getValue();
+
+        // Do not reset to undefined or empty last saved state
+        // Temporary fix for https://github.com/elastic/kibana/issues/201627
+        // TODO remove when architecture fix resolves issue.
+        if (comparatorKeys.length && (!lastSaved || Object.keys(lastSaved).length === 0)) {
+          return false;
+        }
+
        for (const key of comparatorKeys) {
          const setter = comparators[key][1]; // setter function is the 1st element of the tuple
          setter(lastSaved?.[key] as RuntimeState[typeof key]);
        }
+        return true;
      },
      snapshotRuntimeState,
    } as PublishesUnsavedChanges<RuntimeState> & HasSnapshottableState<RuntimeState>,
--- a/packages/presentation/presentation_publishing/interfaces/publishes_unsaved_changes.ts
+++ b/packages/presentation/presentation_publishing/interfaces/publishes_unsaved_changes.ts
@ -11,7 +11,7 @@ import { PublishingSubject } from '../publishing_subject';

 export interface PublishesUnsavedChanges<Runtime extends object = object> {
  unsavedChanges: PublishingSubject<Partial<Runtime> | undefined>;
-  resetUnsavedChanges: () => void;
+  resetUnsavedChanges: () => boolean;
 }

 export const apiPublishesUnsavedChanges = (api: unknown): api is PublishesUnsavedChanges => {
--- a/src/plugins/controls/public/controls/mocks/control_mocks.ts
+++ b/src/plugins/controls/public/controls/mocks/control_mocks.ts
@ -43,7 +43,9 @@ export const getMockedBuildApi =
      uuid,
      parentApi: controlGroupApi ?? getMockedControlGroupApi(),
      unsavedChanges: new BehaviorSubject<Partial<StateType> | undefined>(undefined),
-      resetUnsavedChanges: () => {},
+      resetUnsavedChanges: () => {
+        return true;
+      },
      type: factory.type,
    };
  };
--- a/src/plugins/controls/public/controls/timeslider_control/get_timeslider_control_factory.test.tsx
+++ b/src/plugins/controls/public/controls/timeslider_control/get_timeslider_control_factory.test.tsx
@ -48,7 +48,9 @@ describe('TimesliderControlApi', () => {
      uuid,
      parentApi: controlGroupApi,
      unsavedChanges: new BehaviorSubject<Partial<TimesliderControlState> | undefined>(undefined),
-      resetUnsavedChanges: () => {},
+      resetUnsavedChanges: () => {
+        return true;
+      },
      type: factory.type,
    };
  }
--- a/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx
+++ b/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx
@ -68,6 +68,7 @@ import { KibanaRenderContextProvider } from '@kbn/react-kibana-context-render';
 import { LocatorPublic } from '@kbn/share-plugin/common';
 import { ExitFullScreenButtonKibanaProvider } from '@kbn/shared-ux-button-exit-full-screen';

+import { i18n } from '@kbn/i18n';
 import { DASHBOARD_CONTAINER_TYPE, DashboardApi, DashboardLocatorParams } from '../..';
 import type { DashboardAttributes } from '../../../server/content_management';
 import { DashboardContainerInput, DashboardPanelMap, DashboardPanelState } from '../../../common';
@ -957,7 +958,16 @@ export class DashboardContainer
    for (const panelId of Object.keys(currentChildren)) {
      if (this.getInput().panels[panelId]) {
        const child = currentChildren[panelId];
-        if (apiPublishesUnsavedChanges(child)) child.resetUnsavedChanges();
+        if (apiPublishesUnsavedChanges(child)) {
+          const success = child.resetUnsavedChanges();
+          if (!success) {
+            coreServices.notifications.toasts.addWarning(
+              i18n.translate('dashboard.reset.panelError', {
+                defaultMessage: 'Unable to reset panel changes',
+              })
+            );
+          }
+        }
      } else {
        // if reset resulted in panel removal, we need to update the list of children
        delete currentChildren[panelId];