Spaces - make space a hidden saved object type (elastic#41688)

* make space a hidden saved object type * bulk_create api tests * bulk_get tests * create functional tests * delete space tests * export space tests * find space tests * get space tests * import space tests * resolve_import_errirs space tests * update space tests * standardize test names where appropriate * remove unused import * Switching tests from using the space type directly to a "hidden t… (#21) * add space saved object api tests Co-authored-by: Brandon Kobel <[email protected]>
legrego · Jul 30, 2019 · 647388d · 647388d
1 parent 0501ea6
commit 647388d
Show file tree

Hide file tree

Showing 53 changed files with 1,618 additions and 310 deletions.
diff --git a/x-pack/legacy/plugins/spaces/index.ts b/x-pack/legacy/plugins/spaces/index.ts
@@ -83,6 +83,7 @@ export const spaces = (kibana: Record<string, any>) =>
       savedObjectSchemas: {
         space: {
           isNamespaceAgnostic: true,
+          hidden: true,
         },
       },
       home: ['plugins/spaces/register_feature'],

diff --git a/x-pack/legacy/plugins/spaces/server/lib/create_default_space.ts b/x-pack/legacy/plugins/spaces/server/lib/create_default_space.ts
@@ -20,7 +20,7 @@ export async function createDefaultSpace({ elasticsearch, savedObjects }: Deps)
 
   const client = await elasticsearch.dataClient$.pipe(first()).toPromise();
 
-  const savedObjectsRepository = getSavedObjectsRepository(client.callAsInternalUser);
+  const savedObjectsRepository = getSavedObjectsRepository(client.callAsInternalUser, ['space']);
 
   const defaultSpaceExists = await doesDefaultSpaceExist(
     SavedObjectsClient,

diff --git a/...es/server/lib/saved_objects_client/__snapshots__/spaces_saved_objects_client.test.ts.snap b/...es/server/lib/saved_objects_client/__snapshots__/spaces_saved_objects_client.test.ts.snap
diff --git a/...legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.test.ts b/...legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.test.ts
@@ -54,21 +54,6 @@ const createSpacesService = async (spaceId: string) => {
         ).rejects.toThrowErrorMatchingSnapshot();
       });
 
-      test(`throws error if type is space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(client.get('space', '')).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`supplements options with undefined namespace`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();
@@ -114,23 +99,6 @@ const createSpacesService = async (spaceId: string) => {
         ).rejects.toThrowErrorMatchingSnapshot();
       });
 
-      test(`throws error if objects type is space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(
-          client.bulkGet([{ id: '', type: 'foo' }, { id: '', type: 'space' }], { namespace: 'bar' })
-        ).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`supplements options with undefined namespace`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();
@@ -174,23 +142,6 @@ const createSpacesService = async (spaceId: string) => {
         await expect(client.find({ namespace: 'bar' })).rejects.toThrowErrorMatchingSnapshot();
       });
 
-      test(`throws error if options.type is space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const expectedReturnValue = Symbol();
-        baseClient.find.mockReturnValue(expectedReturnValue);
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(client.find({ type: 'space' })).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`passes options.type to baseClient if valid singular type specified`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();
@@ -215,44 +166,6 @@ const createSpacesService = async (spaceId: string) => {
         });
       });
 
-      test(`throws error if options.type is array containing space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const expectedReturnValue = Symbol();
-        baseClient.find.mockReturnValue(expectedReturnValue);
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(
-          client.find({ type: ['space', 'foo'] })
-        ).rejects.toThrowErrorMatchingSnapshot();
-      });
-
-      test(`if options.type isn't provided specifies options.type based on the types excluding the space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const expectedReturnValue = Symbol();
-        baseClient.find.mockReturnValue(expectedReturnValue);
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(
-          client.find({ type: ['space', 'foo'] })
-        ).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`supplements options with undefined namespace`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();
@@ -296,21 +209,6 @@ const createSpacesService = async (spaceId: string) => {
         ).rejects.toThrowErrorMatchingSnapshot();
       });
 
-      test(`throws error if type is space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(client.create('space', {})).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`supplements options with undefined namespace`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();
@@ -357,26 +255,6 @@ const createSpacesService = async (spaceId: string) => {
         ).rejects.toThrowErrorMatchingSnapshot();
       });
 
-      test(`throws error if objects type is space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(
-          client.bulkCreate([
-            { id: '', type: 'foo', attributes: {} },
-            { id: '', type: 'space', attributes: {} },
-          ])
-        ).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`supplements options with undefined namespace`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();
@@ -423,21 +301,6 @@ const createSpacesService = async (spaceId: string) => {
         ).rejects.toThrowErrorMatchingSnapshot();
       });
 
-      test(`throws error if type is space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(client.update('space', '', {})).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`supplements options with undefined namespace`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();
@@ -486,21 +349,6 @@ const createSpacesService = async (spaceId: string) => {
         ).rejects.toThrowErrorMatchingSnapshot();
       });
 
-      test(`throws error if type is space`, async () => {
-        const request = createMockRequest();
-        const baseClient = createMockClient();
-        const spacesService = await createSpacesService(currentSpace.id);
-
-        const client = new SpacesSavedObjectsClient({
-          request,
-          baseClient,
-          spacesService,
-          types,
-        });
-
-        await expect(client.delete('space', 'foo')).rejects.toThrowErrorMatchingSnapshot();
-      });
-
       test(`supplements options with undefined namespace`, async () => {
         const request = createMockRequest();
         const baseClient = createMockClient();

diff --git a/x-pack/legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.ts b/x-pack/legacy/plugins/spaces/server/lib/saved_objects_client/spaces_saved_objects_client.ts
@@ -38,18 +38,6 @@ const throwErrorIfNamespaceSpecified = (options: any) => {
   }
 };
 
-const throwErrorIfTypeIsSpace = (type: string) => {
-  if (type === 'space') {
-    throw new Error('Spaces can not be accessed using the SavedObjectsClient');
-  }
-};
-
-const throwErrorIfTypesContainsSpace = (types: string[]) => {
-  for (const type of types) {
-    throwErrorIfTypeIsSpace(type);
-  }
-};
-
 export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
   private readonly client: SavedObjectsClientContract;
   private readonly spaceId: string;
@@ -81,7 +69,6 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
     attributes: T = {} as T,
     options: SavedObjectsCreateOptions = {}
   ) {
-    throwErrorIfTypeIsSpace(type);
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.create(type, attributes, {
@@ -103,7 +90,6 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
     objects: SavedObjectsBulkCreateObject[],
     options: SavedObjectsBaseOptions = {}
   ) {
-    throwErrorIfTypesContainsSpace(objects.map(object => object.type));
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.bulkCreate(objects, {
@@ -122,7 +108,6 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
    * @returns {promise}
    */
   public async delete(type: string, id: string, options: SavedObjectsBaseOptions = {}) {
-    throwErrorIfTypeIsSpace(type);
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.delete(type, id, {
@@ -148,10 +133,6 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
    * @returns {promise} - { saved_objects: [{ id, type, version, attributes }], total, per_page, page }
    */
   public async find(options: SavedObjectsFindOptions = {}) {
-    if (options.type) {
-      throwErrorIfTypesContainsSpace(coerceToArray(options.type));
-    }
-
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.find({
@@ -181,7 +162,6 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
     objects: SavedObjectsBulkGetObject[] = [],
     options: SavedObjectsBaseOptions = {}
   ) {
-    throwErrorIfTypesContainsSpace(objects.map(object => object.type));
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.bulkGet(objects, {
@@ -200,7 +180,6 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
    * @returns {promise} - { id, type, version, attributes }
    */
   public async get(type: string, id: string, options: SavedObjectsBaseOptions = {}) {
-    throwErrorIfTypeIsSpace(type);
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.get(type, id, {
@@ -225,7 +204,6 @@ export class SpacesSavedObjectsClient implements SavedObjectsClientContract {
     attributes: Partial<T>,
     options: SavedObjectsUpdateOptions = {}
   ) {
-    throwErrorIfTypeIsSpace(type);
     throwErrorIfNamespaceSpecified(options);
 
     return await this.client.update(type, id, attributes, {

diff --git a/x-pack/legacy/plugins/spaces/server/new_platform/spaces_service/spaces_service.ts b/x-pack/legacy/plugins/spaces/server/new_platform/spaces_service/spaces_service.ts
@@ -93,12 +93,16 @@ export class SpacesService {
           .pipe(
             map(([clusterClient, config]) => {
               const internalRepository = savedObjects.getSavedObjectsRepository(
-                clusterClient.callAsInternalUser
+                clusterClient.callAsInternalUser,
+                ['space']
               );
 
               const callCluster = clusterClient.asScoped(request).callAsCurrentUser;
 
-              const callWithRequestRepository = savedObjects.getSavedObjectsRepository(callCluster);
+              const callWithRequestRepository = savedObjects.getSavedObjectsRepository(
+                callCluster,
+                ['space']
+              );
 
               const authorization = security.isEnabled ? security.authorization : null;
 

diff --git a/x-pack/test/api_integration/apis/index.js b/x-pack/test/api_integration/apis/index.js
@@ -12,6 +12,7 @@ export default function ({ loadTestFile }) {
     loadTestFile(require.resolve('./alerting'));
     loadTestFile(require.resolve('./es'));
     loadTestFile(require.resolve('./security'));
+    loadTestFile(require.resolve('./spaces'));
     loadTestFile(require.resolve('./monitoring'));
     loadTestFile(require.resolve('./xpack_main'));
     loadTestFile(require.resolve('./telemetry'));