Migrate instance uuid logic to new platform

docs/development/core/server/kibana-plugin-server.coresetup.md

@@ -22,4 +22,5 @@ export interface CoreSetup
 |  [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) |
 |  [uiSettings](./kibana-plugin-server.coresetup.uisettings.md) | <code>UiSettingsServiceSetup</code> | [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) |
+|  [uuid](./kibana-plugin-server.coresetup.uuid.md) | <code>UuidServiceSetup</code> | [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md) |
 

docs/development/core/server/kibana-plugin-server.coresetup.uuid.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; [uuid](./kibana-plugin-server.coresetup.uuid.md)
+
+## CoreSetup.uuid property
+
+[UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md)
+
+<b>Signature:</b>
+
+```typescript
+uuid: UuidServiceSetup;
+```

docs/development/core/server/kibana-plugin-server.md

@@ -132,6 +132,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) | UiSettings parameters defined by the plugins. |
 |  [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) |  |
 |  [UserProvidedValues](./kibana-plugin-server.userprovidedvalues.md) | Describes the values explicitly set by user. |
+|  [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md) | APIs to access the application's instance uuid. |
 
 ## Variables
 

docs/development/core/server/kibana-plugin-server.uuidservicesetup.getinstanceuuid.md

@@ -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; [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md) &gt; [getInstanceUuid](./kibana-plugin-server.uuidservicesetup.getinstanceuuid.md)
+
+## UuidServiceSetup.getInstanceUuid() method
+
+Retrieve the Kibana instance uuid.
+
+<b>Signature:</b>
+
+```typescript
+getInstanceUuid(): string;
+```
+<b>Returns:</b>
+
+`string`
+

docs/development/core/server/kibana-plugin-server.uuidservicesetup.md

@@ -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; [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md)
+
+## UuidServiceSetup interface
+
+APIs to access the application's instance uuid.
+
+<b>Signature:</b>
+
+```typescript
+export interface UuidServiceSetup 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [getInstanceUuid()](./kibana-plugin-server.uuidservicesetup.getinstanceuuid.md) | Retrieve the Kibana instance uuid. |
+

src/core/server/http/http_config.ts

@@ -91,6 +91,7 @@ export const config = {
           )
         ),
       }),
+      uuid: schema.maybe(schema.string()),
     },
     {
       validate: rawConfig => {

src/core/server/index.ts

@@ -47,6 +47,7 @@ import { IUiSettingsClient, UiSettingsServiceSetup } from './ui_settings';
 import { SavedObjectsClientContract } from './saved_objects/types';
 import { SavedObjectsServiceSetup, SavedObjectsServiceStart } from './saved_objects';
 import { CapabilitiesSetup, CapabilitiesStart } from './capabilities';
+import { UuidServiceSetup } from './uuid';
 
 export { bootstrap } from './bootstrap';
 export { Capabilities, CapabilitiesProvider, CapabilitiesSwitcher } from './capabilities';
@@ -254,6 +255,8 @@ export interface CoreSetup {
   savedObjects: SavedObjectsServiceSetup;
   /** {@link UiSettingsServiceSetup} */
   uiSettings: UiSettingsServiceSetup;
+  /** {@link UuidServiceSetup} */
+  uuid: UuidServiceSetup;
 }
 
 /**
@@ -275,4 +278,5 @@ export {
   PluginsServiceSetup,
   PluginsServiceStart,
   PluginOpaqueId,
+  UuidServiceSetup,
 };

src/core/server/internal_types.ts

@@ -26,6 +26,7 @@ import {
   InternalSavedObjectsServiceSetup,
 } from './saved_objects';
 import { CapabilitiesSetup, CapabilitiesStart } from './capabilities';
+import { UuidServiceSetup } from './uuid';
 
 /** @internal */
 export interface InternalCoreSetup {
@@ -35,6 +36,7 @@ export interface InternalCoreSetup {
   elasticsearch: InternalElasticsearchServiceSetup;
   uiSettings: InternalUiSettingsServiceSetup;
   savedObjects: InternalSavedObjectsServiceSetup;
+  uuid: UuidServiceSetup;
 }
 
 /**

src/core/server/legacy/config/legacy_object_to_config_adapter.ts

@@ -72,6 +72,7 @@ export class LegacyObjectToConfigAdapter extends ObjectToConfigAdapter {
       keepaliveTimeout: configValue.keepaliveTimeout,
       socketTimeout: configValue.socketTimeout,
       compression: configValue.compression,
+      uuid: configValue.uuid,
     };
   }
 

src/core/server/legacy/config/types.ts

@@ -25,4 +25,6 @@
 export interface LegacyConfig {
   get<T>(key?: string): T;
   has(key: string): boolean;
+  set(key: string, value: any): void;
+  set(config: Record<string, any>): void;
 }

src/core/server/legacy/legacy_service.mock.ts

@@ -0,0 +1,39 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { LegacyServiceDiscoverPlugins } from './legacy_service';
+
+const createDiscoverMock = () => {
+  const setupContract: DeeplyMockedKeys<LegacyServiceDiscoverPlugins> = {
+    pluginSpecs: [],
+    disabledPluginSpecs: [],
+    uiExports: {} as any,
+    settings: {},
+    pluginExtendedConfig: {
+      get: jest.fn(),
+      has: jest.fn(),
+      set: jest.fn(),
+    } as any,
+  };
+  return setupContract;
+};
+
+export const legacyServiceMock = {
+  createDiscover: createDiscoverMock,
+};

src/core/server/legacy/legacy_service.test.ts

@@ -47,6 +47,7 @@ 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';
 import { capabilitiesServiceMock } from '../capabilities/capabilities_service.mock';
+import { uuidServiceMock } from '../uuid/uuid_service.mock';
 
 const MockKbnServer: jest.Mock<KbnServer> = KbnServer as any;
 
@@ -89,6 +90,7 @@ beforeEach(() => {
           browserConfigs: new Map(),
         },
       },
+      uuid: uuidServiceMock.createSetupContract(),
     },
     plugins: { 'plugin-id': 'plugin-value' },
   };

src/core/server/legacy/legacy_service.ts

@@ -282,6 +282,9 @@ export class LegacyService implements CoreService {
       uiSettings: {
         register: setupDeps.core.uiSettings.register,
       },
+      uuid: {
+        getInstanceUuid: setupDeps.core.uuid.getInstanceUuid,
+      },
     };
     const coreStart: CoreStart = {
       capabilities: startDeps.core.capabilities,

src/core/server/mocks.ts

@@ -37,6 +37,7 @@ export { httpServiceMock } from './http/http_service.mock';
 export { loggingServiceMock } from './logging/logging_service.mock';
 export { savedObjectsClientMock } from './saved_objects/service/saved_objects_client.mock';
 export { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
+import { uuidServiceMock } from './uuid/uuid_service.mock';
 
 export function pluginInitializerContextConfigMock<T>(config: T) {
   const globalConfig: SharedGlobalConfig = {
@@ -107,6 +108,7 @@ function createCoreSetupMock() {
     http: httpMock,
     savedObjects: savedObjectsServiceMock.createSetupContract(),
     uiSettings: uiSettingsMock,
+    uuid: uuidServiceMock.createSetupContract(),
   };
 
   return mock;
@@ -129,6 +131,7 @@ function createInternalCoreSetupMock() {
     http: httpServiceMock.createSetupContract(),
     uiSettings: uiSettingsServiceMock.createSetupContract(),
     savedObjects: savedObjectsServiceMock.createSetupContract(),
+    uuid: uuidServiceMock.createSetupContract(),
   };
   return setupDeps;
 }

src/core/server/plugins/plugin_context.ts

@@ -171,6 +171,9 @@ export function createPluginSetupContext<TPlugin, TPluginDependencies>(
     uiSettings: {
       register: deps.uiSettings.register,
     },
+    uuid: {
+      getInstanceUuid: deps.uuid.getInstanceUuid,
+    },
   };
 }
 

src/core/server/saved_objects/migrations/core/build_index_map.test.ts

@@ -22,9 +22,11 @@ import { ObjectToConfigAdapter } from '../../../config';
 import { SavedObjectsSchema } from '../../schema';
 import { LegacyConfig } from '../../../legacy/config';
 
+const config = (new ObjectToConfigAdapter({}) as unknown) as LegacyConfig;
+
 test('mappings without index pattern goes to default index', () => {
   const result = createIndexMap({
-    config: new ObjectToConfigAdapter({}) as LegacyConfig,
+    config,
     kibanaIndexName: '.kibana',
     schema: new SavedObjectsSchema({
       type1: {
@@ -58,7 +60,7 @@ test('mappings without index pattern goes to default index', () => {
 
 test(`mappings with custom index pattern doesn't go to default index`, () => {
   const result = createIndexMap({
-    config: new ObjectToConfigAdapter({}) as LegacyConfig,
+    config,
     kibanaIndexName: '.kibana',
     schema: new SavedObjectsSchema({
       type1: {
@@ -93,7 +95,7 @@ test(`mappings with custom index pattern doesn't go to default index`, () => {
 
 test('creating a script gets added to the index pattern', () => {
   const result = createIndexMap({
-    config: new ObjectToConfigAdapter({}) as LegacyConfig,
+    config,
     kibanaIndexName: '.kibana',
     schema: new SavedObjectsSchema({
       type1: {
@@ -158,7 +160,7 @@ test('throws when two scripts are defined for an index pattern', () => {
   };
   expect(() =>
     createIndexMap({
-      config: new ObjectToConfigAdapter({}) as LegacyConfig,
+      config,
       kibanaIndexName: defaultIndex,
       schema,
       indexMap,

src/core/server/server.api.md

@@ -544,6 +544,8 @@ export interface CoreSetup {
     savedObjects: SavedObjectsServiceSetup;
     // (undocumented)
     uiSettings: UiSettingsServiceSetup;
+    // (undocumented)
+    uuid: UuidServiceSetup;
 }
 
 // @public
@@ -1755,6 +1757,13 @@ export interface UserProvidedValues<T = any> {
     userValue?: T;
 }
 
+// Warning: (ae-missing-release-tag) "UuidServiceSetup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+// 
+// @public
+export interface UuidServiceSetup {
+    getInstanceUuid(): string;
+}
+
 // @public
 export const validBodyOutput: readonly ["data", "stream"];
 

src/core/server/server.test.mocks.ts

@@ -69,3 +69,9 @@ export const mockEnsureValidConfiguration = jest.fn();
 jest.doMock('./legacy/config/ensure_valid_configuration', () => ({
   ensureValidConfiguration: mockEnsureValidConfiguration,
 }));
+
+import { uuidServiceMock } from './uuid/uuid_service.mock';
+export const mockUuidService = uuidServiceMock.create();
+jest.doMock('./uuid/uuid_service', () => ({
+  UuidService: jest.fn(() => mockUuidService),
+}));

src/core/server/server.ts

@@ -42,6 +42,7 @@ import { ContextService } from './context';
 import { RequestHandlerContext } from '.';
 import { InternalCoreSetup } from './internal_types';
 import { CapabilitiesService } from './capabilities';
+import { UuidService } from './uuid';
 
 const coreId = Symbol('core');
 
@@ -56,6 +57,7 @@ export class Server {
   private readonly plugins: PluginsService;
   private readonly savedObjects: SavedObjectsService;
   private readonly uiSettings: UiSettingsService;
+  private readonly uuid: UuidService;
 
   constructor(
     public readonly config$: Observable<Config>,
@@ -74,6 +76,7 @@ export class Server {
     this.savedObjects = new SavedObjectsService(core);
     this.uiSettings = new UiSettingsService(core);
     this.capabilities = new CapabilitiesService(core);
+    this.uuid = new UuidService(core);
   }
 
   public async setup() {
@@ -97,6 +100,8 @@ export class Server {
       ]),
     });
 
+    const uuidSetup = await this.uuid.setup({ legacyPlugins });
+
     const httpSetup = await this.http.setup({
       context: contextServiceSetup,
     });
@@ -125,6 +130,7 @@ export class Server {
       http: httpSetup,
       uiSettings: uiSettingsSetup,
       savedObjects: savedObjectsSetup,
+      uuid: uuidSetup,
     };
 
     const pluginsSetup = await this.plugins.setup(coreSetup);

src/core/server/uuid/index.ts

@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export { UuidService, UuidServiceSetup } from './uuid_service';