Allow savedObjects types registration from NP (#57430) (#58602)

* expose `registerType` API

* expose `getTypeRegistry` API

* change SavedObjectMigrationFn signature to add context

* fix exported types

* update generated doc

* update migration documentation

* fix legacy service test

* fix typings

* update service setup description

* add saved_objects server folder convention

* fix unit test

* documentation NITs

* add typeRegistry to SavedObjectClientWrapperOptions
This commit is contained in:
Pierre Gayvallet 2020-02-26 18:17:51 +01:00 committed by GitHub
parent 2ebec21bd1
commit b4009fcfd2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
45 changed files with 847 additions and 79 deletions

View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ISavedObjectTypeRegistry](./kibana-plugin-server.isavedobjecttyperegistry.md)
## ISavedObjectTypeRegistry type
See [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) for documentation.
<b>Signature:</b>
```typescript
export declare type ISavedObjectTypeRegistry = Pick<SavedObjectTypeRegistry, 'getType' | 'getAllTypes' | 'getIndex' | 'isNamespaceAgnostic' | 'isHidden'>;
```

View file

@ -27,6 +27,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) | |
| [SavedObjectsRepository](./kibana-plugin-server.savedobjectsrepository.md) | |
| [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md) | A serializer that can be used to manually convert [raw](./kibana-plugin-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-server.savedobjectsanitizeddoc.md) documents to the other kind. |
| [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) | Registry holding information about all the registered [saved object types](./kibana-plugin-server.savedobjectstype.md)<!-- -->. |
| [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) | Serves the same purpose as "normal" <code>ClusterClient</code> but exposes additional <code>callAsCurrentUser</code> method that doesn't use credentials of the Kibana internal user (as <code>callAsInternalUser</code> does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API.<!-- -->See [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md)<!-- -->. |
## Enumerations
@ -108,6 +109,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) | Additional options for the RouteValidator class to modify its default behaviour. |
| [SavedObject](./kibana-plugin-server.savedobject.md) | |
| [SavedObjectAttributes](./kibana-plugin-server.savedobjectattributes.md) | The data for a Saved Object is stored as an object in the <code>attributes</code> property. |
| [SavedObjectMigrationContext](./kibana-plugin-server.savedobjectmigrationcontext.md) | Migration context provided when invoking a [migration handler](./kibana-plugin-server.savedobjectmigrationfn.md) |
| [SavedObjectMigrationMap](./kibana-plugin-server.savedobjectmigrationmap.md) | A map of [migration functions](./kibana-plugin-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions.<!-- -->For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one. |
| [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md) | A reference to another saved object. |
| [SavedObjectsBaseOptions](./kibana-plugin-server.savedobjectsbaseoptions.md) | |
@ -143,7 +145,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsRawDoc](./kibana-plugin-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. |
| [SavedObjectsRepositoryFactory](./kibana-plugin-server.savedobjectsrepositoryfactory.md) | Factory provided when invoking a [client factory provider](./kibana-plugin-server.savedobjectsclientfactoryprovider.md) See [SavedObjectsServiceSetup.setClientFactoryProvider](./kibana-plugin-server.savedobjectsservicesetup.setclientfactoryprovider.md) |
| [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. |
| [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) | Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for creating and registering Saved Object client wrappers. |
| [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) | Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories. |
| [SavedObjectsServiceStart](./kibana-plugin-server.savedobjectsservicestart.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects. |
| [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) | |
| [SavedObjectsTypeMappingDefinition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) | Describe a saved object type mapping. |
@ -195,6 +197,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ICustomClusterClient](./kibana-plugin-server.icustomclusterclient.md) | Represents an Elasticsearch cluster API client created by a plugin. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>).<!-- -->See [ClusterClient](./kibana-plugin-server.clusterclient.md)<!-- -->. |
| [IsAuthenticated](./kibana-plugin-server.isauthenticated.md) | Returns authentication status for a request. |
| [ISavedObjectsRepository](./kibana-plugin-server.isavedobjectsrepository.md) | See [SavedObjectsRepository](./kibana-plugin-server.savedobjectsrepository.md) |
| [ISavedObjectTypeRegistry](./kibana-plugin-server.isavedobjecttyperegistry.md) | See [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) for documentation. |
| [IScopedClusterClient](./kibana-plugin-server.iscopedclusterclient.md) | Serves the same purpose as "normal" <code>ClusterClient</code> but exposes additional <code>callAsCurrentUser</code> method that doesn't use credentials of the Kibana internal user (as <code>callAsInternalUser</code> does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API.<!-- -->See [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md)<!-- -->. |
| [KibanaRequestRouteOptions](./kibana-plugin-server.kibanarequestrouteoptions.md) | Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. |
| [KibanaResponseFactory](./kibana-plugin-server.kibanaresponsefactory.md) | Creates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client. |
@ -226,7 +229,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [RouteValidatorFullConfig](./kibana-plugin-server.routevalidatorfullconfig.md) | Route validations config and options merged into one object |
| [SavedObjectAttribute](./kibana-plugin-server.savedobjectattribute.md) | Type definition for a Saved Object attribute value |
| [SavedObjectAttributeSingle](./kibana-plugin-server.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-server.savedobjectattribute.md) |
| [SavedObjectMigrationFn](./kibana-plugin-server.savedobjectmigrationfn.md) | A migration function defined for a [saved objects type](./kibana-plugin-server.savedobjectstype.md) used to migrate it's |
| [SavedObjectMigrationFn](./kibana-plugin-server.savedobjectmigrationfn.md) | A migration function for a [saved object type](./kibana-plugin-server.savedobjectstype.md) used to migrate it to a given version |
| [SavedObjectSanitizedDoc](./kibana-plugin-server.savedobjectsanitizeddoc.md) | |
| [SavedObjectsClientContract](./kibana-plugin-server.savedobjectsclientcontract.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.<!-- -->\#\# SavedObjectsClient errors<!-- -->Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:<!-- -->1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md)<!-- -->Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the <code>isXYZError()</code> helpers exposed at <code>SavedObjectsErrorHelpers</code> should be used to understand and manage error responses from the <code>SavedObjectsClient</code>.<!-- -->Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for <code>error.body.error.type</code> or doing substring checks on <code>error.body.error.reason</code>, just use the helpers to understand the meaning of the error:<!-- -->\`\`\`<!-- -->js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }<!-- -->if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }<!-- -->// always rethrow the error unless you handle it throw error; \`\`\`<!-- -->\#\#\# 404s from missing index<!-- -->From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistance and that index might be missing.<!-- -->At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.<!-- -->From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.<!-- -->\#\#\# 503s from missing index<!-- -->Unlike all other methods, create requests are supposed to succeed even when the Kibana index does not exist because it will be automatically created by elasticsearch. When that is not the case it is because Elasticsearch's <code>action.auto_create_index</code> setting prevents it from being created automatically so we throw a special 503 with the intention of informing the user that their Elasticsearch settings need to be updated.<!-- -->See [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) |
| [SavedObjectsClientFactory](./kibana-plugin-server.savedobjectsclientfactory.md) | Describes the factory used to create instances of the Saved Objects Client. |

View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectMigrationContext](./kibana-plugin-server.savedobjectmigrationcontext.md) &gt; [log](./kibana-plugin-server.savedobjectmigrationcontext.log.md)
## SavedObjectMigrationContext.log property
logger instance to be used by the migration handler
<b>Signature:</b>
```typescript
log: SavedObjectsMigrationLogger;
```

View file

@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectMigrationContext](./kibana-plugin-server.savedobjectmigrationcontext.md)
## SavedObjectMigrationContext interface
Migration context provided when invoking a [migration handler](./kibana-plugin-server.savedobjectmigrationfn.md)
<b>Signature:</b>
```typescript
export interface SavedObjectMigrationContext
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [log](./kibana-plugin-server.savedobjectmigrationcontext.log.md) | <code>SavedObjectsMigrationLogger</code> | logger instance to be used by the migration handler |

View file

@ -4,10 +4,27 @@
## SavedObjectMigrationFn type
A migration function defined for a [saved objects type](./kibana-plugin-server.savedobjectstype.md) used to migrate it's
A migration function for a [saved object type](./kibana-plugin-server.savedobjectstype.md) used to migrate it to a given version
<b>Signature:</b>
```typescript
export declare type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, log: SavedObjectsMigrationLogger) => SavedObjectUnsanitizedDoc;
export declare type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => SavedObjectUnsanitizedDoc;
```
## Example
```typescript
const migrateProperty: SavedObjectMigrationFn = (doc, { log }) => {
if(doc.attributes.someProp === null) {
log.warn('Skipping migration');
} else {
doc.attributes.someProp = migrateProperty(doc.attributes.someProp);
}
return doc;
}
```

View file

@ -18,4 +18,5 @@ export interface SavedObjectsClientWrapperOptions
| --- | --- | --- |
| [client](./kibana-plugin-server.savedobjectsclientwrapperoptions.client.md) | <code>SavedObjectsClientContract</code> | |
| [request](./kibana-plugin-server.savedobjectsclientwrapperoptions.request.md) | <code>KibanaRequest</code> | |
| [typeRegistry](./kibana-plugin-server.savedobjectsclientwrapperoptions.typeregistry.md) | <code>ISavedObjectTypeRegistry</code> | |

View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClientWrapperOptions](./kibana-plugin-server.savedobjectsclientwrapperoptions.md) &gt; [typeRegistry](./kibana-plugin-server.savedobjectsclientwrapperoptions.typeregistry.md)
## SavedObjectsClientWrapperOptions.typeRegistry property
<b>Signature:</b>
```typescript
typeRegistry: ISavedObjectTypeRegistry;
```

View file

@ -4,7 +4,7 @@
## SavedObjectsServiceSetup interface
Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for creating and registering Saved Object client wrappers.
Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories.
<b>Signature:</b>
@ -14,11 +14,9 @@ export interface SavedObjectsServiceSetup
## Remarks
Note: The Saved Object setup API's should only be used for creating and registering client wrappers. Constructing a Saved Objects client or repository for use within your own plugin won't have any of the registered wrappers applied and is considered an anti-pattern. Use the Saved Objects client from the [SavedObjectsServiceStart\#getScopedClient](./kibana-plugin-server.savedobjectsservicestart.md) method or the [route handler context](./kibana-plugin-server.requesthandlercontext.md) instead.
When plugins access the Saved Objects client, a new client is created using the factory provided to `setClientFactory` and wrapped by all wrappers registered through `addClientWrapper`<!-- -->.
When plugins access the Saved Objects client, a new client is created using the factory provided to `setClientFactory` and wrapped by all wrappers registered through `addClientWrapper`<!-- -->. To create a factory or wrapper, plugins will have to construct a Saved Objects client. First create a repository by calling `scopedRepository` or `internalRepository` and then use this repository as the argument to the [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) constructor.
## Example
## Example 1
```ts
@ -34,10 +32,26 @@ export class Plugin() {
```
## Example 2
```ts
import { SavedObjectsClient, CoreSetup } from 'src/core/server';
import { mySoType } from './saved_objects'
export class Plugin() {
setup: (core: CoreSetup) => {
core.savedObjects.registerType(mySoType);
}
}
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [addClientWrapper](./kibana-plugin-server.savedobjectsservicesetup.addclientwrapper.md) | <code>(priority: number, id: string, factory: SavedObjectsClientWrapperFactory) =&gt; void</code> | Add a [client wrapper factory](./kibana-plugin-server.savedobjectsclientwrapperfactory.md) with the given priority. |
| [registerType](./kibana-plugin-server.savedobjectsservicesetup.registertype.md) | <code>(type: SavedObjectsType) =&gt; void</code> | Register a [savedObjects type](./kibana-plugin-server.savedobjectstype.md) definition.<!-- -->See the [mappings format](./kibana-plugin-server.savedobjectstypemappingdefinition.md) and [migration format](./kibana-plugin-server.savedobjectmigrationmap.md) for more details about these. |
| [setClientFactoryProvider](./kibana-plugin-server.savedobjectsservicesetup.setclientfactoryprovider.md) | <code>(clientFactoryProvider: SavedObjectsClientFactoryProvider) =&gt; void</code> | Set the default [factory provider](./kibana-plugin-server.savedobjectsclientfactoryprovider.md) for creating Saved Objects clients. Only one provider can be set, subsequent calls to this method will fail. |

View file

@ -0,0 +1,60 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) &gt; [registerType](./kibana-plugin-server.savedobjectsservicesetup.registertype.md)
## SavedObjectsServiceSetup.registerType property
Register a [savedObjects type](./kibana-plugin-server.savedobjectstype.md) definition.
See the [mappings format](./kibana-plugin-server.savedobjectstypemappingdefinition.md) and [migration format](./kibana-plugin-server.savedobjectmigrationmap.md) for more details about these.
<b>Signature:</b>
```typescript
registerType: (type: SavedObjectsType) => void;
```
## Remarks
The type definition is an aggregation of the legacy savedObjects `schema`<!-- -->, `mappings` and `migration` concepts. This API is the single entry point to register saved object types in the new platform.
## Example
```ts
// src/plugins/my_plugin/server/saved_objects/my_type.ts
import { SavedObjectsType } from 'src/core/server';
import * as migrations from './migrations';
export const myType: SavedObjectsType = {
name: 'MyType',
hidden: false,
namespaceAgnostic: true,
mappings: {
properties: {
textField: {
type: 'text',
},
boolField: {
type: 'boolean',
},
},
},
migrations: {
'2.0.0': migrations.migrateToV2,
'2.1.0': migrations.migrateToV2_1
},
};
// src/plugins/my_plugin/server/plugin.ts
import { SavedObjectsClient, CoreSetup } from 'src/core/server';
import { myType } from './saved_objects';
export class Plugin() {
setup: (core: CoreSetup) => {
core.savedObjects.registerType(myType);
}
}
```

View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsServiceStart](./kibana-plugin-server.savedobjectsservicestart.md) &gt; [getTypeRegistry](./kibana-plugin-server.savedobjectsservicestart.gettyperegistry.md)
## SavedObjectsServiceStart.getTypeRegistry property
Returns the [registry](./kibana-plugin-server.isavedobjecttyperegistry.md) containing all registered [saved object types](./kibana-plugin-server.savedobjectstype.md)
<b>Signature:</b>
```typescript
getTypeRegistry: () => ISavedObjectTypeRegistry;
```

View file

@ -20,4 +20,5 @@ export interface SavedObjectsServiceStart
| [createScopedRepository](./kibana-plugin-server.savedobjectsservicestart.createscopedrepository.md) | <code>(req: KibanaRequest, extraTypes?: string[]) =&gt; ISavedObjectsRepository</code> | Creates a [Saved Objects repository](./kibana-plugin-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. |
| [createSerializer](./kibana-plugin-server.savedobjectsservicestart.createserializer.md) | <code>() =&gt; SavedObjectsSerializer</code> | Creates a [serializer](./kibana-plugin-server.savedobjectsserializer.md) that is aware of all registered types. |
| [getScopedClient](./kibana-plugin-server.savedobjectsservicestart.getscopedclient.md) | <code>(req: KibanaRequest, options?: SavedObjectsClientProviderOptions) =&gt; SavedObjectsClientContract</code> | Creates a [Saved Objects client](./kibana-plugin-server.savedobjectsclientcontract.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. If other plugins have registered Saved Objects client wrappers, these will be applied to extend the functionality of the client.<!-- -->A client that is already scoped to the incoming request is also exposed from the route handler context see [RequestHandlerContext](./kibana-plugin-server.requesthandlercontext.md)<!-- -->. |
| [getTypeRegistry](./kibana-plugin-server.savedobjectsservicestart.gettyperegistry.md) | <code>() =&gt; ISavedObjectTypeRegistry</code> | Returns the [registry](./kibana-plugin-server.isavedobjecttyperegistry.md) containing all registered [saved object types](./kibana-plugin-server.savedobjectstype.md) |

View file

@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [getAllTypes](./kibana-plugin-server.savedobjecttyperegistry.getalltypes.md)
## SavedObjectTypeRegistry.getAllTypes() method
Return all [types](./kibana-plugin-server.savedobjectstype.md) currently registered.
<b>Signature:</b>
```typescript
getAllTypes(): SavedObjectsType[];
```
<b>Returns:</b>
`SavedObjectsType[]`

View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [getIndex](./kibana-plugin-server.savedobjecttyperegistry.getindex.md)
## SavedObjectTypeRegistry.getIndex() method
Returns the `indexPattern` property for given type, or `undefined` if the type is not registered.
<b>Signature:</b>
```typescript
getIndex(type: string): string | undefined;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>string</code> | |
<b>Returns:</b>
`string | undefined`

View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [getType](./kibana-plugin-server.savedobjecttyperegistry.gettype.md)
## SavedObjectTypeRegistry.getType() method
Return the [type](./kibana-plugin-server.savedobjectstype.md) definition for given type name.
<b>Signature:</b>
```typescript
getType(type: string): SavedObjectsType | undefined;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>string</code> | |
<b>Returns:</b>
`SavedObjectsType | undefined`

View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [isHidden](./kibana-plugin-server.savedobjecttyperegistry.ishidden.md)
## SavedObjectTypeRegistry.isHidden() method
Returns the `hidden` property for given type, or `false` if the type is not registered.
<b>Signature:</b>
```typescript
isHidden(type: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>string</code> | |
<b>Returns:</b>
`boolean`

View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [isNamespaceAgnostic](./kibana-plugin-server.savedobjecttyperegistry.isnamespaceagnostic.md)
## SavedObjectTypeRegistry.isNamespaceAgnostic() method
Returns the `namespaceAgnostic` property for given type, or `false` if the type is not registered.
<b>Signature:</b>
```typescript
isNamespaceAgnostic(type: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>string</code> | |
<b>Returns:</b>
`boolean`

View file

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md)
## SavedObjectTypeRegistry class
Registry holding information about all the registered [saved object types](./kibana-plugin-server.savedobjectstype.md)<!-- -->.
<b>Signature:</b>
```typescript
export declare class SavedObjectTypeRegistry
```
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [getAllTypes()](./kibana-plugin-server.savedobjecttyperegistry.getalltypes.md) | | Return all [types](./kibana-plugin-server.savedobjectstype.md) currently registered. |
| [getIndex(type)](./kibana-plugin-server.savedobjecttyperegistry.getindex.md) | | Returns the <code>indexPattern</code> property for given type, or <code>undefined</code> if the type is not registered. |
| [getType(type)](./kibana-plugin-server.savedobjecttyperegistry.gettype.md) | | Return the [type](./kibana-plugin-server.savedobjectstype.md) definition for given type name. |
| [isHidden(type)](./kibana-plugin-server.savedobjecttyperegistry.ishidden.md) | | Returns the <code>hidden</code> property for given type, or <code>false</code> if the type is not registered. |
| [isNamespaceAgnostic(type)](./kibana-plugin-server.savedobjecttyperegistry.isnamespaceagnostic.md) | | Returns the <code>namespaceAgnostic</code> property for given type, or <code>false</code> if the type is not registered. |
| [registerType(type)](./kibana-plugin-server.savedobjecttyperegistry.registertype.md) | | Register a [type](./kibana-plugin-server.savedobjectstype.md) inside the registry. A type can only be registered once. subsequent calls with the same type name will throw an error. |

View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [registerType](./kibana-plugin-server.savedobjecttyperegistry.registertype.md)
## SavedObjectTypeRegistry.registerType() method
Register a [type](./kibana-plugin-server.savedobjectstype.md) inside the registry. A type can only be registered once. subsequent calls with the same type name will throw an error.
<b>Signature:</b>
```typescript
registerType(type: SavedObjectsType): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>SavedObjectsType</code> | |
<b>Returns:</b>
`void`

View file

@ -1,6 +1,13 @@
# Kibana Conventions
- [Plugin Structure](#plugin-structure)
- [Kibana Conventions](#kibana-conventions)
- [Plugin Structure](#plugin-structure)
- [The PluginInitializer](#the-plugininitializer)
- [The Plugin class](#the-plugin-class)
- [Applications](#applications)
- [Services](#services)
- [Usage Collection](#usage-collection)
- [Saved Objects Types](#saved-objects-types)
## Plugin Structure
@ -25,6 +32,9 @@ my_plugin/
│ └── index.ts
├── collectors
│ └── register.ts
├── saved_objects
│ ├── index.ts
│ └── my_type.ts
   ├── services
   │   ├── my_service
   │   │ └── index.ts
@ -253,6 +263,45 @@ export function registerMyPluginUsageCollector(usageCollection?: UsageCollection
}
```
### Saved Objects Types
Saved object type definitions should be defined in their own `server/saved_objects` directory.
The folder should contain a file per type, named after the snake_case name of the type, and an `index.ts` file exporting all the types.
```typescript
// src/plugins/my-plugin/server/saved_objects/my_type.ts
import { SavedObjectsType } from 'src/core/server';
export const myType: SavedObjectsType = {
name: 'my-type',
hidden: false,
namespaceAgnostic: true,
mappings: {
properties: {
someField: {
type: 'text',
},
anotherField: {
type: 'text',
},
},
},
migrations: {
'1.0.0': migrateFirstTypeToV1,
'2.0.0': migrateFirstTypeToV2,
},
};
```
```typescript
// src/plugins/my-plugin/server/saved_objects/index.ts
export { myType } from './my_type';
```
Migration example from the legacy format is available in `src/core/MIGRATION_EXAMPLES.md#saved-objects-types`
### Naming conventions
Export start and setup contracts as `MyPluginStart` and `MyPluginSetup`.

View file

@ -1207,6 +1207,9 @@ In server code, `core` can be accessed from either `server.newPlatform` or `kbnS
| `request.getSavedObjectsClient` | [`context.core.savedObjects.client`](/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md) | |
| `request.getUiSettingsService` | [`context.uiSettings.client`](/docs/development/core/server/kibana-plugin-server.iuisettingsclient.md) | |
| `kibana.Plugin.deprecations` | [Handle plugin configuration deprecations](#handle-plugin-config-deprecations) and [`PluginConfigDescriptor.deprecations`](docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.md) | Deprecations from New Platform are not applied to legacy configuration |
| `kibana.Plugin.savedObjectSchemas` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
| `kibana.Plugin.mappings` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
| `kibana.Plugin.migrations` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
_See also: [Server's CoreSetup API Docs](/docs/development/core/server/kibana-plugin-server.coresetup.md)_

View file

@ -19,6 +19,7 @@ APIs to their New Platform equivalents.
- [Updating an application navlink](#updating-application-navlink)
- [Chromeless Applications](#chromeless-applications)
- [Render HTML Content](#render-html-content)
- [Saved Objects types](#saved-objects-types)
## Configuration
@ -737,3 +738,183 @@ router.get(
}
);
```
## Saved Objects types
In the legacy platform, saved object types were registered using static definitions in the `uiExports` part of
the plugin manifest.
In the new platform, all these registration are to be performed programmatically during your plugin's `setup` phase,
using the core `savedObjects`'s `registerType` setup API.
The most notable difference is that in the new platform, the type registration is performed in a single call to
`registerType`, passing a new `SavedObjectsType` structure that is a superset of the legacy `schema`, `migrations`
and `mappings`.
### Concrete example
Let say we have the following in a legacy plugin:
```js
// src/legacy/core_plugins/my_plugin/index.js
import mappings from './mappings.json';
import { migrations } from './migrations';
new kibana.Plugin({
init(server){
// [...]
},
uiExports: {
mappings,
migrations,
savedObjectSchemas: {
'first-type': {
isNamespaceAgnostic: true,
},
'second-type': {
isHidden: true,
},
},
},
})
```
```json
// src/legacy/core_plugins/my_plugin/mappings.json
{
"first-type": {
"properties": {
"someField": {
"type": "text"
},
"anotherField": {
"type": "text"
}
}
},
"second-type": {
"properties": {
"textField": {
"type": "text"
},
"boolField": {
"type": "boolean"
}
}
}
}
```
```js
// src/legacy/core_plugins/my_plugin/migrations.js
export const migrations = {
'first-type': {
'1.0.0': migrateFirstTypeToV1,
'2.0.0': migrateFirstTypeToV2,
},
'second-type': {
'1.5.0': migrateSecondTypeToV15,
}
}
```
To migrate this, we will have to regroup the declaration per-type. That would become:
First type:
```typescript
// src/plugins/my_plugin/server/saved_objects/first_type.ts
import { SavedObjectsType } from 'src/core/server';
export const firstType: SavedObjectsType = {
name: 'first-type',
hidden: false,
namespaceAgnostic: true,
mappings: {
properties: {
someField: {
type: 'text',
},
anotherField: {
type: 'text',
},
},
},
migrations: {
'1.0.0': migrateFirstTypeToV1,
'2.0.0': migrateFirstTypeToV2,
},
};
```
Second type:
```typescript
// src/plugins/my_plugin/server/saved_objects/second_type.ts
import { SavedObjectsType } from 'src/core/server';
export const secondType: SavedObjectsType = {
name: 'second-type',
hidden: true,
namespaceAgnostic: false,
mappings: {
properties: {
textField: {
type: 'text',
},
boolField: {
type: 'boolean',
},
},
},
migrations: {
'1.5.0': migrateSecondTypeToV15,
},
};
```
Registration in the plugin's setup phase:
```typescript
// src/plugins/my_plugin/server/plugin.ts
import { firstType, secondType } from './saved_objects';
export class MyPlugin implements Plugin {
setup({ savedObjects }) {
savedObjects.registerType(firstType);
savedObjects.registerType(secondType);
}
}
```
### Changes in structure compared to legacy
The NP `registerType` expected input is very close to the legacy format. However, there are some minor changes:
- The `schema.isNamespaceAgnostic` property has been renamed: `SavedObjectsType.namespaceAgnostic`
- The `schema.indexPattern` was accepting either a `string` or a `(config: LegacyConfig) => string`. `SavedObjectsType.indexPattern` only accepts a string, as you can access the configuration during your plugin's setup phase.
- The migration function signature has changed:
In legacy, it was `(doc: SavedObjectUnsanitizedDoc, log: SavedObjectsMigrationLogger) => SavedObjectUnsanitizedDoc;`
In new platform, it is now `(doc: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => SavedObjectUnsanitizedDoc;`
With context being:
```typescript
export interface SavedObjectMigrationContext {
log: SavedObjectsMigrationLogger;
}
```
The changes is very minor though. The legacy migration:
```js
const migration = (doc, log) => {...}
```
Would be converted to:
```typescript
const migration: SavedObjectMigrationFn = (doc, { log }) => {...}
```

View file

@ -201,6 +201,7 @@ export {
SavedObjectsImportRetry,
SavedObjectsImportUnknownError,
SavedObjectsImportUnsupportedTypeError,
SavedObjectMigrationContext,
SavedObjectsMigrationLogger,
SavedObjectsRawDoc,
SavedObjectSanitizedDoc,
@ -224,6 +225,7 @@ export {
SavedObjectsTypeMappingDefinition,
SavedObjectsMappingProperties,
SavedObjectTypeRegistry,
ISavedObjectTypeRegistry,
SavedObjectsType,
SavedObjectMigrationMap,
SavedObjectMigrationFn,

View file

@ -263,6 +263,7 @@ export class LegacyService implements CoreService {
createScopedRepository: startDeps.core.savedObjects.createScopedRepository,
createInternalRepository: startDeps.core.savedObjects.createInternalRepository,
createSerializer: startDeps.core.savedObjects.createSerializer,
getTypeRegistry: startDeps.core.savedObjects.getTypeRegistry,
},
uiSettings: { asScopedToClient: startDeps.core.uiSettings.asScopedToClient },
};
@ -298,6 +299,7 @@ export class LegacyService implements CoreService {
savedObjects: {
setClientFactoryProvider: setupDeps.core.savedObjects.setClientFactoryProvider,
addClientWrapper: setupDeps.core.savedObjects.addClientWrapper,
registerType: setupDeps.core.savedObjects.registerType,
},
uiSettings: {
register: setupDeps.core.uiSettings.register,
@ -329,7 +331,6 @@ export class LegacyService implements CoreService {
__internals: {
hapiServer: setupDeps.core.http.server,
kibanaMigrator: startDeps.core.savedObjects.migrator,
typeRegistry: startDeps.core.savedObjects.typeRegistry,
uiPlugins: setupDeps.core.plugins.uiPlugins,
elasticsearch: setupDeps.core.elasticsearch,
rendering: setupDeps.core.rendering,

View file

@ -114,18 +114,12 @@ function createCoreSetupMock() {
register: uiSettingsServiceMock.createSetupContract().register,
};
const savedObjectsService = savedObjectsServiceMock.createSetupContract();
const savedObjectMock: jest.Mocked<CoreSetup['savedObjects']> = {
addClientWrapper: savedObjectsService.addClientWrapper,
setClientFactoryProvider: savedObjectsService.setClientFactoryProvider,
};
const mock: CoreSetupMockType = {
capabilities: capabilitiesServiceMock.createSetupContract(),
context: contextServiceMock.createSetupContract(),
elasticsearch: elasticsearchServiceMock.createSetup(),
http: httpMock,
savedObjects: savedObjectMock,
savedObjects: savedObjectsServiceMock.createInternalSetupContract(),
uiSettings: uiSettingsMock,
uuid: uuidServiceMock.createSetupContract(),
getStartServices: jest

View file

@ -169,6 +169,7 @@ export function createPluginSetupContext<TPlugin, TPluginDependencies>(
savedObjects: {
setClientFactoryProvider: deps.savedObjects.setClientFactoryProvider,
addClientWrapper: deps.savedObjects.addClientWrapper,
registerType: deps.savedObjects.registerType,
},
uiSettings: {
register: deps.uiSettings.register,
@ -206,6 +207,7 @@ export function createPluginStartContext<TPlugin, TPluginDependencies>(
createInternalRepository: deps.savedObjects.createInternalRepository,
createScopedRepository: deps.savedObjects.createScopedRepository,
createSerializer: deps.savedObjects.createSerializer,
getTypeRegistry: deps.savedObjects.getTypeRegistry,
},
uiSettings: {
asScopedToClient: deps.uiSettings.asScopedToClient,

View file

@ -64,8 +64,8 @@ Array [
},
},
"migrations": Object {
"1.0.0": [MockFunction],
"2.0.4": [MockFunction],
"1.0.0": [Function],
"2.0.4": [Function],
},
"name": "typeA",
"namespaceAgnostic": true,
@ -100,7 +100,7 @@ Array [
},
},
"migrations": Object {
"1.5.3": [MockFunction],
"1.5.3": [Function],
},
"name": "typeC",
"namespaceAgnostic": false,

View file

@ -64,7 +64,11 @@ export {
SavedObjectsTypeMappingDefinitions,
} from './mappings';
export { SavedObjectMigrationMap, SavedObjectMigrationFn } from './migrations';
export {
SavedObjectMigrationMap,
SavedObjectMigrationFn,
SavedObjectMigrationContext,
} from './migrations';
export { SavedObjectsType } from './types';

View file

@ -585,7 +585,7 @@ describe('DocumentMigrator', () => {
typeRegistry: createRegistry({
name: 'dog',
migrations: {
'1.2.3': (doc, log) => {
'1.2.3': (doc, { log }) => {
log.info(logTestMsg);
log.warning(logTestMsg);
return doc;

View file

@ -309,7 +309,8 @@ function wrapWithTry(
) {
return function tryTransformDoc(doc: SavedObjectUnsanitizedDoc) {
try {
const result = migrationFn(doc, new MigrationLogger(log));
const context = { log: new MigrationLogger(log) };
const result = migrationFn(doc, context);
// A basic sanity check to help migration authors detect basic errors
// (e.g. forgetting to return the transformed doc)

View file

@ -18,4 +18,8 @@
*/
export { KibanaMigrator, IKibanaMigrator } from './kibana';
export { SavedObjectMigrationFn, SavedObjectMigrationMap } from './types';
export {
SavedObjectMigrationFn,
SavedObjectMigrationMap,
SavedObjectMigrationContext,
} from './types';

View file

@ -21,14 +21,41 @@ import { SavedObjectUnsanitizedDoc } from '../serialization';
import { SavedObjectsMigrationLogger } from './core/migration_logger';
/**
* A migration function defined for a {@link SavedObjectsType | saved objects type}
* used to migrate it's {@link SavedObjectUnsanitizedDoc | documents}
* A migration function for a {@link SavedObjectsType | saved object type}
* used to migrate it to a given version
*
* @example
* ```typescript
* const migrateProperty: SavedObjectMigrationFn = (doc, { log }) => {
* if(doc.attributes.someProp === null) {
* log.warn('Skipping migration');
* } else {
* doc.attributes.someProp = migrateProperty(doc.attributes.someProp);
* }
*
* return doc;
* }
* ```
*
* @public
*/
export type SavedObjectMigrationFn = (
doc: SavedObjectUnsanitizedDoc,
log: SavedObjectsMigrationLogger
context: SavedObjectMigrationContext
) => SavedObjectUnsanitizedDoc;
/**
* Migration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}
*
* @public
*/
export interface SavedObjectMigrationContext {
/**
* logger instance to be used by the migration handler
*/
log: SavedObjectsMigrationLogger;
}
/**
* A map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.
* The map's keys must be valid semver versions.

View file

@ -38,11 +38,13 @@ const createStartContractMock = () => {
createInternalRepository: jest.fn(),
createScopedRepository: jest.fn(),
createSerializer: jest.fn(),
getTypeRegistry: jest.fn(),
};
startContrat.getScopedClient.mockReturnValue(savedObjectsClientMock.create());
startContrat.createInternalRepository.mockReturnValue(savedObjectsRepositoryMock.create());
startContrat.createScopedRepository.mockReturnValue(savedObjectsRepositoryMock.create());
startContrat.getTypeRegistry.mockReturnValue(typeRegistryMock.create());
return startContrat;
};
@ -52,7 +54,6 @@ const createInternalStartContractMock = () => {
...createStartContractMock(),
clientProvider: savedObjectsClientProviderMock.create(),
migrator: mockKibanaMigrator.create(),
typeRegistry: typeRegistryMock.create(),
};
return internalStartContract;
@ -62,6 +63,7 @@ const createSetupContractMock = () => {
const setupContract: jest.Mocked<SavedObjectsServiceSetup> = {
setClientFactoryProvider: jest.fn(),
addClientWrapper: jest.fn(),
registerType: jest.fn(),
};
return setupContract;
@ -70,7 +72,6 @@ const createSetupContractMock = () => {
const createInternalSetupContractMock = () => {
const internalSetupContract: jest.Mocked<InternalSavedObjectsServiceSetup> = {
...createSetupContractMock(),
registerType: jest.fn(),
};
return internalSetupContract;
};

View file

@ -130,7 +130,7 @@ describe('SavedObjectsService', () => {
});
});
describe('registerType', () => {
describe('#registerType', () => {
it('registers the type to the internal typeRegistry', async () => {
const coreContext = createCoreContext();
const soService = new SavedObjectsService(coreContext);
@ -231,5 +231,16 @@ describe('SavedObjectsService', () => {
expect(startContract.migrator).toBe(migratorInstanceMock);
expect(migratorInstanceMock.runMigrations).toHaveBeenCalledTimes(1);
});
describe('#getTypeRegistry', () => {
it('returns the internal type registry of the service', async () => {
const coreContext = createCoreContext({ skipMigration: false });
const soService = new SavedObjectsService(coreContext);
await soService.setup(createSetupDeps());
const { getTypeRegistry } = await soService.start({});
expect(getTypeRegistry()).toBe(typeRegistryInstanceMock);
});
});
});
});

View file

@ -53,26 +53,13 @@ import { registerRoutes } from './routes';
/**
* Saved Objects is Kibana's data persistence mechanism allowing plugins to
* use Elasticsearch for storing and querying state. The
* SavedObjectsServiceSetup API exposes methods for creating and registering
* Saved Object client wrappers.
* use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods
* for registering Saved Object types, creating and registering Saved Object client wrappers and factories.
*
* @remarks
* Note: The Saved Object setup API's should only be used for creating and
* registering client wrappers. Constructing a Saved Objects client or
* repository for use within your own plugin won't have any of the registered
* wrappers applied and is considered an anti-pattern. Use the Saved Objects
* client from the
* {@link SavedObjectsServiceStart | SavedObjectsServiceStart#getScopedClient }
* method or the {@link RequestHandlerContext | route handler context} instead.
*
* When plugins access the Saved Objects client, a new client is created using
* the factory provided to `setClientFactory` and wrapped by all wrappers
* registered through `addClientWrapper`. To create a factory or wrapper,
* plugins will have to construct a Saved Objects client. First create a
* repository by calling `scopedRepository` or `internalRepository` and then
* use this repository as the argument to the {@link SavedObjectsClient}
* constructor.
* registered through `addClientWrapper`.
*
* @example
* ```ts
@ -87,6 +74,18 @@ import { registerRoutes } from './routes';
* }
* ```
*
* @example
* ```ts
* import { SavedObjectsClient, CoreSetup } from 'src/core/server';
* import { mySoType } from './saved_objects'
*
* export class Plugin() {
* setup: (core: CoreSetup) => {
* core.savedObjects.registerType(mySoType);
* }
* }
* ```
*
* @public
*/
export interface SavedObjectsServiceSetup {
@ -104,14 +103,60 @@ export interface SavedObjectsServiceSetup {
id: string,
factory: SavedObjectsClientWrapperFactory
) => void;
/**
* Register a {@link SavedObjectsType | savedObjects type} definition.
*
* See the {@link SavedObjectsTypeMappingDefinition | mappings format} and
* {@link SavedObjectMigrationMap | migration format} for more details about these.
*
* @example
* ```ts
* // src/plugins/my_plugin/server/saved_objects/my_type.ts
* import { SavedObjectsType } from 'src/core/server';
* import * as migrations from './migrations';
*
* export const myType: SavedObjectsType = {
* name: 'MyType',
* hidden: false,
* namespaceAgnostic: true,
* mappings: {
* properties: {
* textField: {
* type: 'text',
* },
* boolField: {
* type: 'boolean',
* },
* },
* },
* migrations: {
* '2.0.0': migrations.migrateToV2,
* '2.1.0': migrations.migrateToV2_1
* },
* };
*
* // src/plugins/my_plugin/server/plugin.ts
* import { SavedObjectsClient, CoreSetup } from 'src/core/server';
* import { myType } from './saved_objects';
*
* export class Plugin() {
* setup: (core: CoreSetup) => {
* core.savedObjects.registerType(myType);
* }
* }
* ```
*
* @remarks The type definition is an aggregation of the legacy savedObjects `schema`, `mappings` and `migration` concepts.
* This API is the single entry point to register saved object types in the new platform.
*/
registerType: (type: SavedObjectsType) => void;
}
/**
* @internal
*/
export interface InternalSavedObjectsServiceSetup extends SavedObjectsServiceSetup {
registerType: (type: SavedObjectsType) => void;
}
export type InternalSavedObjectsServiceSetup = SavedObjectsServiceSetup;
/**
* Saved Objects is Kibana's data persisentence mechanism allowing plugins to
@ -159,6 +204,11 @@ export interface SavedObjectsServiceStart {
* Creates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types.
*/
createSerializer: () => SavedObjectsSerializer;
/**
* Returns the {@link ISavedObjectTypeRegistry | registry} containing all registered
* {@link SavedObjectsType | saved object types}
*/
getTypeRegistry: () => ISavedObjectTypeRegistry;
}
export interface InternalSavedObjectsServiceStart extends SavedObjectsServiceStart {
@ -170,10 +220,6 @@ export interface InternalSavedObjectsServiceStart extends SavedObjectsServiceSta
* @deprecated Exposed only for injecting into Legacy
*/
clientProvider: ISavedObjectsClientProvider;
/**
* @deprecated Exposed only for injecting into Legacy
*/
typeRegistry: ISavedObjectTypeRegistry;
}
/**
@ -359,6 +405,7 @@ export class SavedObjectsService
const repository = repositoryFactory.createScopedRepository(request);
return new SavedObjectsClient(repository);
},
typeRegistry: this.typeRegistry,
});
if (this.clientFactoryProvider) {
const clientFactory = this.clientFactoryProvider(repositoryFactory);
@ -371,11 +418,11 @@ export class SavedObjectsService
return {
migrator,
clientProvider,
typeRegistry: this.typeRegistry,
getScopedClient: clientProvider.getClient.bind(clientProvider),
createScopedRepository: repositoryFactory.createScopedRepository,
createInternalRepository: repositoryFactory.createInternalRepository,
createSerializer: () => new SavedObjectsSerializer(this.typeRegistry),
getTypeRegistry: () => this.typeRegistry,
};
}

View file

@ -17,9 +17,10 @@
* under the License.
*/
import { ISavedObjectTypeRegistry } from './saved_objects_type_registry';
import { ISavedObjectTypeRegistry, SavedObjectTypeRegistry } from './saved_objects_type_registry';
const createRegistryMock = (): jest.Mocked<ISavedObjectTypeRegistry> => {
const createRegistryMock = (): jest.Mocked<ISavedObjectTypeRegistry &
Pick<SavedObjectTypeRegistry, 'registerType'>> => {
const mock = {
registerType: jest.fn(),
getType: jest.fn(),

View file

@ -23,14 +23,17 @@ import { SavedObjectsType } from './types';
/**
* See {@link SavedObjectTypeRegistry} for documentation.
*
* @internal
* */
export type ISavedObjectTypeRegistry = PublicMethodsOf<SavedObjectTypeRegistry>;
* @public
*/
export type ISavedObjectTypeRegistry = Pick<
SavedObjectTypeRegistry,
'getType' | 'getAllTypes' | 'getIndex' | 'isNamespaceAgnostic' | 'isHidden'
>;
/**
* Registry holding information about all the registered {@link SavedObjectsType | savedObject types}.
* Registry holding information about all the registered {@link SavedObjectsType | saved object types}.
*
* @internal
* @public
*/
export class SavedObjectTypeRegistry {
private readonly types = new Map<string, SavedObjectsType>();

View file

@ -18,6 +18,7 @@
*/
import { SavedObjectsClientProvider } from './scoped_client_provider';
import { typeRegistryMock } from '../../saved_objects_type_registry.mock';
test(`uses default client factory when one isn't set`, () => {
const returnValue = Symbol();
@ -26,6 +27,7 @@ test(`uses default client factory when one isn't set`, () => {
const clientProvider = new SavedObjectsClientProvider({
defaultClientFactory: defaultClientFactoryMock,
typeRegistry: typeRegistryMock.create(),
});
const result = clientProvider.getClient(request);
@ -44,6 +46,7 @@ test(`uses custom client factory when one is set`, () => {
const clientProvider = new SavedObjectsClientProvider({
defaultClientFactory: defaultClientFactoryMock,
typeRegistry: typeRegistryMock.create(),
});
clientProvider.setClientFactory(customClientFactoryMock);
const result = clientProvider.getClient(request);
@ -68,6 +71,7 @@ test(`throws error when registering a wrapper with a duplicate id`, () => {
const defaultClientFactoryMock = jest.fn();
const clientProvider = new SavedObjectsClientProvider({
defaultClientFactory: defaultClientFactoryMock,
typeRegistry: typeRegistryMock.create(),
});
const firstClientWrapperFactoryMock = jest.fn();
const secondClientWrapperFactoryMock = jest.fn();
@ -80,9 +84,11 @@ test(`throws error when registering a wrapper with a duplicate id`, () => {
test(`invokes and uses wrappers in specified order`, () => {
const defaultClient = Symbol();
const typeRegistry = typeRegistryMock.create();
const defaultClientFactoryMock = jest.fn().mockReturnValue(defaultClient);
const clientProvider = new SavedObjectsClientProvider({
defaultClientFactory: defaultClientFactoryMock,
typeRegistry,
});
const firstWrappedClient = Symbol('first client');
const firstClientWrapperFactoryMock = jest.fn().mockReturnValue(firstWrappedClient);
@ -98,18 +104,22 @@ test(`invokes and uses wrappers in specified order`, () => {
expect(firstClientWrapperFactoryMock).toHaveBeenCalledWith({
request,
client: secondWrapperClient,
typeRegistry,
});
expect(secondClientWrapperFactoryMock).toHaveBeenCalledWith({
request,
client: defaultClient,
typeRegistry,
});
});
test(`does not invoke or use excluded wrappers`, () => {
const defaultClient = Symbol();
const typeRegistry = typeRegistryMock.create();
const defaultClientFactoryMock = jest.fn().mockReturnValue(defaultClient);
const clientProvider = new SavedObjectsClientProvider({
defaultClientFactory: defaultClientFactoryMock,
typeRegistry,
});
const firstWrappedClient = Symbol('first client');
const firstClientWrapperFactoryMock = jest.fn().mockReturnValue(firstWrappedClient);
@ -128,6 +138,7 @@ test(`does not invoke or use excluded wrappers`, () => {
expect(firstClientWrapperFactoryMock).toHaveBeenCalledWith({
request,
client: defaultClient,
typeRegistry,
});
expect(secondClientWrapperFactoryMock).not.toHaveBeenCalled();
});
@ -137,6 +148,7 @@ test(`allows all wrappers to be excluded`, () => {
const defaultClientFactoryMock = jest.fn().mockReturnValue(defaultClient);
const clientProvider = new SavedObjectsClientProvider({
defaultClientFactory: defaultClientFactoryMock,
typeRegistry: typeRegistryMock.create(),
});
const firstWrappedClient = Symbol('first client');
const firstClientWrapperFactoryMock = jest.fn().mockReturnValue(firstWrappedClient);

View file

@ -19,6 +19,7 @@
import { PriorityCollection } from './priority_collection';
import { SavedObjectsClientContract } from '../../types';
import { SavedObjectsRepositoryFactory } from '../../saved_objects_service';
import { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry';
import { KibanaRequest } from '../../../http';
/**
@ -27,6 +28,7 @@ import { KibanaRequest } from '../../../http';
*/
export interface SavedObjectsClientWrapperOptions {
client: SavedObjectsClientContract;
typeRegistry: ISavedObjectTypeRegistry;
request: KibanaRequest;
}
@ -84,9 +86,17 @@ export class SavedObjectsClientProvider {
}>();
private _clientFactory: SavedObjectsClientFactory;
private readonly _originalClientFactory: SavedObjectsClientFactory;
private readonly _typeRegistry: ISavedObjectTypeRegistry;
constructor({ defaultClientFactory }: { defaultClientFactory: SavedObjectsClientFactory }) {
constructor({
defaultClientFactory,
typeRegistry,
}: {
defaultClientFactory: SavedObjectsClientFactory;
typeRegistry: ISavedObjectTypeRegistry;
}) {
this._originalClientFactory = this._clientFactory = defaultClientFactory;
this._typeRegistry = typeRegistry;
}
addClientWrapperFactory(
@ -129,6 +139,7 @@ export class SavedObjectsClientProvider {
return factory({
request,
client: clientToWrap,
typeRegistry: this._typeRegistry,
});
}, client);
}

View file

@ -34,6 +34,8 @@ export {
} from './import/types';
import { LegacyConfig } from '../legacy';
import { SavedObjectUnsanitizedDoc } from './serialization';
import { SavedObjectsMigrationLogger } from './migrations/core/migration_logger';
export {
SavedObjectAttributes,
SavedObjectAttribute,
@ -273,9 +275,26 @@ export interface SavedObjectsLegacyMapping {
* @deprecated
*/
export interface SavedObjectsLegacyMigrationDefinitions {
[type: string]: SavedObjectMigrationMap;
[type: string]: SavedObjectLegacyMigrationMap;
}
/**
* @internal
* @deprecated
*/
export interface SavedObjectLegacyMigrationMap {
[version: string]: SavedObjectLegacyMigrationFn;
}
/**
* @internal
* @deprecated
*/
export type SavedObjectLegacyMigrationFn = (
doc: SavedObjectUnsanitizedDoc,
log: SavedObjectsMigrationLogger
) => SavedObjectUnsanitizedDoc;
/**
* @internal
* @deprecated

View file

@ -20,7 +20,8 @@
import { legacyServiceMock } from '../legacy/legacy_service.mock';
import { convertLegacyTypes, convertTypesToLegacySchema } from './utils';
import { SavedObjectsLegacyUiExports, SavedObjectsType } from './types';
import { LegacyConfig } from 'kibana/server';
import { LegacyConfig, SavedObjectMigrationContext } from 'kibana/server';
import { SavedObjectUnsanitizedDoc } from './serialization';
describe('convertLegacyTypes', () => {
let legacyConfig: ReturnType<typeof legacyServiceMock.createLegacyConfig>;
@ -190,8 +191,48 @@ describe('convertLegacyTypes', () => {
const converted = convertLegacyTypes(uiExports, legacyConfig);
expect(converted.length).toEqual(2);
expect(converted[0].migrations).toEqual(migrationsA);
expect(converted[1].migrations).toEqual(migrationsB);
expect(Object.keys(converted[0]!.migrations!)).toEqual(Object.keys(migrationsA));
expect(Object.keys(converted[1]!.migrations!)).toEqual(Object.keys(migrationsB));
});
it('converts the migration to the new format', () => {
const legacyMigration = jest.fn();
const migrationsA = {
'1.0.0': legacyMigration,
};
const uiExports: SavedObjectsLegacyUiExports = {
savedObjectMappings: [
{
pluginId: 'pluginA',
properties: {
typeA: {
properties: {
fieldA: { type: 'text' },
},
},
},
},
],
savedObjectMigrations: {
typeA: migrationsA,
},
savedObjectSchemas: {},
savedObjectValidations: {},
savedObjectsManagement: {},
};
const converted = convertLegacyTypes(uiExports, legacyConfig);
expect(Object.keys(converted[0]!.migrations!)).toEqual(['1.0.0']);
const migration = converted[0]!.migrations!['1.0.0']!;
const doc = {} as SavedObjectUnsanitizedDoc;
const context = { log: {} } as SavedObjectMigrationContext;
migration(doc, context);
expect(legacyMigration).toHaveBeenCalledTimes(1);
expect(legacyMigration).toHaveBeenCalledWith(doc, context.log);
});
it('merges everything when all are present', () => {

View file

@ -18,7 +18,12 @@
*/
import { LegacyConfig } from '../legacy';
import { SavedObjectsType, SavedObjectsLegacyUiExports } from './types';
import { SavedObjectMigrationMap } from './migrations';
import {
SavedObjectsType,
SavedObjectsLegacyUiExports,
SavedObjectLegacyMigrationMap,
} from './types';
import { SavedObjectsSchemaDefinition } from './schema';
/**
@ -49,7 +54,7 @@ export const convertLegacyTypes = (
? schema.indexPattern(legacyConfig)
: schema?.indexPattern,
convertToAliasScript: schema?.convertToAliasScript,
migrations: migrations ?? {},
migrations: convertLegacyMigrations(migrations ?? {}),
};
}),
];
@ -74,3 +79,14 @@ export const convertTypesToLegacySchema = (
};
}, {} as SavedObjectsSchemaDefinition);
};
const convertLegacyMigrations = (
legacyMigrations: SavedObjectLegacyMigrationMap
): SavedObjectMigrationMap => {
return Object.entries(legacyMigrations).reduce((migrated, [version, migrationFn]) => {
return {
...migrated,
[version]: (doc, context) => migrationFn(doc, context.log),
};
}, {} as SavedObjectMigrationMap);
};

View file

@ -929,6 +929,9 @@ export type IsAuthenticated = (request: KibanaRequest | LegacyRequest) => boolea
// @public
export type ISavedObjectsRepository = Pick<SavedObjectsRepository, keyof SavedObjectsRepository>;
// @public
export type ISavedObjectTypeRegistry = Pick<SavedObjectTypeRegistry, 'getType' | 'getAllTypes' | 'getIndex' | 'isNamespaceAgnostic' | 'isHidden'>;
// @public
export type IScopedClusterClient = Pick<ScopedClusterClient, 'callAsCurrentUser' | 'callAsInternalUser'>;
@ -1489,12 +1492,15 @@ export interface SavedObjectAttributes {
// @public
export type SavedObjectAttributeSingle = string | number | boolean | null | undefined | SavedObjectAttributes;
// @public
export interface SavedObjectMigrationContext {
log: SavedObjectsMigrationLogger;
}
// Warning: (ae-forgotten-export) The symbol "SavedObjectUnsanitizedDoc" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "SavedObjectMigrationFn" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "SavedObjectUnsanitizedDoc"
//
// @public
export type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, log: SavedObjectsMigrationLogger) => SavedObjectUnsanitizedDoc;
export type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => SavedObjectUnsanitizedDoc;
// @public
export interface SavedObjectMigrationMap {
@ -1619,6 +1625,8 @@ export interface SavedObjectsClientWrapperOptions {
client: SavedObjectsClientContract;
// (undocumented)
request: KibanaRequest;
// (undocumented)
typeRegistry: ISavedObjectTypeRegistry;
}
// @public
@ -2013,8 +2021,6 @@ export class SavedObjectsSchema {
// @public
export class SavedObjectsSerializer {
// Warning: (ae-forgotten-export) The symbol "ISavedObjectTypeRegistry" needs to be exported by the entry point index.d.ts
//
// @internal
constructor(registry: ISavedObjectTypeRegistry);
generateRawId(namespace: string | undefined, type: string, id?: string): string;
@ -2026,6 +2032,7 @@ export class SavedObjectsSerializer {
// @public
export interface SavedObjectsServiceSetup {
addClientWrapper: (priority: number, id: string, factory: SavedObjectsClientWrapperFactory) => void;
registerType: (type: SavedObjectsType) => void;
setClientFactoryProvider: (clientFactoryProvider: SavedObjectsClientFactoryProvider) => void;
}
@ -2035,6 +2042,7 @@ export interface SavedObjectsServiceStart {
createScopedRepository: (req: KibanaRequest, extraTypes?: string[]) => ISavedObjectsRepository;
createSerializer: () => SavedObjectsSerializer;
getScopedClient: (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract;
getTypeRegistry: () => ISavedObjectTypeRegistry;
}
// @public (undocumented)
@ -2069,7 +2077,7 @@ export interface SavedObjectsUpdateResponse<T = unknown> extends Omit<SavedObjec
references: SavedObjectReference[] | undefined;
}
// @internal
// @public
export class SavedObjectTypeRegistry {
getAllTypes(): SavedObjectsType[];
getIndex(type: string): string | undefined;

View file

@ -114,7 +114,6 @@ export interface KibanaCore {
elasticsearch: LegacyServiceSetupDeps['core']['elasticsearch'];
hapiServer: LegacyServiceSetupDeps['core']['http']['server'];
kibanaMigrator: LegacyServiceStartDeps['core']['savedObjects']['migrator'];
typeRegistry: LegacyServiceStartDeps['core']['savedObjects']['typeRegistry'];
legacy: ILegacyInternals;
rendering: LegacyServiceSetupDeps['core']['rendering'];
uiPlugins: LegacyServiceSetupDeps['core']['plugins']['uiPlugins'];

View file

@ -33,7 +33,7 @@ import { SavedObjectsManagement } from '../../../core/server/saved_objects/manag
export function savedObjectsMixin(kbnServer, server) {
const migrator = kbnServer.newPlatform.__internals.kibanaMigrator;
const typeRegistry = kbnServer.newPlatform.__internals.typeRegistry;
const typeRegistry = kbnServer.newPlatform.start.core.savedObjects.getTypeRegistry();
const mappings = migrator.getActiveMappings();
const allTypes = Object.keys(getRootPropertiesObjects(mappings));
const schema = new SavedObjectsSchema(convertTypesToLegacySchema(typeRegistry.getAllTypes()));

View file

@ -142,18 +142,21 @@ describe('Saved Objects Mixin', () => {
},
},
};
const coreStart = coreMock.createStart();
coreStart.savedObjects.getTypeRegistry.mockReturnValue(typeRegistry);
mockKbnServer = {
newPlatform: {
__internals: {
kibanaMigrator: migrator,
savedObjectsClientProvider: clientProvider,
typeRegistry,
},
setup: {
core: coreMock.createSetup(),
},
start: {
core: coreMock.createStart(),
core: coreStart,
},
},
server: mockServer,