Sharing saved objects phase 3.5 #100424

jportner · 2021-05-20T21:06:48Z

Changes

Primary changes are:

Updated Share to Space flyout:
- Changed design
- Now shares the target object and all of its references (excluding tags)
- Now disables legacy URL aliases when they exist in target space(s)
Updated Saved Object Management "Delete" modal to indicate when objects are shared

Add usage data collection:

core.services.savedObjects.legacyUrlAliases.activeCount
core.services.savedObjects.legacyUrlAliases.inactiveCount
core.services.savedObjects.legacyUrlAliases.disabledCount
core.services.savedObjects.legacyUrlAliases.totalCount
core.savedObjectsRepository.resolvedOutcome.exactMatch
core.savedObjectsRepository.resolvedOutcome.aliasMatch
core.savedObjectsRepository.resolvedOutcome.conflict
core.savedObjectsRepository.resolvedOutcome.notFound
core.savedObjectsRepository.resolvedOutcome.total
spaces.apiCalls.disableLegacyUrlAliases.total

Updated client-side SavedObjectsClient to support resolve API and namespaces field (will be needed for future consumers)

Screenshots

Click to expand

Share with relatives:

Share and disable aliases:

Delete modal:

Manual testing procedures

A. Setup:

Uncomment code to enable Spaces column in Saved Object Mgmt page:

Click to show diff

diff --git a/x-pack/plugins/spaces/public/share_saved_objects_to_space/share_saved_objects_to_space_service.ts b/x-pack/plugins/spaces/public/share_saved_objects_to_space/share_saved_objects_to_space_service.ts
index bc703477604..c59c857beb9 100644
--- a/x-pack/plugins/spaces/public/share_saved_objects_to_space/share_saved_objects_to_space_service.ts
+++ b/x-pack/plugins/spaces/public/share_saved_objects_to_space/share_saved_objects_to_space_service.ts
@@ -9,7 +9,7 @@ import type { SavedObjectsManagementPluginSetup } from 'src/plugins/saved_object
 import type { SpacesApiUi } from 'src/plugins/spaces_oss/public';
 
 import { ShareToSpaceSavedObjectsManagementAction } from './share_saved_objects_to_space_action';
-// import { ShareToSpaceSavedObjectsManagementColumn } from './share_saved_objects_to_space_column';
+import { ShareToSpaceSavedObjectsManagementColumn } from './share_saved_objects_to_space_column';
 
 interface SetupDeps {
   savedObjectsManagementSetup: SavedObjectsManagementPluginSetup;
@@ -21,7 +21,7 @@ export class ShareSavedObjectsToSpaceService {
     const action = new ShareToSpaceSavedObjectsManagementAction(spacesApiUi);
     savedObjectsManagementSetup.actions.register(action);
     // Note: this column is hidden for now because no saved objects are shareable. It should be uncommented when at least one saved object type is multi-namespace.
-    // const column = new ShareToSpaceSavedObjectsManagementColumn(spacesApiUi);
-    // savedObjectsManagementSetup.columns.register(column);
+    const column = new ShareToSpaceSavedObjectsManagementColumn(spacesApiUi);
+    savedObjectsManagementSetup.columns.register(column);
   }
 }

Install the Sharing Saved Objects Test Plugin
Start Kibana
Navigate to the "barney" app and generate new toys

Navigate to Kibana Dev Tools and create the 26 test spaces:

Click to show command

POST .kibana/_bulk
{"index":{"_id":"space:alpha"}}
{"space":{"name":"Alpha","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:01.830Z"}
{"index":{"_id":"space:bravo"}}
{"space":{"name":"Bravo","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:02.591Z"}
{"index":{"_id":"space:charlie"}}
{"space":{"name":"Charlie","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:03.587Z"}
{"index":{"_id":"space:delta"}}
{"space":{"name":"Delta","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:04.604Z"}
{"index":{"_id":"space:echo"}}
{"space":{"name":"Echo","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:05.616Z"}
{"index":{"_id":"space:foxtrot"}}
{"space":{"name":"Foxtrot","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:06.630Z"}
{"index":{"_id":"space:golf"}}
{"space":{"name":"Golf","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:07.650Z"}
{"index":{"_id":"space:hotel"}}
{"space":{"name":"Hotel","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:08.664Z"}
{"index":{"_id":"space:india"}}
{"space":{"name":"India","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:09.688Z"}
{"index":{"_id":"space:juliett"}}
{"space":{"name":"Juliett","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:10.711Z"}
{"index":{"_id":"space:kilo"}}
{"space":{"name":"Kilo","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:11.727Z"}
{"index":{"_id":"space:lima"}}
{"space":{"name":"Lima","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:12.743Z"}
{"index":{"_id":"space:mike"}}
{"space":{"name":"Mike","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:13.755Z"}
{"index":{"_id":"space:november"}}
{"space":{"name":"November","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:14.770Z"}
{"index":{"_id":"space:oscar"}}
{"space":{"name":"Oscar","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:15.791Z"}
{"index":{"_id":"space:papa"}}
{"space":{"name":"Papa","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:16.802Z"}
{"index":{"_id":"space:quebec"}}
{"space":{"name":"Quebec","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:17.820Z"}
{"index":{"_id":"space:romeo"}}
{"space":{"name":"Romeo","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:18.842Z"}
{"index":{"_id":"space:sierra"}}
{"space":{"name":"Sierra","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:19.849Z"}
{"index":{"_id":"space:tango"}}
{"space":{"name":"Tango","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:20.868Z"}
{"index":{"_id":"space:uniform"}}
{"space":{"name":"Uniform","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:21.876Z"}
{"index":{"_id":"space:victor"}}
{"space":{"name":"Victor","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:22.904Z"}
{"index":{"_id":"space:whiskey"}}
{"space":{"name":"Whiskey","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:23.921Z"}
{"index":{"_id":"space:x-ray"}}
{"space":{"name":"X-ray","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:24.937Z"}
{"index":{"_id":"space:yankee"}}
{"space":{"name":"Yankee","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:25.948Z"}
{"index":{"_id":"space:zulu"}}
{"space":{"name":"Zulu","disabledFeatures":[]},"type":"space","references":[],"migrationVersion":{"space":"6.6.0"},"coreMigrationVersion":"8.0.0","updated_at":"2021-06-17T14:50:26.963Z"}

Navigate to the Saved Objects Management screen

B. Share an object with references:

Each of the four Army Men objects has a reference to the other three. If you share one of them, the other three should be shared too.

Share one of the Army Men objects to any other space
Note that at the bottom of the Share flyout, three other related objects (the other Army Men) are included when you share
Select other space(s) and click Save & Continue
Note each of the Army Men have been updated on the screen

C. Share an object and disable legacy URL aliases

The Sheriff Woody object has legacy URL aliases in 27 spaces: 26 for the alphabet (Alpha, Bravo, Charlie, etc.), and one in an additional space (---).

Open your browser's developer tools to track network requests
Share the Sheriff Woody object, select the Alpha space, and click Continue
Note that on the next screen, the flyout will indicate that an alias will be disabled in the Alpha space; click Save & Close
In your browser's developer tools, note that the alias in the Alpha space was disabled
Share the Sheriff Woody object again, this time select "All spaces" and click Continue
Note that on the next screen, the flyout will indicate that an alias will be disabled in 25 spaces (Bravo, Charlie, ..., Zulu); click Save & Close
In your browser's developer tools, note that 26 aliases were disabled; these are the 25 aliases for Bravo through Zulu, and additionally the alias for the --- space which does not exist

This is used in feature-specific contexts for SpaceList and ShareToSpaceFlyout components, so the rendered avatar for a space is in a disabled state if the feature is disabled in that space.

…ient Add support for `resolve` method to the public SOC client abstraction. This was overlooked in Sharing Saved Objects Phase 2 because it does not use the same type definitions as the server-side SOC client. Also added the `namespaces` field to the SimpleSavedObject type, which is always present as of several releases ago.

A user is authorized to change a legacy URL alias if they are have privileges to modify the target object. TODO: add an HTTP route for this API

Before, only the target object would be updated.

When sharing an object, we include all of its references *except* for tags. Note, this does not preclude tags from being shared directly.

jportner · 2021-06-02T00:00:13Z

@legrego @watson this is ready for a draft review whenever you are ready.

What changes are already included:

Several design changes to the Share flyout
Addition of "disableLegacyUrlAliases" API (and HTTP route) for SpacesClient
Change Share flyout to update spaces for the target object and all of its references (excluding tags)

Next I have to add:

The additional Flyout screen to prevent alias conflicts while sharing
Small update to the SavedObjectsManagement "Delete" modal to ~~allow shared objects to be deleted~~ warn users when they are about to delete shared objects
Usage data for aliases

For the usage data, I think we could just add another counter value for the "disableLegacyUrlAliases" HTTP API route and call it a day. Thoughts?

legrego

General code/structure looks good to me. I haven't manually tested this yet, but I'll do so once you have the rest of the UI changes in place.

For the usage data, I think we could just add another counter value for the "disableLegacyUrlAliases" HTTP API route and call it a day. Thoughts?

What types of questions do we want to answer with this information? If I understand correctly, this would just tell us how often the endpoint was called, but not how many aliases have been disabled.

...plugins/saved_objects_management/public/management_section/object_view/saved_object_view.tsx

...ins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx

x-pack/plugins/security/server/spaces/secure_spaces_client_wrapper.ts

x-pack/plugins/spaces/public/space_avatar/space_avatar_internal.tsx

x-pack/plugins/spaces/public/spaces_manager/spaces_manager.ts

These were broken after the latest merge from master.

jportner · 2021-06-10T22:09:04Z

What types of questions do we want to answer with this information? If I understand correctly, this would just tell us how often the endpoint was called, but not how many aliases have been disabled.

After thinking on it some more, we probably want to be able to answer:

How many aliases exist?
How many aliases are disabled?
How many aliases are being used (!disabled && resolveCounter > 0)?
How often are users experiencing the different resolve alias outcomes? (exact match, alias match, conflict)
How often do users need to disable aliases (in other words: how often are we preventing alias conflicts from occurring)?

We already have standard Core usage stats fields for the /internal/saved_objects/resolve/{type}/{id} HTTP route. However, it's very likely that consumers will implement their own routes to resolve their objects with the SOC.

For questions 1-3: we should update the Core usage data service to fetch alias data from the Kibana index to answer the first three questions.

For question 4: we should add the following Core usage stats fields that are incremented whenever SOR.resolve is called:

core.savedObjects.resolved.exactMatchOutcome
core.savedObjects.resolved.aliasMatchOutcome
core.savedObjects.resolved.conflictOutcome
core.savedObjects.resolved.total

For question 5: we should add the following Spaces usage stats field that is incremented whenever the /api/spaces/_disable_legacy_url_aliases HTTP route is called:

spaces.apiCalls.disableLegacyUrlAliases.total

Thoughts?

...plugins/saved_objects_management/public/management_section/object_view/saved_object_view.tsx

x-pack/plugins/security/server/spaces/secure_spaces_client_wrapper.ts

x-pack/plugins/spaces/public/share_saved_objects_to_space/components/relatives_control.tsx

.../plugins/spaces/public/share_saved_objects_to_space/components/selectable_spaces_control.tsx

...plugins/spaces/public/share_saved_objects_to_space/components/selectable_spaces_control.scss

...ins/spaces/public/share_saved_objects_to_space/components/share_to_space_flyout_internal.tsx

pgayvallet

You can never be sure with SO features, but LGTM

legrego

LGTM!

...plugins/spaces/public/share_saved_objects_to_space/components/selectable_spaces_control.scss

jportner · 2021-06-28T16:54:45Z

@elasticmachine merge upstream

jportner · 2021-06-28T18:10:14Z

@elasticmachine merge upstream

jportner · 2021-06-28T18:39:47Z

@elasticmachine merge upstream

jportner · 2021-06-28T19:03:47Z

@elasticmachine merge upstream

jportner · 2021-06-28T19:57:37Z

@elasticmachine merge upstream

kibanamachine · 2021-06-28T22:06:51Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`savedObjectsManagement`	78	79	+1
`spaces`	249	251	+2
total			+3

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`core`	1055	1056	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`ml`	5.9MB	5.9MB	+9.0B
`savedObjectsManagement`	138.9KB	141.9KB	+3.0KB
`spaces`	272.8KB	279.8KB	+6.9KB
total			+10.0KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	417.2KB	417.7KB	+531.0B
`spaces`	41.6KB	42.3KB	+712.0B
total			+1.2KB

Saved Objects .kibana field count

Every field in each saved object type adds overhead to Elasticsearch. Kibana needs to keep the total field count below Elasticsearch's default limit of 1000 fields. Only specify field mappings for the fields you wish to search on or query. See https://www.elastic.co/guide/en/kibana/master/development-plugin-saved-objects.html#_mappings

id	before	after	diff
`legacy-url-alias`	4	5	+1

Unknown metric groups

API count

id	before	after	diff
`core`	2284	2296	+12
`spaces`	96	106	+10
`spacesOss`	71	72	+1
total			+23

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kibanamachine · 2021-06-28T22:27:05Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>

jportner force-pushed the sharing-saved-objects-phase-3.5 branch 4 times, most recently from d82b858 to 64c8014 Compare May 31, 2021 14:03

jportner mentioned this pull request Jun 1, 2021

Sharing saved-objects in multiple spaces #27004

Closed

jportner added 10 commits June 1, 2021 19:48

Expose EuiAvatar's isDisabled property to be usable for SpaceAvatar

b923c05

This is used in feature-specific contexts for SpaceList and ShareToSpaceFlyout components, so the rendered avatar for a space is in a disabled state if the feature is disabled in that space.

Do not render loading spinner when waiting for flyout

2ffc0ff

Change ShareModeControl to use button group instead of checkable cards

adaae05

Add description of relatives in footer

b2fe20c

Stretch selectable spaces control vertically

71c10a7

Add SpacesClient API to disable legacy URL aliases

b101900

A user is authorized to change a legacy URL alias if they are have privileges to modify the target object. TODO: add an HTTP route for this API

Change Share flyout to update the object and all of its references

863e69c

Before, only the target object would be updated.

Exclude tags from shared references

7e61185

When sharing an object, we include all of its references *except* for tags. Note, this does not preclude tags from being shared directly.

Change Share flyout title

fc2f7d2

jportner force-pushed the sharing-saved-objects-phase-3.5 branch from 64c8014 to bc7e2fa Compare June 1, 2021 23:51

jportner requested review from legrego and watson June 2, 2021 00:00

jportner added 2 commits June 1, 2021 20:18

When an object is shared, refresh all objects that have been updated

b01887e

Add HTTP route for disableLegacyUrlAliases API

ce1a020

jportner force-pushed the sharing-saved-objects-phase-3.5 branch from bc7e2fa to ce1a020 Compare June 2, 2021 00:19

legrego reviewed Jun 7, 2021

View reviewed changes

jportner added 3 commits June 10, 2021 12:18

Merge branch 'master' into pr/jportner/100424

51c2aa4

Fix security plugin contract types and mocks

70ab7a2

These were broken after the latest merge from master.

PR review feedback

b81a720

Fix tests

31c99d4

jportner linked an issue Jun 11, 2021 that may be closed by this pull request

Deleting shared saved objects #81605

Closed

Update delete modal to show shared objects warning

72906df

legrego reviewed Jun 21, 2021

View reviewed changes

PR review feedback

8e10636

pgayvallet approved these changes Jun 22, 2021

View reviewed changes

legrego approved these changes Jun 22, 2021

View reviewed changes

...plugins/spaces/public/share_saved_objects_to_space/components/selectable_spaces_control.scss Outdated Show resolved Hide resolved

jportner added 2 commits June 23, 2021 15:50

Merge branch 'master' into pr/jportner/100424

c7dfd68

Merge branch 'master' into pr/jportner/100424

84318e8

mshustov approved these changes Jun 28, 2021

View reviewed changes

Merge branch 'master' into sharing-saved-objects-phase-3.5

0c34e2b

jportner enabled auto-merge (squash) June 28, 2021 16:55

Merge branch 'master' into sharing-saved-objects-phase-3.5

1db9ec1

Merge branch 'master' into sharing-saved-objects-phase-3.5

c38dcb6

Merge branch 'master' into sharing-saved-objects-phase-3.5

9dc1612

Merge branch 'master' into sharing-saved-objects-phase-3.5

4893d32

jportner merged commit 1965315 into elastic:master Jun 28, 2021

jportner deleted the sharing-saved-objects-phase-3.5 branch June 28, 2021 22:23

jportner added the auto-backport Deprecated - use backport:version if exact versions are needed label Jun 28, 2021

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 28, 2021

Sharing saved objects phase 3.5 (elastic#100424)

bf624b1

kibanamachine mentioned this pull request Jun 28, 2021

[7.x] Sharing saved objects phase 3.5 (#100424) #103575

Merged

kibanamachine added a commit that referenced this pull request Jun 29, 2021

Sharing saved objects phase 3.5 (#100424) (#103575)

06313f3

Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>

jportner mentioned this pull request Jul 28, 2021

Better ux for "include related objects" checkbox for copy saved objects between spaces panel #106932

Open

jportner mentioned this pull request Aug 13, 2021

[Fleet] Package assets should not break when installed within a space #74353

Closed

9 tasks

jportner mentioned this pull request Sep 27, 2021

POC - Sharing index patterns #95958

Closed

jportner added the Feature:Security/Sharing Saved Objects Platform Security - Sharing Saved Objects feature label Oct 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sharing saved objects phase 3.5 #100424

Sharing saved objects phase 3.5 #100424

jportner commented May 20, 2021 •

edited

Loading

jportner commented Jun 2, 2021 •

edited

Loading

legrego left a comment

jportner commented Jun 10, 2021 •

edited

Loading

pgayvallet left a comment

legrego left a comment

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

kibanamachine commented Jun 28, 2021

API count

kibanamachine commented Jun 28, 2021

Sharing saved objects phase 3.5 #100424

Sharing saved objects phase 3.5 #100424

Conversation

jportner commented May 20, 2021 • edited Loading

Changes

Screenshots

Share with relatives:

Share and disable aliases:

Delete modal:

Manual testing procedures

A. Setup:

B. Share an object with references:

C. Share an object and disable legacy URL aliases

jportner commented Jun 2, 2021 • edited Loading

legrego left a comment

Choose a reason for hiding this comment

jportner commented Jun 10, 2021 • edited Loading

pgayvallet left a comment

Choose a reason for hiding this comment

legrego left a comment

Choose a reason for hiding this comment

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

jportner commented Jun 28, 2021

kibanamachine commented Jun 28, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

Saved Objects .kibana field count

API count

History

kibanamachine commented Jun 28, 2021

💚 Backport successful

jportner commented May 20, 2021 •

edited

Loading

jportner commented Jun 2, 2021 •

edited

Loading

jportner commented Jun 10, 2021 •

edited

Loading