Expose internal SavedObjectsClient to plugins

rudolf · rudolf · commit df75b176663e · 2019-10-22T14:02:03.000+02:00
diff --git a/docs/development/core/server/kibana-plugin-server.basepath.get.md b/docs/development/core/server/kibana-plugin-server.basepath.get.md
@@ -9,5 +9,5 @@ returns `basePath` value, specific for an incoming request.
 <b>Signature:</b>
 
 ```typescript
-get: (request: LegacyRequest | KibanaRequest<unknown, unknown, unknown>) => string;
+get: (request: KibanaRequest<unknown, unknown, unknown> | LegacyRequest) => string;
 ```
diff --git a/docs/development/core/server/kibana-plugin-server.basepath.md b/docs/development/core/server/kibana-plugin-server.basepath.md
@@ -16,11 +16,11 @@ export declare class BasePath
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [get](./kibana-plugin-server.basepath.get.md) |  | <code>(request: LegacyRequest &#124; KibanaRequest&lt;unknown, unknown, unknown&gt;) =&gt; string</code> | returns <code>basePath</code> value, specific for an incoming request. |
+|  [get](./kibana-plugin-server.basepath.get.md) |  | <code>(request: KibanaRequest&lt;unknown, unknown, unknown&gt; &#124; LegacyRequest) =&gt; string</code> | returns <code>basePath</code> value, specific for an incoming request. |
 |  [prepend](./kibana-plugin-server.basepath.prepend.md) |  | <code>(path: string) =&gt; string</code> | Prepends <code>path</code> with the basePath. |
 |  [remove](./kibana-plugin-server.basepath.remove.md) |  | <code>(path: string) =&gt; string</code> | Removes the prepended basePath from the <code>path</code>. |
 |  [serverBasePath](./kibana-plugin-server.basepath.serverbasepath.md) |  | <code>string</code> | returns the server's basePath<!-- -->See [BasePath.get](./kibana-plugin-server.basepath.get.md) for getting the basePath value for a specific request |
-|  [set](./kibana-plugin-server.basepath.set.md) |  | <code>(request: LegacyRequest &#124; KibanaRequest&lt;unknown, unknown, unknown&gt;, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |
+|  [set](./kibana-plugin-server.basepath.set.md) |  | <code>(request: KibanaRequest&lt;unknown, unknown, unknown&gt; &#124; LegacyRequest, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |
 
 ## Remarks
 
diff --git a/docs/development/core/server/kibana-plugin-server.basepath.set.md b/docs/development/core/server/kibana-plugin-server.basepath.set.md
@@ -9,5 +9,5 @@ sets `basePath` value, specific for an incoming request.
 <b>Signature:</b>
 
 ```typescript
-set: (request: LegacyRequest | KibanaRequest<unknown, unknown, unknown>, requestSpecificBasePath: string) => void;
+set: (request: KibanaRequest<unknown, unknown, unknown> | LegacyRequest, requestSpecificBasePath: string) => void;
 ```
diff --git a/docs/development/core/server/kibana-plugin-server.coresetup.md b/docs/development/core/server/kibana-plugin-server.coresetup.md
@@ -19,4 +19,5 @@ export interface CoreSetup
 |  [context](./kibana-plugin-server.coresetup.context.md) | <code>ContextSetup</code> | [ContextSetup](./kibana-plugin-server.contextsetup.md) |
 |  [elasticsearch](./kibana-plugin-server.coresetup.elasticsearch.md) | <code>ElasticsearchServiceSetup</code> | [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) |
 |  [http](./kibana-plugin-server.coresetup.http.md) | <code>HttpServiceSetup</code> | [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) |
+|  [savedObjects](./kibana-plugin-server.coresetup.savedobjects.md) | <code>SavedObjectsServiceSetup</code> | [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) |
 
diff --git a/docs/development/core/server/kibana-plugin-server.coresetup.savedobjects.md b/docs/development/core/server/kibana-plugin-server.coresetup.savedobjects.md
@@ -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; [CoreSetup](./kibana-plugin-server.coresetup.md) &gt; [savedObjects](./kibana-plugin-server.coresetup.savedobjects.md)
+
+## CoreSetup.savedObjects property
+
+[SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md)
+
+<b>Signature:</b>
+
+```typescript
+savedObjects: SavedObjectsServiceSetup;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.md b/docs/development/core/server/kibana-plugin-server.md
@@ -110,6 +110,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [SavedObjectsMigrationVersion](./kibana-plugin-server.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
 |  [SavedObjectsRawDoc](./kibana-plugin-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. |
 |  [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. |
+|  [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) |  |
 |  [SavedObjectsUpdateOptions](./kibana-plugin-server.savedobjectsupdateoptions.md) |  |
 |  [SavedObjectsUpdateResponse](./kibana-plugin-server.savedobjectsupdateresponse.md) |  |
 |  [SessionStorage](./kibana-plugin-server.sessionstorage.md) | Provides an interface to store and retrieve data across requests. |
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.internalclient.md b/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.internalclient.md
@@ -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; [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) &gt; [internalClient](./kibana-plugin-server.savedobjectsservicesetup.internalclient.md)
+
+## SavedObjectsServiceSetup.internalClient property
+
+<b>Signature:</b>
+
+```typescript
+internalClient: SavedObjectsClientContract;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.md b/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.md
@@ -0,0 +1,19 @@
+<!-- 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)
+
+## SavedObjectsServiceSetup interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsServiceSetup 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [internalClient](./kibana-plugin-server.savedobjectsservicesetup.internalclient.md) | <code>SavedObjectsClientContract</code> |  |
+
diff --git a/src/core/server/index.ts b/src/core/server/index.ts
@@ -51,6 +51,7 @@ import { SavedObjectsServiceStart } from './saved_objects';
 
 import { InternalUiSettingsServiceSetup } from './ui_settings';
 import { SavedObjectsClientContract } from './saved_objects/types';
+import { SavedObjectsServiceSetup } from './saved_objects/saved_objects_service';
 
 export { bootstrap } from './bootstrap';
 export { ConfigPath, ConfigService, EnvironmentMode, PackageInfo } from './config';
@@ -166,6 +167,7 @@ export {
   SavedObjectsLegacyService,
   SavedObjectsUpdateOptions,
   SavedObjectsUpdateResponse,
+  SavedObjectsServiceSetup,
 } from './saved_objects';
 
 export {
@@ -228,6 +230,8 @@ export interface CoreSetup {
   elasticsearch: ElasticsearchServiceSetup;
   /** {@link HttpServiceSetup} */
   http: HttpServiceSetup;
+  /** {@link SavedObjectsServiceSetup} */
+  savedObjects: SavedObjectsServiceSetup;
 }
 
 /**
@@ -243,6 +247,7 @@ export interface InternalCoreSetup {
   http: InternalHttpServiceSetup;
   elasticsearch: InternalElasticsearchServiceSetup;
   uiSettings: InternalUiSettingsServiceSetup;
+  savedObjects: SavedObjectsServiceSetup;
 }
 
 /**
diff --git a/src/core/server/legacy/legacy_service.test.ts b/src/core/server/legacy/legacy_service.test.ts
@@ -47,6 +47,7 @@ import { KibanaMigrator } from '../saved_objects/migrations';
 import { ISavedObjectsClientProvider } from '../saved_objects';
 import { httpServiceMock } from '../http/http_service.mock';
 import { uiSettingsServiceMock } from '../ui_settings/ui_settings_service.mock';
+import { savedObjectsServiceMock } from '../saved_objects/saved_objects_service.mock';
 
 const MockKbnServer: jest.Mock<KbnServer> = KbnServer as any;
 
@@ -79,7 +80,7 @@ beforeEach(() => {
           getAuthHeaders: () => undefined,
         } as any,
       },
-
+      savedObjects: savedObjectsServiceMock.createSetupContract(),
       plugins: {
         contracts: new Map([['plugin-id', 'plugin-value']]),
         uiPlugins: {
diff --git a/src/core/server/legacy/legacy_service.ts b/src/core/server/legacy/legacy_service.ts
@@ -259,6 +259,9 @@ export class LegacyService implements CoreService {
         basePath: setupDeps.core.http.basePath,
         isTlsEnabled: setupDeps.core.http.isTlsEnabled,
       },
+      savedObjects: {
+        internalClient: setupDeps.core.savedObjects.internalClient,
+      },
     };
     const coreStart: CoreStart = {};
 
diff --git a/src/core/server/mocks.ts b/src/core/server/mocks.ts
@@ -22,6 +22,7 @@ import { loggingServiceMock } from './logging/logging_service.mock';
 import { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.mock';
 import { httpServiceMock } from './http/http_service.mock';
 import { contextServiceMock } from './context/context_service.mock';
+import { savedObjectsServiceMock } from './saved_objects/saved_objects_service.mock';
 
 export { httpServerMock } from './http/http_server.mocks';
 export { sessionStorageMock } from './http/cookie_session_storage.mocks';
@@ -83,6 +84,7 @@ function createCoreSetupMock() {
     context: contextServiceMock.createSetupContract(),
     elasticsearch: elasticsearchServiceMock.createSetupContract(),
     http: httpMock,
+    savedObjects: savedObjectsServiceMock.createSetupContract(),
   };
 
   return mock;
diff --git a/src/core/server/plugins/plugin.test.ts b/src/core/server/plugins/plugin.test.ts
@@ -33,6 +33,7 @@ import { PluginWrapper } from './plugin';
 import { PluginManifest } from './types';
 import { createPluginInitializerContext, createPluginSetupContext } from './plugin_context';
 import { contextServiceMock } from '../context/context_service.mock';
+import { savedObjectsServiceMock } from '../saved_objects/saved_objects_service.mock';
 
 const mockPluginInitializer = jest.fn();
 const logger = loggingServiceMock.create();
@@ -72,6 +73,7 @@ const setupDeps = {
   context: contextServiceMock.createSetupContract(),
   elasticsearch: elasticsearchServiceMock.createSetupContract(),
   http: httpServiceMock.createSetupContract(),
+  savedObjects: savedObjectsServiceMock.createSetupContract(),
 };
 beforeEach(() => {
   coreId = Symbol('core');
diff --git a/src/core/server/plugins/plugin_context.ts b/src/core/server/plugins/plugin_context.ts
@@ -123,6 +123,9 @@ export function createPluginSetupContext<TPlugin, TPluginDependencies>(
       basePath: deps.http.basePath,
       isTlsEnabled: deps.http.isTlsEnabled,
     },
+    savedObjects: {
+      internalClient: deps.savedObjects.internalClient,
+    },
   };
 }
 
diff --git a/src/core/server/plugins/plugins_service.test.ts b/src/core/server/plugins/plugins_service.test.ts
@@ -34,6 +34,7 @@ import { PluginsService } from './plugins_service';
 import { PluginsSystem } from './plugins_system';
 import { config } from './plugins_config';
 import { contextServiceMock } from '../context/context_service.mock';
+import { savedObjectsServiceMock } from '../saved_objects/saved_objects_service.mock';
 
 const MockPluginsSystem: jest.Mock<PluginsSystem> = PluginsSystem as any;
 
@@ -46,6 +47,7 @@ const setupDeps = {
   context: contextServiceMock.createSetupContract(),
   elasticsearch: elasticsearchServiceMock.createSetupContract(),
   http: httpServiceMock.createSetupContract(),
+  savedObjects: savedObjectsServiceMock.createSetupContract(),
 };
 const logger = loggingServiceMock.create();
 
diff --git a/src/core/server/plugins/plugins_service.ts b/src/core/server/plugins/plugins_service.ts
@@ -30,6 +30,7 @@ import { DiscoveredPlugin, DiscoveredPluginInternal, PluginName } from './types'
 import { PluginsConfig, PluginsConfigType } from './plugins_config';
 import { PluginsSystem } from './plugins_system';
 import { ContextSetup } from '../context';
+import { InternalSavedObjectsServiceSetup } from '../saved_objects/saved_objects_service';
 
 /** @public */
 export interface PluginsServiceSetup {
@@ -50,6 +51,7 @@ export interface PluginsServiceSetupDeps {
   context: ContextSetup;
   elasticsearch: InternalElasticsearchServiceSetup;
   http: InternalHttpServiceSetup;
+  savedObjects: InternalSavedObjectsServiceSetup;
 }
 
 /** @internal */
diff --git a/src/core/server/plugins/plugins_system.test.ts b/src/core/server/plugins/plugins_system.test.ts
@@ -35,6 +35,7 @@ import { PluginWrapper } from './plugin';
 import { PluginName } from './types';
 import { PluginsSystem } from './plugins_system';
 import { contextServiceMock } from '../context/context_service.mock';
+import { savedObjectsServiceMock } from '../saved_objects/saved_objects_service.mock';
 
 const logger = loggingServiceMock.create();
 function createPlugin(
@@ -72,6 +73,7 @@ const setupDeps = {
   context: contextServiceMock.createSetupContract(),
   elasticsearch: elasticsearchServiceMock.createSetupContract(),
   http: httpServiceMock.createSetupContract(),
+  savedObjects: savedObjectsServiceMock.createSetupContract(),
 };
 beforeEach(() => {
   env = Env.createDefault(getEnvOptions());
diff --git a/src/core/server/saved_objects/index.ts b/src/core/server/saved_objects/index.ts
@@ -35,6 +35,10 @@ export { SavedObjectsSerializer, RawDoc as SavedObjectsRawDoc } from './serializ
 
 export { SavedObjectsMigrationLogger } from './migrations/core/migration_logger';
 
-export { SavedObjectsService, SavedObjectsServiceStart } from './saved_objects_service';
+export {
+  SavedObjectsService,
+  SavedObjectsServiceStart,
+  SavedObjectsServiceSetup,
+} from './saved_objects_service';
 
 export { config } from './saved_objects_config';
diff --git a/src/core/server/saved_objects/saved_objects_service.mock.ts b/src/core/server/saved_objects/saved_objects_service.mock.ts
@@ -17,7 +17,11 @@
  * under the License.
  */
 
-import { SavedObjectsService, SavedObjectsServiceStart } from './saved_objects_service';
+import {
+  SavedObjectsService,
+  SavedObjectsServiceStart,
+  InternalSavedObjectsServiceSetup,
+} from './saved_objects_service';
 import { mockKibanaMigrator } from './migrations/kibana/kibana_migrator.mock';
 import { savedObjectsClientProviderMock } from './service/lib/scoped_client_provider.mock';
 import { SavedObjectsClientMock } from './service/saved_objects_client.mock';
@@ -33,6 +37,15 @@ const createStartContractMock = () => {
   return startContract;
 };
 
+const createSetupContractMock = () => {
+  const setupContract: jest.Mocked<InternalSavedObjectsServiceSetup> = {
+    clientProvider: savedObjectsClientProviderMock.create(),
+    internalClient: SavedObjectsClientMock.create(),
+  };
+
+  return setupContract;
+};
+
 const createsavedObjectsServiceMock = () => {
   const mocked: jest.Mocked<SavedObjectsServiceContract> = {
     setup: jest.fn(),
@@ -51,5 +64,6 @@ const createsavedObjectsServiceMock = () => {
 
 export const savedObjectsServiceMock = {
   create: createsavedObjectsServiceMock,
+  createSetupContract: createSetupContractMock,
   createStartContract: createStartContractMock,
 };
diff --git a/src/core/server/saved_objects/saved_objects_service.ts b/src/core/server/saved_objects/saved_objects_service.ts
@@ -43,10 +43,16 @@ import { Logger } from '..';
  * @public
  */
 export interface SavedObjectsServiceSetup {
-  clientProvider: ISavedObjectsClientProvider;
   internalClient: SavedObjectsClientContract;
 }
 
+/**
+ * @internal
+ */
+export interface InternalSavedObjectsServiceSetup extends SavedObjectsServiceSetup {
+  clientProvider: ISavedObjectsClientProvider;
+}
+
 /**
  * @public
  */
@@ -66,7 +72,7 @@ export interface SavedObjectsSetupDeps {
 export interface SavedObjectsStartDeps {}
 
 export class SavedObjectsService
-  implements CoreService<SavedObjectsServiceSetup, SavedObjectsServiceStart> {
+  implements CoreService<InternalSavedObjectsServiceSetup, SavedObjectsServiceStart> {
   private migrator: KibanaMigrator | undefined;
   private logger: Logger;
   private clientProvider: ISavedObjectsClientProvider<KibanaRequest> | undefined;
@@ -75,7 +81,7 @@ export class SavedObjectsService
     this.logger = coreContext.logger.get('savedobjects-service');
   }
 
-  public async setup(setupDeps: SavedObjectsSetupDeps): Promise<SavedObjectsServiceSetup> {
+  public async setup(setupDeps: SavedObjectsSetupDeps): Promise<InternalSavedObjectsServiceSetup> {
     this.logger.debug('Setting up SavedObjects service');
 
     const {
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -449,11 +449,11 @@ export interface AuthToolkit {
 export class BasePath {
     // @internal
     constructor(serverBasePath?: string);
-    get: (request: LegacyRequest | KibanaRequest<unknown, unknown, unknown>) => string;
+    get: (request: KibanaRequest<unknown, unknown, unknown> | LegacyRequest) => string;
     prepend: (path: string) => string;
     remove: (path: string) => string;
     readonly serverBasePath: string;
-    set: (request: LegacyRequest | KibanaRequest<unknown, unknown, unknown>, requestSpecificBasePath: string) => void;
+    set: (request: KibanaRequest<unknown, unknown, unknown> | LegacyRequest, requestSpecificBasePath: string) => void;
 }
 
 // Warning: (ae-forgotten-export) The symbol "BootstrapArgs" needs to be exported by the entry point index.d.ts
@@ -511,6 +511,8 @@ export interface CoreSetup {
     elasticsearch: ElasticsearchServiceSetup;
     // (undocumented)
     http: HttpServiceSetup;
+    // (undocumented)
+    savedObjects: SavedObjectsServiceSetup;
 }
 
 // @public
@@ -723,6 +725,8 @@ export interface InternalCoreSetup {
     // (undocumented)
     http: InternalHttpServiceSetup;
     // (undocumented)
+    savedObjects: SavedObjectsServiceSetup;
+    // (undocumented)
     uiSettings: InternalUiSettingsServiceSetup;
 }
 
@@ -1551,6 +1555,12 @@ export class SavedObjectsSerializer {
     savedObjectToRaw(savedObj: SanitizedSavedObjectDoc): SavedObjectsRawDoc;
     }
 
+// @public (undocumented)
+export interface SavedObjectsServiceSetup {
+    // (undocumented)
+    internalClient: SavedObjectsClientContract;
+}
+
 // @public (undocumented)
 export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions {
     references?: SavedObjectReference[];
@@ -1613,6 +1623,6 @@ export type UiSettingsType = 'json' | 'markdown' | 'number' | 'select' | 'boolea
 // Warnings were encountered during analysis:
 // 
 // src/core/server/http/router/response.ts:316:3 - (ae-forgotten-export) The symbol "KibanaResponse" needs to be exported by the entry point index.d.ts
-// src/core/server/plugins/plugins_service.ts:39:5 - (ae-forgotten-export) The symbol "DiscoveredPluginInternal" needs to be exported by the entry point index.d.ts
+// src/core/server/plugins/plugins_service.ts:40:5 - (ae-forgotten-export) The symbol "DiscoveredPluginInternal" needs to be exported by the entry point index.d.ts
 
 ```
diff --git a/src/core/server/server.ts b/src/core/server/server.ts
@@ -38,7 +38,7 @@ import { config as savedObjectsConfig } from './saved_objects';
 import { config as uiSettingsConfig } from './ui_settings';
 import { mapToObject } from '../utils/';
 import { ContextService } from './context';
-import { SavedObjectsServiceSetup } from './saved_objects/saved_objects_service';
+import { InternalSavedObjectsServiceSetup } from './saved_objects/saved_objects_service';
 import { RequestHandlerContext } from '.';
 
 const coreId = Symbol('core');
@@ -168,7 +168,7 @@ export class Server {
   private registerCoreContext(coreSetup: {
     http: InternalHttpServiceSetup;
     elasticsearch: ElasticsearchServiceSetup;
-    savedObjects: SavedObjectsServiceSetup;
+    savedObjects: InternalSavedObjectsServiceSetup;
   }) {
     coreSetup.http.registerRouteHandlerContext(
       coreId,
