Migrate saved object service

[epixa]

The saved object service should be migrated to the new platform core and injected into the legacy world. New Core API's are denoted with ⭐️

7.3

• Migrate Saved Objects Client to typescript [Core] Rewrite saved objects in typescript #36829
• Move SavedObjects files to core and expose all types through core [Core] Move Saved objects files to core #38771

7.4

• ⭐️Public Saved Objects client. Allows plugin authors to create, get, find and delete Saved Objects from Public plugins in the new platform. [Core] Public saved objects client #39891
• SavedObjectsFindOptions make type required [Core] Make type option required for SavedObjects.find #42236

7.5

• Move KibanaMigrator to the New Platform Move KibanaMigrator into Server SavedObjectsService #43433
• ⭐️Server Saved Objects client (through request context). Allows plugin authors to create, get, find and delete Saved Objects from Server plugins in the new platform. Server saved objects client through request context #44143

7.x

• ️⭐️SavedObject Management [Platform] SavedObject Management #50308. Allow plugins to configure the values in
  SavedObjectsManagementTypeDefinition for each of their Saved Object types.

  interface SavedObjectsManagementTypeDefinition {
    isImportableAndExportable?: boolean;
    defaultSearchField?: string;
    icon?: string;
    getTitle?: (savedObject: SavedObject) => string;
    getEditUrl?: (savedObject: SavedObject) => string;
    getInAppUrl?: (savedObject: SavedObject) => { path: string; uiCapabilitiesPath: string };
  }

• ⭐️SavedObject Mappings [Platform] SavedObject Mappings #50309. Allow plugins to register a Saved Object type with the associated Elasticsearch mappings.
• ⭐️SavedObject Migrations [Platform] SavedObject Migrations #50311. Allow plugins to register SavedObject document
  migrations.
  • Remove SavedObjectsMigrationLogger and replace all log.warning() -> log.warn() inside existing migrations.
• ️⭐️SavedObject Schemas [Platform] SavedObject Schemas #50313. Allow plugins to configure the values in the
  SavedObjectsSchemaTypeDefinition for each of their Saved Object types.

  interface SavedObjectsSchemaTypeDefinition {
    isNamespaceAgnostic: boolean;
    hidden?: boolean;
    indexPattern?: ((config: Config) => string) | string;
    convertToAliasScript?: string; // rename to reindexScript?
  }

• Move server-side SavedObjects routes to core [Platform] Move SavedObject routes to Core #50321
• Create stronger type safety with discriminated union and type guards for methods like bulkGet which return results and errors in a single array.
• Public SavedObjectsClient: Introduce error helper functions and deprecate accessing err.res.status.
• Move showAutoCreateIndexErrorPage ui/public/error_auto_create_index/error_auto_create_index to NP
• Migrate auto create index error to an error modal powered by the NP? (check with Dave Snider)
• Implement sortOrder in the HTTP API and public SavedObjectsClient
• Deprecate Dashboard Import API Remove Dashboard Import/Export API #41439

8.x

• ️⭐️ SavedObject Validations. Allow plugins to validate documents before
  being saved. No legacy plugins are using this functionality, which means we
  have an opportunity to rethink this before moving to Core.
• Attempt to cleanup when kibana is stopped before migrations have completed by pointing the .kibana index to the last known good .kibana_n index and renaming the half-migrated .kibana_n+1 index to indicate failure (needs investigation).

[elasticmachine]

Pinging @elastic/kibana-platform

[epixa]

cc @mikecote

[joshdover]

@skaapgif I confirmed with the Security team that we're going to be blocked on migrating the backend by the security migration. Is there other work that makes sense to do on this before that is done, or do you think we should put this on hold after #36829 is merged?

[rudolf]

I've re-arranged the order of the tasks. We should be able to complete client-side SavedObjects/SimpleSavedObject which could help unblock some client-side plugins.

[epixa]

I confirmed with the Security team that we're going to be blocked on migrating the backend by the security migration

Can you clarify why? I would expect the HTTP endpoints to be blocked, but I'm not sure why the saved object service itself would be blocked.

[joshdover]

Right, we can refactor the endpoints into the new shape required by the new platform, but we cannot move the endpoint registration to the new platform's HttpService yet because those endpoints need authorization.

[joshdover]

Handling legacy SavedObjects/migrations

What about a 3rd option where we add migration support to NP plugins and copy all the existing migrations over? This would be a breaking change for whichever version that is released in, but it seems like it would eliminate some work that would just be thrown away later anyways.

[joshdover]

Some more legacy saved objects code came up today and I don't see it captured in the plan above so I wanted to flag it.

In the kibana plugin we have two pieces that need to be migrated to the New Platform:

• src/legacy/core_plugins/kibana/public/management/sections/objects
  • Management UI for saved objects, exports, imports
• src/legacy/core_plugins/kibana/server/routes/api/management/saved_objects
  • API routes to support the UI above

It seems to me that this code should be moved into a separate NP plugin (saved_objects_ui?), though until the new Management plugin is created, this may or may not be practical.

We may also want to consider moving parts of the API into the first-class Core SavedObjects API & Client if we think it may be useful. Specifically, I think the relationships endpoint and the scrolling / export endpoints may be useful to developers.

In terms of just getting this code migrated to the New Platform, we still need to decide who will get this code to be NP-ready. The App team is working on shimming the frontend of the kibana plugin, and this will need to be done for this UI as well. The root of this UI is still heavily in Angular, however much of the newer development is in React.

[rudolf]

Closing as we've moved all of Saved Objects to core. There are some enhancement tasks left in the issue description, but these will be separately prioritized.