[dashboard] update server interfaces to accept SavedObjectsClientContract instead of RequestHandlerContext (elastic#269750)

Closes elastic#261984

Dashboard interfaces currently require `RequestHandlerContext` when they
really only require `SavedObjectsClientContract`. This makes plugins
that want to use these interfaces outside of request scope have to mock
a request scope. Since `RequestHandlerContext` is not needed by server
interfaces, it would be best to narrow the interface to only require
`SavedObjectsClientContract`.

---------

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

Author: nreese

src/platform/plugins/shared/dashboard/server/api/read/read.ts

@@ -7,7 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import type { RequestHandlerContext } from '@kbn/core/server';
+import type { SavedObjectsClientContract } from '@kbn/core/server';
 import type { RequestTiming } from '@kbn/core-http-server';
 import type { DashboardSavedObjectAttributes } from '../../dashboard_saved_object';
 import { DASHBOARD_SAVED_OBJECT_TYPE } from '../../../common/constants';
@@ -16,20 +16,18 @@ import type { DashboardReadResponseBody } from './types';
 import type { getDashboardStateSchema } from '../dashboard_state_schemas';
 
 export async function read(
-  requestCtx: RequestHandlerContext,
+  savedObjectsClient: SavedObjectsClientContract,
   dashboardStateSchema: ReturnType<typeof getDashboardStateSchema>,
   id: string,
   serverTiming?: RequestTiming,
   isDashboardAppRequest: boolean = false
 ): Promise<{ body: DashboardReadResponseBody; resolveHeaders: Record<string, string> }> {
-  const { core } = await requestCtx.resolve(['core']);
-
   const {
     saved_object: savedObject,
     outcome,
     alias_purpose,
     alias_target_id,
-  } = await core.savedObjects.client.resolve<DashboardSavedObjectAttributes>(
+  } = await savedObjectsClient.resolve<DashboardSavedObjectAttributes>(
     DASHBOARD_SAVED_OBJECT_TYPE,
     id
   );

src/platform/plugins/shared/dashboard/server/api/read/register_read_route.ts

@@ -77,7 +77,9 @@ export function registerReadRoute(
       telemetryHandler(req, usageCounter, async () => {
         try {
           const { body, resolveHeaders } = await read(
-            ctx,
+            (
+              await ctx.resolve(['core'])
+            ).core.savedObjects.client,
             getCachedDashboardStateSchema(),
             req.params.id,
             req.serverTiming,

src/platform/plugins/shared/dashboard/server/plugin.ts

@@ -24,7 +24,7 @@ import type {
   CoreStart,
   Plugin,
   Logger,
-  RequestHandlerContext,
+  SavedObjectsClientContract,
 } from '@kbn/core/server';
 import { registerContentInsights } from '@kbn/content-management-content-insights-server';
 import type { UsageCounter } from '@kbn/usage-collection-plugin/server';
@@ -183,8 +183,8 @@ export class DashboardPlugin
     return {
       scanDashboards,
       client: {
-        read: async (requestCtx: RequestHandlerContext, id: string) =>
-          (await read(requestCtx, getCachedDashboardStateSchema(), id)).body,
+        read: async (savedObjectsClient: SavedObjectsClientContract, id: string) =>
+          (await read(savedObjectsClient, getCachedDashboardStateSchema(), id)).body,
       },
     };
   }

src/platform/plugins/shared/dashboard/server/scan_dashboards.ts

@@ -7,7 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import type { RequestHandlerContext } from '@kbn/core/server';
+import type { SavedObjectsClientContract } from '@kbn/core/server';
 import type { Reference } from '@kbn/content-management-utils';
 import type { DashboardSavedObjectAttributes } from './dashboard_saved_object';
 import { DASHBOARD_SAVED_OBJECT_TYPE } from '../common/constants';
@@ -33,12 +33,11 @@ export interface ScanDashboardsResult {
 }
 
 export async function scanDashboards(
-  ctx: RequestHandlerContext,
+  savedObjectsClient: SavedObjectsClientContract,
   page: number,
   perPage: number
 ): Promise<ScanDashboardsResult> {
-  const { core } = await ctx.resolve(['core']);
-  const soResponse = await core.savedObjects.client.find<DashboardSavedObjectAttributes>({
+  const soResponse = await savedObjectsClient.find<DashboardSavedObjectAttributes>({
     type: DASHBOARD_SAVED_OBJECT_TYPE,
     fields: ['description', 'title', 'panelsJSON', 'sections'],
     perPage,

src/platform/plugins/shared/dashboard/server/types.ts

@@ -7,15 +7,18 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import type { RequestHandlerContext } from '@kbn/core/server';
+import type { SavedObjectsClientContract } from '@kbn/core/server';
 import type { ScanDashboardsResult } from './scan_dashboards';
 import type { DashboardReadResponseBody } from './api';
 
 /**
  * Client interface for dashboard CRUD operations
  */
 export interface DashboardServerClient {
-  read(requestCtx: RequestHandlerContext, id: string): Promise<DashboardReadResponseBody>;
+  read(
+    savedObjectsClient: SavedObjectsClientContract,
+    id: string
+  ): Promise<DashboardReadResponseBody>;
 }
 
 /** The setup contract for the Dashboard plugin on the server. */
@@ -39,7 +42,7 @@ export interface DashboardPluginStart {
    * @returns A promise that resolves to the {@link ScanDashboardsResult}.
    */
   scanDashboards: (
-    ctx: RequestHandlerContext,
+    savedObjectsClient: SavedObjectsClientContract,
     page: number,
     perPage: number
   ) => Promise<ScanDashboardsResult>;

x-pack/platform/plugins/shared/agent_builder_dashboards/server/attachment_types/dashboard.test.ts

@@ -92,7 +92,7 @@ const createAttachment = (
 });
 
 describe('createDashboardAttachmentType', () => {
-  it('resolves dashboard attachments with dashboard client.read', async () => {
+  it('resolve should return dashboard attachement', async () => {
     const dashboardClient = createDashboardClient();
     const savedObjectsClient = createSavedObjectsClient();
     const definition = createDashboardAttachmentType({
@@ -106,17 +106,6 @@ describe('createDashboardAttachmentType', () => {
       savedObjectsClient,
     });
 
-    expect(dashboardClient.read).toHaveBeenCalledWith(
-      expect.objectContaining({ resolve: expect.any(Function) }),
-      'dashboard-1'
-    );
-    await expect(dashboardClient.read.mock.calls[0][0].resolve(['core'])).resolves.toEqual({
-      core: {
-        savedObjects: {
-          client: savedObjectsClient,
-        },
-      },
-    });
     expect(result).toEqual(
       expect.objectContaining({
         title: 'System Overview',
@@ -126,7 +115,7 @@ describe('createDashboardAttachmentType', () => {
     expect(result?.panels).toHaveLength(1);
   });
 
-  it('returns true when the saved dashboard changed after the snapshot', async () => {
+  it('isStale should return true when the dashboard changed after the snapshot', async () => {
     const dashboardClient = createDashboardClient();
     const savedObjectsClient = createSavedObjectsClient();
     const definition = createDashboardAttachmentType({
@@ -148,20 +137,9 @@ describe('createDashboardAttachmentType', () => {
     );
 
     expect(isStale).toBe(true);
-    expect(dashboardClient.read).toHaveBeenCalledWith(
-      expect.objectContaining({ resolve: expect.any(Function) }),
-      'dashboard-1'
-    );
-    await expect(dashboardClient.read.mock.calls[0][0].resolve(['core'])).resolves.toEqual({
-      core: {
-        savedObjects: {
-          client: savedObjectsClient,
-        },
-      },
-    });
   });
 
-  it('returns false when the saved dashboard content matches the attachment', async () => {
+  it('isStale should return false when the dashboard has not changed', async () => {
     const dashboardClient = createDashboardClient();
     const savedObjectsClient = createSavedObjectsClient();
     const definition = createDashboardAttachmentType({
@@ -181,17 +159,6 @@ describe('createDashboardAttachmentType', () => {
     });
 
     expect(isStale).toBe(false);
-    expect(dashboardClient.read).toHaveBeenLastCalledWith(
-      expect.objectContaining({ resolve: expect.any(Function) }),
-      'dashboard-1'
-    );
-    await expect(dashboardClient.read.mock.calls[1][0].resolve(['core'])).resolves.toEqual({
-      core: {
-        savedObjects: {
-          client: savedObjectsClient,
-        },
-      },
-    });
   });
 
   it('treats legacy wrapped Lens configs as equal when checking staleness', async () => {

x-pack/platform/plugins/shared/agent_builder_dashboards/server/attachment_types/dashboard.ts

@@ -21,7 +21,6 @@ import {
 } from '@kbn/agent-builder-dashboards-common';
 import type { DashboardPluginStart } from '@kbn/dashboard-plugin/server';
 import type { Logger } from '@kbn/core/server';
-import { createRequestHandlerContext } from '../create_request_handler_context';
 
 interface CreateDashboardAttachmentTypeOptions {
   logger: Logger;
@@ -51,10 +50,8 @@ export const createDashboardAttachmentType = ({
     if (!context.savedObjectsClient) {
       throw new Error('Saved objects client is required to read dashboard attachments');
     }
-    // todo: this should be passed from agent builder
-    const requestHandlerContext = createRequestHandlerContext(context.savedObjectsClient);
     const dashboardClient = await getDashboardClient();
-    return dashboardClient.read(requestHandlerContext, origin);
+    return dashboardClient.read(context.savedObjectsClient, origin);
   };
 
   return {

x-pack/platform/plugins/shared/agent_builder_dashboards/server/create_request_handler_context.ts

@@ -182,14 +182,6 @@ describe('dashboardSmlType', () => {
     expect(result?.chunks[0].content).toContain('Operations');
     expect(result?.chunks[0].content).toContain('2 panels');
     expect(result?.chunks[0].content).toContain('1 sections');
-    const requestHandlerContext = dashboardClient.read.mock.calls[0][0];
-    await expect(requestHandlerContext.resolve(['core'])).resolves.toEqual({
-      core: {
-        savedObjects: {
-          client: savedObjectsClient,
-        },
-      },
-    });
   });
 
   it('converts saved dashboards into dashboard attachments with origin', async () => {
@@ -244,14 +236,6 @@ describe('dashboardSmlType', () => {
         }),
       ])
     );
-    const requestHandlerContext = dashboardClient.read.mock.calls[0][0];
-    await expect(requestHandlerContext.resolve(['core'])).resolves.toEqual({
-      core: {
-        savedObjects: {
-          client: savedObjectsClient,
-        },
-      },
-    });
   });
 
   it('falls back to generic panel storage when a lens panel is already in API format', async () => {
@@ -323,13 +307,5 @@ describe('dashboardSmlType', () => {
         chunks: [expect.objectContaining({ type: 'dashboard', title: 'System Overview' })],
       })
     );
-    const requestHandlerContext = dashboardClient.read.mock.calls[0][0];
-    await expect(requestHandlerContext.resolve(['core'])).resolves.toEqual({
-      core: {
-        savedObjects: {
-          client: savedObjectsClient,
-        },
-      },
-    });
   });
 });

x-pack/platform/plugins/shared/agent_builder_dashboards/server/sml_types/dashboard.test.ts

@@ -16,7 +16,6 @@ import type {
   DashboardSection,
   DashboardState,
 } from '@kbn/dashboard-plugin/server';
-import { createRequestHandlerContext } from '../create_request_handler_context';
 
 const DASHBOARD_SML_TYPE = 'dashboard';
 
@@ -92,10 +91,8 @@ export const createDashboardSmlType = ({
 
   getSmlData: async (originId, context) => {
     try {
-      // todo: this should be passed from agent builder
-      const requestHandlerContext = createRequestHandlerContext(context.savedObjectsClient);
       const dashboardClient = await getDashboardClient();
-      const dashboard = await dashboardClient.read(requestHandlerContext, originId);
+      const dashboard = await dashboardClient.read(context.savedObjectsClient, originId);
 
       return {
         chunks: [
@@ -117,10 +114,8 @@ export const createDashboardSmlType = ({
 
   toAttachment: async (item, context) => {
     try {
-      // todo: this should be passed from agent builder
-      const requestHandlerContext = createRequestHandlerContext(context.savedObjectsClient);
       const dashboardClient = await getDashboardClient();
-      const dashboard = await dashboardClient.read(requestHandlerContext, item.origin_id);
+      const dashboard = await dashboardClient.read(context.savedObjectsClient, item.origin_id);
 
       return {
         type: DASHBOARD_ATTACHMENT_TYPE,