Migrate instance uuid logic to new platform (#52060)

* move and migrate uuid code to new platform

* create and wire uuid service

* handle legacy compatibility

* update generated docs

* add `set` to LegacyConfig interface

* Fix types

* fix config access

* respect naming conventions for uuid

* remove hardcoded config paths

* rename manageInstanceUuid to resolveInstanceUuid

* moves legacy config uuid set from uuid to legacy service

* log specific message depending on how uuid was resolved

* resolve merge conflicts

* use fs.promises

* add forgotten @public in uuid contract

* add explicit errors and tests

* ensure uuid is valid in configuration

* fix read/write tests

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

@@ -138,6 +138,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.test.ts

@@ -17,6 +17,7 @@
  * under the License.
  */
 
+import uuid from 'uuid';
 import { config, HttpConfig } from '.';
 import { Env } from '../config';
 import { getEnvOptions } from '../config/__mocks__/env';
@@ -77,6 +78,14 @@ test('throws if basepath is not specified, but rewriteBasePath is set', () => {
   expect(() => httpSchema.validate(obj)).toThrowErrorMatchingSnapshot();
 });
 
+test('accepts only valid uuids for server.uuid', () => {
+  const httpSchema = config.schema;
+  expect(() => httpSchema.validate({ uuid: uuid.v4() })).not.toThrow();
+  expect(() => httpSchema.validate({ uuid: 'not an uuid' })).toThrowErrorMatchingInlineSnapshot(
+    `"[uuid]: must be a valid uuid"`
+  );
+});
+
 describe('with TLS', () => {
   test('throws if TLS is enabled but `key` is not specified', () => {
     const httpSchema = config.schema;

src/core/server/http/http_config.ts

@@ -23,6 +23,7 @@ import { CspConfigType, CspConfig, ICspConfig } from '../csp';
 import { SslConfig, sslSchema } from './ssl_config';
 
 const validBasePathRegex = /(^$|^\/.*[^\/]$)/;
+const uuidRegexp = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
 
 const match = (regex: RegExp, errorMsg: string) => (str: string) =>
   regex.test(str) ? undefined : errorMsg;
@@ -92,6 +93,11 @@ export const config = {
           )
         ),
       }),
+      uuid: schema.maybe(
+        schema.string({
+          validate: match(uuidRegexp, 'must be a valid uuid'),
+        })
+      ),
     },
     {
       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';
@@ -269,6 +270,8 @@ export interface CoreSetup {
   savedObjects: SavedObjectsServiceSetup;
   /** {@link UiSettingsServiceSetup} */
   uiSettings: UiSettingsServiceSetup;
+  /** {@link UuidServiceSetup} */
+  uuid: UuidServiceSetup;
 }
 
 /**
@@ -290,4 +293,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,
+}));