[Discover] Add support for contextual awareness functional tests

.buildkite/ftr_configs.yml

@@ -126,6 +126,7 @@ enabled:
   - test/functional/apps/discover/group6/config.ts
   - test/functional/apps/discover/group7/config.ts
   - test/functional/apps/discover/group8/config.ts
+  - test/functional/apps/discover/context_awareness/config.ts
   - test/functional/apps/getting_started/config.ts
   - test/functional/apps/home/config.ts
   - test/functional/apps/kibana_overview/config.ts
@@ -424,6 +425,7 @@ enabled:
   - x-pack/test_serverless/functional/test_suites/observability/config.ts
   - x-pack/test_serverless/functional/test_suites/observability/config.examples.ts
   - x-pack/test_serverless/functional/test_suites/observability/config.saved_objects_management.ts
+  - x-pack/test_serverless/functional/test_suites/observability/config.context_awareness.ts
   - x-pack/test_serverless/functional/test_suites/observability/common_configs/config.group1.ts
   - x-pack/test_serverless/functional/test_suites/observability/common_configs/config.group2.ts
   - x-pack/test_serverless/functional/test_suites/observability/common_configs/config.group3.ts
@@ -436,6 +438,7 @@ enabled:
   - x-pack/test_serverless/functional/test_suites/search/config.examples.ts
   - x-pack/test_serverless/functional/test_suites/search/config.screenshots.ts
   - x-pack/test_serverless/functional/test_suites/search/config.saved_objects_management.ts
+  - x-pack/test_serverless/functional/test_suites/search/config.context_awareness.ts
   - x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts
   - x-pack/test_serverless/functional/test_suites/search/common_configs/config.group2.ts
   - x-pack/test_serverless/functional/test_suites/search/common_configs/config.group3.ts
@@ -447,6 +450,7 @@ enabled:
   - x-pack/test_serverless/functional/test_suites/security/config.cloud_security_posture.basic.ts
   - x-pack/test_serverless/functional/test_suites/security/config.cloud_security_posture.essentials.ts
   - x-pack/test_serverless/functional/test_suites/security/config.saved_objects_management.ts
+  - x-pack/test_serverless/functional/test_suites/security/config.context_awareness.ts
   - x-pack/test_serverless/functional/test_suites/security/common_configs/config.group1.ts
   - x-pack/test_serverless/functional/test_suites/security/common_configs/config.group2.ts
   - x-pack/test_serverless/functional/test_suites/security/common_configs/config.group3.ts

src/plugins/discover/common/config.ts

@@ -13,9 +13,10 @@ export const configSchema = schema.object({
   experimental: schema.maybe(
     schema.object({
       ruleFormV2Enabled: schema.maybe(schema.boolean({ defaultValue: false })),
+      enabledProfiles: schema.maybe(schema.arrayOf(schema.string(), { defaultValue: [] })),
     })
   ),
 });
 
 export type ConfigSchema = TypeOf<typeof configSchema>;
-export type ExperimentalFeatures = ConfigSchema['experimental'];
+export type ExperimentalFeatures = NonNullable<ConfigSchema['experimental']>;

src/plugins/discover/public/context_awareness/__mocks__/index.ts

@@ -19,10 +19,12 @@ import {
   RootProfileService,
   SolutionType,
 } from '../profiles';
-import { createProfileProviderServices } from '../profiles/profile_provider_services';
+import { createProfileProviderServices } from '../profile_providers/profile_provider_services';
 import { ProfilesManager } from '../profiles_manager';
 
-export const createContextAwarenessMocks = () => {
+export const createContextAwarenessMocks = ({
+  shouldRegisterProviders = true,
+}: { shouldRegisterProviders?: boolean } = {}) => {
   const rootProfileProviderMock: RootProfileProvider = {
     profileId: 'root-profile',
     profile: {
@@ -92,15 +94,15 @@ export const createContextAwarenessMocks = () => {
   const records = getDataTableRecords(dataViewWithTimefieldMock);
   const contextRecordMock = records[0];
   const contextRecordMock2 = records[1];
-
   const rootProfileServiceMock = new RootProfileService();
-  rootProfileServiceMock.registerProvider(rootProfileProviderMock);
-
   const dataSourceProfileServiceMock = new DataSourceProfileService();
-  dataSourceProfileServiceMock.registerProvider(dataSourceProfileProviderMock);
-
   const documentProfileServiceMock = new DocumentProfileService();
-  documentProfileServiceMock.registerProvider(documentProfileProviderMock);
+
+  if (shouldRegisterProviders) {
+    rootProfileServiceMock.registerProvider(rootProfileProviderMock);
+    dataSourceProfileServiceMock.registerProvider(dataSourceProfileProviderMock);
+    documentProfileServiceMock.registerProvider(documentProfileProviderMock);
+  }
 
   const profilesManagerMock = new ProfilesManager(
     rootProfileServiceMock,
@@ -114,6 +116,9 @@ export const createContextAwarenessMocks = () => {
     rootProfileProviderMock,
     dataSourceProfileProviderMock,
     documentProfileProviderMock,
+    rootProfileServiceMock,
+    dataSourceProfileServiceMock,
+    documentProfileServiceMock,
     contextRecordMock,
     contextRecordMock2,
     profilesManagerMock,

src/plugins/discover/public/context_awareness/profile_providers/example_data_source_profile/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export { exampleDataSourceProfileProvider } from './profile';

src/plugins/discover/public/context_awareness/profile_providers/example_data_source_profile/profile.tsx

@@ -0,0 +1,83 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import { EuiBadge } from '@elastic/eui';
+import type { DataTableRecord } from '@kbn/discover-utils';
+import { isOfAggregateQueryType } from '@kbn/es-query';
+import { getIndexPatternFromESQLQuery } from '@kbn/esql-utils';
+import { euiThemeVars } from '@kbn/ui-theme';
+import { capitalize } from 'lodash';
+import React from 'react';
+import { DataSourceType, isDataSourceType } from '../../../../common/data_sources';
+import { DataSourceCategory, DataSourceProfileProvider } from '../../profiles';
+
+export const exampleDataSourceProfileProvider: DataSourceProfileProvider = {
+  profileId: 'example-data-source-profile',
+  profile: {
+    getCellRenderers: (prev) => () => ({
+      ...prev(),
+      'log.level': (props) => {
+        const level = getFieldValue(props.row, 'log.level');
+
+        if (!level) {
+          return (
+            <span
+              css={{ color: euiThemeVars.euiTextSubduedColor }}
+              data-test-subj="exampleDataSourceProfileLogLevelEmpty"
+            >
+              (None)
+            </span>
+          );
+        }
+
+        const levelMap: Record<string, string> = {
+          info: 'primary',
+          debug: 'default',
+          error: 'danger',
+        };
+
+        return (
+          <EuiBadge
+            color={levelMap[level]}
+            title={level}
+            data-test-subj="exampleDataSourceProfileLogLevel"
+          >
+            {capitalize(level)}
+          </EuiBadge>
+        );
+      },
+    }),
+  },
+  resolve: (params) => {
+    let indexPattern: string | undefined;
+
+    if (isDataSourceType(params.dataSource, DataSourceType.Esql)) {
+      if (!isOfAggregateQueryType(params.query)) {
+        return { isMatch: false };
+      }
+
+      indexPattern = getIndexPatternFromESQLQuery(params.query.esql);
+    } else if (isDataSourceType(params.dataSource, DataSourceType.DataView) && params.dataView) {
+      indexPattern = params.dataView.getIndexPattern();
+    }
+
+    if (indexPattern !== 'my-example-logs') {
+      return { isMatch: false };
+    }
+
+    return {
+      isMatch: true,
+      context: { category: DataSourceCategory.Logs },
+    };
+  },
+};
+
+const getFieldValue = (record: DataTableRecord, field: string) => {
+  const value = record.flattened[field];
+  return Array.isArray(value) ? value[0] : value;
+};

src/plugins/discover/public/context_awareness/profile_providers/example_document_profile/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export { exampleDocumentProfileProvider } from './profile';

src/plugins/discover/public/context_awareness/profile_providers/example_document_profile/profile.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { DataTableRecord } from '@kbn/discover-utils';
+import { DocumentProfileProvider, DocumentType } from '../../profiles';
+
+export const exampleDocumentProfileProvider: DocumentProfileProvider = {
+  profileId: 'example-document-profile',
+  profile: {},
+  resolve: (params) => {
+    if (getFieldValue(params.record, 'data_stream.type') !== 'logs') {
+      return { isMatch: false };
+    }
+
+    return {
+      isMatch: true,
+      context: {
+        type: DocumentType.Log,
+      },
+    };
+  },
+};
+
+const getFieldValue = (record: DataTableRecord, field: string) => {
+  const value = record.flattened[field];
+  return Array.isArray(value) ? value[0] : value;
+};

src/plugins/discover/public/context_awareness/profile_providers/example_root_pofile/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export { exampleRootProfileProvider } from './profile';

src/plugins/discover/public/context_awareness/profile_providers/example_root_pofile/profile.tsx

@@ -0,0 +1,42 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import { EuiBadge } from '@elastic/eui';
+import type { DataTableRecord } from '@kbn/discover-utils';
+import React from 'react';
+import { RootProfileProvider, SolutionType } from '../../profiles';
+
+export const exampleRootProfileProvider: RootProfileProvider = {
+  profileId: 'example-root-profile',
+  profile: {
+    getCellRenderers: (prev) => () => ({
+      ...prev(),
+      '@timestamp': (props) => {
+        const timestamp = getFieldValue(props.row, '@timestamp');
+
+        return (
+          <EuiBadge color="hollow" title={timestamp} data-test-subj="exampleRootProfileTimestamp">
+            {timestamp}
+          </EuiBadge>
+        );
+      },
+    }),
+  },
+  resolve: (params) => {
+    if (params.solutionNavId != null) {
+      return { isMatch: false };
+    }
+
+    return { isMatch: true, context: { solutionType: SolutionType.Default } };
+  },
+};
+
+const getFieldValue = (record: DataTableRecord, field: string) => {
+  const value = record.flattened[field];
+  return Array.isArray(value) ? value[0] : value;
+};

src/plugins/discover/public/context_awareness/profile_providers/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export { registerProfileProviders } from './register_profile_providers';

src/plugins/discover/public/context_awareness/profile_providers/log_document_profile/profile.ts

@@ -8,7 +8,7 @@
 
 import { DataTableRecord } from '@kbn/discover-utils';
 import { DocumentProfileProvider, DocumentType } from '../../profiles';
-import { ProfileProviderServices } from '../../profiles/profile_provider_services';
+import { ProfileProviderServices } from '../profile_provider_services';
 
 export const createLogDocumentProfileProvider = (
   services: ProfileProviderServices

src/plugins/discover/public/context_awareness/profile_providers/logs_data_source_profile/profile.ts

@@ -14,7 +14,7 @@ import {
   DataSourceProfileProvider,
   DataSourceProfileProviderParams,
 } from '../../profiles';
-import { ProfileProviderServices } from '../../profiles/profile_provider_services';
+import { ProfileProviderServices } from '../profile_provider_services';
 
 export const createLogsDataSourceProfileProvider = (
   services: ProfileProviderServices