remove locator from dashboard setup and start contract

elastic · Mar 3, 2025 · fea861e · fea861e
1 parent 7d79495
commit fea861e
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 40 deletions.
diff --git a/src/platform/plugins/shared/dashboard/public/index.ts b/src/platform/plugins/shared/dashboard/public/index.ts
@@ -20,7 +20,7 @@ export type { DashboardApi, DashboardCreationOptions } from './dashboard_api/typ
 export { DASHBOARD_API_TYPE } from './dashboard_api/types';
 export { LazyDashboardRenderer as DashboardRenderer } from './dashboard_container/external_api/lazy_dashboard_renderer';
 export type { DashboardLocatorParams } from './dashboard_container/types';
-export type { DashboardSetup, DashboardStart } from './plugin';
+export type { DashboardStart } from './plugin';
 
 export { DashboardListingTable } from './dashboard_listing';
 export { DashboardTopNav } from './dashboard_top_nav';

diff --git a/src/platform/plugins/shared/dashboard/public/plugin.tsx b/src/platform/plugins/shared/dashboard/public/plugin.tsx
@@ -61,10 +61,7 @@ import type {
 } from '@kbn/usage-collection-plugin/public';
 
 import { CONTENT_ID, LATEST_VERSION } from '../common/content_management';
-import {
-  DashboardAppLocatorDefinition,
-  type DashboardAppLocator,
-} from './dashboard_app/locator/locator';
+import { DashboardAppLocatorDefinition } from './dashboard_app/locator/locator';
 import { DashboardMountContextProps } from './dashboard_app/types';
 import {
   DASHBOARD_APP_ID,
@@ -122,22 +119,10 @@ export interface DashboardStartDependencies {
   observabilityAIAssistant?: ObservabilityAIAssistantPublicStart;
 }
 
-export interface DashboardSetup {
-  /**
-   * @deprecated
-   *
-   * Use `shareStartService.url.locators.get(DASHBOARD_APP_LOCATOR)` instead.
-   */
-  locator?: DashboardAppLocator;
-}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface DashboardSetup {}
 
 export interface DashboardStart {
-  /**
-   * @deprecated
-   *
-   * Use `shareStartService.url.locators.get(DASHBOARD_APP_LOCATOR)` instead.
-   */
-  locator?: DashboardAppLocator;
   findDashboardsService: () => Promise<FindDashboardsService>;
   registerDashboardPanelPlacementSetting: <SerializedState extends object = object>(
     embeddableType: string,
@@ -156,19 +141,18 @@ export class DashboardPlugin
   private appStateUpdater = new BehaviorSubject<AppUpdater>(() => ({}));
   private stopUrlTracking: (() => void) | undefined = undefined;
   private currentHistory: ScopedHistory | undefined = undefined;
-  private locator?: DashboardAppLocator;
 
   public setup(
     core: CoreSetup<DashboardStartDependencies, DashboardStart>,
     { share, embeddable, home, urlForwarding, data, contentManagement }: DashboardSetupDependencies
-  ): DashboardSetup {
+  ) {
     core.analytics.registerEventType({
       eventType: 'dashboard_loaded_with_data',
       schema: {},
     });
 
     if (share) {
-      this.locator = share.url.locators.create(
+      share.url.locators.create(
         new DashboardAppLocatorDefinition({
           useHashedUrl: core.uiSettings.get('state:storeInSessionStorage'),
           getDashboardFilterFields: async (dashboardId: string) => {
@@ -319,9 +303,7 @@ export class DashboardPlugin
       name: dashboardAppTitle,
     });
 
-    return {
-      locator: this.locator,
-    };
+    return {};
   }
 
   public start(core: CoreStart, plugins: DashboardStartDependencies): DashboardStart {
@@ -336,7 +318,6 @@ export class DashboardPlugin
     });
 
     return {
-      locator: this.locator,
       registerDashboardPanelPlacementSetting,
       findDashboardsService: async () => {
         const { getDashboardContentManagementService } = await import(

diff --git a/x-pack/platform/plugins/shared/dashboard_enhanced/kibana.jsonc b/x-pack/platform/plugins/shared/dashboard_enhanced/kibana.jsonc
@@ -15,14 +15,14 @@
       "dashboardEnhanced"
     ],
     "requiredPlugins": [
-      "dashboard",
       "data",
       "embeddable",
       "share",
       "uiActionsEnhanced",
       "unifiedSearch"
     ],
     "requiredBundles": [
+      "dashboard",
       "embeddable",
       "embeddableEnhanced",
       "kibanaUtils",

diff --git a/x-pack/platform/plugins/shared/dashboard_enhanced/public/plugin.ts b/x-pack/platform/plugins/shared/dashboard_enhanced/public/plugin.ts
@@ -13,7 +13,6 @@ import {
   AdvancedUiActionsSetup,
   AdvancedUiActionsStart,
 } from '@kbn/ui-actions-enhanced-plugin/public';
-import { DashboardStart } from '@kbn/dashboard-plugin/public';
 import { DashboardDrilldownsService } from './services';
 
 export interface SetupDependencies {
@@ -27,7 +26,6 @@ export interface StartDependencies {
   data: DataPublicPluginStart;
   embeddable: EmbeddableStart;
   share: SharePluginStart;
-  dashboard: DashboardStart;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

diff --git a/.../public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx b/.../public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx
@@ -5,17 +5,17 @@
  * 2.0.
  */
 
-import type { KibanaLocation } from '@kbn/share-plugin/public';
+import type { KibanaLocation, SharePluginStart } from '@kbn/share-plugin/public';
 import React from 'react';
 import { DataPublicPluginStart } from '@kbn/data-plugin/public';
-import { DashboardStart } from '@kbn/dashboard-plugin/public';
 import {
   AdvancedUiActionsStart,
   UiActionsEnhancedBaseActionFactoryContext as BaseActionFactoryContext,
   UiActionsEnhancedDrilldownDefinition as Drilldown,
 } from '@kbn/ui-actions-enhanced-plugin/public';
 import { CollectConfigProps, StartServicesGetter } from '@kbn/kibana-utils-plugin/public';
 import { DEFAULT_DASHBOARD_DRILLDOWN_OPTIONS } from '@kbn/presentation-util-plugin/public';
+import { DASHBOARD_APP_LOCATOR } from '@kbn/deeplinks-analytics';
 
 import { CollectConfigContainer } from './components';
 import { txtGoToDashboard } from './i18n';
@@ -24,7 +24,7 @@ export interface Params {
   start: StartServicesGetter<{
     uiActionsEnhanced: AdvancedUiActionsStart;
     data: DataPublicPluginStart;
-    dashboard: DashboardStart;
+    share: SharePluginStart;
   }>;
 }
 
@@ -87,7 +87,7 @@ export abstract class AbstractDashboardDrilldown<Context extends object = object
   };
 
   protected get locator() {
-    const locator = this.params.start().plugins.dashboard.locator;
+    const locator = this.params.start().plugins.share.url.locators.get(DASHBOARD_APP_LOCATOR);
     if (!locator) throw new Error('Dashboard locator is required for dashboard drilldown.');
     return locator;
   }

diff --git a/...s/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.test.tsx b/...s/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.test.tsx
@@ -92,17 +92,21 @@ describe('.execute() & getHref', () => {
         },
         plugins: {
           uiActionsEnhanced: {},
-          dashboard: {
-            locator: {
-              getLocation: async (params: DashboardLocatorParams) => {
-                return await definition.getLocation(params);
-              },
-            },
+          share: {
+            url: {
+              locators: {
+                get: () => ({
+                  getLocation: async (params: DashboardLocatorParams) => {
+                    return await definition.getLocation(params);
+                  },
+                })
+              }
+            }
           },
         },
         self: {},
       })) as unknown as StartServicesGetter<
-        Pick<StartDependencies, 'data' | 'uiActionsEnhanced' | 'dashboard'>
+        Pick<StartDependencies, 'data' | 'uiActionsEnhanced' | 'share'>
       >,
     });