[SOM] Add visibleInManagement option to management metadata (#112073) (#112639)

* implement SavedObjectsTypeManagementDefinition.visibleInManagement

* update generated doc

* improve FTR tests

* fix FTR test

Co-authored-by: Pierre Gayvallet <[email protected]>

Author: kibanamachine

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

@@ -27,6 +27,7 @@ async function getDeprecations({ esClient, savedObjectsClient }: GetDeprecations
   const deprecations: DeprecationsDetails[] = [];
   const count = await getFooCount(savedObjectsClient);
   if (count > 0) {
+    // Example of a manual correctiveAction
     deprecations.push({
       title: i18n.translate('xpack.foo.deprecations.title', {
         defaultMessage: `Foo's are deprecated`

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

@@ -25,4 +25,5 @@ export interface SavedObjectsTypeManagementDefinition<Attributes = any>
 |  [isExportable](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md) | <code>SavedObjectsExportablePredicate&lt;Attributes&gt;</code> | Optional hook to specify whether an object should be exportable.<!-- -->If specified, <code>isExportable</code> will be called during export for each of this type's objects in the export, and the ones not matching the predicate will be excluded from the export.<!-- -->When implementing both <code>isExportable</code> and <code>onExport</code>, it is mandatory that <code>isExportable</code> returns the same value for an object before and after going though the export transform. E.g <code>isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)</code> |
 |  [onExport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md) | <code>SavedObjectsExportTransform&lt;Attributes&gt;</code> | An optional export transform function that can be used transform the objects of the registered type during the export process.<!-- -->It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.<!-- -->See [the transform type documentation](./kibana-plugin-core-server.savedobjectsexporttransform.md) for more info and examples.<!-- -->When implementing both <code>isExportable</code> and <code>onExport</code>, it is mandatory that <code>isExportable</code> returns the same value for an object before and after going though the export transform. E.g <code>isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)</code> |
 |  [onImport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md) | <code>SavedObjectsImportHook&lt;Attributes&gt;</code> | An optional [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) to use when importing given type.<!-- -->Import hooks are executed during the savedObjects import process and allow to interact with the imported objects. See the [hook documentation](./kibana-plugin-core-server.savedobjectsimporthook.md) for more info. |
+|  [visibleInManagement](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md) | <code>boolean</code> | When set to false, the type will not be listed or searchable in the SO management section. Main usage of setting this property to false for a type is when objects from the type should be included in the export via references or export hooks, but should not directly appear in the SOM. Defaults to <code>true</code>. |
 

docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) &gt; [visibleInManagement](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md)
+
+## SavedObjectsTypeManagementDefinition.visibleInManagement property
+
+When set to false, the type will not be listed or searchable in the SO management section. Main usage of setting this property to false for a type is when objects from the type should be included in the export via references or export hooks, but should not directly appear in the SOM. Defaults to `true`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+visibleInManagement?: boolean;
+```
+
+## Remarks
+
+`importableAndExportable` must be `true` to specify this property.
+

src/core/server/saved_objects/saved_objects_type_registry.test.ts

@@ -47,6 +47,59 @@ describe('SavedObjectTypeRegistry', () => {
       }).toThrowErrorMatchingInlineSnapshot(`"Type 'typeA' is already registered"`);
     });
 
+    it('throws when `management.visibleInManagement` is specified but `management.importableAndExportable` is undefined or false', () => {
+      expect(() => {
+        registry.registerType(
+          createType({
+            name: 'typeA',
+            management: {
+              visibleInManagement: true,
+            },
+          })
+        );
+      }).toThrowErrorMatchingInlineSnapshot(
+        `"Type typeA: 'management.importableAndExportable' must be 'true' when specifying 'management.visibleInManagement'"`
+      );
+
+      expect(() => {
+        registry.registerType(
+          createType({
+            name: 'typeA',
+            management: {
+              visibleInManagement: false,
+            },
+          })
+        );
+      }).toThrowErrorMatchingInlineSnapshot(
+        `"Type typeA: 'management.importableAndExportable' must be 'true' when specifying 'management.visibleInManagement'"`
+      );
+
+      expect(() => {
+        registry.registerType(
+          createType({
+            name: 'typeA',
+            management: {
+              importableAndExportable: false,
+              visibleInManagement: false,
+            },
+          })
+        );
+      }).toThrowErrorMatchingInlineSnapshot(
+        `"Type typeA: 'management.importableAndExportable' must be 'true' when specifying 'management.visibleInManagement'"`
+      );
+      expect(() => {
+        registry.registerType(
+          createType({
+            name: 'typeA',
+            management: {
+              importableAndExportable: true,
+              visibleInManagement: false,
+            },
+          })
+        );
+      }).not.toThrow();
+    });
+
     it('throws when `management.onExport` is specified but `management.importableAndExportable` is undefined or false', () => {
       expect(() => {
         registry.registerType(

src/core/server/saved_objects/saved_objects_type_registry.ts

@@ -134,5 +134,10 @@ const validateType = ({ name, management }: SavedObjectsType) => {
         `Type ${name}: 'management.importableAndExportable' must be 'true' when specifying 'management.onExport'`
       );
     }
+    if (management.visibleInManagement !== undefined && !management.importableAndExportable) {
+      throw new Error(
+        `Type ${name}: 'management.importableAndExportable' must be 'true' when specifying 'management.visibleInManagement'`
+      );
+    }
   }
 };

src/core/server/saved_objects/types.ts

@@ -356,6 +356,15 @@ export interface SavedObjectsTypeManagementDefinition<Attributes = any> {
    * Is the type importable or exportable. Defaults to `false`.
    */
   importableAndExportable?: boolean;
+  /**
+   * When set to false, the type will not be listed or searchable in the SO management section.
+   * Main usage of setting this property to false for a type is when objects from the type should
+   * be included in the export via references or export hooks, but should not directly appear in the SOM.
+   * Defaults to `true`.
+   *
+   * @remarks `importableAndExportable` must be `true` to specify this property.
+   */
+  visibleInManagement?: boolean;
   /**
    * The default search field to use for this type. Defaults to `id`.
    */

src/core/server/server.api.md

@@ -2728,6 +2728,7 @@ export interface SavedObjectsTypeManagementDefinition<Attributes = any> {
     isExportable?: SavedObjectsExportablePredicate<Attributes>;
     onExport?: SavedObjectsExportTransform<Attributes>;
     onImport?: SavedObjectsImportHook<Attributes>;
+    visibleInManagement?: boolean;
 }
 
 // @public

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

@@ -17,6 +17,7 @@ export const registerGetAllowedTypesRoute = (router: IRouter) => {
     async (context, req, res) => {
       const allowedTypes = context.core.savedObjects.typeRegistry
         .getImportableAndExportableTypes()
+        .filter((type) => type.management!.visibleInManagement ?? true)
         .map((type) => type.name);
 
       return res.ok({

test/functional/fixtures/es_archiver/saved_objects_management/visible_in_management/data.json

@@ -0,0 +1,20 @@
+{
+  "type": "doc",
+  "value": {
+    "id": "test-not-visible-in-management:vim-1",
+    "index": ".kibana",
+    "source": {
+      "coreMigrationVersion": "7.14.0",
+      "references": [
+      ],
+      "test-not-visible-in-management": {
+        "enabled": true,
+        "title": "vim-1"
+      },
+      "type": "test-not-visible-in-management",
+      "updated_at": "2018-12-21T00:43:07.096Z"
+    },
+    "type": "_doc"
+  }
+}
+