[Discover] Add migrations for visContextJSON. Create saved search pac…

…kage for common code.

package.json

@@ -664,6 +664,7 @@
     "@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",

packages/kbn-saved-search/README.md

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

src/plugins/saved_search_so/common/index.ts → packages/kbn-saved-search/index.ts

@@ -6,4 +6,8 @@
  * Side Public License, v 1.
  */
 
-export { MIN_SAVED_SEARCH_SAMPLE_SIZE, MAX_SAVED_SEARCH_SAMPLE_SIZE, VIEW_MODE } from './constants';
+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/tsconfig.json

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

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;
+}

src/plugins/saved_search/common/content_management/v1/cm_services.ts

@@ -15,10 +15,7 @@ import {
   updateOptionsSchema,
   createResultSchema,
 } from '@kbn/content-management-utils';
-import {
-  MIN_SAVED_SEARCH_SAMPLE_SIZE,
-  MAX_SAVED_SEARCH_SAMPLE_SIZE,
-} from '@kbn/saved-search-so-plugin/common';
+import { MIN_SAVED_SEARCH_SAMPLE_SIZE, MAX_SAVED_SEARCH_SAMPLE_SIZE } from '@kbn/saved-search';
 
 const sortSchema = schema.arrayOf(schema.string(), { maxSize: 2 });
 

src/plugins/saved_search/common/index.ts

@@ -10,16 +10,16 @@ export {
   VIEW_MODE,
   MIN_SAVED_SEARCH_SAMPLE_SIZE,
   MAX_SAVED_SEARCH_SAMPLE_SIZE,
-} from '@kbn/saved-search-so-plugin/common';
-export { getSavedSearchUrl, getSavedSearchFullPathUrl } from './saved_searches_url';
-export { fromSavedSearchAttributes } from './saved_searches_utils';
-
+} from '@kbn/saved-search';
 export type {
   DiscoverGridSettings,
   DiscoverGridSettingsColumn,
-  SavedSearch,
   SavedSearchAttributes,
-} from './types';
+} from '@kbn/saved-search/types';
+export { getSavedSearchUrl, getSavedSearchFullPathUrl } from './saved_searches_url';
+export { fromSavedSearchAttributes } from './saved_searches_utils';
+
+export type { SavedSearch } from './types';
 
 export { SavedSearchType, LATEST_VERSION } from './constants';
 export { getKibanaContextFn } from './expressions/kibana_context';

src/plugins/saved_search/common/types.ts

@@ -9,43 +9,8 @@
 import type { ISearchSource, RefreshInterval, TimeRange } from '@kbn/data-plugin/common';
 import type { SavedObjectReference } from '@kbn/core-saved-objects-server';
 import type { SavedObjectsResolveResponse } from '@kbn/core/server';
-import type { SerializableRecord } from '@kbn/utility-types';
-import { VIEW_MODE } from '.';
-
-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;
-}
+import { VIEW_MODE } from '@kbn/saved-search';
+import { DiscoverGridSettings } from '@kbn/saved-search/types';
 
 /** @internal **/
 export type SortOrder = [string, string];

src/plugins/saved_search_so/server/plugin.ts

@@ -8,23 +8,30 @@
 
 import { CoreSetup, Plugin } from '@kbn/core/server';
 import type { PluginSetup as DataPluginSetup } from '@kbn/data-plugin/server';
+import type { LensServerPluginSetup } from '@kbn/lens-plugin/server';
 import { getSavedSearchObjectType } from './saved_objects';
 
 /**
  * Saved search SO plugin server Setup contract
  */
 export interface SavedSearchSOPublicSetupDependencies {
   data: DataPluginSetup;
+  lens: LensServerPluginSetup;
 }
 
 export class SavedSearchSOServerPlugin implements Plugin<object, object, object> {
   constructor() {}
 
-  public setup(core: CoreSetup, { data }: SavedSearchSOPublicSetupDependencies) {
+  public setup(core: CoreSetup, { data, lens }: SavedSearchSOPublicSetupDependencies) {
     const searchSource = data.search.searchSource;
 
     const getSearchSourceMigrations = searchSource.getAllMigrations.bind(searchSource);
-    core.savedObjects.registerType(getSavedSearchObjectType(getSearchSourceMigrations));
+    core.savedObjects.registerType(
+      getSavedSearchObjectType({
+        getSearchSourceMigrations,
+        lensEmbeddableFactory: lens.lensEmbeddableFactory,
+      })
+    );
 
     return {};
   }

src/plugins/saved_search_so/server/saved_objects/schema.ts

@@ -11,7 +11,7 @@ import {
   MIN_SAVED_SEARCH_SAMPLE_SIZE,
   MAX_SAVED_SEARCH_SAMPLE_SIZE,
   VIEW_MODE,
-} from '../../common';
+} from '@kbn/saved-search';
 
 const SCHEMA_SEARCH_BASE = {
   // General

src/plugins/saved_search_so/server/saved_objects/search.ts

@@ -9,12 +9,17 @@
 import { ANALYTICS_SAVED_OBJECT_INDEX } from '@kbn/core-saved-objects-server';
 import { SavedObjectsType } from '@kbn/core/server';
 import { MigrateFunctionsObject } from '@kbn/kibana-utils-plugin/common';
+import type { LensServerPluginSetup } from '@kbn/lens-plugin/server';
 import { getAllMigrations } from './search_migrations';
 import { SCHEMA_SEARCH_V8_8_0, SCHEMA_SEARCH_V8_12_0, SCHEMA_SEARCH_V8_13_0 } from './schema';
 
-export function getSavedSearchObjectType(
-  getSearchSourceMigrations: () => MigrateFunctionsObject
-): SavedObjectsType {
+export function getSavedSearchObjectType({
+  getSearchSourceMigrations,
+  lensEmbeddableFactory,
+}: {
+  getSearchSourceMigrations: () => MigrateFunctionsObject;
+  lensEmbeddableFactory: LensServerPluginSetup['lensEmbeddableFactory'];
+}): SavedObjectsType {
   return {
     name: 'search',
     indexPattern: ANALYTICS_SAVED_OBJECT_INDEX,
@@ -47,6 +52,10 @@ export function getSavedSearchObjectType(
       '8.12.0': SCHEMA_SEARCH_V8_12_0,
       '8.13.0': SCHEMA_SEARCH_V8_13_0,
     },
-    migrations: () => getAllMigrations(getSearchSourceMigrations()), // TODO: add lens embeddable migrations for `visContextJSON`
+    migrations: () =>
+      getAllMigrations({
+        searchSourceMigrations: getSearchSourceMigrations(),
+        lensEmbeddableFactory,
+      }),
   };
 }

src/plugins/saved_search_so/server/saved_objects/search_migrations.ts

@@ -16,6 +16,8 @@ import { mergeSavedObjectMigrationMaps } from '@kbn/core/server';
 import { DEFAULT_QUERY_LANGUAGE } from '@kbn/data-plugin/server';
 import { MigrateFunctionsObject, MigrateFunction } from '@kbn/kibana-utils-plugin/common';
 import { isSerializedSearchSource, SerializedSearchSourceFields } from '@kbn/data-plugin/common';
+import type { LensServerPluginSetup } from '@kbn/lens-plugin/server';
+import { getLensVisContextMigrations } from './search_vis_migrations';
 
 export interface SavedSearchMigrationAttributes extends SavedObjectAttributes {
   kibanaSavedObjectMeta: {
@@ -168,11 +170,18 @@ export const searchMigrations = {
   '7.9.3': flow(migrateMatchAllQuery),
 };
 
-export const getAllMigrations = (
-  searchSourceMigrations: MigrateFunctionsObject
-): SavedObjectMigrationMap => {
+export const getAllMigrations = ({
+  searchSourceMigrations,
+  lensEmbeddableFactory,
+}: {
+  searchSourceMigrations: MigrateFunctionsObject;
+  lensEmbeddableFactory: LensServerPluginSetup['lensEmbeddableFactory'];
+}): SavedObjectMigrationMap => {
   return mergeSavedObjectMigrationMaps(
-    searchMigrations,
-    getSearchSourceMigrations(searchSourceMigrations) as SavedObjectMigrationMap
+    mergeSavedObjectMigrationMaps(
+      searchMigrations,
+      getSearchSourceMigrations(searchSourceMigrations) as SavedObjectMigrationMap
+    ),
+    getLensVisContextMigrations(lensEmbeddableFactory)
   );
 };