From d40b1c439f1cfe7edc2c1f25189e7ec5d8c94181 Mon Sep 17 00:00:00 2001
From: Nick Peihl <nick.peihl@elastic.co>
Date: Thu, 10 Apr 2025 14:52:38 -0400
Subject: [PATCH] [Dashboards] Replace contentClient with getContentClient on
 DashboardStart server api (#217586)

## Summary

Changes the DashboardStart server api to provide a getContentClient
function.

In https://github.com/elastic/kibana/pull/214788, we set the
`contentClient` returned from the content management register method
after start lifecycle of all plugins. This means the `contentClient`
returned from the `DashboardStart` contract was undefined. This PR
changes the start contract to provide a getContentClient function
instead.

Only one consumer was using the contentClient from DashboardStart and
this PR also updates that consumer.

(cherry picked from commit 72d18d8b992c99bb0be42123406453f0379f29d8)

# Conflicts:
#	x-pack/solutions/observability/plugins/observability/server/routes/alerts/route.ts
---
 .../shared/dashboard/server/plugin.test.ts     |  4 +++-
 .../plugins/shared/dashboard/server/plugin.ts  |  2 +-
 .../plugins/shared/dashboard/server/types.ts   | 18 +++++++++---------
 3 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/src/platform/plugins/shared/dashboard/server/plugin.test.ts b/src/platform/plugins/shared/dashboard/server/plugin.test.ts
index 88903898a3981..de64b41e6c6ad 100644
--- a/src/platform/plugins/shared/dashboard/server/plugin.test.ts
+++ b/src/platform/plugins/shared/dashboard/server/plugin.test.ts
@@ -51,7 +51,9 @@ describe('DashboardPlugin', () => {
       });
       expect(scheduleDashboardTelemetry).toHaveBeenCalledTimes(1);
       expect(await mockTaskManager.runSoon).toHaveBeenCalledTimes(1);
-      expect(response).toEqual({});
+      expect(response).toEqual({
+        getContentClient: expect.any(Function),
+      });
     });
   });
 });
diff --git a/src/platform/plugins/shared/dashboard/server/plugin.ts b/src/platform/plugins/shared/dashboard/server/plugin.ts
index d8704dc740840..7ad376f8698b5 100644
--- a/src/platform/plugins/shared/dashboard/server/plugin.ts
+++ b/src/platform/plugins/shared/dashboard/server/plugin.ts
@@ -144,7 +144,7 @@ export class DashboardPlugin
     }
 
     return {
-      contentClient: this.contentClient,
+      getContentClient: () => this.contentClient,
     };
   }
 
diff --git a/src/platform/plugins/shared/dashboard/server/types.ts b/src/platform/plugins/shared/dashboard/server/types.ts
index 05358b2bd69b7..9c3edc6a4abad 100644
--- a/src/platform/plugins/shared/dashboard/server/types.ts
+++ b/src/platform/plugins/shared/dashboard/server/types.ts
@@ -13,40 +13,40 @@ import { ContentManagementServerSetup } from '@kbn/content-management-plugin/ser
 export interface DashboardPluginSetup {}
 export interface DashboardPluginStart {
   /**
-   * Use contentClient.getForRequest to get a scoped client to perform CRUD and search operations for dashboards using the methods available in the {@link DashboardStorage} class.
+   * Use getContentClient().getForRequest to get a scoped client to perform CRUD and search operations for dashboards using the methods available in the {@link DashboardStorage} class.
    *
    * @example
    * Get a dashboard client for the current request
    * ```ts
    * // dashboardClient is scoped to the current user
    * // specifying the version is recommended to return a consistent result
-   * const dashboardClient = plugins.dashboard.contentClient.getForRequest({ requestHandlerContext, request, version: 3 });
-   *
-   * const { search, create, update, delete: deleteDashboard } = dashboardClient;
+   * const dashboardClient = plugins.dashboard.getContentClient().getForRequest({ requestHandlerContext, request, version: 3 });
    * ```
    *
    * @example
    * Search using {@link DashboardStorage#search}
    * ```ts
-   * const dashboardList = await search({ text: 'my dashboard' }, { spaces: ['default'] } });
+   * const dashboardList = await dashboardClient.search({ text: 'my dashboard' }, { spaces: ['default'] } });
    * ```
    * @example
    * Create a new dashboard using {@link DashboardCreateIn}
    * ```ts
-   * const newDashboard = await create({ attributes: { title: 'My Dashboard' } });
+   * const newDashboard = await dashboardClient.create({ attributes: { title: 'My Dashboard' } });
    * ```
    *
    * @example
    * Update an existing dashboard using {@link DashboardUpdateIn}
    * ```ts
-   * const updatedDashboard = await update({ id: 'dashboard-id', attributes: { title: 'My Updated Dashboard' } });
+   * const updatedDashboard = await dashboardClient.update({ id: 'dashboard-id', attributes: { title: 'My Updated Dashboard' } });
    * ```
    *
    * @example
    * Delete an existing dashboard using {@link DashboardDeleteIn}
    * ```ts
-   * deleteDashboard({ id: 'dashboard-id' });
+   * dashboardClient.delete({ id: 'dashboard-id' });
    * ```
    */
-  contentClient?: ReturnType<ContentManagementServerSetup['register']>['contentClient'];
+  getContentClient: () =>
+    | ReturnType<ContentManagementServerSetup['register']>['contentClient']
+    | undefined;
 }