Convert uiSettings service to TypeScript (#47018)

* tsify is_config_version_upgradeable

* tsify get_upgradeable_config

* tsify create_or_upgrade_saved_config

* tsify ui_settings_service

* tsify ui_settings_service_factory

* tsify ui_settings_service_for_request

* declare types on server object

* tsify set route

* tsify set_many route

* tsify get route

* tsify delete route

* tsify logWithMetadata

* improve ui_settings_service typings

* introduce uiService mocks

* remove private methods from public contract

* add types for server.uiSettingsServiceFactory

* rename IUiSettingsService --> IUiSettingsClient

src/legacy/server/kbn_server.d.ts

@@ -39,6 +39,8 @@ import { CallClusterWithRequest, ElasticsearchPlugin } from '../core_plugins/ela
 import { CapabilitiesModifier } from './capabilities';
 import { IndexPatternsServiceFactory } from './index_patterns';
 import { Capabilities } from '../../core/public';
+import { IUiSettingsClient } from '../../legacy/ui/ui_settings/ui_settings_service';
+import { UiSettingsServiceFactoryOptions } from '../../legacy/ui/ui_settings/ui_settings_service_factory';
 
 export interface KibanaConfig {
   get<T>(key: string): T;
@@ -77,14 +79,15 @@ declare module 'hapi' {
       name: string,
       factoryFn: (request: Request) => Record<string, any>
     ) => void;
-    uiSettingsServiceFactory: (options: any) => any;
+    uiSettingsServiceFactory: (options?: UiSettingsServiceFactoryOptions) => IUiSettingsClient;
+    logWithMetadata: (tags: string[], message: string, meta: Record<string, any>) => void;
   }
 
   interface Request {
     getSavedObjectsClient(options?: SavedObjectsClientProviderOptions): SavedObjectsClientContract;
     getBasePath(): string;
     getDefaultRoute(): Promise<string>;
-    getUiSettingsService(): any;
+    getUiSettingsService(): IUiSettingsClient;
     getCapabilities(): Promise<Capabilities>;
   }
 

src/legacy/ui/ui_settings/create_objects_client_stub.ts

@@ -26,6 +26,10 @@ export interface SavedObjectsClientStub {
   update: sinon.SinonStub<any[], any>;
   get: sinon.SinonStub<any[], any>;
   create: sinon.SinonStub<any[], any>;
+  bulkCreate: sinon.SinonStub<any[], any>;
+  bulkGet: sinon.SinonStub<any[], any>;
+  delete: sinon.SinonStub<any[], any>;
+  find: sinon.SinonStub<any[], any>;
   errors: typeof savedObjectsClientErrors;
 }
 
@@ -35,6 +39,10 @@ export function createObjectsClientStub(esDocSource = {}): SavedObjectsClientStu
     get: sinon.stub().returns({ attributes: esDocSource }),
     create: sinon.stub(),
     errors: savedObjectsClientErrors,
+    bulkCreate: sinon.stub(),
+    bulkGet: sinon.stub(),
+    delete: sinon.stub(),
+    find: sinon.stub(),
   };
   return savedObjectsClient;
 }

src/legacy/ui/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts

@@ -21,9 +21,7 @@ import sinon from 'sinon';
 import expect from '@kbn/expect';
 import Chance from 'chance';
 
-// @ts-ignore
 import * as getUpgradeableConfigNS from './get_upgradeable_config';
-// @ts-ignore
 import { createOrUpgradeSavedConfig } from './create_or_upgrade_saved_config';
 
 const chance = new Chance();
@@ -45,7 +43,7 @@ describe('uiSettings/createOrUpgradeSavedConfig', function() {
         id: options.id,
         version: 'foo',
       })),
-    };
+    } as any; // mute until we have savedObjects mocks
 
     async function run(options = {}) {
       const resp = await createOrUpgradeSavedConfig({
@@ -103,7 +101,12 @@ describe('uiSettings/createOrUpgradeSavedConfig', function() {
         [chance.word()]: chance.sentence(),
       };
 
-      getUpgradeableConfig.returns({ id: prevVersion, attributes: savedAttributes });
+      getUpgradeableConfig.resolves({
+        id: prevVersion,
+        attributes: savedAttributes,
+        type: '',
+        references: [],
+      });
 
       await run();
 
@@ -125,7 +128,12 @@ describe('uiSettings/createOrUpgradeSavedConfig', function() {
     it('should log a message for upgrades', async () => {
       const { getUpgradeableConfig, logWithMetadata, run } = setup();
 
-      getUpgradeableConfig.returns({ id: prevVersion, attributes: { buildNum: buildNum - 100 } });
+      getUpgradeableConfig.resolves({
+        id: prevVersion,
+        attributes: { buildNum: buildNum - 100 },
+        type: '',
+        references: [],
+      });
 
       await run();
       sinon.assert.calledOnce(logWithMetadata);
@@ -143,7 +151,12 @@ describe('uiSettings/createOrUpgradeSavedConfig', function() {
     it('does not log when upgrade fails', async () => {
       const { getUpgradeableConfig, logWithMetadata, run, savedObjectsClient } = setup();
 
-      getUpgradeableConfig.returns({ id: prevVersion, attributes: { buildNum: buildNum - 100 } });
+      getUpgradeableConfig.resolves({
+        id: prevVersion,
+        attributes: { buildNum: buildNum - 100 },
+        type: '',
+        references: [],
+      });
 
       savedObjectsClient.create.callsFake(async () => {
         throw new Error('foo');

src/legacy/ui/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.js → src/legacy/ui/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts

@@ -18,37 +18,38 @@
  */
 
 import { defaults } from 'lodash';
+import { SavedObjectsClientContract, SavedObjectAttribute } from 'src/core/server';
+import { Legacy } from 'kibana';
 
 import { getUpgradeableConfig } from './get_upgradeable_config';
 
-export async function createOrUpgradeSavedConfig(options) {
-  const {
-    savedObjectsClient,
-    version,
-    buildNum,
-    logWithMetadata,
-    onWriteError,
-  } = options;
+interface Options {
+  savedObjectsClient: SavedObjectsClientContract;
+  version: string;
+  buildNum: number;
+  logWithMetadata: Legacy.Server['logWithMetadata'];
+  onWriteError?: <T extends SavedObjectAttribute = any>(
+    error: Error,
+    attributes: Record<string, any>
+  ) => Record<string, T> | undefined;
+}
+export async function createOrUpgradeSavedConfig<T extends SavedObjectAttribute = any>(
+  options: Options
+): Promise<Record<string, T> | undefined> {
+  const { savedObjectsClient, version, buildNum, logWithMetadata, onWriteError } = options;
 
   // try to find an older config we can upgrade
   const upgradeableConfig = await getUpgradeableConfig({
     savedObjectsClient,
-    version
+    version,
   });
 
   // default to the attributes of the upgradeableConfig if available
-  const attributes = defaults(
-    { buildNum },
-    upgradeableConfig ? upgradeableConfig.attributes : {}
-  );
+  const attributes = defaults({ buildNum }, upgradeableConfig ? upgradeableConfig.attributes : {});
 
   try {
     // create the new SavedConfig
-    await savedObjectsClient.create(
-      'config',
-      attributes,
-      { id: version }
-    );
+    await savedObjectsClient.create('config', attributes, { id: version });
   } catch (error) {
     if (onWriteError) {
       return onWriteError(error, attributes);
@@ -58,9 +59,13 @@ export async function createOrUpgradeSavedConfig(options) {
   }
 
   if (upgradeableConfig) {
-    logWithMetadata(['plugin', 'elasticsearch'], `Upgrade config from ${upgradeableConfig.id} to ${version}`, {
-      prevVersion: upgradeableConfig.id,
-      newVersion: version
-    });
+    logWithMetadata(
+      ['plugin', 'elasticsearch'],
+      `Upgrade config from ${upgradeableConfig.id} to ${version}`,
+      {
+        prevVersion: upgradeableConfig.id,
+        newVersion: version,
+      }
+    );
   }
 }

src/legacy/ui/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.js → src/legacy/ui/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import { SavedObjectsClientContract } from 'src/core/server';
 import { isConfigVersionUpgradeable } from './is_config_version_upgradeable';
 
 /**
@@ -26,18 +26,22 @@ import { isConfigVersionUpgradeable } from './is_config_version_upgradeable';
  *  @property {string} version
  *  @return {Promise<SavedConfig|undefined>}
  */
-export async function getUpgradeableConfig({ savedObjectsClient, version }) {
+export async function getUpgradeableConfig({
+  savedObjectsClient,
+  version,
+}: {
+  savedObjectsClient: SavedObjectsClientContract;
+  version: string;
+}) {
   // attempt to find a config we can upgrade
   const { saved_objects: savedConfigs } = await savedObjectsClient.find({
     type: 'config',
     page: 1,
     perPage: 1000,
     sortField: 'buildNum',
-    sortOrder: 'desc'
+    sortOrder: 'desc',
   });
 
   // try to find a config that we can upgrade
-  return savedConfigs.find(savedConfig => (
-    isConfigVersionUpgradeable(savedConfig.id, version)
-  ));
+  return savedConfigs.find(savedConfig => isConfigVersionUpgradeable(savedConfig.id, version));
 }

src/legacy/ui/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts

@@ -24,7 +24,6 @@ import { SavedObjectsClientContract } from 'src/core/server';
 
 import KbnServer from '../../../../server/kbn_server';
 import { createTestServers } from '../../../../../test_utils/kbn_server';
-// @ts-ignore
 import { createOrUpgradeSavedConfig } from '../create_or_upgrade_saved_config';
 
 describe('createOrUpgradeSavedConfig()', () => {

src/legacy/ui/ui_settings/create_or_upgrade_saved_config/is_config_version_upgradeable.test.ts

@@ -19,7 +19,6 @@
 
 import expect from '@kbn/expect';
 
-// @ts-ignore
 import { isConfigVersionUpgradeable } from './is_config_version_upgradeable';
 // @ts-ignore
 import { pkg } from '../../../utils';

src/legacy/ui/ui_settings/create_or_upgrade_saved_config/is_config_version_upgradeable.js → src/legacy/ui/ui_settings/create_or_upgrade_saved_config/is_config_version_upgradeable.ts

@@ -20,14 +20,12 @@
 import semver from 'semver';
 const rcVersionRegex = /^(\d+\.\d+\.\d+)\-rc(\d+)$/i;
 
-function extractRcNumber(version) {
+function extractRcNumber(version: string): [string, number] {
   const match = version.match(rcVersionRegex);
-  return match
-    ? [match[1], parseInt(match[2], 10)]
-    : [version, Infinity];
+  return match ? [match[1], parseInt(match[2], 10)] : [version, Infinity];
 }
 
-export function isConfigVersionUpgradeable(savedVersion, kibanaVersion) {
+export function isConfigVersionUpgradeable(savedVersion: string, kibanaVersion: string): boolean {
   if (
     typeof savedVersion !== 'string' ||
     typeof kibanaVersion !== 'string' ||

src/legacy/ui/ui_settings/integration_tests/ui_settings_mixin.test.ts

@@ -23,9 +23,7 @@ import expect from '@kbn/expect';
 // @ts-ignore
 import { Config } from '../../../server/config';
 
-// @ts-ignore
 import * as uiSettingsServiceFactoryNS from '../ui_settings_service_factory';
-// @ts-ignore
 import * as getUiSettingsServiceForRequestNS from '../ui_settings_service_for_request';
 // @ts-ignore
 import { uiSettingsMixin } from '../ui_settings_mixin';
@@ -123,7 +121,8 @@ describe('uiSettingsMixin()', () => {
         foo: 'bar',
       });
       sinon.assert.calledOnce(uiSettingsServiceFactoryStub);
-      sinon.assert.calledWithExactly(uiSettingsServiceFactoryStub, server, {
+      sinon.assert.calledWithExactly(uiSettingsServiceFactoryStub, server as any, {
+        // @ts-ignore foo doesn't exist on Hapi.Server
         foo: 'bar',
         overrides: {
           foo: 'bar',
@@ -162,7 +161,12 @@ describe('uiSettingsMixin()', () => {
       sinon.assert.notCalled(getUiSettingsServiceForRequestStub);
       const request = {};
       decorations.request.getUiSettingsService.call(request);
-      sinon.assert.calledWith(getUiSettingsServiceForRequestStub, server, request);
+      sinon.assert.calledWith(getUiSettingsServiceForRequestStub, server as any, request as any, {
+        overrides: {
+          foo: 'bar',
+        },
+        getDefaults: sinon.match.func,
+      });
     });
   });
 

src/legacy/ui/ui_settings/routes/delete.js → src/legacy/ui/ui_settings/routes/delete.ts

@@ -16,21 +16,22 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { Legacy } from 'kibana';
 
-async function handleRequest(request) {
+async function handleRequest(request: Legacy.Request) {
   const { key } = request.params;
   const uiSettings = request.getUiSettingsService();
 
   await uiSettings.remove(key);
   return {
-    settings: await uiSettings.getUserProvided()
+    settings: await uiSettings.getUserProvided(),
   };
 }
 
 export const deleteRoute = {
   path: '/api/kibana/settings/{key}',
   method: 'DELETE',
-  handler: async (request, h) => {
-    return h.response(await handleRequest(request));
-  }
+  handler: async (request: Legacy.Request) => {
+    return await handleRequest(request);
+  },
 };

src/legacy/ui/ui_settings/routes/get.js → src/legacy/ui/ui_settings/routes/get.ts

@@ -16,18 +16,19 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { Legacy } from 'kibana';
 
-async function handleRequest(request) {
+async function handleRequest(request: Legacy.Request) {
   const uiSettings = request.getUiSettingsService();
   return {
-    settings: await uiSettings.getUserProvided()
+    settings: await uiSettings.getUserProvided(),
   };
 }
 
 export const getRoute = {
   path: '/api/kibana/settings',
   method: 'GET',
-  handler: function (request) {
+  handler(request: Legacy.Request) {
     return handleRequest(request);
-  }
+  },
 };

src/legacy/ui/ui_settings/routes/integration_tests/lib/servers.ts

@@ -23,6 +23,7 @@ import { SavedObjectsClientContract } from 'src/core/server';
 import KbnServer from '../../../../../server/kbn_server';
 import { createTestServers } from '../../../../../../test_utils/kbn_server';
 import { CallCluster } from '../../../../../../legacy/core_plugins/elasticsearch';
+import { IUiSettingsClient } from '../../../ui_settings_service';
 
 let kbnServer: KbnServer;
 let servers: ReturnType<typeof createTestServers>;
@@ -33,7 +34,7 @@ interface AllServices {
   kbnServer: KbnServer;
   savedObjectsClient: SavedObjectsClientContract;
   callCluster: CallCluster;
-  uiSettings: any;
+  uiSettings: IUiSettingsClient;
   deleteKibanaIndex: typeof deleteKibanaIndex;
 }