Audit of Tasking for AppSvc on Breaking Saved Object ID Type Conversions

[petrklapka]

Conduct an audit of tasks that need to be performed within AppSvc Domains for the
[Meta] Breaking saved object type conversions in 8.0 #100489 project and break them out in Jira.

[elasticmachine]

Pinging @elastic/kibana-app-services (Team:AppServices)

[jportner]

In case anyone is following this issue but not the linked meta-issue (#100489):

I published the Sharing Saved Objects developer guide, please take a look before proceeding with the implementation. And of course, please reach out if you run into any problems!

[jportner]

Related: #108335

[tsullivan]

@ppisljar there are 2 places in Reporting that use savedObjects.get:

• https://github.com/elastic/kibana/blob/master/x-pack/plugins/reporting/server/export_types/csv/create_job.ts#L24
• https://github.com/elastic/kibana/blob/master/x-pack/plugins/reporting/server/export_types/printable_pdf/create_job/compatibility_shim.ts#L20-L27

[jportner]

I spoke with Peter today offline to get a sense of all the individual Sharing Saved Objects-related tasks that need to be accomplished for App Services saved objects. Notes from our chat below.

---

Question: does the object type ever need to become shareable? Or, does the object have any inbound references from other objects that will be shareable in the future?

• index-pattern - Yes, Index Patterns (soon to be "Data Views") should be shareable.
• query - Yes, Saved Queries should be shareable.
• search-session - No, Search Sessions don't realistically need to be shared (they are for long-running queries so the user doesn't have to sit on the page) and they don't have inbound references.
• url - No, Short URLs don't need to be shared, and they don't have inbound references.

Going through the Sharing Saved Objects Dev Guide for each object type:

index-pattern

• Step 1: skipped; Index Patterns do not have links to other objects.
• Step 2: done in use savedObjectsClient.resolve for retrieving index patterns #108335 ← note that this was completed for the service that is exposed to other consumers.
• Step 3: skipped; there are technically deep links to Index Patterns (in Stack Management) but it's acceptable if these URLs break in 8.0+.
• Step 4: planned in make index pattern saved object "share-capable" #113370
• Step 5: skipped; Index Patterns are not encrypted.

query

• Step 1: planned in saved queries SO needs to extract references  #108184
• Step 2: done in use savedObjectsClient.resolve inside saved queries service #108336
• Step 3: skipped; there are no deep links where this is the primary object, this is primarily interacted with via popovers (the "resolve" outcome will eventually need to be surfaced to consumers).
• Step 4: done in make saved queries SO share-capable #113371
• Step 5: skipped; Saved Queries are not encrypted.

search-session

• Step 1: skipped for now due to time constraints; this stores a URL and when a user loads a Search Session, it changes the page to that location. That will continue to work post-8.0, because the app for the page itself will resolve the actual object IDs. Eventually we do want to use the new URL service instead, which means we won't be storing the URL, instead we will store parameters that can be used to generate the URL. Once that service is used, the fields for parameters can be injected/extracted to/from references. (Note that if this is done after the 8.0 release, those referenced object IDs may be outdated; a special post-start custom migration will need to be used to resolve referenced object IDs and update them if necessary)
• Step 2-5: skipped; Search Sessions will not be converted to become share-capable

url

• Step 1: planned in short url saved object should extract/inject references and perform migrations #113372
• Step 2-5: skipped; Short URLs will not be converted to become share-capable

In addition to all of that, Reporting needs to use savedObjects.resolve in a few places as Tim mentioned above. That work is tracked in #112565