[Discover] Allow to store the configured ES|QL visualization v3 (with migrations)

.github/CODEOWNERS

@@ -661,7 +661,9 @@ src/plugins/saved_objects @elastic/kibana-core
 packages/kbn-saved-objects-settings @elastic/appex-sharedux
 src/plugins/saved_objects_tagging_oss @elastic/appex-sharedux
 x-pack/plugins/saved_objects_tagging @elastic/appex-sharedux
+packages/kbn-saved-search @elastic/kibana-data-discovery
 src/plugins/saved_search @elastic/kibana-data-discovery
+src/plugins/saved_search_so @elastic/kibana-data-discovery
 examples/screenshot_mode_example @elastic/appex-sharedux
 src/plugins/screenshot_mode @elastic/appex-sharedux
 x-pack/examples/screenshotting_example @elastic/appex-sharedux

docs/developer/plugin-list.asciidoc

@@ -303,6 +303,10 @@ oss plugins.
 |Contains the saved search saved object definition and helpers.
 
 
+|{kib-repo}blob/{branch}/src/plugins/saved_search_so/README.md[savedSearchSo]
+|Contains the saved search saved object definition.
+
+
 |{kib-repo}blob/{branch}/src/plugins/screenshot_mode/README.md[screenshotMode]
 |The service exposed by this plugin informs consumers whether they should optimize for non-interactivity. In this way plugins can avoid loading unnecessary code, data or other services.
 

package.json

@@ -664,7 +664,9 @@
     "@kbn/saved-objects-settings": "link:packages/kbn-saved-objects-settings",
     "@kbn/saved-objects-tagging-oss-plugin": "link:src/plugins/saved_objects_tagging_oss",
     "@kbn/saved-objects-tagging-plugin": "link:x-pack/plugins/saved_objects_tagging",
+    "@kbn/saved-search": "link:packages/kbn-saved-search",
     "@kbn/saved-search-plugin": "link:src/plugins/saved_search",
+    "@kbn/saved-search-so-plugin": "link:src/plugins/saved_search_so",
     "@kbn/screenshot-mode-example-plugin": "link:examples/screenshot_mode_example",
     "@kbn/screenshot-mode-plugin": "link:src/plugins/screenshot_mode",
     "@kbn/screenshotting-example-plugin": "link:x-pack/examples/screenshotting_example",

packages/kbn-saved-search/README.md

@@ -0,0 +1,3 @@
+# @kbn/saved-search
+
+Package for extracted saved search plugin logic

packages/kbn-saved-search/index.ts

@@ -0,0 +1,13 @@
+/*
+ * 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 {
+  MIN_SAVED_SEARCH_SAMPLE_SIZE,
+  MAX_SAVED_SEARCH_SAMPLE_SIZE,
+  VIEW_MODE,
+} from './src/constants';

packages/kbn-saved-search/jest.config.js

@@ -0,0 +1,13 @@
+/*
+ * 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.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../..',
+  roots: ['<rootDir>/packages/kbn-saved-search'],
+};

packages/kbn-saved-search/kibana.jsonc

@@ -0,0 +1,5 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/saved-search",
+  "owner": "@elastic/kibana-data-discovery"
+}

packages/kbn-saved-search/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@kbn/saved-search",
+  "private": true,
+  "version": "1.0.0",
+  "license": "SSPL-1.0 OR Elastic License 2.0",
+  "sideEffects": false
+}

packages/kbn-saved-search/src/constants.ts

@@ -0,0 +1,15 @@
+/*
+ * 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 const MIN_SAVED_SEARCH_SAMPLE_SIZE = 1;
+export const MAX_SAVED_SEARCH_SAMPLE_SIZE = 10000;
+
+export enum VIEW_MODE {
+  DOCUMENT_LEVEL = 'documents',
+  AGGREGATED_LEVEL = 'aggregated',
+}

packages/kbn-saved-search/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["*.ts", "src/**/*", "__mocks__/**/*.ts"],
+  "compilerOptions": {
+    "outDir": "target/types"
+  },
+  "exclude": [
+    "target/**/*"
+  ],
+  "kbn_references": [
+    "@kbn/data-plugin",
+    "@kbn/utility-types",
+  ]
+}

packages/kbn-saved-search/types.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 { RefreshInterval, TimeRange } from '@kbn/data-plugin/common';
+import type { SerializableRecord } from '@kbn/utility-types';
+import { VIEW_MODE } from './src/constants';
+
+export interface DiscoverGridSettings extends SerializableRecord {
+  columns?: Record<string, DiscoverGridSettingsColumn>;
+}
+
+export interface DiscoverGridSettingsColumn extends SerializableRecord {
+  width?: number;
+}
+
+/** @internal **/
+export interface SavedSearchAttributes {
+  title: string;
+  sort: Array<[string, string]>;
+  columns: string[];
+  description: string;
+  grid: DiscoverGridSettings;
+  hideChart: boolean;
+  isTextBasedQuery: boolean;
+  usesAdHocDataView?: boolean;
+  kibanaSavedObjectMeta: {
+    searchSourceJSON: string;
+  };
+  viewMode?: VIEW_MODE;
+  hideAggregatedPreview?: boolean;
+  rowHeight?: number;
+
+  timeRestore?: boolean;
+  timeRange?: Pick<TimeRange, 'from' | 'to'>;
+  refreshInterval?: RefreshInterval;
+
+  rowsPerPage?: number;
+  sampleSize?: number;
+  breakdownField?: string;
+  visContextJSON?: string;
+}

packages/kbn-visualization-utils/src/get_lens_attributes.test.ts

@@ -20,6 +20,7 @@ describe('getLensAttributesFromSuggestion', () => {
     timeFieldName: '@timestamp',
     isPersisted: () => false,
     toSpec: () => ({}),
+    toMinimalSpec: () => ({}),
   } as unknown as DataView;
   const query: AggregateQuery = { esql: 'from foo | limit 10' };
 

packages/kbn-visualization-utils/src/get_lens_attributes.ts

@@ -20,7 +20,17 @@ export const getLensAttributesFromSuggestion = ({
   query: Query | AggregateQuery;
   suggestion: Suggestion | undefined;
   dataView?: DataView;
-}) => {
+}): {
+  references: Array<{ name: string; id: string; type: string }>;
+  visualizationType: string;
+  state: {
+    visualization: {};
+    datasourceStates: Record<string, unknown>;
+    query: Query | AggregateQuery;
+    filters: Filter[];
+  };
+  title: string;
+} => {
   const suggestionDatasourceState = Object.assign({}, suggestion?.datasourceState);
   const suggestionVisualizationState = Object.assign({}, suggestion?.visualizationState);
   const datasourceStates =
@@ -35,11 +45,11 @@ export const getLensAttributesFromSuggestion = ({
         };
   const visualization = suggestionVisualizationState;
   const attributes = {
-    title: suggestion
-      ? suggestion.title
-      : i18n.translate('visualizationUtils.config.suggestion.title', {
-          defaultMessage: 'New suggestion',
-        }),
+    title:
+      suggestion?.title ??
+      i18n.translate('visualizationUtils.config.suggestion.title', {
+        defaultMessage: 'New suggestion',
+      }),
     references: [
       {
         id: dataView?.id ?? '',
@@ -55,7 +65,7 @@ export const getLensAttributesFromSuggestion = ({
       ...(dataView &&
         dataView.id &&
         !dataView.isPersisted() && {
-          adHocDataViews: { [dataView.id]: dataView.toSpec(false) },
+          adHocDataViews: { [dataView.id]: dataView.toMinimalSpec() },
         }),
     },
     visualizationType: suggestion ? suggestion.visualizationId : 'lnsXY',

src/core/server/integration_tests/ci_checks/saved_objects/check_registered_types.test.ts

@@ -134,7 +134,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "risk-engine-configuration": "b105d4a3c6adce40708d729d12e5ef3c8fbd9508",
         "rules-settings": "892a2918ebaeba809a612b8d97cec0b07c800b5f",
         "sample-data-telemetry": "37441b12f5b0159c2d6d5138a494c9f440e950b5",
-        "search": "2c1ab8a17e6972be2fa8d3880ba2305dfd9a5a6e",
+        "search": "e49d124ed4c28131c52fadf85e6470871e22b20c",
         "search-session": "b2fcd840e12a45039ada50b1355faeafa39876d1",
         "search-telemetry": "b568601618744720b5662946d3103e3fb75fe8ee",
         "security-rule": "07abb4d7e707d91675ec0495c73816394c7b521f",

src/plugins/discover/public/application/main/components/layout/discover_histogram_layout.tsx

@@ -6,15 +6,13 @@
  * Side Public License, v 1.
  */
 
-import React, { useCallback, useMemo } from 'react';
+import React, { useCallback } from 'react';
 import { UnifiedHistogramContainer } from '@kbn/unified-histogram-plugin/public';
 import { css } from '@emotion/react';
 import useObservable from 'react-use/lib/useObservable';
-import { Datatable } from '@kbn/expressions-plugin/common';
 import { useDiscoverHistogram } from './use_discover_histogram';
 import { type DiscoverMainContentProps, DiscoverMainContent } from './discover_main_content';
 import { useAppStateSelector } from '../../services/discover_app_state_container';
-import { FetchStatus } from '../../../types';
 
 export interface DiscoverHistogramLayoutProps extends DiscoverMainContentProps {
   container: HTMLElement | null;
@@ -35,14 +33,14 @@ export const DiscoverHistogramLayout = ({
   const { dataState } = stateContainer;
   const searchSessionId = useObservable(stateContainer.searchSessionManager.searchSessionId$);
   const hideChart = useAppStateSelector((state) => state.hideChart);
+
   const unifiedHistogramProps = useDiscoverHistogram({
     stateContainer,
     inspectorAdapters: dataState.inspectorAdapters,
     hideChart,
     isPlainRecord,
   });
 
-  const datatable = useObservable(dataState.data$.documents$);
   const renderCustomChartToggleActions = useCallback(
     () =>
       React.isValidElement(panelsToggle)
@@ -51,20 +49,6 @@ export const DiscoverHistogramLayout = ({
     [panelsToggle]
   );
 
-  const table: Datatable | undefined = useMemo(() => {
-    if (
-      isPlainRecord &&
-      datatable &&
-      [FetchStatus.PARTIAL, FetchStatus.COMPLETE].includes(datatable.fetchStatus)
-    ) {
-      return {
-        type: 'datatable' as 'datatable',
-        rows: datatable.result!.map((r) => r.raw),
-        columns: datatable.textBasedQueryColumns || [],
-      };
-    }
-  }, [datatable, isPlainRecord]);
-
   // Initialized when the first search has been requested or
   // when in text-based mode since search sessions are not supported
   if (!searchSessionId && !isPlainRecord) {
@@ -76,7 +60,6 @@ export const DiscoverHistogramLayout = ({
       {...unifiedHistogramProps}
       searchSessionId={searchSessionId}
       requestAdapter={dataState.inspectorAdapters.requests}
-      table={table}
       container={container}
       css={histogramLayoutCss}
       renderCustomChartToggleActions={renderCustomChartToggleActions}