[8.x] [Presentation Util] Cleanup services (#194201) (#195445)

# Backport This will backport the following commits from `main` to `8.x`: - [[Presentation Util] Cleanup services (#194201)](#194201)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) \r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"9f2208db1a83889c76fd2413a0a133a858f4891e","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Presentation","loe:small","technical debt","release_note:skip","impact:high","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-management"],"title":"[Presentation Util] Cleanup services","number":194201,"url":"https://github.com/elastic/kibana/pull/194201","mergeCommit":{"message":"[Presentation Util] Cleanup services (#194201)\n\nCloses https://github.com/elastic/kibana/issues/167440\r\n\r\n## Summary\r\n\r\nThis PR refactors the `PresentationUtil` services to no longer use its\r\nown `PluginServiceProvider`. In doing this, it removes the\r\n`PresentationUtil` context provider, since it is no longer necessary.\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n\r\n\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"9f2208db1a83889c76fd2413a0a133a858f4891e"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194201","number":194201,"mergeCommit":{"message":"[Presentation Util] Cleanup services (#194201)\n\nCloses https://github.com/elastic/kibana/issues/167440\r\n\r\n## Summary\r\n\r\nThis PR refactors the `PresentationUtil` services to no longer use its\r\nown `PluginServiceProvider`. In doing this, it removes the\r\n`PresentationUtil` context provider, since it is no longer necessary.\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n\r\n\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"9f2208db1a83889c76fd2413a0a133a858f4891e"}}]}] BACKPORT--> Co-authored-by: Hannah Mudge <[email protected]>
elastic · Oct 9, 2024 · 1aceffc · 1aceffc
1 parent a02cb35
commit 1aceffc
Show file tree

Hide file tree

Showing 67 changed files with 471 additions and 1,093 deletions.
diff --git a/src/plugins/controls/public/control_group/components/control_panel.test.tsx b/src/plugins/controls/public/control_group/components/control_panel.test.tsx
@@ -10,12 +10,13 @@
 import React, { useImperativeHandle } from 'react';
 import { BehaviorSubject } from 'rxjs';
 
-import { pluginServices as presentationUtilPluginServices } from '@kbn/presentation-util-plugin/public/services';
-import { registry as presentationUtilServicesRegistry } from '@kbn/presentation-util-plugin/public/services/plugin_services.story';
+import { setMockedPresentationUtilServices } from '@kbn/presentation-util-plugin/public/mocks';
+import { uiActionsService } from '@kbn/presentation-util-plugin/public/services/kibana_services';
 import { render, waitFor } from '@testing-library/react';
 
 import type { ControlLabelPosition, ControlWidth } from '../../../common';
 import { ControlPanel } from './control_panel';
+import { Action } from '@kbn/ui-actions-plugin/public';
 
 describe('render', () => {
   let mockApi = {};
@@ -27,19 +28,14 @@ describe('render', () => {
   }) as any;
 
   beforeAll(() => {
-    presentationUtilServicesRegistry.start({});
-    presentationUtilPluginServices.setRegistry(presentationUtilServicesRegistry);
-    presentationUtilPluginServices.getServices().uiActions.getTriggerCompatibleActions = jest
-      .fn()
-      .mockImplementation(() => {
-        return [
-          {
-            isCompatible: jest.fn().mockResolvedValue(true),
-            id: 'testAction',
-            MenuItem: () => <div>test1</div>,
-          },
-        ];
-      });
+    setMockedPresentationUtilServices();
+    jest.spyOn(uiActionsService, 'getTriggerCompatibleActions').mockResolvedValue([
+      {
+        isCompatible: jest.fn().mockResolvedValue(true),
+        id: 'testAction',
+        MenuItem: () => <div>test1</div>,
+      },
+    ] as unknown as Action[]);
   });
 
   beforeEach(() => {

diff --git a/src/plugins/dashboard/public/dashboard_top_nav/internal_dashboard_top_nav.tsx b/src/plugins/dashboard/public/dashboard_top_nav/internal_dashboard_top_nav.tsx
@@ -25,11 +25,7 @@ import { FormattedMessage } from '@kbn/i18n-react';
 import { getManagedContentBadge } from '@kbn/managed-content-badge';
 import { TopNavMenuBadgeProps, TopNavMenuProps } from '@kbn/navigation-plugin/public';
 import { useBatchedPublishingSubjects } from '@kbn/presentation-publishing';
-import {
-  LazyLabsFlyout,
-  getContextProvider as getPresentationUtilContextProvider,
-  withSuspense,
-} from '@kbn/presentation-util-plugin/public';
+import { LazyLabsFlyout, withSuspense } from '@kbn/presentation-util-plugin/public';
 
 import { UI_SETTINGS } from '../../common';
 import { useDashboardApi } from '../dashboard_api/use_dashboard_api';
@@ -88,7 +84,6 @@ export function InternalDashboardTopNav({
   const { setHeaderActionMenu, onAppLeave } = useDashboardMountContext();
 
   const dashboardApi = useDashboardApi();
-  const PresentationUtilContextProvider = getPresentationUtilContextProvider();
 
   const [
     allDataViews,
@@ -405,9 +400,7 @@ export function InternalDashboardTopNav({
         onSavedQueryIdChange={setSavedQueryId}
       />
       {viewMode !== 'print' && isLabsEnabled && isLabsShown ? (
-        <PresentationUtilContextProvider>
-          <LabsFlyout solutions={['dashboard']} onClose={() => setIsLabsShown(false)} />
-        </PresentationUtilContextProvider>
+        <LabsFlyout solutions={['dashboard']} onClose={() => setIsLabsShown(false)} />
       ) : null}
       {viewMode === 'edit' ? <DashboardEditingToolbar isDisabled={!!focusedPanelId} /> : null}
       {showBorderBottom && <EuiHorizontalRule margin="none" />}

diff --git a/src/plugins/dashboard/public/services/mocks.ts b/src/plugins/dashboard/public/services/mocks.ts
@@ -60,7 +60,7 @@ export const setStubKibanaServices = () => {
     navigation: navigationPluginMock.createStartContract(),
     noDataPage: noDataPagePublicMock.createStart(),
     observabilityAIAssistant: observabilityAIAssistantPluginMock.createStartContract(),
-    presentationUtil: presentationUtilPluginMock.createStartContract(core),
+    presentationUtil: presentationUtilPluginMock.createStartContract(),
     savedObjectsManagement: savedObjectsManagementPluginMock.createStartContract(),
     savedObjectsTaggingOss: savedObjectTaggingOssPluginMock.createStart(),
     screenshotMode: screenshotModePluginMock.createStartContract(),

diff --git a/src/plugins/event_annotation_listing/public/get_table_list.tsx b/src/plugins/event_annotation_listing/public/get_table_list.tsx
@@ -7,7 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import React, { FC } from 'react';
+import React from 'react';
 import { FormattedRelative } from '@kbn/i18n-react';
 import { TableListViewKibanaProvider } from '@kbn/content-management-table-list-view-table';
 import { type TableListTabParentProps } from '@kbn/content-management-tabbed-table-list-view';
@@ -25,7 +25,6 @@ export interface EventAnnotationListingPageServices {
   core: CoreStart;
   savedObjectsTagging: SavedObjectsTaggingApi;
   eventAnnotationService: EventAnnotationServiceType;
-  PresentationUtilContextProvider: FC;
   dataViews: DataView[];
   createDataView: (spec: DataViewSpec) => Promise<DataView>;
   queryInputServices: QueryInputServices;

diff --git a/src/plugins/event_annotation_listing/public/plugin.ts b/src/plugins/event_annotation_listing/public/plugin.ts
@@ -74,7 +74,6 @@ export class EventAnnotationListingPlugin
           LensEmbeddableComponent: pluginsStart.lens.EmbeddableComponent,
           savedObjectsTagging: pluginsStart.savedObjectsTagging,
           eventAnnotationService,
-          PresentationUtilContextProvider: pluginsStart.presentationUtil.ContextProvider,
           dataViews,
           createDataView: pluginsStart.dataViews.create.bind(pluginsStart.dataViews),
           sessionService: pluginsStart.data.search.session,

diff --git a/src/plugins/links/public/mocks.ts b/src/plugins/links/public/mocks.ts
@@ -40,7 +40,7 @@ export const setStubKibanaServices = () => {
     dashboard: dashboardPluginMock.createStartContract(),
     embeddable: embeddablePluginMock.createStartContract(),
     contentManagement: contentManagementMock.createStartContract(),
-    presentationUtil: presentationUtilPluginMock.createStartContract(core),
+    presentationUtil: presentationUtilPluginMock.createStartContract(),
     uiActions: uiActionsPluginMock.createStartContract(),
   });
 };

diff --git a/src/plugins/presentation_util/public/components/dashboard_picker/dashboard_picker.tsx b/src/plugins/presentation_util/public/components/dashboard_picker/dashboard_picker.tsx
@@ -24,7 +24,7 @@ import { i18n } from '@kbn/i18n';
 import { ToolbarButton } from '@kbn/shared-ux-button-toolbar';
 import { SavedObjectCommon } from '@kbn/saved-objects-finder-plugin/common';
 
-import { pluginServices } from '../../services';
+import { contentManagementService } from '../../services/kibana_services';
 
 export interface DashboardPickerProps {
   onChange: (dashboard: { name: string; id: string } | null) => void;
@@ -53,10 +53,6 @@ export function DashboardPicker({ isDisabled, onChange, idsToOmit }: DashboardPi
 
   const [selectedDashboard, setSelectedDashboard] = useState<DashboardOption | null>(null);
 
-  const {
-    contentManagement: { client: cmClient },
-  } = pluginServices.getServices();
-
   /**
    * Debounce the query to avoid many calls to content management.
    */
@@ -77,7 +73,7 @@ export function DashboardPicker({ isDisabled, onChange, idsToOmit }: DashboardPi
     (async () => {
       setIsLoading(true);
 
-      const response = await cmClient.mSearch<DashboardHit>({
+      const response = await contentManagementService.client.mSearch<DashboardHit>({
         contentTypes: [{ contentTypeId: 'dashboard' }],
         query: {
           text: debouncedQuery ? `${debouncedQuery}*` : undefined,
@@ -95,7 +91,7 @@ export function DashboardPicker({ isDisabled, onChange, idsToOmit }: DashboardPi
     return () => {
       canceled = true;
     };
-  }, [debouncedQuery, cmClient]);
+  }, [debouncedQuery]);
 
   /**
    * Format items with dashboard hits and selected option

diff --git a/...plugins/presentation_util/public/components/data_view_picker/data_view_picker.stories.tsx b/...plugins/presentation_util/public/components/data_view_picker/data_view_picker.stories.tsx
@@ -9,40 +9,30 @@
 
 import React, { useState } from 'react';
 
-import useMount from 'react-use/lib/useMount';
 import { DataView, DataViewListItem } from '@kbn/data-views-plugin/common';
+import useMount from 'react-use/lib/useMount';
 import { DataViewPicker } from './data_view_picker';
-import { injectStorybookDataView } from '../../services/data_views/data_views.story';
-import { storybookFlightsDataView } from '../../mocks';
-import { pluginServices, registry, StorybookParams } from '../../services/plugin_services.story';
+import { dataViewsService } from '../../services/kibana_services';
 
 export default {
   component: DataViewPicker,
   title: 'Data View Picker',
   argTypes: {},
 };
 
-injectStorybookDataView(storybookFlightsDataView);
-
-export function Example({}: {} & StorybookParams) {
-  pluginServices.setRegistry(registry.start({}));
-
-  const {
-    dataViews: { getIdsWithTitle, get },
-  } = pluginServices.getServices();
-
+export function Example() {
   const [dataViews, setDataViews] = useState<DataViewListItem[]>();
   const [dataView, setDataView] = useState<DataView | undefined>(undefined);
 
   useMount(() => {
     (async () => {
-      const listItems = await getIdsWithTitle();
+      const listItems = await dataViewsService.getIdsWithTitle();
       setDataViews(listItems);
     })();
   });
 
   const onChange = (newId: string) => {
-    get(newId).then((newDataView) => {
+    dataViewsService.get(newId).then((newDataView) => {
       setDataView(newDataView);
     });
   };

diff --git a/src/plugins/presentation_util/public/components/floating_actions/floating_actions.tsx b/src/plugins/presentation_util/public/components/floating_actions/floating_actions.tsx
@@ -12,15 +12,15 @@ import React, { FC, ReactElement, useEffect, useState } from 'react';
 import { v4 } from 'uuid';
 
 import {
-  panelHoverTrigger,
   PANEL_HOVER_TRIGGER,
+  panelHoverTrigger,
   type EmbeddableInput,
   type ViewMode,
 } from '@kbn/embeddable-plugin/public';
 import { apiHasUniqueId } from '@kbn/presentation-publishing';
 import { Action } from '@kbn/ui-actions-plugin/public';
 
-import { pluginServices } from '../../services';
+import { uiActionsService } from '../../services/kibana_services';
 import './floating_actions.scss';
 
 export interface FloatingActionsProps {
@@ -41,9 +41,6 @@ export const FloatingActions: FC<FloatingActionsProps> = ({
   className = '',
   disabledActions,
 }) => {
-  const {
-    uiActions: { getTriggerCompatibleActions },
-  } = pluginServices.getServices();
   const [floatingActions, setFloatingActions] = useState<JSX.Element | undefined>(undefined);
 
   useEffect(() => {
@@ -55,7 +52,9 @@ export const FloatingActions: FC<FloatingActionsProps> = ({
         embeddable: api,
         trigger: panelHoverTrigger,
       };
-      const actions = (await getTriggerCompatibleActions(PANEL_HOVER_TRIGGER, context))
+      const actions = (
+        await uiActionsService.getTriggerCompatibleActions(PANEL_HOVER_TRIGGER, context)
+      )
         .filter((action): action is Action & { MenuItem: React.FC<{ context: unknown }> } => {
           return action.MenuItem !== undefined && (disabledActions ?? []).indexOf(action.id) === -1;
         })
@@ -82,7 +81,7 @@ export const FloatingActions: FC<FloatingActionsProps> = ({
     };
 
     getActions();
-  }, [api, getTriggerCompatibleActions, viewMode, disabledActions]);
+  }, [api, viewMode, disabledActions]);
 
   return (
     <div className="presentationUtil__floatingActionsWrapper">

diff --git a/src/plugins/presentation_util/public/components/labs/environment_switch.tsx b/src/plugins/presentation_util/public/components/labs/environment_switch.tsx
@@ -7,7 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import React from 'react';
+import React, { useMemo } from 'react';
 import {
   EuiFlexGroup,
   EuiFlexItem,
@@ -17,9 +17,9 @@ import {
   EuiScreenReaderOnly,
 } from '@elastic/eui';
 
-import { pluginServices } from '../../services';
 import { EnvironmentName } from '../../../common/labs';
 import { LabsStrings } from '../../i18n';
+import { getPresentationCapabilities } from '../../utils/get_presentation_capabilities';
 
 const { Switch: strings } = LabsStrings.Components;
 
@@ -37,9 +37,11 @@ export interface Props {
 }
 
 export const EnvironmentSwitch = ({ env, isChecked, onChange, name }: Props) => {
-  const { capabilities } = pluginServices.getHooks();
+  const { canSetAdvancedSettings } = useMemo(() => {
+    return getPresentationCapabilities();
+  }, []);
 
-  const canSet = env === 'kibana' ? capabilities.useService().canSetAdvancedSettings() : true;
+  const canSet = env === 'kibana' ? canSetAdvancedSettings : true;
 
   return (
     <EuiFlexItem grow={false} style={{ marginBottom: '.25rem' }}>

diff --git a/src/plugins/presentation_util/public/components/labs/labs_beaker_button.tsx b/src/plugins/presentation_util/public/components/labs/labs_beaker_button.tsx
@@ -7,20 +7,20 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import React, { useState } from 'react';
+import React, { useMemo, useState } from 'react';
 import { EuiButton, EuiIcon, EuiNotificationBadge, EuiButtonProps } from '@elastic/eui';
 
-import { pluginServices } from '../../services';
 import { LabsFlyout, Props as FlyoutProps } from './labs_flyout';
+import { getPresentationLabsService } from '../../services/presentation_labs_service';
 
 export type Props = EuiButtonProps & Pick<FlyoutProps, 'solutions'>;
 
 export const LabsBeakerButton = ({ solutions, ...props }: Props) => {
-  const { labs: labsService } = pluginServices.getHooks();
-  const { getProjects } = labsService.useService();
+  const labsService = useMemo(() => getPresentationLabsService(), []);
+
   const [isOpen, setIsOpen] = useState(false);
 
-  const projects = getProjects();
+  const projects = labsService.getProjects();
 
   const [overrideCount, onEnabledCountChange] = useState(
     Object.values(projects).filter((project) => project.status.isOverride).length

diff --git a/src/plugins/presentation_util/public/components/labs/labs_flyout.tsx b/src/plugins/presentation_util/public/components/labs/labs_flyout.tsx
@@ -7,26 +7,26 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import React, { ReactNode, useRef, useState, useEffect } from 'react';
 import {
+  EuiButton,
+  EuiButtonEmpty,
+  EuiFlexGroup,
+  EuiFlexItem,
   EuiFlyout,
-  EuiTitle,
-  EuiSpacer,
-  EuiText,
   EuiFlyoutBody,
   EuiFlyoutFooter,
   EuiFlyoutHeader,
-  EuiButton,
-  EuiButtonEmpty,
-  EuiFlexItem,
-  EuiFlexGroup,
   EuiIcon,
+  EuiSpacer,
+  EuiText,
+  EuiTitle,
 } from '@elastic/eui';
+import React, { ReactNode, useEffect, useMemo, useRef, useState } from 'react';
 
-import { SolutionName, ProjectStatus, ProjectID, Project, EnvironmentName } from '../../../common';
-import { pluginServices } from '../../services';
+import { EnvironmentName, Project, ProjectID, ProjectStatus, SolutionName } from '../../../common';
 import { LabsStrings } from '../../i18n';
 
+import { getPresentationLabsService } from '../../services/presentation_labs_service';
 import { ProjectList } from './project_list';
 
 const { Flyout: strings } = LabsStrings.Components;
@@ -56,12 +56,11 @@ export const getOverridenCount = (projects: Record<ProjectID, Project>) =>
 
 export const LabsFlyout = (props: Props) => {
   const { solutions, onEnabledCountChange = () => {}, onClose } = props;
-  const { labs: labsService } = pluginServices.getHooks();
-  const { getProjects, setProjectStatus, reset } = labsService.useService();
+  const labsService = useMemo(() => getPresentationLabsService(), []);
 
-  const [projects, setProjects] = useState(getProjects());
+  const [projects, setProjects] = useState(labsService.getProjects());
   const [overrideCount, setOverrideCount] = useState(getOverridenCount(projects));
-  const initialStatus = useRef(getProjects());
+  const initialStatus = useRef(labsService.getProjects());
 
   const isChanged = hasStatusChanged(initialStatus.current, projects);
 
@@ -74,17 +73,17 @@ export const LabsFlyout = (props: Props) => {
   }, [onEnabledCountChange, overrideCount]);
 
   const onStatusChange = (id: ProjectID, env: EnvironmentName, enabled: boolean) => {
-    setProjectStatus(id, env, enabled);
-    setProjects(getProjects());
+    labsService.setProjectStatus(id, env, enabled);
+    setProjects(labsService.getProjects());
   };
 
   let footer: ReactNode = null;
 
   const resetButton = (
     <EuiButtonEmpty
       onClick={() => {
-        reset();
-        setProjects(getProjects());
+        labsService.reset();
+        setProjects(labsService.getProjects());
       }}
       isDisabled={!overrideCount}
     >