Copy Saved Objects to Spaces API by legrego · Pull Request #38014 · elastic/kibana

legrego · 2019-06-04T16:43:15Z

Summary

Introduces an API to allow saved objects to be copied from one space to other spaces.

The API design closely follows the Import & Resolve Import Errors Saved Objects APIs, with the following notable exception:

The "resolve import errors" api allows callers to replace references to index patterns and saved searches. The corresponding Copy saved objects "conflict resolution" endpoint does not allow for such behavior, as the primary consumer (the UI) would need a way to do a cross-space search of these objects. While we could technically put something in place, a more holistic solution would be preferred, such as #27003

Copy saved objects endpoints:

POST /api/spaces/_copy_saved_objects - copy objects from the default space.
POST /s/my-space/api/spaces/_copy_saved_objects - copy objects from the my-space space.

Sample request payload

{
	"spaces": ["space-1", "space-3"],
	"objects": [{
		"type": "dashboard",
		"id": "7adfa750-4c81-11e8-b3d7-01146121b73d"
	}],
	"overwrite": true,
	"includeReferences": true
}

Copy saved objects "conflict resolution" endpoints:

POST /api/spaces/_resolve_copy_saved_objects_errors - resolve copy conflicts from the default space.
POST /s/my-space/api/spaces/_resolve_copy_saved_objects_errors - resolve copy conflicts from the my-space space.

Sample request payload

{
	"objects": [{
		"type": "dashboard",
		"id": "7adfa750-4c81-11e8-b3d7-01146121b73d"
	}],
	"includeReferences": true,
    "retries": {
		"space-1": [{
          "type": "index-pattern",
          "id": "foo",
          "overwrite": true
       }]
	}
}

src/legacy/server/saved_objects/export/objects_to_ndjson.ts

src/legacy/server/saved_objects/saved_objects_mixin.js

x-pack/plugins/security/index.js

x-pack/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.ts

x-pack/plugins/spaces/server/lib/spaces_client.ts

legrego · 2019-06-04T20:39:03Z

retest

…o-space-api

legrego · 2019-06-05T14:16:53Z

@kobelb here's one possible implementation, using the approach you offered here where we swap the security and spaces SOC wrapper orders. It's by no means review-ready, it's just meant to convey the general approach. Thoughts on what we have here before I flesh this out further?

elasticmachine · 2019-06-05T15:27:00Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

x-pack/plugins/security/server/lib/authorization/check_privileges_dynamically.ts

...ty/server/lib/authorization/privileges/feature_privilege_builder/saved_objects_management.ts

x-pack/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.ts

…o-space-api

elasticmachine · 2019-07-09T18:11:31Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…o-space-api

elasticmachine · 2019-07-15T16:28:25Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…o-space-api

elasticmachine · 2019-08-20T12:42:10Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-20T13:44:59Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-20T15:28:32Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

legrego · 2019-08-20T15:42:42Z

Retest

elasticmachine · 2019-08-20T16:52:25Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

legrego · 2019-08-20T17:37:05Z

@kobelb thanks for the test review - much appreciated! I think I've addressed all of your feedback if you're able to take another look.

legrego · 2019-08-21T14:47:51Z

If there are additional non-critical findings with the tests, I would prefer to merge this sooner rather than later in order to get #39002 in a reviewable state ASAP. We can address findings in a followup post-FF

kobelb · 2019-08-21T14:47:12Z

x-pack/legacy/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.test.ts

+          attributes: {},
+        },
+      ],
+      importSavedObjectsImpl: opts => {


Overwriting this removes this check expect(objectsToImport).toEqual(setupOpts.objects);.

It does... my thinking here was that it wasn't creating any meaningful gaps, since the override is only used to test specific failure conditions. I'll update regardless.

kobelb · 2019-08-21T14:50:15Z

x-pack/legacy/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.test.ts

+            `);
+
+    expect((savedObjectsService.importExport.importSavedObjects as jest.Mock).mock.calls)
+      .toMatchInlineSnapshot(`


Personally, I'm not overly fond of using jest's snapshots for stuff like this... It requires that we supplement it with another expectation and can lead to hard to understand failures. I don't necessarily think we need to change this now, but I'd prefer we have an offline discussion with @azasypkin to figure out when/where we want to use the snapshotting functionality in the future.

kobelb · 2019-08-21T14:52:02Z

x-pack/legacy/plugins/spaces/server/lib/copy_to_spaces/resolve_copy_conflicts.test.ts

+          attributes: {},
+        },
+      ],
+      resolveImportErrorsImpl: opts => {


Specifying this removes this check: expect(objectsToResolve).toEqual(setupOpts.objects); from above.

kobelb · 2019-08-21T14:53:40Z

x-pack/legacy/plugins/spaces/server/lib/spaces_client/spaces_client.test.ts

-  describe('useRbacForRequest is true', () => {
-    test(`throws Boom.forbidden when user isn't authorized for any spaces`, async () => {
-      const username = Symbol();
+    test(`ignores the provided purpose`, async () => {


Should we be throwing an error when there's an invalid purpose when useRbac is false? It feels like this would be more consistent.

Sure, I'm fine either way

elasticmachine · 2019-08-21T16:38:35Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

kobelb · 2019-08-21T16:39:26Z

retest

legrego · 2019-08-21T17:35:20Z

retest

elasticmachine · 2019-08-21T18:43:23Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…o-space-api

elasticmachine · 2019-08-21T20:01:20Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

legrego · 2019-08-21T20:10:11Z

retest

elasticmachine · 2019-08-21T21:27:35Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

POC for copy-to-space

0051703

legrego commented Jun 4, 2019

View reviewed changes

x-pack/plugins/spaces/server/lib/spaces_client.ts Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

legrego added 2 commits June 5, 2019 07:02

fix typings

d6d18b0

update import/export tests

a3109ce

This comment has been minimized.

Sign in to view

Merge branch 'master' of github.com:elastic/kibana into spaces/copy-t…

9590fd2

…o-space-api

kobelb self-requested a review June 5, 2019 14:40

kobelb reviewed Jun 5, 2019

View reviewed changes

x-pack/plugins/security/server/lib/authorization/check_privileges_dynamically.ts Outdated Show resolved Hide resolved

...ty/server/lib/authorization/privileges/feature_privilege_builder/saved_objects_management.ts Outdated Show resolved Hide resolved

kobelb reviewed Jun 5, 2019

View reviewed changes

x-pack/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.ts Outdated Show resolved Hide resolved

This was referenced Jun 10, 2019

Feature Controls - Simplify Saved Objects Management UI Capabilities #38461

Merged

Spaces - Copy Saved Objects to Spaces UI #39002

Merged

legrego mentioned this pull request Jun 26, 2019

Saved Objects - make import/export stream based #39674

Merged

legrego added 2 commits July 9, 2019 12:19

Merge branch 'master' of github.com:elastic/kibana into spaces/copy-t…

48cbd59

…o-space-api

fix merge from master

6054610

legrego added 5 commits July 15, 2019 09:32

Merge branch 'master' of github.com:elastic/kibana into spaces/copy-t…

9278c15

…o-space-api

reintroduce spaces SOC namespace check

3135f8b

export new SOC typedefs

5b041e1

fix import/export module resolution

53ae63e

use new excludedWrappers option

445c0f3

legrego added 3 commits July 22, 2019 14:04

rename ImportError -> SavedObjectsImportError for exportability

505b1f7

cleanup

05b79ba

allow resolve_import_errors to accept an optional namespace

deb66b5

legrego added 5 commits August 20, 2019 07:26

testing readStreamToCompletion and createReadableStreamFromArray

393f8e6

verify the correct number of spaces were copied into

23fdb80

add missing tests

76dbdc0

Merge branch 'master' of github.com:elastic/kibana into spaces/copy-t…

61df1e2

…o-space-api

fix test suite name

d913b59

fixing test reference

0acb332

fix it again

302230c

kobelb reviewed Aug 21, 2019

View reviewed changes

addressing feedback

37ac143

kobelb approved these changes Aug 21, 2019

View reviewed changes

Merge branch 'master' of github.com:elastic/kibana into spaces/copy-t…

5c467ba

…o-space-api

legrego merged commit 608e239 into elastic:master Aug 21, 2019

legrego deleted the spaces/copy-to-space-api branch August 21, 2019 21:27

legrego mentioned this pull request Aug 21, 2019

[7.x] Copy Saved Objects to Spaces API (#38014) #43723

Merged

legrego added a commit to legrego/kibana that referenced this pull request Aug 21, 2019

Copy Saved Objects to Spaces API (elastic#38014)

3e60810

legrego added a commit that referenced this pull request Aug 21, 2019

Copy Saved Objects to Spaces API (#38014) (#43723)

19b3941

Conversation

legrego commented Jun 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Copy saved objects endpoints:

Sample request payload

Copy saved objects "conflict resolution" endpoints:

Sample request payload

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

legrego commented Jun 4, 2019

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

legrego commented Jun 5, 2019

Uh oh!

elasticmachine commented Jun 5, 2019

💚 Build Succeeded

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Jul 9, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 15, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Aug 20, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Aug 20, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Aug 20, 2019

💔 Build Failed

Uh oh!

legrego commented Aug 20, 2019

Uh oh!

elasticmachine commented Aug 20, 2019

💚 Build Succeeded

Uh oh!

legrego commented Aug 20, 2019

Uh oh!

legrego commented Aug 21, 2019

Uh oh!

kobelb Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

legrego Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

kobelb Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

kobelb Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

kobelb Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

legrego Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Aug 21, 2019

💔 Build Failed

Uh oh!

kobelb commented Aug 21, 2019

Uh oh!

legrego commented Aug 21, 2019

Uh oh!

elasticmachine commented Aug 21, 2019

💔 Build Failed

Uh oh!

legrego commented Jun 4, 2019 •

edited

Loading