[dashboard] fix add panel fails when custom panel placement callback throws (#222446)

While working on #221314, I
noticed that "Add panel" will silently fail if
`getDashboardPanelPlacementSetting` throws. Dashboard should be more
resilient since it does not control what may be provided from a
registry. PR just adds a try/catch around the call to avoid breaking
"Add panel".

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Author: 3 people

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

@@ -39,7 +39,7 @@ import { DEFAULT_PANEL_HEIGHT, DEFAULT_PANEL_WIDTH } from '../../common/content_
 import { prefixReferencesFromPanel } from '../../common/dashboard_container/persistable_state/dashboard_container_references';
 import { dashboardClonePanelActionStrings } from '../dashboard_actions/_dashboard_actions_strings';
 import { getPanelAddedSuccessString } from '../dashboard_app/_dashboard_app_strings';
-import { getDashboardPanelPlacementSetting } from '../panel_placement/panel_placement_registry';
+import { getPanelPlacementSetting } from '../panel_placement/get_panel_placement_settings';
 import { placeClonePanel } from '../panel_placement/place_clone_panel_strategy';
 import { runPanelPlacementStrategy } from '../panel_placement/place_new_panel_strategies';
 import { PanelPlacementStrategy } from '../plugin_constants';
@@ -165,10 +165,7 @@ export function initializeLayoutManager(
         },
       };
     }
-    const getCustomPlacementSettingFunc = getDashboardPanelPlacementSetting(type);
-    const customPlacementSettings = getCustomPlacementSettingFunc
-      ? await getCustomPlacementSettingFunc(serializedState)
-      : undefined;
+    const customPlacementSettings = await getPanelPlacementSetting(type, serializedState);
     const { newPanelPlacement, otherPanels } = runPanelPlacementStrategy(
       customPlacementSettings?.strategy ?? PanelPlacementStrategy.findTopLeftMostOpenSpace,
       {

src/platform/plugins/shared/dashboard/public/panel_placement/get_panel_placement_settings.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { SerializedPanelState } from '@kbn/presentation-publishing';
+import { getRegistryItem } from './panel_placement_registry';
+import { PanelPlacementSettings } from './types';
+
+export async function getPanelPlacementSetting(
+  embeddableType: string,
+  serializedState?: SerializedPanelState<object>
+): Promise<undefined | PanelPlacementSettings> {
+  const registryItem = getRegistryItem(embeddableType);
+  if (!registryItem) return;
+
+  try {
+    return await registryItem(serializedState);
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      `Unable to get panel placement settings; embeddableType: ${embeddableType}, serializedState: ${serializedState}, error: ${e}`
+    );
+  }
+}

src/platform/plugins/shared/dashboard/public/panel_placement/panel_placement_registry.ts

@@ -27,6 +27,9 @@ export const registerDashboardPanelPlacementSetting = <SerializedState extends o
   registry.set(embeddableType, getPanelPlacementSettings as GetPanelPlacementSettings<object>);
 };
 
-export const getDashboardPanelPlacementSetting = (embeddableType: string) => {
+/**
+ * Use getPanelPlacementSetting to access registry
+ */
+export const getRegistryItem = (embeddableType: string) => {
   return registry.get(embeddableType);
 };