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

@@ -136,6 +136,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';
@@ -268,6 +269,8 @@ export interface CoreSetup {
   savedObjects: SavedObjectsServiceSetup;
   /** {@link UiSettingsServiceSetup} */
   uiSettings: UiSettingsServiceSetup;
+  /** {@link UuidServiceSetup} */
+  uuid: UuidServiceSetup;
 }
 
 /**
@@ -289,4 +292,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

@@ -73,6 +73,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,6 +25,8 @@
 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.mocks.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 const findLegacyPluginSpecsMock = jest
+  .fn()
+  .mockImplementation((settings: Record<string, any>) => ({
+    pluginSpecs: [],
+    pluginExtendedConfig: {
+      has: jest.fn(),
+      get: jest.fn(() => settings),
+      set: jest.fn(),
+    },
+    disabledPluginSpecs: [],
+    uiExports: [],
+  }));
+jest.doMock('./plugins/find_legacy_plugin_specs.ts', () => ({
+  findLegacyPluginSpecs: findLegacyPluginSpecsMock,
+}));

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

@@ -17,36 +17,34 @@
  * under the License.
  */
 
-import { BehaviorSubject, throwError } from 'rxjs';
-
 jest.mock('../../../legacy/server/kbn_server');
 jest.mock('../../../cli/cluster/cluster_manager');
-jest.mock('./plugins/find_legacy_plugin_specs');
 jest.mock('./config/legacy_deprecation_adapters', () => ({
   convertLegacyDeprecationProvider: (provider: any) => Promise.resolve(provider),
 }));
+import { findLegacyPluginSpecsMock } from './legacy_service.test.mocks';
 
+import { BehaviorSubject, throwError } from 'rxjs';
 import { LegacyService, LegacyServiceSetupDeps, LegacyServiceStartDeps } from '.';
 // @ts-ignore: implicit any for JS file
 import MockClusterManager from '../../../cli/cluster/cluster_manager';
 import KbnServer from '../../../legacy/server/kbn_server';
 import { Config, Env, ObjectToConfigAdapter } from '../config';
-import { contextServiceMock } from '../context/context_service.mock';
 import { getEnvOptions } from '../config/__mocks__/env';
-import { configServiceMock } from '../config/config_service.mock';
-
 import { BasePathProxyServer } from '../http';
-import { loggingServiceMock } from '../logging/logging_service.mock';
 import { DiscoveredPlugin } from '../plugins';
+import { findLegacyPluginSpecs } from './plugins/find_legacy_plugin_specs';
 
+import { configServiceMock } from '../config/config_service.mock';
+import { loggingServiceMock } from '../logging/logging_service.mock';
+import { contextServiceMock } from '../context/context_service.mock';
 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 { findLegacyPluginSpecs } from './plugins/find_legacy_plugin_specs';
+import { uuidServiceMock } from '../uuid/uuid_service.mock';
 
 const MockKbnServer: jest.Mock<KbnServer> = KbnServer as any;
-const findLegacyPluginSpecsMock: jest.Mock<typeof findLegacyPluginSpecs> = findLegacyPluginSpecs as any;
 
 let coreId: symbol;
 let env: Env;
@@ -58,23 +56,17 @@ let startDeps: LegacyServiceStartDeps;
 
 const logger = loggingServiceMock.create();
 let configService: ReturnType<typeof configServiceMock.create>;
+let uuidSetup: ReturnType<typeof uuidServiceMock.createSetupContract>;
 
 beforeEach(() => {
   coreId = Symbol();
   env = Env.createDefault(getEnvOptions());
   configService = configServiceMock.create();
+  uuidSetup = uuidServiceMock.createSetupContract();
 
-  findLegacyPluginSpecsMock.mockImplementation(
-    settings =>
-      Promise.resolve({
-        pluginSpecs: [],
-        pluginExtendedConfig: settings,
-        disabledPluginSpecs: [],
-        uiExports: [],
-      }) as any
-  );
-
+  findLegacyPluginSpecsMock.mockClear();
   MockKbnServer.prototype.ready = jest.fn().mockReturnValue(Promise.resolve());
+  MockKbnServer.prototype.listen = jest.fn();
 
   setupDeps = {
     core: {
@@ -97,6 +89,7 @@ beforeEach(() => {
           browserConfigs: new Map(),
         },
       },
+      uuid: uuidSetup,
     },
     plugins: { 'plugin-id': 'plugin-value' },
   };
@@ -123,7 +116,6 @@ beforeEach(() => {
 
 afterEach(() => {
   jest.clearAllMocks();
-  findLegacyPluginSpecsMock.mockReset();
 });
 
 describe('once LegacyService is set up with connection info', () => {
@@ -142,11 +134,15 @@ describe('once LegacyService is set up with connection info', () => {
 
     expect(MockKbnServer).toHaveBeenCalledTimes(1);
     expect(MockKbnServer).toHaveBeenCalledWith(
-      { path: { autoListen: true }, server: { autoListen: true } },
       { path: { autoListen: true }, server: { autoListen: true } }, // Because of the mock, path also gets the value
+      expect.objectContaining({ get: expect.any(Function) }),
       expect.any(Object),
       { disabledPluginSpecs: [], pluginSpecs: [], uiExports: [] }
     );
+    expect(MockKbnServer.mock.calls[0][1].get()).toEqual({
+      path: { autoListen: true },
+      server: { autoListen: true },
+    });
 
     const [mockKbnServer] = MockKbnServer.mock.instances;
     expect(mockKbnServer.listen).toHaveBeenCalledTimes(1);
@@ -169,10 +165,14 @@ describe('once LegacyService is set up with connection info', () => {
     expect(MockKbnServer).toHaveBeenCalledTimes(1);
     expect(MockKbnServer).toHaveBeenCalledWith(
       { path: { autoListen: false }, server: { autoListen: true } },
-      { path: { autoListen: false }, server: { autoListen: true } },
+      expect.objectContaining({ get: expect.any(Function) }),
       expect.any(Object),
       { disabledPluginSpecs: [], pluginSpecs: [], uiExports: [] }
     );
+    expect(MockKbnServer.mock.calls[0][1].get()).toEqual({
+      path: { autoListen: false },
+      server: { autoListen: true },
+    });
 
     const [mockKbnServer] = MockKbnServer.mock.instances;
     expect(mockKbnServer.ready).toHaveBeenCalledTimes(1);
@@ -306,10 +306,14 @@ describe('once LegacyService is set up without connection info', () => {
     expect(MockKbnServer).toHaveBeenCalledTimes(1);
     expect(MockKbnServer).toHaveBeenCalledWith(
       { path: {}, server: { autoListen: true } },
-      { path: {}, server: { autoListen: true } },
+      expect.objectContaining({ get: expect.any(Function) }),
       expect.any(Object),
       { disabledPluginSpecs: [], pluginSpecs: [], uiExports: [] }
     );
+    expect(MockKbnServer.mock.calls[0][1].get()).toEqual({
+      path: {},
+      server: { autoListen: true },
+    });
   });
 
   test('reconfigures logging configuration if new config is received.', async () => {
@@ -440,3 +444,34 @@ describe('#discoverPlugins()', () => {
     expect(configService.addDeprecationProvider).toHaveBeenCalledWith('', 'providerB');
   });
 });
+
+test('Sets the server.uuid property on the legacy configuration', async () => {
+  configService.atPath.mockReturnValue(new BehaviorSubject({ autoListen: true }));
+  const legacyService = new LegacyService({
+    coreId,
+    env,
+    logger,
+    configService: configService as any,
+  });
+
+  uuidSetup.getInstanceUuid.mockImplementation(() => 'UUID_FROM_SERVICE');
+
+  const configSetMock = jest.fn();
+
+  findLegacyPluginSpecsMock.mockImplementation((settings: Record<string, any>) => ({
+    pluginSpecs: [],
+    pluginExtendedConfig: {
+      has: jest.fn(),
+      get: jest.fn(() => settings),
+      set: configSetMock,
+    },
+    disabledPluginSpecs: [],
+    uiExports: [],
+  }));
+
+  await legacyService.discoverPlugins();
+  await legacyService.setup(setupDeps);
+
+  expect(configSetMock).toHaveBeenCalledTimes(1);
+  expect(configSetMock).toHaveBeenCalledWith('server.uuid', 'UUID_FROM_SERVICE');
+});