[8.8] [Dashboard] [Controls] Fix race condition on reset (#156209) (#156708)

# Backport This will backport the following commits from `main` to `8.8`: - [[Dashboard] [Controls] Fix race condition on reset (#156209)](https://github.com/elastic/kibana/pull/156209)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com>
2025-04-24 17:59:23 -04:00 · 2023-05-04 12:38:33 -04:00 · 2023-05-04 12:38:33 -04:00 · 09d3dc42a4
commit 09d3dc42a4
parent de9c32a7f1
3 changed files with 23 additions and 21 deletions
--- a/src/plugins/dashboard/public/dashboard_container/embeddable/create/controls/dashboard_control_group_integration.ts
+++ b/src/plugins/dashboard/public/dashboard_container/embeddable/create/controls/dashboard_control_group_integration.ts
@ -10,11 +10,10 @@ import { isEqual } from 'lodash';
 import { Observable } from 'rxjs';
 import deepEqual from 'fast-deep-equal';
 import { compareFilters, COMPARE_ALL_OPTIONS, type Filter } from '@kbn/es-query';
-import { debounceTime, distinctUntilChanged, distinctUntilKeyChanged, skip } from 'rxjs/operators';
+import { distinctUntilChanged, skip } from 'rxjs/operators';

 import {
  ControlGroupInput,
-  getDefaultControlGroupInput,
  persistableControlGroupInputIsEqual,
 } from '@kbn/controls-plugin/common';
 import { ControlGroupContainer } from '@kbn/controls-plugin/public';
@ -106,23 +105,6 @@ export function startSyncingDashboardControlGroup(this: DashboardContainer) {
      })
  );

-  // dashboard may reset the control group input when discarding changes. Subscribe to these changes and update accordingly
-  this.subscriptions.add(
-    (this.getInput$() as Readonly<Observable<DashboardContainerInput>>)
-      .pipe(debounceTime(10), distinctUntilKeyChanged('controlGroupInput'))
-      .subscribe(() => {
-        if (!isControlGroupInputEqual()) {
-          if (!this.getInput().controlGroupInput) {
-            this.controlGroup!.updateInput(getDefaultControlGroupInput());
-            return;
-          }
-          this.controlGroup!.updateInput({
-            ...this.getInput().controlGroupInput,
-          });
-        }
-      })
-  );
-
  // when control group outputs filters, force a refresh!
  this.subscriptions.add(
    this.controlGroup
--- a/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx
+++ b/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx
@ -27,6 +27,7 @@ import type { RefreshInterval } from '@kbn/data-plugin/public';
 import { KibanaThemeProvider } from '@kbn/kibana-react-plugin/public';
 import type { ControlGroupContainer } from '@kbn/controls-plugin/public';
 import type { KibanaExecutionContext, OverlayRef } from '@kbn/core/public';
+import { persistableControlGroupInputIsEqual } from '@kbn/controls-plugin/common';
 import { ExitFullScreenButtonKibanaProvider } from '@kbn/shared-ux-button-exit-full-screen';

 import {
@ -331,10 +332,21 @@ export class DashboardContainer extends Container<InheritedChildInput, Dashboard
    const {
      explicitInput: { timeRange, refreshInterval },
      componentState: {
-        lastSavedInput: { timeRestore: lastSavedTimeRestore },
+        lastSavedInput: {
+          controlGroupInput: lastSavedControlGroupInput,
+          timeRestore: lastSavedTimeRestore,
+        },
      },
    } = this.getState();

+    if (
+      this.controlGroup &&
+      lastSavedControlGroupInput &&
+      !persistableControlGroupInputIsEqual(this.controlGroup.getInput(), lastSavedControlGroupInput)
+    ) {
+      this.controlGroup.updateInput(lastSavedControlGroupInput);
+    }
+
    // if we are using the unified search integration, we need to force reset the time picker.
    if (this.creationOptions?.useUnifiedSearchIntegration && lastSavedTimeRestore) {
      const {
--- a/src/plugins/dashboard/public/dashboard_container/state/dashboard_container_reducers.ts
+++ b/src/plugins/dashboard/public/dashboard_container/state/dashboard_container_reducers.ts
@ -116,10 +116,18 @@ export const dashboardContainerReducers = {
    state.componentState.lastSavedInput = action.payload;
  },

+  /**
+   * Resets the dashboard to the last saved input, excluding:
+   * 1) The time range, unless `timeRestore` is `true` - if we include the time range on reset even when
+   *    `timeRestore` is `false`, this causes unecessary data fetches for the control group.
+   * 2) The view mode, since resetting should never impact this - sometimes the Dashboard saved objects
+   *    have this saved in and we don't want resetting to cause unexpected view mode changes.
+   */
  resetToLastSavedInput: (state: DashboardReduxState) => {
    state.explicitInput = {
      ...state.componentState.lastSavedInput,
-      viewMode: state.explicitInput.viewMode, // keep current view mode when resetting
+      ...(!state.explicitInput.timeRestore && { timeRange: state.explicitInput.timeRange }),
+      viewMode: state.explicitInput.viewMode,
    };
  },