[Saved Objects] Allow exporting and importing hidden types

docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md

@@ -11,8 +11,9 @@ core: {
         savedObjects: {
             client: SavedObjectsClientContract;
             typeRegistry: ISavedObjectTypeRegistry;
-            exporter: ISavedObjectsExporter;
-            importer: ISavedObjectsImporter;
+            getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract;
+            getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter;
+            getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter;
         };
         elasticsearch: {
             client: IScopedClusterClient;

docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md

@@ -18,5 +18,5 @@ export interface RequestHandlerContext
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | <code>{</code><br/><code>        savedObjects: {</code><br/><code>            client: SavedObjectsClientContract;</code><br/><code>            typeRegistry: ISavedObjectTypeRegistry;</code><br/><code>            exporter: ISavedObjectsExporter;</code><br/><code>            importer: ISavedObjectsImporter;</code><br/><code>        };</code><br/><code>        elasticsearch: {</code><br/><code>            client: IScopedClusterClient;</code><br/><code>            legacy: {</code><br/><code>                client: ILegacyScopedClusterClient;</code><br/><code>            };</code><br/><code>        };</code><br/><code>        uiSettings: {</code><br/><code>            client: IUiSettingsClient;</code><br/><code>        };</code><br/><code>    }</code> |  |
+|  [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | <code>{</code><br/><code>        savedObjects: {</code><br/><code>            client: SavedObjectsClientContract;</code><br/><code>            typeRegistry: ISavedObjectTypeRegistry;</code><br/><code>            getClient: (options?: SavedObjectsClientProviderOptions) =&gt; SavedObjectsClientContract;</code><br/><code>            getExporter: (client: SavedObjectsClientContract) =&gt; ISavedObjectsExporter;</code><br/><code>            getImporter: (client: SavedObjectsClientContract) =&gt; ISavedObjectsImporter;</code><br/><code>        };</code><br/><code>        elasticsearch: {</code><br/><code>            client: IScopedClusterClient;</code><br/><code>            legacy: {</code><br/><code>                client: ILegacyScopedClusterClient;</code><br/><code>            };</code><br/><code>        };</code><br/><code>        uiSettings: {</code><br/><code>            client: IUiSettingsClient;</code><br/><code>        };</code><br/><code>    }</code> |  |
 

src/core/server/core_route_handler_context.ts

@@ -15,6 +15,7 @@ import {
   ISavedObjectTypeRegistry,
   ISavedObjectsExporter,
   ISavedObjectsImporter,
+  SavedObjectsClientProviderOptions,
 } from './saved_objects';
 import {
   InternalElasticsearchServiceStart,
@@ -75,19 +76,23 @@ class CoreSavedObjectsRouteHandlerContext {
     return this.#typeRegistry;
   }
 
-  public get exporter() {
+  public getClient = (options?: SavedObjectsClientProviderOptions) => {
+    return this.savedObjectsStart.getScopedClient(this.request, options);
+  };
+
+  public getExporter = (client: SavedObjectsClientContract) => {
     if (this.#exporter == null) {
-      this.#exporter = this.savedObjectsStart.createExporter(this.client);
+      this.#exporter = this.savedObjectsStart.createExporter(client);
     }
     return this.#exporter;
-  }
+  };
 
-  public get importer() {
+  public getImporter = (client: SavedObjectsClientContract) => {
     if (this.#importer == null) {
-      this.#importer = this.savedObjectsStart.createImporter(this.client);
+      this.#importer = this.savedObjectsStart.createImporter(client);
     }
     return this.#importer;
-  }
+  };
 }
 
 class CoreUiSettingsRouteHandlerContext {

src/core/server/index.ts

@@ -49,6 +49,7 @@ import {
   SavedObjectsServiceStart,
   ISavedObjectsExporter,
   ISavedObjectsImporter,
+  SavedObjectsClientProviderOptions,
 } from './saved_objects';
 import { CapabilitiesSetup, CapabilitiesStart } from './capabilities';
 import { MetricsServiceSetup, MetricsServiceStart } from './metrics';
@@ -409,8 +410,9 @@ export interface RequestHandlerContext {
     savedObjects: {
       client: SavedObjectsClientContract;
       typeRegistry: ISavedObjectTypeRegistry;
-      exporter: ISavedObjectsExporter;
-      importer: ISavedObjectsImporter;
+      getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract;
+      getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter;
+      getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter;
     };
     elasticsearch: {
       client: IScopedClusterClient;

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

@@ -31,11 +31,20 @@ export const registerDeleteRoute = (router: IRouter, { coreUsageData }: RouteDep
     router.handleLegacyErrors(async (context, req, res) => {
       const { type, id } = req.params;
       const { force } = req.query;
+      const { getClient, typeRegistry } = context.core.savedObjects;
 
       const usageStatsClient = coreUsageData.getClient();
       usageStatsClient.incrementSavedObjectsDelete({ request: req }).catch(() => {});
 
-      const result = await context.core.savedObjects.client.delete(type, id, { force });
+      const includedHiddenTypes = [type].filter(
+        (supportedType) =>
+          typeRegistry.isHidden(supportedType) &&
+          typeRegistry.isImportableAndExportable(supportedType)
+      );
+
+      const client = getClient({ includedHiddenTypes });
+
+      const result = await client.delete(type, id, { force });
       return res.ok({ body: result });
     })
   );

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

@@ -165,9 +165,9 @@ export const registerExportRoute = (
     },
     router.handleLegacyErrors(async (context, req, res) => {
       const cleaned = cleanOptions(req.body);
-      const supportedTypes = context.core.savedObjects.typeRegistry
-        .getImportableAndExportableTypes()
-        .map((t) => t.name);
+      const { typeRegistry, getExporter, getClient } = context.core.savedObjects;
+      const supportedTypes = typeRegistry.getImportableAndExportableTypes().map((t) => t.name);
+
       let options: EitherExportOptions;
       try {
         options = validateOptions(cleaned, {
@@ -181,7 +181,12 @@ export const registerExportRoute = (
         });
       }
 
-      const exporter = context.core.savedObjects.exporter;
+      const includedHiddenTypes = supportedTypes.filter((supportedType) =>
+        typeRegistry.isHidden(supportedType)
+      );
+
+      const client = getClient({ includedHiddenTypes });
+      const exporter = getExporter(client);
 
       const usageStatsClient = coreUsageData.getClient();
       usageStatsClient

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

@@ -63,6 +63,7 @@ export const registerImportRoute = (
     },
     router.handleLegacyErrors(async (context, req, res) => {
       const { overwrite, createNewCopies } = req.query;
+      const { getClient, getImporter, typeRegistry } = context.core.savedObjects;
 
       const usageStatsClient = coreUsageData.getClient();
       usageStatsClient
@@ -84,7 +85,15 @@ export const registerImportRoute = (
         });
       }
 
-      const { importer } = context.core.savedObjects;
+      const supportedTypes = typeRegistry.getImportableAndExportableTypes().map((t) => t.name);
+
+      const includedHiddenTypes = supportedTypes.filter((supportedType) =>
+        typeRegistry.isHidden(supportedType)
+      );
+
+      const client = getClient({ includedHiddenTypes });
+      const importer = getImporter(client);
+
       try {
         const result = await importer.import({
           readStream,

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

@@ -92,7 +92,18 @@ export const registerResolveImportErrorsRoute = (
         });
       }
 
-      const { importer } = context.core.savedObjects;
+      const { getClient, getImporter, typeRegistry } = context.core.savedObjects;
+
+      const includedHiddenTypes = req.body.retries
+        .map((retry) => retry.type)
+        .filter(
+          (supportedType) =>
+            typeRegistry.isHidden(supportedType) &&
+            typeRegistry.isImportableAndExportable(supportedType)
+        );
+
+      const client = getClient({ includedHiddenTypes });
+      const importer = getImporter(client);
 
       try {
         const result = await importer.resolveImportErrors({

src/core/server/server.api.md

@@ -1913,8 +1913,9 @@ export interface RequestHandlerContext {
         savedObjects: {
             client: SavedObjectsClientContract;
             typeRegistry: ISavedObjectTypeRegistry;
-            exporter: ISavedObjectsExporter;
-            importer: ISavedObjectsImporter;
+            getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract;
+            getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter;
+            getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter;
         };
         elasticsearch: {
             client: IScopedClusterClient;

src/plugins/home/server/services/sample_data/routes/install.ts

@@ -143,7 +143,15 @@ export function createInstallRoute(
 
       let createResults;
       try {
-        createResults = await context.core.savedObjects.client.bulkCreate(
+        const { getClient, typeRegistry } = context.core.savedObjects;
+
+        const includedHiddenTypes = sampleDataset.savedObjects
+          .map((object) => object.type)
+          .filter((supportedType) => typeRegistry.isHidden(supportedType));
+
+        const client = getClient({ includedHiddenTypes });
+
+        createResults = await client.bulkCreate(
           sampleDataset.savedObjects.map(({ version, ...savedObject }) => savedObject),
           { overwrite: true }
         );
@@ -156,8 +164,8 @@ export function createInstallRoute(
         return Boolean(savedObjectCreateResult.error);
       });
       if (errors.length > 0) {
-        const errMsg = `sample_data install errors while loading saved objects. Errors: ${errors.join(
-          ','
+        const errMsg = `sample_data install errors while loading saved objects. Errors: ${JSON.stringify(
+          errors
         )}`;
         logger.warn(errMsg);
         return res.customError({ body: errMsg, statusCode: 403 });

src/plugins/home/server/services/sample_data/routes/uninstall.ts

@@ -33,7 +33,7 @@ export function createUninstallRoute(
               client: { callAsCurrentUser },
             },
           },
-          savedObjects: { client: savedObjectsClient },
+          savedObjects: { getClient: getSavedObjectsClient, typeRegistry },
         },
       },
       request,
@@ -61,6 +61,12 @@ export function createUninstallRoute(
         }
       }
 
+      const includedHiddenTypes = sampleDataset.savedObjects
+        .map((object) => object.type)
+        .filter((supportedType) => typeRegistry.isHidden(supportedType));
+
+      const savedObjectsClient = getSavedObjectsClient({ includedHiddenTypes });
+
       const deletePromises = sampleDataset.savedObjects.map(({ type, id }) =>
         savedObjectsClient.delete(type, id)
       );

src/plugins/saved_objects_management/server/routes/find.ts

@@ -45,17 +45,24 @@ export const registerFindRoute = (
       },
     },
     router.handleLegacyErrors(async (context, req, res) => {
+      const { query } = req;
       const managementService = await managementServicePromise;
-      const { client } = context.core.savedObjects;
-      const searchTypes = Array.isArray(req.query.type) ? req.query.type : [req.query.type];
-      const includedFields = Array.isArray(req.query.fields)
-        ? req.query.fields
-        : [req.query.fields];
+      const { getClient } = context.core.savedObjects;
+
+      const searchTypes = Array.isArray(query.type) ? query.type : [query.type];
+      const includedFields = Array.isArray(query.fields) ? query.fields : [query.fields];
+
       const importAndExportableTypes = searchTypes.filter((type) =>
         managementService.isImportAndExportable(type)
       );
 
+      const includedHiddenTypes = importAndExportableTypes.filter((type) =>
+        managementService.isHidden(type)
+      );
+
+      const client = getClient({ includedHiddenTypes });
       const searchFields = new Set<string>();
+
       importAndExportableTypes.forEach((type) => {
         const searchField = managementService.getDefaultSearchField(type);
         if (searchField) {
@@ -64,7 +71,7 @@ export const registerFindRoute = (
       });
 
       const findResponse = await client.find<any>({
-        ...req.query,
+        ...query,
         fields: undefined,
         searchFields: [...searchFields],
       });

src/plugins/saved_objects_management/server/services/management.ts

@@ -18,6 +18,10 @@ export class SavedObjectsManagement {
     return this.registry.isImportableAndExportable(type);
   }
 
+  public isHidden(type: string) {
+    return this.registry.isHidden(type);
+  }
+
   public getDefaultSearchField(type: string) {
     return this.registry.getType(type)?.management?.defaultSearchField;
   }

x-pack/plugins/features/server/plugin.ts

@@ -113,7 +113,7 @@ export class Plugin {
 
   private registerOssFeatures(savedObjects: SavedObjectsServiceStart) {
     const registry = savedObjects.getTypeRegistry();
-    const savedObjectTypes = registry.getVisibleTypes().map((t) => t.name);
+    const savedObjectTypes = registry.getImportableAndExportableTypes().map((t) => t.name);
 
     this.logger.debug(
       `Registering OSS features with SO types: ${savedObjectTypes.join(', ')}. "includeTimelion": ${