Refactor saved object types to use namespaceType (#63217)

Remove `namespaceAgnostic` field that was deprecated in #54605, use `namespaceType` instead.
elastic · Apr 16, 2020 · d72de0e · d72de0e
1 parent 10ccc0a
commit d72de0e
Show file tree

Hide file tree

Showing 46 changed files with 69 additions and 136 deletions.
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md
@@ -25,6 +25,5 @@ This is only internal for now, and will only be public when we expose the regist
 |  [mappings](./kibana-plugin-core-server.savedobjectstype.mappings.md) | <code>SavedObjectsTypeMappingDefinition</code> | The [mapping definition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) for the type. |
 |  [migrations](./kibana-plugin-core-server.savedobjectstype.migrations.md) | <code>SavedObjectMigrationMap</code> | An optional map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used to migrate the type. |
 |  [name](./kibana-plugin-core-server.savedobjectstype.name.md) | <code>string</code> | The name of the type, which is also used as the internal id. |
-|  [namespaceAgnostic](./kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md) | <code>boolean</code> | Is the type global (true), or not (false). |
 |  [namespaceType](./kibana-plugin-core-server.savedobjectstype.namespacetype.md) | <code>SavedObjectsNamespaceType</code> | The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) for the type. |
 
diff --git a/...ent/core/server/kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md b/...ent/core/server/kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md
diff --git a/...lopment/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md b/...lopment/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md
@@ -9,5 +9,5 @@ The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) f
 <b>Signature:</b>
 
 ```typescript
-namespaceType?: SavedObjectsNamespaceType;
+namespaceType: SavedObjectsNamespaceType;
 ```
diff --git a/examples/embeddable_examples/server/todo_saved_object.ts b/examples/embeddable_examples/server/todo_saved_object.ts
@@ -22,7 +22,7 @@ import { SavedObjectsType } from 'kibana/server';
 export const todoSavedObject: SavedObjectsType = {
   name: 'todo',
   hidden: false,
-  namespaceAgnostic: true,
+  namespaceType: 'agnostic',
   mappings: {
     properties: {
       title: {

diff --git a/src/core/server/saved_objects/migrations/core/build_index_map.test.ts b/src/core/server/saved_objects/migrations/core/build_index_map.test.ts
@@ -26,7 +26,7 @@ const createRegistry = (...types: Array<Partial<SavedObjectsType>>) => {
   types.forEach(type =>
     registry.registerType({
       name: 'unknown',
-      namespaceAgnostic: false,
+      namespaceType: 'single',
       hidden: false,
       mappings: { properties: {} },
       migrations: {},
@@ -41,7 +41,7 @@ test('mappings without index pattern goes to default index', () => {
     kibanaIndexName: '.kibana',
     registry: createRegistry({
       name: 'type1',
-      namespaceAgnostic: false,
+      namespaceType: 'single',
     }),
     indexMap: {
       type1: {
@@ -73,7 +73,7 @@ test(`mappings with custom index pattern doesn't go to default index`, () => {
     kibanaIndexName: '.kibana',
     registry: createRegistry({
       name: 'type1',
-      namespaceAgnostic: false,
+      namespaceType: 'single',
       indexPattern: '.other_kibana',
     }),
     indexMap: {
@@ -106,7 +106,7 @@ test('creating a script gets added to the index pattern', () => {
     kibanaIndexName: '.kibana',
     registry: createRegistry({
       name: 'type1',
-      namespaceAgnostic: false,
+      namespaceType: 'single',
       indexPattern: '.other_kibana',
       convertToAliasScript: `ctx._id = ctx._source.type + ':' + ctx._id`,
     }),
@@ -141,12 +141,12 @@ test('throws when two scripts are defined for an index pattern', () => {
   const registry = createRegistry(
     {
       name: 'type1',
-      namespaceAgnostic: false,
+      namespaceType: 'single',
       convertToAliasScript: `ctx._id = ctx._source.type + ':' + ctx._id`,
     },
     {
       name: 'type2',
-      namespaceAgnostic: false,
+      namespaceType: 'single',
       convertToAliasScript: `ctx._id = ctx._source.type + ':' + ctx._id`,
     }
   );

diff --git a/src/core/server/saved_objects/migrations/core/document_migrator.test.ts b/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
@@ -32,7 +32,7 @@ const createRegistry = (...types: Array<Partial<SavedObjectsType>>) => {
   types.forEach(type =>
     registry.registerType({
       name: 'unknown',
-      namespaceAgnostic: false,
+      namespaceType: 'single',
       hidden: false,
       mappings: { properties: {} },
       migrations: {},

diff --git a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.mock.ts b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.mock.ts
@@ -27,7 +27,7 @@ const defaultSavedObjectTypes: SavedObjectsType[] = [
   {
     name: 'testtype',
     hidden: false,
-    namespaceAgnostic: false,
+    namespaceType: 'single',
     mappings: {
       properties: {
         name: { type: 'keyword' },

diff --git a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
@@ -28,8 +28,8 @@ const createRegistry = (types: Array<Partial<SavedObjectsType>>) => {
   types.forEach(type =>
     registry.registerType({
       name: 'unknown',
-      namespaceAgnostic: false,
       hidden: false,
+      namespaceType: 'single',
       mappings: { properties: {} },
       migrations: {},
       ...type,
@@ -120,7 +120,7 @@ function mockOptions(): KibanaMigratorOptions {
       {
         name: 'testtype',
         hidden: false,
-        namespaceAgnostic: false,
+        namespaceType: 'single',
         mappings: {
           properties: {
             name: { type: 'keyword' },
@@ -131,7 +131,7 @@ function mockOptions(): KibanaMigratorOptions {
       {
         name: 'testtype2',
         hidden: false,
-        namespaceAgnostic: false,
+        namespaceType: 'single',
         indexPattern: 'other-index',
         mappings: {
           properties: {

diff --git a/src/core/server/saved_objects/routes/integration_tests/test_utils.ts b/src/core/server/saved_objects/routes/integration_tests/test_utils.ts
@@ -49,7 +49,7 @@ export const createExportableType = (name: string): SavedObjectsType => {
   return {
     name,
     hidden: false,
-    namespaceAgnostic: false,
+    namespaceType: 'single',
     mappings: {
       properties: {},
     },

diff --git a/src/core/server/saved_objects/saved_objects_type_registry.test.ts b/src/core/server/saved_objects/saved_objects_type_registry.test.ts
@@ -183,14 +183,6 @@ describe('SavedObjectTypeRegistry', () => {
       expectResult(false, { namespaceType: 'single' });
       expectResult(false, { namespaceType: undefined });
     });
-
-    // deprecated test cases
-    it(`returns true when namespaceAgnostic is true`, () => {
-      expectResult(true, { namespaceAgnostic: true, namespaceType: 'agnostic' });
-      expectResult(true, { namespaceAgnostic: true, namespaceType: 'multiple' });
-      expectResult(true, { namespaceAgnostic: true, namespaceType: 'single' });
-      expectResult(true, { namespaceAgnostic: true, namespaceType: undefined });
-    });
   });
 
   describe('#isSingleNamespace', () => {
@@ -213,14 +205,6 @@ describe('SavedObjectTypeRegistry', () => {
       expectResult(false, { namespaceType: 'agnostic' });
       expectResult(false, { namespaceType: 'multiple' });
     });
-
-    // deprecated test cases
-    it(`returns false when namespaceAgnostic is true`, () => {
-      expectResult(false, { namespaceAgnostic: true, namespaceType: 'agnostic' });
-      expectResult(false, { namespaceAgnostic: true, namespaceType: 'multiple' });
-      expectResult(false, { namespaceAgnostic: true, namespaceType: 'single' });
-      expectResult(false, { namespaceAgnostic: true, namespaceType: undefined });
-    });
   });
 
   describe('#isMultiNamespace', () => {
@@ -243,14 +227,6 @@ describe('SavedObjectTypeRegistry', () => {
       expectResult(false, { namespaceType: 'single' });
       expectResult(false, { namespaceType: undefined });
     });
-
-    // deprecated test cases
-    it(`returns false when namespaceAgnostic is true`, () => {
-      expectResult(false, { namespaceAgnostic: true, namespaceType: 'agnostic' });
-      expectResult(false, { namespaceAgnostic: true, namespaceType: 'multiple' });
-      expectResult(false, { namespaceAgnostic: true, namespaceType: 'single' });
-      expectResult(false, { namespaceAgnostic: true, namespaceType: undefined });
-    });
   });
 
   describe('#isHidden', () => {

diff --git a/src/core/server/saved_objects/saved_objects_type_registry.ts b/src/core/server/saved_objects/saved_objects_type_registry.ts
@@ -72,18 +72,15 @@ export class SavedObjectTypeRegistry {
    * resolves to `false` if the type is not registered
    */
   public isNamespaceAgnostic(type: string) {
-    return (
-      this.types.get(type)?.namespaceType === 'agnostic' ||
-      this.types.get(type)?.namespaceAgnostic ||
-      false
-    );
+    return this.types.get(type)?.namespaceType === 'agnostic';
   }
 
   /**
    * Returns whether the type is single-namespace (isolated);
    * resolves to `true` if the type is not registered
    */
   public isSingleNamespace(type: string) {
+    // in the case we somehow registered a type with an invalid `namespaceType`, treat it as single-namespace
     return !this.isNamespaceAgnostic(type) && !this.isMultiNamespace(type);
   }
 
@@ -92,7 +89,7 @@ export class SavedObjectTypeRegistry {
    * resolves to `false` if the type is not registered
    */
   public isMultiNamespace(type: string) {
-    return !this.isNamespaceAgnostic(type) && this.types.get(type)?.namespaceType === 'multiple';
+    return this.types.get(type)?.namespaceType === 'multiple';
   }
 
   /**

diff --git a/src/core/server/saved_objects/service/lib/repository_create_repository.test.ts b/src/core/server/saved_objects/service/lib/repository_create_repository.test.ts
@@ -32,7 +32,7 @@ describe('SavedObjectsRepository#createRepository', () => {
   typeRegistry.registerType({
     name: 'nsAgnosticType',
     hidden: false,
-    namespaceAgnostic: true,
+    namespaceType: 'agnostic',
     mappings: {
       properties: {
         name: { type: 'keyword' },
@@ -44,7 +44,7 @@ describe('SavedObjectsRepository#createRepository', () => {
   typeRegistry.registerType({
     name: 'nsType',
     hidden: false,
-    namespaceAgnostic: false,
+    namespaceType: 'single',
     indexPattern: 'beats',
     mappings: {
       properties: {
@@ -56,7 +56,7 @@ describe('SavedObjectsRepository#createRepository', () => {
   typeRegistry.registerType({
     name: 'hiddenType',
     hidden: true,
-    namespaceAgnostic: true,
+    namespaceType: 'agnostic',
     mappings: {
       properties: {
         name: { type: 'keyword' },

diff --git a/src/core/server/saved_objects/types.ts b/src/core/server/saved_objects/types.ts
@@ -202,15 +202,10 @@ export interface SavedObjectsType {
    * See {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}.
    */
   hidden: boolean;
-  /**
-   * Is the type global (true), or not (false).
-   * @deprecated Use `namespaceType` instead.
-   */
-  namespaceAgnostic?: boolean;
   /**
    * The {@link SavedObjectsNamespaceType | namespace type} for the type.
    */
-  namespaceType?: SavedObjectsNamespaceType;
+  namespaceType: SavedObjectsNamespaceType;
   /**
    * If defined, the type instances will be stored in the given index instead of the default one.
    */

diff --git a/src/core/server/saved_objects/utils.test.ts b/src/core/server/saved_objects/utils.test.ts
@@ -421,14 +421,6 @@ describe('convertTypesToLegacySchema', () => {
         namespaceType: 'multiple',
         mappings: { properties: {} },
       },
-      // deprecated test case
-      {
-        name: 'typeD',
-        hidden: false,
-        namespaceAgnostic: true,
-        namespaceType: 'multiple', // if namespaceAgnostic and namespaceType are both set, namespaceAgnostic takes precedence
-        mappings: { properties: {} },
-      },
     ];
     expect(convertTypesToLegacySchema(types)).toEqual({
       typeA: {
@@ -448,12 +440,6 @@ describe('convertTypesToLegacySchema', () => {
         isNamespaceAgnostic: false,
         multiNamespace: true,
       },
-      // deprecated test case
-      typeD: {
-        hidden: false,
-        isNamespaceAgnostic: true,
-        multiNamespace: false,
-      },
     });
   });
 });
diff --git a/src/core/server/saved_objects/utils.ts b/src/core/server/saved_objects/utils.ts
@@ -82,8 +82,8 @@ export const convertTypesToLegacySchema = (
     return {
       ...schema,
       [type.name]: {
-        isNamespaceAgnostic: type.namespaceAgnostic || type.namespaceType === 'agnostic',
-        multiNamespace: !type.namespaceAgnostic && type.namespaceType === 'multiple',
+        isNamespaceAgnostic: type.namespaceType === 'agnostic',
+        multiNamespace: type.namespaceType === 'multiple',
         hidden: type.hidden,
         indexPattern: type.indexPattern,
         convertToAliasScript: type.convertToAliasScript,

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -2263,9 +2263,7 @@ export interface SavedObjectsType {
     mappings: SavedObjectsTypeMappingDefinition;
     migrations?: SavedObjectMigrationMap;
     name: string;
-    // @deprecated
-    namespaceAgnostic?: boolean;
-    namespaceType?: SavedObjectsNamespaceType;
+    namespaceType: SavedObjectsNamespaceType;
 }
 
 // @public

diff --git a/src/core/server/ui_settings/saved_objects/ui_settings.ts b/src/core/server/ui_settings/saved_objects/ui_settings.ts
@@ -22,7 +22,7 @@ import { SavedObjectsType } from '../../saved_objects';
 export const uiSettingsType: SavedObjectsType = {
   name: 'config',
   hidden: false,
-  namespaceAgnostic: false,
+  namespaceType: 'single',
   mappings: {
     // we don't want to allow `true` in the public `SavedObjectsTypeMappingDefinition` type, however
     // this is needed for the config that is kinda a special type. To avoid adding additional internal types

diff --git a/src/plugins/data/server/saved_objects/index_patterns.ts b/src/plugins/data/server/saved_objects/index_patterns.ts
@@ -23,7 +23,7 @@ import { indexPatternSavedObjectTypeMigrations } from './index_pattern_migration
 export const indexPatternSavedObjectType: SavedObjectsType = {
   name: 'index-pattern',
   hidden: false,
-  namespaceAgnostic: false,
+  namespaceType: 'single',
   management: {
     icon: 'indexPatternApp',
     defaultSearchField: 'title',

diff --git a/src/plugins/data/server/saved_objects/query.ts b/src/plugins/data/server/saved_objects/query.ts
@@ -22,7 +22,7 @@ import { SavedObjectsType } from 'kibana/server';
 export const querySavedObjectType: SavedObjectsType = {
   name: 'query',
   hidden: false,
-  namespaceAgnostic: false,
+  namespaceType: 'single',
   management: {
     icon: 'search',
     defaultSearchField: 'title',

diff --git a/src/plugins/data/server/saved_objects/search.ts b/src/plugins/data/server/saved_objects/search.ts
@@ -23,7 +23,7 @@ import { searchSavedObjectTypeMigrations } from './search_migrations';
 export const searchSavedObjectType: SavedObjectsType = {
   name: 'search',
   hidden: false,
-  namespaceAgnostic: false,
+  namespaceType: 'single',
   management: {
     icon: 'discoverApp',
     defaultSearchField: 'title',

diff --git a/src/plugins/saved_objects_management/server/services/management.test.ts b/src/plugins/saved_objects_management/server/services/management.test.ts
@@ -28,7 +28,7 @@ describe('SavedObjectsManagement', () => {
     registry.registerType({
       name: 'unknown',
       hidden: false,
-      namespaceAgnostic: false,
+      namespaceType: 'single',
       mappings: { properties: {} },
       migrations: {},
       ...type,

diff --git a/src/plugins/telemetry/server/collectors/application_usage/saved_objects_types.ts b/src/plugins/telemetry/server/collectors/application_usage/saved_objects_types.ts
@@ -33,7 +33,7 @@ export function registerMappings(registerType: SavedObjectsServiceSetup['registe
   registerType({
     name: 'application_usage_totals',
     hidden: false,
-    namespaceAgnostic: true,
+    namespaceType: 'agnostic',
     mappings: {
       properties: {
         appId: { type: 'keyword' },
@@ -46,7 +46,7 @@ export function registerMappings(registerType: SavedObjectsServiceSetup['registe
   registerType({
     name: 'application_usage_transactional',
     hidden: false,
-    namespaceAgnostic: true,
+    namespaceType: 'agnostic',
     mappings: {
       properties: {
         timestamp: { type: 'date' },

diff --git a/src/plugins/telemetry/server/collectors/ui_metric/telemetry_ui_metric_collector.ts b/src/plugins/telemetry/server/collectors/ui_metric/telemetry_ui_metric_collector.ts
@@ -38,7 +38,7 @@ export function registerUiMetricUsageCollector(
   registerType({
     name: 'ui-metric',
     hidden: false,
-    namespaceAgnostic: true,
+    namespaceType: 'agnostic',
     mappings: {
       properties: {
         count: {

diff --git a/src/plugins/telemetry/server/plugin.ts b/src/plugins/telemetry/server/plugin.ts
@@ -125,7 +125,7 @@ export class TelemetryPlugin implements Plugin {
     registerType({
       name: 'telemetry',
       hidden: false,
-      namespaceAgnostic: true,
+      namespaceType: 'agnostic',
       mappings: {
         properties: {
           enabled: {