[Saved Objects Management] Encapsulate saved objects deletion behind an API endpoint #148602

dokmic · 2023-01-09T22:51:16Z

Summary

Resolves #148615.

The API endpoint delegates the delete operation to the bulkDelete (#139680) method of the SO client on the server.

Checklist

Unit or functional tests were updated or added to match the most common scenarios

…en objects

elasticmachine · 2023-01-10T13:42:19Z

Pinging @elastic/kibana-core (Team:Core)

TinaHeiligers

Overall, great work!

We need to make sure we don't accidentally call bulk_delete for hidden saved objects. The API won't recognize those and we should give the impression that one can delete hidden objects from SOM.

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

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

TinaHeiligers · 2023-01-10T23:46:17Z

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

+    deleteStatus
+      .filter(({ success }) => !success)
+      .forEach(({ id, type, error }) => {
+        notifications.toasts.addDanger({


Adding a toast for every failed delete is going to get very noisy for large payloads. It's not a problem for single-item deletes but might cause toast floods for multiple delete failures.

Alright, I've updated the code to show a single toast only. But I have some concerns that it's better. It seems like we are hiding from the user all the errors we've got during the deletion.
IMO, it's okay to show a toast per each failed operation as we perform it only for the manually selected objects which should not be more than 50 in the worst case.

which should not be more than 50 in the worst case

With anything related to saved objects, we cannot assume that. If there aren't any objections from other members of the team, go with what you 'feel' is right.

TinaHeiligers · 2023-01-10T23:50:20Z

src/plugins/saved_objects_management/public/lib/bulk_delete_objects.ts

+  http: HttpStart,
+  objects: SavedObjectDeleteRequest[]
+): Promise<SavedObjectDeleteStatus[]> {
+  return http.post<SavedObjectDeleteStatus[]>('/api/kibana/management/saved_objects/_bulk_delete', {


The repository won't recognize hidden saved object types as those aren't recognized as registered unless the hidden types are included. We're not instantiating the client with any hidden types and will need to filter these out in a similar manner as:
https://github.com/elastic/kibana/pull/148602/files#diff-47d724c5a7bb6e8c1286f67e3ed1b117ac27e05387052760388bd477bd76337bL525

const deletes = selectedSavedObjects .filter((object) => !object.meta.hiddenType) .map((object) => savedObjectsClient.delete(object.type, object.id, { force: true })); await Promise.all(deletes);

Now that we have a dedicated endpoint, we could use a custom client with all hidden types. Not sure if we should, though.

I implemented that at first but then removed it to keep the existing behavior exactly the same. Just wanted to confirm whether should we ever provide such an option as hidden objects deletion.

Just wanted to confirm whether should we ever provide such an option as hidden objects deletion.

Right now, IMHO, no. There are far too many issues that could cause. Type owners specifically register their saved objects as hidden to implement their own APIs and handle dependencies themselves. I don't think we could or even should bypass that and blindly allow users to shoot themselves in the foot. Preventing issues from editing saved objects in SOM is why we changed the edit to view-only in the first place.

Maybe, if we had object-level security we could implement it or even some other "advanced, super scary uber auth" where we have a registry of hidden types' delete APIs to use as the underlying implementation?

+1 to keep the behaviour as is. In general / long term, I would lean towards removing the delete ability for most types in management and moving that to their listing UIs which I think is also part of content management's vision.

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

src/plugins/saved_objects_management/public/lib/bulk_delete_objects.ts

pgayvallet · 2023-01-17T08:25:42Z

src/plugins/saved_objects_management/public/lib/bulk_delete_objects.ts

+  http: HttpStart,
+  objects: SavedObjectDeleteRequest[]
+): Promise<SavedObjectDeleteStatus[]> {
+  return http.post<SavedObjectDeleteStatus[]>('/api/kibana/management/saved_objects/_bulk_delete', {


Now that we have a dedicated endpoint, we could use a custom client with all hidden types. Not sure if we should, though.

src/plugins/saved_objects_management/public/lib/bulk_delete_objects.ts

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

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

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

+    deleteStatus
+      .filter(({ success }) => !success)
+      .forEach(({ id, type, error }) => {
+        notifications.toasts.addDanger({


…sages per each object

dokmic · 2023-01-18T20:56:50Z

@TinaHeiligers @pgayvallet I've updated the PR with some fixes based on your feedback. Would you mind taking another look?

TinaHeiligers

I still need to pull the branch and test

TinaHeiligers

Code LGTM!

kibana-ci · 2023-01-19T12:00:14Z

💚 Build Succeeded

Buildkite Build
Commit: e8eb772

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`savedObjectsManagement`	78	79	+1

Async chunks

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

id	before	after	diff
`savedObjectsManagement`	83.9KB	84.6KB	+663.0B

Page load bundle

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

id	before	after	diff
`savedObjectsManagement`	19.3KB	19.4KB	+85.0B

Unknown metric groups

References to deprecated APIs

id	before	after	diff
`savedObjectsManagement`	157	149	-8

History

💔 Build #101224 failed 8e2dd86046991ad5fd73f36aac906aa784a55a98
💚 Build #99155 succeeded 7b579b573f7263abc9897d46fba30a7bfd401fdb
💔 Build #98996 failed 9ab433233de5d9d0497ec0c48c712e65592e7de0

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

…an API endpoint (elastic#148602)

## Summary Part of preparing HTTP APIs and associated interfaces for versioning: * Add domain-specific interfaces to the saved object management plugin * Add a V1 interface of domain types to `common` * Remove use of deprecated `SavedObject` type from public * Follows on from #148602 Related #149098 Fixes #149495 --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

dokmic added 5 commits January 4, 2023 14:56

Add bulk delete endpoint to the saved objects management API

7a0d6e2

Update single saved object view to use deletion endpoint

8c19806

Update saved objects table to use deletion endpoint

2ec3f0e

Prevent bulk deletion endpoint from deleting hidden types

8d3f3ca

Fix deletion in the saved objects table not to attempt to delete hidd…

81e2700

…en objects

dokmic added review Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:skip Skip the PR/issue when compiling release notes Feature:Saved Objects Management v8.7.0 labels Jan 9, 2023

dokmic force-pushed the feature/KBNA-7991 branch from 9ab4332 to 22899e3 Compare January 10, 2023 11:57

dokmic marked this pull request as ready for review January 10, 2023 13:42

dokmic requested a review from a team as a code owner January 10, 2023 13:42

dokmic requested review from TinaHeiligers and rudolf January 10, 2023 13:46

TinaHeiligers requested changes Jan 11, 2023

View reviewed changes

pgayvallet reviewed Jan 17, 2023

View reviewed changes

dokmic added 3 commits January 18, 2023 16:51

Update toast to show a number of deleted objects instead of error mes…

eeeca57

…sages per each object

Rename bulk delete API endpoint to internal

2e4e4b6

Fix used saved objects types

e8eb772

dokmic force-pushed the feature/KBNA-7991 branch from 7b579b5 to 607c3b6 Compare January 18, 2023 20:47

TinaHeiligers reviewed Jan 19, 2023

View reviewed changes

TinaHeiligers self-requested a review January 19, 2023 00:08

TinaHeiligers approved these changes Jan 19, 2023

View reviewed changes

dokmic force-pushed the feature/KBNA-7991 branch from 8e2dd86 to e8eb772 Compare January 19, 2023 10:58

pgayvallet approved these changes Jan 19, 2023

View reviewed changes

dokmic merged commit 091b15e into elastic:main Jan 19, 2023

kibanamachine added the backport:skip This commit does not require backporting label Jan 19, 2023

dokmic deleted the feature/KBNA-7991 branch January 19, 2023 14:05

wayneseymour pushed a commit to wayneseymour/kibana that referenced this pull request Jan 19, 2023

[Saved Objects Management] Encapsulate saved objects deletion behind …

e88e88d

…an API endpoint (elastic#148602)

jloleysens mentioned this pull request Jan 25, 2023

[Saved objects] Prepare SO management for versionable types #149495

Merged

TinaHeiligers mentioned this pull request Jan 30, 2023

Saved Objects Management: Delegate delete actions to listing page for most types #149881

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Saved Objects Management] Encapsulate saved objects deletion behind an API endpoint #148602

[Saved Objects Management] Encapsulate saved objects deletion behind an API endpoint #148602

dokmic commented Jan 9, 2023 •

edited

Loading

elasticmachine commented Jan 10, 2023

TinaHeiligers left a comment

TinaHeiligers Jan 10, 2023 •

edited

Loading

This comment was marked as resolved.

dokmic Jan 18, 2023

TinaHeiligers Jan 19, 2023

TinaHeiligers Jan 10, 2023

pgayvallet Jan 17, 2023

dokmic Jan 17, 2023

TinaHeiligers Jan 17, 2023

rudolf Jan 19, 2023 •

edited

Loading

pgayvallet Jan 17, 2023

This comment was marked as resolved.

dokmic commented Jan 18, 2023

TinaHeiligers left a comment

TinaHeiligers left a comment

kibana-ci commented Jan 19, 2023

References to deprecated APIs

[Saved Objects Management] Encapsulate saved objects deletion behind an API endpoint #148602

[Saved Objects Management] Encapsulate saved objects deletion behind an API endpoint #148602

Conversation

dokmic commented Jan 9, 2023 • edited Loading

Summary

Checklist

elasticmachine commented Jan 10, 2023

TinaHeiligers left a comment

Choose a reason for hiding this comment

TinaHeiligers Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

dokmic Jan 18, 2023

Choose a reason for hiding this comment

TinaHeiligers Jan 19, 2023

Choose a reason for hiding this comment

TinaHeiligers Jan 10, 2023

Choose a reason for hiding this comment

pgayvallet Jan 17, 2023

Choose a reason for hiding this comment

dokmic Jan 17, 2023

Choose a reason for hiding this comment

TinaHeiligers Jan 17, 2023

Choose a reason for hiding this comment

rudolf Jan 19, 2023 • edited Loading

Choose a reason for hiding this comment

pgayvallet Jan 17, 2023

Choose a reason for hiding this comment

This comment was marked as resolved.

dokmic commented Jan 18, 2023

TinaHeiligers left a comment

Choose a reason for hiding this comment

TinaHeiligers left a comment

Choose a reason for hiding this comment

kibana-ci commented Jan 19, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

References to deprecated APIs

History

dokmic commented Jan 9, 2023 •

edited

Loading

TinaHeiligers Jan 10, 2023 •

edited

Loading

rudolf Jan 19, 2023 •

edited

Loading