[8.x] [Discover] Only show logs profiles for O11y solution view (elas…

…tic#199255) (elastic#200477) # Backport This will backport the following commits from `main` to `8.x`: - [[Discover] Only show logs profiles for O11y solution view (elastic#199255)](elastic#199255)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
kibanamachine · Nov 18, 2024 · dc645a7 · dc645a7
1 parent 8a49c1f
commit dc645a7
Show file tree

Hide file tree

Showing 59 changed files with 1,304 additions and 1,622 deletions.
diff --git a/.../common/logs_data_source_profile/index.ts → ...profile_providers/observability/consts.ts b/.../common/logs_data_source_profile/index.ts → ...profile_providers/observability/consts.ts
@@ -7,4 +7,4 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-export { createLogsDataSourceProfileProviders } from './create_profile_providers';
+export const OBSERVABILITY_ROOT_PROFILE_ID = 'observability-root-profile';
diff --git a/...ment_profile/accessors/get_doc_viewer.tsx → ...ment_profile/accessors/get_doc_viewer.tsx b/...ment_profile/accessors/get_doc_viewer.tsx → ...ment_profile/accessors/get_doc_viewer.tsx
diff --git a/...n/log_document_profile/accessors/index.ts → ...y/log_document_profile/accessors/index.ts b/...n/log_document_profile/accessors/index.ts → ...y/log_document_profile/accessors/index.ts
diff --git a/...ders/common/log_document_profile/index.ts → ...servability/log_document_profile/index.ts b/...ders/common/log_document_profile/index.ts → ...servability/log_document_profile/index.ts
@@ -7,4 +7,4 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-export { createLogDocumentProfileProvider } from './profile';
+export { createObservabilityLogDocumentProfileProvider } from './profile';
diff --git a/...mmon/log_document_profile/profile.test.ts → ...lity/log_document_profile/profile.test.ts b/...mmon/log_document_profile/profile.test.ts → ...lity/log_document_profile/profile.test.ts
@@ -12,19 +12,28 @@ import { DocViewsRegistry } from '@kbn/unified-doc-viewer';
 import {
   DataSourceCategory,
   DataSourceContext,
+  DocumentProfileProviderParams,
   DocumentType,
   RootContext,
   SolutionType,
 } from '../../../profiles';
 import { createContextAwarenessMocks } from '../../../__mocks__';
-import { createLogDocumentProfileProvider } from './profile';
+import { createObservabilityLogDocumentProfileProvider } from './profile';
+import { ContextWithProfileId } from '../../../profile_service';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../consts';
 
 const mockServices = createContextAwarenessMocks().profileProviderServices;
 
 describe('logDocumentProfileProvider', () => {
-  const logDocumentProfileProvider = createLogDocumentProfileProvider(mockServices);
-  const ROOT_CONTEXT: RootContext = { solutionType: SolutionType.Default };
-  const DATA_SOURCE_CONTEXT: DataSourceContext = { category: DataSourceCategory.Logs };
+  const logDocumentProfileProvider = createObservabilityLogDocumentProfileProvider(mockServices);
+  const ROOT_CONTEXT: ContextWithProfileId<RootContext> = {
+    profileId: OBSERVABILITY_ROOT_PROFILE_ID,
+    solutionType: SolutionType.Observability,
+  };
+  const DATA_SOURCE_CONTEXT: ContextWithProfileId<DataSourceContext> = {
+    profileId: 'data-source-profile',
+    category: DataSourceCategory.Logs,
+  };
   const RESOLUTION_MATCH = {
     isMatch: true,
     context: {
@@ -99,6 +108,42 @@ describe('logDocumentProfileProvider', () => {
     ).toEqual(RESOLUTION_MISMATCH);
   });
 
+  it('does not match records when solution type is not Observability', () => {
+    const params: Omit<DocumentProfileProviderParams, 'rootContext'> = {
+      dataSourceContext: DATA_SOURCE_CONTEXT,
+      record: buildMockRecord('another-index', {
+        'data_stream.type': ['logs'],
+      }),
+    };
+    expect(
+      logDocumentProfileProvider.resolve({
+        ...params,
+        rootContext: ROOT_CONTEXT,
+      })
+    ).toEqual(RESOLUTION_MATCH);
+    expect(
+      logDocumentProfileProvider.resolve({
+        ...params,
+        rootContext: { profileId: 'other-data-source-profile', solutionType: SolutionType.Default },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+    expect(
+      logDocumentProfileProvider.resolve({
+        ...params,
+        rootContext: { profileId: 'other-data-source-profile', solutionType: SolutionType.Search },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+    expect(
+      logDocumentProfileProvider.resolve({
+        ...params,
+        rootContext: {
+          profileId: 'other-data-source-profile',
+          solutionType: SolutionType.Security,
+        },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+  });
+
   describe('getDocViewer', () => {
     it('adds a log overview doc view to the registry', () => {
       const getDocViewer = logDocumentProfileProvider.profile.getDocViewer!(

diff --git a/...s/common/log_document_profile/profile.tsx → ...vability/log_document_profile/profile.tsx b/...s/common/log_document_profile/profile.tsx → ...vability/log_document_profile/profile.tsx
@@ -11,15 +11,20 @@ import { DataTableRecord } from '@kbn/discover-utils';
 import { DocumentProfileProvider, DocumentType } from '../../../profiles';
 import { ProfileProviderServices } from '../../profile_provider_services';
 import { getDocViewer } from './accessors';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../consts';
 
-export const createLogDocumentProfileProvider = (
+export const createObservabilityLogDocumentProfileProvider = (
   services: ProfileProviderServices
 ): DocumentProfileProvider => ({
-  profileId: 'log-document-profile',
+  profileId: 'observability-log-document-profile',
   profile: {
     getDocViewer,
   },
-  resolve: ({ record }) => {
+  resolve: ({ record, rootContext }) => {
+    if (rootContext.profileId !== OBSERVABILITY_ROOT_PROFILE_ID) {
+      return { isMatch: false };
+    }
+
     const isLogRecord = getIsLogRecord(record, services.logsContextService.isLogsIndexPattern);
 
     if (!isLogRecord) {

diff --git a/..._profile/accessors/get_cell_renderers.tsx → ..._profile/accessors/get_cell_renderers.tsx b/..._profile/accessors/get_cell_renderers.tsx → ..._profile/accessors/get_cell_renderers.tsx
diff --git a/...rofile/accessors/get_default_app_state.ts → ...rofile/accessors/get_default_app_state.ts b/...rofile/accessors/get_default_app_state.ts → ...rofile/accessors/get_default_app_state.ts
diff --git a/...rs/get_row_additional_leading_controls.ts → ...rs/get_row_additional_leading_controls.ts b/...rs/get_row_additional_leading_controls.ts → ...rs/get_row_additional_leading_controls.ts
diff --git a/...e/accessors/get_row_indicator_provider.ts → ...e/accessors/get_row_indicator_provider.ts b/...e/accessors/get_row_indicator_provider.ts → ...e/accessors/get_row_indicator_provider.ts
diff --git a/...gs_data_source_profile/accessors/index.ts → ...gs_data_source_profile/accessors/index.ts b/...gs_data_source_profile/accessors/index.ts → ...gs_data_source_profile/accessors/index.ts
diff --git a/...common/logs_data_source_profile/consts.ts → ...bility/logs_data_source_profile/consts.ts b/...common/logs_data_source_profile/consts.ts → ...bility/logs_data_source_profile/consts.ts
diff --git a/...ource_profile/create_profile_providers.ts → ...ource_profile/create_profile_providers.ts b/...ource_profile/create_profile_providers.ts → ...ource_profile/create_profile_providers.ts
@@ -19,7 +19,9 @@ import {
   createWindowsLogsDataSourceProfileProvider,
 } from './sub_profiles';
 
-export const createLogsDataSourceProfileProviders = (providerServices: ProfileProviderServices) => {
+export const createObservabilityLogsDataSourceProfileProviders = (
+  providerServices: ProfileProviderServices
+) => {
   const logsDataSourceProfileProvider = createLogsDataSourceProfileProvider(providerServices);
 
   return [

diff --git a/...ublic/context_awareness/profile_providers/observability/logs_data_source_profile/index.ts b/...ublic/context_awareness/profile_providers/observability/logs_data_source_profile/index.ts
@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export { createObservabilityLogsDataSourceProfileProviders } from './create_profile_providers';
diff --git a/.../logs_data_source_profile/profile.test.ts → .../logs_data_source_profile/profile.test.ts b/.../logs_data_source_profile/profile.test.ts → .../logs_data_source_profile/profile.test.ts
@@ -11,11 +11,18 @@ import { buildDataTableRecord } from '@kbn/discover-utils';
 import type { EuiThemeComputed } from '@elastic/eui';
 import { createStubIndexPattern } from '@kbn/data-views-plugin/common/data_view.stub';
 import { createDataViewDataSource, createEsqlDataSource } from '../../../../../common/data_sources';
-import { DataSourceCategory, RootContext, SolutionType } from '../../../profiles';
+import {
+  DataSourceCategory,
+  DataSourceProfileProviderParams,
+  RootContext,
+  SolutionType,
+} from '../../../profiles';
 import { createContextAwarenessMocks } from '../../../__mocks__';
 import { createLogsDataSourceProfileProvider } from './profile';
 import { DataGridDensity } from '@kbn/unified-data-table';
 import { dataViewWithTimefieldMock } from '../../../../__mocks__/data_view_with_timefield';
+import type { ContextWithProfileId } from '../../../profile_service';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../consts';
 
 const mockServices = createContextAwarenessMocks().profileProviderServices;
 
@@ -24,7 +31,10 @@ describe('logsDataSourceProfileProvider', () => {
   const VALID_INDEX_PATTERN = 'logs-nginx.access-*';
   const MIXED_INDEX_PATTERN = 'logs-nginx.access-*,metrics-*';
   const INVALID_INDEX_PATTERN = 'my_source-access-*';
-  const ROOT_CONTEXT: RootContext = { solutionType: SolutionType.Default };
+  const ROOT_CONTEXT: ContextWithProfileId<RootContext> = {
+    profileId: OBSERVABILITY_ROOT_PROFILE_ID,
+    solutionType: SolutionType.Observability,
+  };
   const RESOLUTION_MATCH = {
     isMatch: true,
     context: { category: DataSourceCategory.Logs },
@@ -87,6 +97,34 @@ describe('logsDataSourceProfileProvider', () => {
     ).toEqual(RESOLUTION_MISMATCH);
   });
 
+  it('does NOT match data view sources when solution type is not Observability', () => {
+    const params: Omit<DataSourceProfileProviderParams, 'rootContext'> = {
+      dataSource: createEsqlDataSource(),
+      query: { esql: `from ${VALID_INDEX_PATTERN}` },
+    };
+    expect(logsDataSourceProfileProvider.resolve({ ...params, rootContext: ROOT_CONTEXT })).toEqual(
+      RESOLUTION_MATCH
+    );
+    expect(
+      logsDataSourceProfileProvider.resolve({
+        ...params,
+        rootContext: { profileId: 'other-root-profile', solutionType: SolutionType.Default },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+    expect(
+      logsDataSourceProfileProvider.resolve({
+        ...params,
+        rootContext: { profileId: 'other-root-profile', solutionType: SolutionType.Search },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+    expect(
+      logsDataSourceProfileProvider.resolve({
+        ...params,
+        rootContext: { profileId: 'other-root-profile', solutionType: SolutionType.Security },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+  });
+
   const dataViewWithLogLevel = createStubIndexPattern({
     spec: {
       title: VALID_INDEX_PATTERN,

diff --git a/...ommon/logs_data_source_profile/profile.ts → ...ility/logs_data_source_profile/profile.ts b/...ommon/logs_data_source_profile/profile.ts → ...ility/logs_data_source_profile/profile.ts
@@ -15,17 +15,22 @@ import {
   getRowAdditionalLeadingControls,
 } from './accessors';
 import { extractIndexPatternFrom } from '../../extract_index_pattern_from';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../consts';
 
 export const createLogsDataSourceProfileProvider = (
   services: ProfileProviderServices
 ): DataSourceProfileProvider => ({
-  profileId: 'logs-data-source-profile',
+  profileId: 'observability-logs-data-source-profile',
   profile: {
     getCellRenderers,
     getRowIndicatorProvider,
     getRowAdditionalLeadingControls,
   },
   resolve: (params) => {
+    if (params.rootContext.profileId !== OBSERVABILITY_ROOT_PROFILE_ID) {
+      return { isMatch: false };
+    }
+
     const indexPattern = extractIndexPatternFrom(params);
 
     if (!services.logsContextService.isLogsIndexPattern(indexPattern)) {

diff --git a/...le/sub_profiles/apache_error_logs.test.ts → ...le/sub_profiles/apache_error_logs.test.ts b/...le/sub_profiles/apache_error_logs.test.ts → ...le/sub_profiles/apache_error_logs.test.ts
@@ -13,8 +13,13 @@ import { DataSourceCategory, RootContext, SolutionType } from '../../../../profi
 import { createContextAwarenessMocks } from '../../../../__mocks__';
 import { createLogsDataSourceProfileProvider } from '../profile';
 import { createApacheErrorLogsDataSourceProfileProvider } from './apache_error_logs';
+import type { ContextWithProfileId } from '../../../../profile_service';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../../consts';
 
-const ROOT_CONTEXT: RootContext = { solutionType: SolutionType.Default };
+const ROOT_CONTEXT: ContextWithProfileId<RootContext> = {
+  profileId: OBSERVABILITY_ROOT_PROFILE_ID,
+  solutionType: SolutionType.Observability,
+};
 const { profileProviderServices } = createContextAwarenessMocks();
 const logsDataSourceProfileProvider = createLogsDataSourceProfileProvider(profileProviderServices);
 const dataSourceProfileProvider = createApacheErrorLogsDataSourceProfileProvider(

diff --git a/...profile/sub_profiles/apache_error_logs.ts → ...profile/sub_profiles/apache_error_logs.ts b/...profile/sub_profiles/apache_error_logs.ts → ...profile/sub_profiles/apache_error_logs.ts
@@ -17,7 +17,7 @@ export const createApacheErrorLogsDataSourceProfileProvider = (
   logsDataSourceProfileProvider: DataSourceProfileProvider
 ): DataSourceProfileProvider =>
   extendProfileProvider(logsDataSourceProfileProvider, {
-    profileId: 'apache-error-logs-data-source',
+    profileId: 'observability-apache-error-logs-data-source-profile',
     profile: {
       getDefaultAppState: createGetDefaultAppState({
         defaultColumns: [LOG_LEVEL_COLUMN, CLIENT_IP_COLUMN, MESSAGE_COLUMN],

diff --git a/...le/sub_profiles/aws_s3access_logs.test.ts → ...le/sub_profiles/aws_s3access_logs.test.ts b/...le/sub_profiles/aws_s3access_logs.test.ts → ...le/sub_profiles/aws_s3access_logs.test.ts
@@ -13,8 +13,13 @@ import { DataSourceCategory, RootContext, SolutionType } from '../../../../profi
 import { createContextAwarenessMocks } from '../../../../__mocks__';
 import { createLogsDataSourceProfileProvider } from '../profile';
 import { createAwsS3accessLogsDataSourceProfileProvider } from './aws_s3access_logs';
+import type { ContextWithProfileId } from '../../../../profile_service';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../../consts';
 
-const ROOT_CONTEXT: RootContext = { solutionType: SolutionType.Default };
+const ROOT_CONTEXT: ContextWithProfileId<RootContext> = {
+  profileId: OBSERVABILITY_ROOT_PROFILE_ID,
+  solutionType: SolutionType.Observability,
+};
 const { profileProviderServices } = createContextAwarenessMocks();
 const logsDataSourceProfileProvider = createLogsDataSourceProfileProvider(profileProviderServices);
 const dataSourceProfileProvider = createAwsS3accessLogsDataSourceProfileProvider(

diff --git a/...profile/sub_profiles/aws_s3access_logs.ts → ...profile/sub_profiles/aws_s3access_logs.ts b/...profile/sub_profiles/aws_s3access_logs.ts → ...profile/sub_profiles/aws_s3access_logs.ts
@@ -17,7 +17,7 @@ export const createAwsS3accessLogsDataSourceProfileProvider = (
   logsDataSourceProfileProvider: DataSourceProfileProvider
 ): DataSourceProfileProvider =>
   extendProfileProvider(logsDataSourceProfileProvider, {
-    profileId: 'aws-s3access-logs-data-source',
+    profileId: 'observability-aws-s3access-logs-data-source-profile',
     profile: {
       getDefaultAppState: createGetDefaultAppState({
         defaultColumns: [

diff --git a/...file_providers/observability/logs_data_source_profile/sub_profiles/create_resolve.test.ts b/...file_providers/observability/logs_data_source_profile/sub_profiles/create_resolve.test.ts
@@ -0,0 +1,85 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import type { ContextWithProfileId } from '../../../../profile_service';
+import { createEsqlDataSource } from '../../../../../../common/data_sources';
+import {
+  DataSourceCategory,
+  DataSourceProfileProviderParams,
+  RootContext,
+  SolutionType,
+} from '../../../../profiles';
+import { createResolve } from './create_resolve';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../../consts';
+
+describe('createResolve', () => {
+  const VALID_INDEX_PATTERN = 'valid';
+  const INVALID_INDEX_PATTERN = 'invalid';
+  const ROOT_CONTEXT: ContextWithProfileId<RootContext> = {
+    profileId: OBSERVABILITY_ROOT_PROFILE_ID,
+    solutionType: SolutionType.Observability,
+  };
+  const RESOLUTION_MATCH = {
+    isMatch: true,
+    context: { category: DataSourceCategory.Logs },
+  };
+  const RESOLUTION_MISMATCH = {
+    isMatch: false,
+  };
+  const resolve = createResolve(VALID_INDEX_PATTERN);
+
+  it('should match a valid index pattern', () => {
+    const result = resolve({
+      rootContext: ROOT_CONTEXT,
+      dataSource: createEsqlDataSource(),
+      query: { esql: `FROM ${VALID_INDEX_PATTERN}` },
+    });
+    expect(result).toEqual(RESOLUTION_MATCH);
+  });
+
+  it('should not match an invalid index pattern', () => {
+    const result = resolve({
+      rootContext: ROOT_CONTEXT,
+      dataSource: createEsqlDataSource(),
+      query: { esql: `FROM ${INVALID_INDEX_PATTERN}` },
+    });
+    expect(result).toEqual(RESOLUTION_MISMATCH);
+  });
+
+  it('should not match when the solution type is not Observability', () => {
+    const params: Omit<DataSourceProfileProviderParams, 'rootContext'> = {
+      dataSource: createEsqlDataSource(),
+      query: { esql: `FROM ${VALID_INDEX_PATTERN}` },
+    };
+    expect(
+      resolve({
+        ...params,
+        rootContext: ROOT_CONTEXT,
+      })
+    ).toEqual(RESOLUTION_MATCH);
+    expect(
+      resolve({
+        ...params,
+        rootContext: { profileId: 'other-root-profile', solutionType: SolutionType.Default },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+    expect(
+      resolve({
+        ...params,
+        rootContext: { profileId: 'other-root-profile', solutionType: SolutionType.Search },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+    expect(
+      resolve({
+        ...params,
+        rootContext: { profileId: 'other-root-profile', solutionType: SolutionType.Security },
+      })
+    ).toEqual(RESOLUTION_MISMATCH);
+  });
+});
diff --git a/...ce_profile/sub_profiles/create_resolve.ts → ...ce_profile/sub_profiles/create_resolve.ts b/...ce_profile/sub_profiles/create_resolve.ts → ...ce_profile/sub_profiles/create_resolve.ts
@@ -10,13 +10,18 @@
 import { createRegExpPatternFrom, testPatternAgainstAllowedList } from '@kbn/data-view-utils';
 import { DataSourceCategory, DataSourceProfileProvider } from '../../../../profiles';
 import { extractIndexPatternFrom } from '../../../extract_index_pattern_from';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../../consts';
 
 export const createResolve = (baseIndexPattern: string): DataSourceProfileProvider['resolve'] => {
   const testIndexPattern = testPatternAgainstAllowedList([
     createRegExpPatternFrom(baseIndexPattern),
   ]);
 
   return (params) => {
+    if (params.rootContext.profileId !== OBSERVABILITY_ROOT_PROFILE_ID) {
+      return { isMatch: false };
+    }
+
     const indexPattern = extractIndexPatternFrom(params);
 
     if (!indexPattern || !testIndexPattern(indexPattern)) {

diff --git a/...data_source_profile/sub_profiles/index.ts → ...data_source_profile/sub_profiles/index.ts b/...data_source_profile/sub_profiles/index.ts → ...data_source_profile/sub_profiles/index.ts
diff --git a/...rofiles/kubernetes_container_logs.test.ts → ...rofiles/kubernetes_container_logs.test.ts b/...rofiles/kubernetes_container_logs.test.ts → ...rofiles/kubernetes_container_logs.test.ts
@@ -13,8 +13,13 @@ import { DataSourceCategory, RootContext, SolutionType } from '../../../../profi
 import { createContextAwarenessMocks } from '../../../../__mocks__';
 import { createLogsDataSourceProfileProvider } from '../profile';
 import { createKubernetesContainerLogsDataSourceProfileProvider } from './kubernetes_container_logs';
+import { ContextWithProfileId } from '../../../../profile_service';
+import { OBSERVABILITY_ROOT_PROFILE_ID } from '../../consts';
 
-const ROOT_CONTEXT: RootContext = { solutionType: SolutionType.Default };
+const ROOT_CONTEXT: ContextWithProfileId<RootContext> = {
+  profileId: OBSERVABILITY_ROOT_PROFILE_ID,
+  solutionType: SolutionType.Observability,
+};
 const { profileProviderServices } = createContextAwarenessMocks();
 const logsDataSourceProfileProvider = createLogsDataSourceProfileProvider(profileProviderServices);
 const dataSourceProfileProvider = createKubernetesContainerLogsDataSourceProfileProvider(