Add deprecation warning when unknown SO types are present

src/core/server/saved_objects/deprecations/deprecation_factory.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { RegisterDeprecationsConfig } from '../../deprecations';
+import type { ISavedObjectTypeRegistry } from '../saved_objects_type_registry';
+import type { SavedObjectConfig } from '../saved_objects_config';
+import type { KibanaConfigType } from '../../kibana_config';
+import { getUnknownTypesDeprecations } from './unknown_object_types';
+
+interface GetDeprecationProviderOptions {
+  typeRegistry: ISavedObjectTypeRegistry;
+  savedObjectsConfig: SavedObjectConfig;
+  kibanaConfig: KibanaConfigType;
+  kibanaVersion: string;
+}
+
+export const getSavedObjectsDeprecationsProvider = (
+  config: GetDeprecationProviderOptions
+): RegisterDeprecationsConfig => {
+  return {
+    getDeprecations: async (context) => {
+      return [
+        ...(await getUnknownTypesDeprecations({
+          ...config,
+          esClient: context.esClient,
+        })),
+      ];
+    },
+  };
+};

src/core/server/saved_objects/deprecations/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 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 { hasUnknownObjectTypes } from './unknown_object_types';
+export { getSavedObjectsDeprecationsProvider } from './deprecation_factory';

src/core/server/saved_objects/deprecations/unknown_object_types.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 { estypes } from '@elastic/elasticsearch';
+import { i18n } from '@kbn/i18n';
+import type { DeprecationsDetails } from '../../deprecations';
+import { IScopedClusterClient } from '../../elasticsearch';
+import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry';
+import { SavedObjectsRawDocSource } from '../serialization';
+import type { KibanaConfigType } from '../../kibana_config';
+import type { SavedObjectConfig } from '../saved_objects_config';
+import { getIndexForType } from '../service/lib';
+
+interface UnknownTypesDeprecationOptions {
+  typeRegistry: ISavedObjectTypeRegistry;
+  esClient: IScopedClusterClient;
+  kibanaConfig: KibanaConfigType;
+  savedObjectsConfig: SavedObjectConfig;
+  kibanaVersion: string;
+}
+
+export const hasUnknownObjectTypes = async ({
+  typeRegistry,
+  esClient,
+  kibanaConfig,
+  savedObjectsConfig,
+  kibanaVersion,
+}: UnknownTypesDeprecationOptions) => {
+  const knownTypes = typeRegistry.getAllTypes().map((type) => type.name);
+  const targetIndices = [
+    ...new Set(
+      knownTypes.map((type) =>
+        getIndexForType({
+          type,
+          typeRegistry,
+          migV2Enabled: savedObjectsConfig.migration.enableV2,
+          kibanaVersion,
+          defaultIndex: kibanaConfig.index,
+        })
+      )
+    ),
+  ];
+
+  const query: estypes.QueryDslQueryContainer = {
+    bool: {
+      must_not: knownTypes.map((type) => ({
+        term: { type },
+      })),
+    },
+  };
+
+  const { body } = await esClient.asInternalUser.search<SavedObjectsRawDocSource>({
+    index: targetIndices,
+    body: {
+      size: 10000,
+      query,
+    },
+  });
+  const { hits: unknownDocs } = body.hits;
+
+  return unknownDocs.length > 0;
+};
+
+export const getUnknownTypesDeprecations = async (
+  options: UnknownTypesDeprecationOptions
+): Promise<DeprecationsDetails[]> => {
+  const deprecations: DeprecationsDetails[] = [];
+  if (await hasUnknownObjectTypes(options)) {
+    deprecations.push({
+      title: i18n.translate('core.savedObjects.deprecations.unknownTypes.title', {
+        defaultMessage: 'Saved objects with unknown types are present in Kibana system indices',
+      }),
+      message: i18n.translate('core.savedObjects.deprecations.unknownTypes.message', {
+        defaultMessage: '',
+      }),
+      level: 'critical',
+      requireRestart: false,
+      deprecationType: undefined, // not config nor feature...
+      correctiveActions: {
+        manualSteps: [], // TODO
+        api: {
+          path: '/internal/saved_objects/deprecations/_delete_unknown_types',
+          method: 'POST',
+          body: {},
+        },
+      },
+    });
+  }
+  return deprecations;
+};

src/core/server/saved_objects/routes/deprecations/delete_unknown_types.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 { IRouter } from '../../../http';
+import { catchAndReturnBoomErrors } from '../utils';
+
+export const registerDeleteUnknownTypesRoute = (router: IRouter) => {
+  router.post(
+    {
+      path: '/deprecations/_delete_unknown_types',
+      validate: false,
+    },
+    catchAndReturnBoomErrors(async (context, req, res) => {
+      // TODO: actually peform the action.
+      return res.ok({
+        body: {
+          success: true,
+        },
+      });
+    })
+  );
+};

src/core/server/saved_objects/routes/deprecations/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 { registerDeleteUnknownTypesRoute } from './delete_unknown_types';

src/core/server/saved_objects/routes/index.ts

@@ -25,6 +25,7 @@ import { registerExportRoute } from './export';
 import { registerImportRoute } from './import';
 import { registerResolveImportErrorsRoute } from './resolve_import_errors';
 import { registerMigrateRoute } from './migrate';
+import { registerDeleteUnknownTypesRoute } from './deprecations';
 
 export function registerRoutes({
   http,
@@ -58,4 +59,5 @@ export function registerRoutes({
   const internalRouter = http.createRouter('/internal/saved_objects/');
 
   registerMigrateRoute(internalRouter, migratorPromise);
+  registerDeleteUnknownTypesRoute(internalRouter);
 }

src/core/server/saved_objects/saved_objects_service.ts

@@ -22,6 +22,7 @@ import {
   InternalElasticsearchServiceSetup,
   InternalElasticsearchServiceStart,
 } from '../elasticsearch';
+import { InternalDeprecationsServiceSetup } from '../deprecations';
 import { KibanaConfigType } from '../kibana_config';
 import {
   SavedObjectsConfigType,
@@ -44,6 +45,7 @@ import { registerRoutes } from './routes';
 import { ServiceStatus } from '../status';
 import { calculateStatus$ } from './status';
 import { registerCoreObjectTypes } from './object_types';
+import { getSavedObjectsDeprecationsProvider } from './deprecations';
 
 /**
  * Saved Objects is Kibana's data persistence mechanism allowing plugins to
@@ -251,6 +253,7 @@ export interface SavedObjectsSetupDeps {
   http: InternalHttpServiceSetup;
   elasticsearch: InternalElasticsearchServiceSetup;
   coreUsageData: InternalCoreUsageDataSetup;
+  deprecations: InternalDeprecationsServiceSetup;
 }
 
 interface WrappedClientFactoryWrapper {
@@ -286,7 +289,7 @@ export class SavedObjectsService
     this.logger.debug('Setting up SavedObjects service');
 
     this.setupDeps = setupDeps;
-    const { http, elasticsearch, coreUsageData } = setupDeps;
+    const { http, elasticsearch, coreUsageData, deprecations } = setupDeps;
 
     const savedObjectsConfig = await this.coreContext.configService
       .atPath<SavedObjectsConfigType>('savedObjects')
@@ -298,6 +301,20 @@ export class SavedObjectsService
       .toPromise();
     this.config = new SavedObjectConfig(savedObjectsConfig, savedObjectsMigrationConfig);
 
+    const kibanaConfig = await this.coreContext.configService
+      .atPath<KibanaConfigType>('kibana')
+      .pipe(first())
+      .toPromise();
+
+    deprecations.getRegistry('core').registerDeprecations(
+      getSavedObjectsDeprecationsProvider({
+        kibanaConfig,
+        savedObjectsConfig: this.config,
+        kibanaVersion: this.coreContext.env.packageInfo.version,
+        typeRegistry: this.typeRegistry,
+      })
+    );
+
     coreUsageData.registerType(this.typeRegistry);
 
     registerRoutes({

src/core/server/saved_objects/service/lib/get_index_for_type.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry';
+
+interface GetIndexForTypeOptions {
+  type: string;
+  typeRegistry: ISavedObjectTypeRegistry;
+  migV2Enabled: boolean;
+  kibanaVersion: string;
+  defaultIndex: string;
+}
+
+export const getIndexForType = ({
+  type,
+  typeRegistry,
+  migV2Enabled,
+  defaultIndex,
+  kibanaVersion,
+}: GetIndexForTypeOptions): string => {
+  // TODO migrationsV2: Remove once we remove migrations v1
+  //   This is a hacky, but it required the least amount of changes to
+  //   existing code to support a migrations v2 index. Long term we would
+  //   want to always use the type registry to resolve a type's index
+  //   (including the default index).
+  if (migV2Enabled) {
+    return `${typeRegistry.getIndex(type) || defaultIndex}_${kibanaVersion}`;
+  } else {
+    return typeRegistry.getIndex(type) || defaultIndex;
+  }
+};

src/core/server/saved_objects/service/lib/index.ts

@@ -41,3 +41,5 @@ export type {
   SavedObjectsUpdateObjectsSpacesResponse,
   SavedObjectsUpdateObjectsSpacesResponseObject,
 } from './update_objects_spaces';
+
+export { getIndexForType } from './get_index_for_type';

src/core/server/saved_objects/service/lib/repository.ts

@@ -92,6 +92,7 @@ import {
   SavedObjectsUpdateObjectsSpacesObject,
   SavedObjectsUpdateObjectsSpacesOptions,
 } from './update_objects_spaces';
+import { getIndexForType } from './get_index_for_type';
 
 // BEWARE: The SavedObjectClient depends on the implementation details of the SavedObjectsRepository
 // so any breaking changes to this repository are considered breaking changes to the SavedObjectsClient.
@@ -2099,16 +2100,13 @@ export class SavedObjectsRepository {
    * @param type - the type
    */
   private getIndexForType(type: string) {
-    // TODO migrationsV2: Remove once we remove migrations v1
-    //   This is a hacky, but it required the least amount of changes to
-    //   existing code to support a migrations v2 index. Long term we would
-    //   want to always use the type registry to resolve a type's index
-    //   (including the default index).
-    if (this._migrator.soMigrationsConfig.enableV2) {
-      return `${this._registry.getIndex(type) || this._index}_${this._migrator.kibanaVersion}`;
-    } else {
-      return this._registry.getIndex(type) || this._index;
-    }
+    return getIndexForType({
+      type,
+      defaultIndex: this._index,
+      typeRegistry: this._registry,
+      kibanaVersion: this._migrator.kibanaVersion,
+      migV2Enabled: this._migrator.soMigrationsConfig.enableV2,
+    });
   }
 
   /**

src/core/server/server.ts

@@ -211,6 +211,10 @@ export class Server {
 
     const capabilitiesSetup = this.capabilities.setup({ http: httpSetup });
 
+    const deprecationsSetup = this.deprecations.setup({
+      http: httpSetup,
+    });
+
     const elasticsearchServiceSetup = await this.elasticsearch.setup({
       http: httpSetup,
       executionContext: executionContextSetup,
@@ -228,6 +232,7 @@ export class Server {
     const savedObjectsSetup = await this.savedObjects.setup({
       http: httpSetup,
       elasticsearch: elasticsearchServiceSetup,
+      deprecations: deprecationsSetup,
       coreUsageData: coreUsageDataSetup,
     });
 
@@ -259,10 +264,6 @@ export class Server {
 
     const loggingSetup = this.logging.setup();
 
-    const deprecationsSetup = this.deprecations.setup({
-      http: httpSetup,
-    });
-
     const coreSetup: InternalCoreSetup = {
       capabilities: capabilitiesSetup,
       context: contextServiceSetup,
@@ -302,6 +303,7 @@ export class Server {
 
     const executionContextStart = this.executionContext.start();
     const elasticsearchStart = await this.elasticsearch.start();
+    const deprecationsStart = this.deprecations.start();
     const soStartSpan = startTransaction?.startSpan('saved_objects.migration', 'migration');
     const savedObjectsStart = await this.savedObjects.start({
       elasticsearch: elasticsearchStart,
@@ -319,7 +321,7 @@ export class Server {
       savedObjects: savedObjectsStart,
       exposedConfigsToUsage: this.plugins.getExposedPluginConfigsToUsage(),
     });
-    const deprecationsStart = this.deprecations.start();
+
     this.status.start();
 
     this.coreStart = {