[dashboard as code] dashboard client (#241393)

Part of #238500

PR consolidates HTTP requests into `dashboardClient`. `get` and `delete`
are migrated to REST endpoints while `create`, `search`, and `update`
are labeled with TODOs. Those endpoints need some work before dashboard
can use them.

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>

Author: 3 people

src/platform/plugins/shared/dashboard/common/content_management/constants.ts

@@ -8,6 +8,7 @@
  */
 
 export const LATEST_VERSION = 1;
+export const DASHBOARD_API_VERSION = String(LATEST_VERSION);
 
 export const CONTENT_ID = 'dashboard';
 

src/platform/plugins/shared/dashboard/jest_setup.ts

@@ -16,8 +16,6 @@
  */
 import {
   mockDashboardBackupService,
-  mockDashboardContentManagementCache,
-  mockDashboardContentManagementService,
   setStubKibanaServices,
   setStubLogger,
 } from './public/services/mocks';
@@ -26,14 +24,6 @@ setStubLogger();
 // Start the kibana services with stubs
 setStubKibanaServices();
 
-// Mock the dashboard services
-jest.mock('./public/services/dashboard_content_management_service', () => {
-  return {
-    getDashboardContentManagementCache: () => mockDashboardContentManagementCache,
-    getDashboardContentManagementService: () => mockDashboardContentManagementService,
-  };
-});
-
 jest.mock('./public/services/dashboard_backup_service', () => {
   return {
     getDashboardBackupService: () => mockDashboardBackupService,

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

@@ -15,8 +15,6 @@ import { CONTROLS_GROUP_TYPE } from '@kbn/controls-constants';
 import { DASHBOARD_APP_ID } from '../../common/constants';
 import { getReferencesForControls, getReferencesForPanelId } from '../../common';
 import type { DashboardState } from '../../common/types';
-import { getDashboardContentManagementService } from '../services/dashboard_content_management_service';
-import type { LoadDashboardReturn } from '../services/dashboard_content_management_service/types';
 import {
   CONTROL_GROUP_EMBEDDABLE_ID,
   initializeControlGroupManager,
@@ -37,6 +35,8 @@ import { initializeUnifiedSearchManager } from './unified_search_manager';
 import { initializeUnsavedChangesManager } from './unsaved_changes_manager';
 import { initializeViewModeManager } from './view_mode_manager';
 import { mergeControlGroupStates } from './merge_control_group_states';
+import type { DashboardAPIGetOut } from '../../server/content_management';
+import { saveDashboard } from './save_modal/save_dashboard';
 
 export function getDashboardApi({
   creationOptions,
@@ -48,15 +48,19 @@ export function getDashboardApi({
   creationOptions?: DashboardCreationOptions;
   incomingEmbeddables?: EmbeddablePackageState[] | undefined;
   initialState: DashboardState;
-  savedObjectResult?: LoadDashboardReturn;
+  savedObjectResult?: DashboardAPIGetOut;
   savedObjectId?: string;
 }) {
   const fullScreenMode$ = new BehaviorSubject(creationOptions?.fullScreenMode ?? false);
-  const isManaged = savedObjectResult?.managed ?? false;
+  const isManaged = savedObjectResult?.meta.managed ?? false;
   const savedObjectId$ = new BehaviorSubject<string | undefined>(savedObjectId);
   const dashboardContainerRef$ = new BehaviorSubject<HTMLElement | null>(null);
 
-  const viewModeManager = initializeViewModeManager(incomingEmbeddables, savedObjectResult);
+  const viewModeManager = initializeViewModeManager({
+    incomingEmbeddables,
+    isManaged,
+    savedObjectId,
+  });
   const trackPanel = initializeTrackPanel(async (id: string) => {
     await layoutManager.api.getChildApi(id);
   }, dashboardContainerRef$);
@@ -107,7 +111,7 @@ export function getDashboardApi({
     viewMode$: viewModeManager.api.viewMode$,
     storeUnsavedChanges: creationOptions?.useSessionStorageIntegration,
     controlGroupManager,
-    lastSavedState: savedObjectResult?.dashboardInput ?? DEFAULT_DASHBOARD_STATE,
+    lastSavedState: savedObjectResult?.data ?? DEFAULT_DASHBOARD_STATE,
     layoutManager,
     savedObjectId$,
     settingsManager,
@@ -209,7 +213,7 @@ export function getDashboardApi({
     runQuickSave: async () => {
       if (isManaged) return;
       const { dashboardState, references } = getState();
-      const saveResult = await getDashboardContentManagementService().saveDashboardState({
+      const saveResult = await saveDashboard({
         dashboardState,
         references,
         saveOptions: {},

src/platform/plugins/shared/dashboard/public/dashboard_api/load_dashboard_api/load_dashboard_api.test.ts

@@ -25,6 +25,18 @@ jest.mock('@kbn/content-management-content-insights-public', () => {
   };
 });
 
+jest.mock('../../dashboard_client', () => {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const defaultState = require('../default_dashboard_state');
+  return {
+    dashboardClient: {
+      get: jest.fn().mockResolvedValue({
+        data: { ...defaultState.DEFAULT_DASHBOARD_STATE },
+      }),
+    },
+  };
+});
+
 const lastSavedQuery = { query: 'memory:>220000', language: 'kuery' };
 
 describe('loadDashboardApi', () => {
@@ -39,16 +51,6 @@ describe('loadDashboardApi', () => {
       internalApi: {},
     });
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    require('../../services/dashboard_content_management_service').getDashboardContentManagementService =
-      () => ({
-        loadDashboardState: () => ({
-          dashboardFound: true,
-          dashboardInput: DEFAULT_DASHBOARD_STATE,
-          references: [],
-        }),
-      });
-
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     require('../../services/dashboard_backup_service').getDashboardBackupService = () => ({
       getState: () => ({
@@ -71,10 +73,7 @@ describe('loadDashboardApi', () => {
       });
       expect(getDashboardApiMock).toHaveBeenCalled();
       // @ts-ignore
-      expect(getDashboardApiMock.mock.calls[0][0].initialState).toEqual({
-        ...DEFAULT_DASHBOARD_STATE,
-        references: [],
-      });
+      expect(getDashboardApiMock.mock.calls[0][0].initialState).toEqual(DEFAULT_DASHBOARD_STATE);
     });
 
     test('should overwrite saved object state with unsaved state', async () => {
@@ -88,7 +87,6 @@ describe('loadDashboardApi', () => {
       // @ts-ignore
       expect(getDashboardApiMock.mock.calls[0][0].initialState).toEqual({
         ...DEFAULT_DASHBOARD_STATE,
-        references: [],
         query: lastSavedQuery,
       });
     });
@@ -109,7 +107,6 @@ describe('loadDashboardApi', () => {
       // @ts-ignore
       expect(getDashboardApiMock.mock.calls[0][0].initialState).toEqual({
         ...DEFAULT_DASHBOARD_STATE,
-        references: [],
         query: queryFromUrl,
       });
     });

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

@@ -8,15 +8,15 @@
  */
 
 import { ContentInsightsClient } from '@kbn/content-management-content-insights-public';
-import type { DashboardState } from '../../../common';
 import { getDashboardBackupService } from '../../services/dashboard_backup_service';
-import { getDashboardContentManagementService } from '../../services/dashboard_content_management_service';
 import { coreServices } from '../../services/kibana_services';
 import { logger } from '../../services/logger';
 import { getDashboardApi } from '../get_dashboard_api';
 import { startQueryPerformanceTracking } from '../performance/query_performance_tracking';
 import type { DashboardCreationOptions } from '../types';
 import { transformPanels } from './transform_panels';
+import { dashboardClient } from '../../dashboard_client';
+import { DEFAULT_DASHBOARD_STATE } from '../default_dashboard_state';
 
 export async function loadDashboardApi({
   getCreationOptions,
@@ -28,13 +28,8 @@ export async function loadDashboardApi({
   const creationStartTime = performance.now();
   const creationOptions = await getCreationOptions?.();
   const incomingEmbeddables = creationOptions?.getIncomingEmbeddables?.();
-  const savedObjectResult = await getDashboardContentManagementService().loadDashboardState({
-    id: savedObjectId,
-  });
+  const savedObjectResult = savedObjectId ? await dashboardClient.get(savedObjectId) : undefined;
 
-  // --------------------------------------------------------------------------------------
-  // Run validation.
-  // --------------------------------------------------------------------------------------
   const validationResult =
     savedObjectResult && creationOptions?.validateLoadedSavedObject?.(savedObjectResult);
   if (validationResult === 'invalid') {
@@ -44,25 +39,10 @@ export async function loadDashboardApi({
     return;
   }
 
-  // --------------------------------------------------------------------------------------
-  // Combine saved object state and session storage state
-  // --------------------------------------------------------------------------------------
-  const sessionStorageInput = ((): Partial<DashboardState> | undefined => {
-    if (!creationOptions?.useSessionStorageIntegration) return;
-    return getDashboardBackupService().getState(savedObjectResult.dashboardId);
-  })();
-
-  const combinedSessionState: DashboardState = {
-    ...(savedObjectResult?.dashboardInput ?? {}),
-    ...sessionStorageInput,
-  };
-  combinedSessionState.references = sessionStorageInput?.references?.length
-    ? sessionStorageInput?.references
-    : savedObjectResult?.references;
+  const unsavedChanges = creationOptions?.useSessionStorageIntegration
+    ? getDashboardBackupService().getState(savedObjectId)
+    : undefined;
 
-  // --------------------------------------------------------------------------------------
-  // Combine state with overrides.
-  // --------------------------------------------------------------------------------------
   const { viewMode, ...overrideState } = creationOptions?.getInitialInput?.() ?? {};
   if (overrideState.panels) {
     overrideState.panels = await transformPanels(overrideState.panels, overrideState.references);
@@ -73,14 +53,13 @@ export async function loadDashboardApi({
     getDashboardBackupService().storeViewMode(viewMode);
   }
 
-  // --------------------------------------------------------------------------------------
-  // get dashboard Api
-  // --------------------------------------------------------------------------------------
   const { api, cleanup, internalApi } = getDashboardApi({
     creationOptions,
     incomingEmbeddables,
     initialState: {
-      ...combinedSessionState,
+      ...DEFAULT_DASHBOARD_STATE,
+      ...savedObjectResult?.data,
+      ...unsavedChanges,
       ...overrideState,
     },
     savedObjectResult,

src/platform/plugins/shared/dashboard/public/dashboard_api/save_modal/open_save_modal.tsx

@@ -13,14 +13,14 @@ import type { Reference } from '@kbn/content-management-utils';
 import { reportPerformanceMetricEvent } from '@kbn/ebt-tools';
 import { showSaveModal } from '@kbn/saved-objects-plugin/public';
 import { i18n } from '@kbn/i18n';
-import type { SaveDashboardReturn } from '../../services/dashboard_content_management_service/types';
-import type { DashboardSaveOptions } from './types';
+import type { DashboardSaveOptions, SaveDashboardReturn } from './types';
 import { coreServices, savedObjectsTaggingService } from '../../services/kibana_services';
-import { getDashboardContentManagementService } from '../../services/dashboard_content_management_service';
 import type { DashboardState } from '../../../common';
 import { DASHBOARD_CONTENT_ID, SAVED_OBJECT_POST_TIME } from '../../utils/telemetry_constants';
 import { extractTitleAndCount } from '../../utils/extract_title_and_count';
 import { DashboardSaveModal } from './save_modal';
+import { checkForDuplicateDashboardTitle } from '../../dashboard_client';
+import { saveDashboard } from './save_dashboard';
 
 /**
  * @description exclusively for user directed dashboard save actions, also
@@ -51,7 +51,6 @@ export async function openSaveModal({
     if (viewMode === 'edit' && isManaged) {
       return undefined;
     }
-    const dashboardContentManagementService = getDashboardContentManagementService();
     const saveAsTitle = lastSavedId ? await getSaveAsTitle(title) : title;
     return new Promise<(SaveDashboardReturn & { savedState: DashboardState }) | undefined>(
       (resolve) => {
@@ -73,7 +72,7 @@ export async function openSaveModal({
 
           try {
             if (
-              !(await dashboardContentManagementService.checkForDuplicateDashboardTitle({
+              !(await checkForDuplicateDashboardTitle({
                 title: newTitle,
                 onTitleDuplicate,
                 lastSavedTitle: title,
@@ -99,7 +98,7 @@ export async function openSaveModal({
 
             const beforeAddTime = window.performance.now();
 
-            const saveResult = await dashboardContentManagementService.saveDashboardState({
+            const saveResult = await saveDashboard({
               references,
               saveOptions,
               dashboardState: dashboardStateToSave,
@@ -178,7 +177,7 @@ function generateDashboardNotSavedToast(title: string, errorMessage: any) {
 async function getSaveAsTitle(title: string) {
   const [baseTitle, baseCount] = extractTitleAndCount(title);
   let saveAsTitle = `${baseTitle} (${baseCount + 1})`;
-  await getDashboardContentManagementService().checkForDuplicateDashboardTitle({
+  await checkForDuplicateDashboardTitle({
     title: saveAsTitle,
     lastSavedTitle: title,
     copyOnSave: true,