[8.x] [Discover] Support overriding `solutionNavId` used fo…

…r root profile resolution in embeddable (#205986) (#206525) # Backport This will backport the following commits from `main` to `8.x`: - [[Discover] Support overriding `solutionNavId` used for root profile resolution in embeddable (#205986)](#205986)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Davis McPhee <davis.mcphee@elastic.co>
elastic · Jan 14, 2025 · c45c19f · c45c19f
1 parent 56fb054
commit c45c19f
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 5 deletions.
diff --git a/src/platform/packages/shared/kbn-saved-search-component/README.md b/src/platform/packages/shared/kbn-saved-search-component/README.md
@@ -2,7 +2,7 @@
 
 A component wrapper around Discover session embeddable. This can be used in solutions without being within a Dasboard context.
 
-This can be used to render a context-aware (logs etc) "document table". 
+This can be used to render a context-aware (logs etc) "document table".
 
 In the past you may have used the Log Stream Component to achieve this, this component supersedes that.
 
@@ -22,5 +22,10 @@ import { LazySavedSearchComponent } from '@kbn/saved-search-component';
     filters={optionalFilters}
     query={optionalQuery}
     timestampField={optionalTimestampFieldString}
+    displayOptions={{
+        solutionNavIdOverride: 'oblt',
+        enableDocumentViewer: true,
+        enableFilters: false,
+    }}
 />
-```
+```
diff --git a/src/platform/packages/shared/kbn-saved-search-component/src/components/saved_search.tsx b/src/platform/packages/shared/kbn-saved-search-component/src/components/saved_search.tsx
@@ -41,6 +41,7 @@ export const SavedSearchComponent: React.FC<SavedSearchComponentProps> = (props)
   } = props;
 
   const {
+    solutionNavIdOverride,
     enableDocumentViewer: documentViewerEnabled = true,
     enableFilters: filtersEnabled = true,
   } = props.displayOptions ?? {};
@@ -75,6 +76,7 @@ export const SavedSearchComponent: React.FC<SavedSearchComponentProps> = (props)
               attributes: { ...attributes, references },
               timeRange,
               nonPersistedDisplayOptions: {
+                solutionNavIdOverride,
                 enableDocumentViewer: documentViewerEnabled,
                 enableFilters: filtersEnabled,
               },
@@ -100,6 +102,7 @@ export const SavedSearchComponent: React.FC<SavedSearchComponentProps> = (props)
     index,
     query,
     searchSourceService,
+    solutionNavIdOverride,
     timeRange,
     timestampField,
   ]);

diff --git a/...platform/plugins/shared/discover/public/embeddable/get_search_embeddable_factory.test.tsx b/...platform/plugins/shared/discover/public/embeddable/get_search_embeddable_factory.test.tsx
@@ -244,6 +244,31 @@ describe('saved search embeddable', () => {
       expect(resolveRootProfileSpy).not.toHaveBeenCalled();
     });
 
+    it('should allow overriding the solutionNavId used to resolve the root profile', async () => {
+      const resolveRootProfileSpy = jest.spyOn(
+        discoverServiceMock.profilesManager,
+        'resolveRootProfile'
+      );
+      const initialRuntimeState = {
+        ...getInitialRuntimeState(),
+        nonPersistedDisplayOptions: {
+          solutionNavIdOverride: 'search' as const,
+        },
+      };
+      await factory.buildEmbeddable(
+        initialRuntimeState,
+        buildApiMock,
+        uuid,
+        mockedDashboardApi,
+        jest.fn().mockImplementation((newApi) => newApi),
+        initialRuntimeState // initialRuntimeState only contains lastSavedRuntimeState
+      );
+      await waitOneTick(); // wait for build to complete
+      expect(resolveRootProfileSpy).toHaveBeenCalledWith({
+        solutionNavId: 'search',
+      });
+    });
+
     it('should resolve data source profile when fetching', async () => {
       const resolveDataSourceProfileSpy = jest.spyOn(
         discoverServiceMock.profilesManager,

diff --git a/src/platform/plugins/shared/discover/public/embeddable/get_search_embeddable_factory.tsx b/src/platform/plugins/shared/discover/public/embeddable/get_search_embeddable_factory.tsx
@@ -69,9 +69,9 @@ export const getSearchEmbeddableFactory = ({
     },
     buildEmbeddable: async (initialState, buildApi, uuid, parentApi) => {
       /** One Discover context awareness */
-      const solutionNavId = await firstValueFrom(
-        discoverServices.core.chrome.getActiveSolutionNavId$()
-      );
+      const solutionNavId =
+        initialState.nonPersistedDisplayOptions?.solutionNavIdOverride ??
+        (await firstValueFrom(discoverServices.core.chrome.getActiveSolutionNavId$()));
       const { getRenderAppWrapper } = await discoverServices.profilesManager.resolveRootProfile({
         solutionNavId,
       });

diff --git a/src/platform/plugins/shared/discover/public/embeddable/types.ts b/src/platform/plugins/shared/discover/public/embeddable/types.ts
@@ -64,6 +64,7 @@ export type SearchEmbeddableSerializedAttributes = Omit<
 // These are options that are not persisted in the saved object, but can be used by solutions
 // when utilising the SavedSearchComponent package outside of dashboard contexts.
 export interface NonPersistedDisplayOptions {
+  solutionNavIdOverride?: 'oblt' | 'security' | 'search';
   enableDocumentViewer?: boolean;
   enableFilters?: boolean;
 }

diff --git a/...ogs_overview/src/components/log_category_details/log_category_document_examples_table.tsx b/...ogs_overview/src/components/log_category_details/log_category_document_examples_table.tsx
@@ -41,6 +41,7 @@ export const LogCategoryDocumentExamplesTable: React.FC<LogCategoryDocumentExamp
       index={logsSource.indexName}
       timestampField={logsSource.timestampField}
       displayOptions={{
+        solutionNavIdOverride: 'oblt',
         enableDocumentViewer: false,
         enableFilters: false,
       }}

diff --git a/x-pack/solutions/observability/plugins/apm/public/components/app/service_logs/index.tsx b/x-pack/solutions/observability/plugins/apm/public/components/app/service_logs/index.tsx
@@ -95,6 +95,7 @@ export function ClassicServiceLogsStream() {
       query={query}
       height={'60vh'}
       displayOptions={{
+        solutionNavIdOverride: 'oblt',
         enableDocumentViewer: true,
         enableFilters: false,
       }}