Convert uiSettings service to TypeScript #47018

mshustov · 2019-10-01T09:38:26Z

Summary

Convert service to TS and declare IUiSettingsService public interface.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~[ ] This was checked for cross-browser compatibility, including a check against IE11~~
~~[ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~[ ] Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
~~[ ] This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

elasticmachine · 2019-10-01T09:38:28Z

Pinging @elastic/kibana-platform

mshustov · 2019-10-01T09:42:11Z

src/legacy/ui/ui_settings/ui_settings_service.ts

+  getAll: <T extends SavedObjectAttribute = any>() => Promise<Record<string, T>>;
+  getUserProvided: () => Promise<UserProvided>;
+  setMany: <T extends SavedObjectAttribute = any>(changes: Record<string, T>) => Promise<void>;
+  set: <T extends SavedObjectAttribute = any>(key: string, value: T) => Promise<void>;


value must satisfy SavedObjectAttribute` constraints. @rudolf is it okay that we cannot set an array of primitives? according to SavedObjects interface

I've created #47317 but see #47334 for some of the issues consumers of these types have experienced with the SavedObjectsClient which will be similar for the UiSettingsService.

mshustov · 2019-10-01T09:43:25Z

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

@@ -233,7 +231,7 @@ describe('ui settings', () => {
      });

      try {
-        await uiSettings.setMany(['bar', 'foo']);
+        await uiSettings.setMany({ baz: 'baz', foo: 'foo' });


I believe it was used in unexpected way

mshustov · 2019-10-01T09:43:56Z

x-pack/legacy/plugins/apm/server/lib/helpers/setup_request.test.ts

      // mock includeFrozen to return false
-      mockRequest.getUiSettingsService = () => ({ get: async () => false });
+      uiSettingsService.get.mockResolvedValue(false);
+      mockRequest.getUiSettingsService = () => uiSettingsService;


had to update tests to fix a type error

mshustov · 2019-10-01T09:44:54Z

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

@@ -489,7 +487,7 @@ describe('ui settings', () => {
    it('pulls user configuration from ES', async () => {
      const esDocSource = {};
      const { uiSettings, assertGetQuery } = setup({ esDocSource });
-      await uiSettings.get();
+      await uiSettings.get('any');


key is required argument

mshustov · 2019-10-01T09:45:56Z

src/legacy/ui/ui_settings/ui_settings_service.ts

  }

-  async getRaw() {
+  // NOTE: should be a private method
+  async getRaw(): Promise<UiSettingsRaw> {


right now we used them in tests. I'd re-write test and hide them later

mshustov · 2019-10-01T09:48:39Z

src/legacy/ui/ui_settings/ui_settings_service.ts

+  get: <T extends SavedObjectAttribute = any>(key: string) => Promise<T>;
+  getAll: <T extends SavedObjectAttribute = any>() => Promise<Record<string, T>>;
+  getUserProvided: () => Promise<UserProvided>;
+  setMany: <T extends SavedObjectAttribute = any>(changes: Record<string, T>) => Promise<void>;


We can use T extends SavedObjectAttributes = any but not sure we should. I thought it made it harder to read the code.

mshustov · 2019-10-01T09:55:47Z

src/legacy/ui/ui_settings/ui_settings_service.ts

    await this._write({ changes });
  }

-  async set(key, value) {
+  async set<T extends SavedObjectAttribute = any>(key: string, value: T) {


probably we should improve client side typings as well, right now they get/set any https://github.com/restrry/kibana/blob/33486f99d4c77cc9213f83cb4b7109ffa84207fe/src/core/public/ui_settings/ui_settings_client.ts#L125

mshustov · 2019-10-01T09:57:08Z

src/legacy/ui/ui_settings/ui_settings_service.ts

+
+export interface IUiSettingsService {
+  getDefaults: () => Promise<Record<string, UiSettingsParams>>;
+  get: <T extends SavedObjectAttribute = any>(key: string) => Promise<T>;


used as

const value = uiSettings.get<string>('key'); // error const value = uiSettings.get<string []>('key');

sorenlouv

APM changes lgtm

mshustov · 2019-10-01T10:45:16Z

src/legacy/ui/ui_settings/ui_settings_service.ts

-   *  @property {Function} [options.log]
-   */
-  constructor(options) {
+export class UiSettingsService implements IUiSettingsService {


Shall we rename it to UiSettingsClient? It's not a service but a designated object for the plugins to interact with.

Yeah I think that makes sense, or even just UISettings?

Actually, we probably need to decide on our convention for capitalization of acronyms. For example we use HttpServiceSetup instead of HTTPServiceSetup in core right now. Should this be UiSettingsClient? I prefer this pattern because then the I-prefix looks a little less strange: IUiSettingsClient

elasticmachine · 2019-10-01T10:53:24Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-10-01T12:22:54Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

mshustov · 2019-10-01T12:28:39Z

retest

elasticmachine · 2019-10-01T13:41:50Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

joshdover · 2019-10-02T20:23:11Z

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

+export async function createOrUpgradeSavedConfig<T extends SavedObjectAttribute = any>(
+  options: Options
+): Promise<Record<string, T> | undefined> {
+  const { savedObjectsClient, version, buildNum, logWithMetadata, onWriteError } = options;


Move object destructure to function arguments?

I'd prefer not to do. there are already too many params to use positional arguments.

mshustov · 2019-10-04T09:23:27Z

retest

elasticmachine · 2019-10-04T10:34:49Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 9d7d8bf

* 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

mshustov added 15 commits October 1, 2019 09:17

tsify is_config_version_upgradeable

faa2b29

tsify get_upgradeable_config

f006647

tsify create_or_upgrade_saved_config

3ab346f

tsify ui_settings_service

19d9392

tsify ui_settings_service_factory

c03ff7e

tsify ui_settings_service_for_request

741fd2a

declare types on server object

4eb3c0f

tsify set route

38a9541

tsify set_many route

19c6428

tsify get route

8abddc3

tsify delete route

1a7f78b

tsify logWithMetadata

8363353

improve ui_settings_service typings

ea54444

introduce uiService mocks

dd2bcc8

remove private methods from public contract

33486f9

mshustov added chore Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes v7.5.0 labels Oct 1, 2019

mshustov requested a review from a team as a code owner October 1, 2019 09:38

mshustov requested a review from a team October 1, 2019 09:39

mshustov commented Oct 1, 2019

View reviewed changes

mshustov added the review label Oct 1, 2019

mshustov commented Oct 1, 2019

View reviewed changes

sorenlouv approved these changes Oct 1, 2019

View reviewed changes

mshustov commented Oct 1, 2019

View reviewed changes

stacey-gammon mentioned this pull request Oct 1, 2019

[New Platform] Expose uiSettings on server side #44994

Closed

11 tasks

add types for server.uiSettingsServiceFactory

041e4fc

joshdover approved these changes Oct 2, 2019

View reviewed changes

mshustov added 2 commits October 4, 2019 09:58

Merge branch 'master' into ts-ui-settings-code

0dcc00b

rename IUiSettingsService --> IUiSettingsClient

9d7d8bf

mshustov merged commit d1a99ea into elastic:master Oct 4, 2019

mshustov deleted the ts-ui-settings-code branch October 4, 2019 10:48

mshustov mentioned this pull request Oct 4, 2019

[7.x] Convert uiSettings service to TypeScript (#47018) #47320

Merged

rudolf mentioned this pull request Oct 4, 2019

SavedObjectAttribute allow array of primitives #47317

Merged

7 tasks

mshustov added backported and removed review labels Oct 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert uiSettings service to TypeScript #47018

Convert uiSettings service to TypeScript #47018

mshustov commented Oct 1, 2019

elasticmachine commented Oct 1, 2019

mshustov Oct 1, 2019

rudolf Oct 4, 2019

mshustov Oct 1, 2019

mshustov Oct 1, 2019 •

edited

Loading

mshustov Oct 1, 2019 •

edited

Loading

mshustov Oct 1, 2019 •

edited

Loading

mshustov Oct 1, 2019

mshustov Oct 1, 2019

mshustov Oct 1, 2019

sorenlouv left a comment

mshustov Oct 1, 2019 •

edited

Loading

joshdover Oct 2, 2019

joshdover Oct 2, 2019

elasticmachine commented Oct 1, 2019

elasticmachine commented Oct 1, 2019

mshustov commented Oct 1, 2019

elasticmachine commented Oct 1, 2019

joshdover Oct 2, 2019

mshustov Oct 4, 2019

mshustov commented Oct 4, 2019

elasticmachine commented Oct 4, 2019

Convert uiSettings service to TypeScript #47018

Convert uiSettings service to TypeScript #47018

Conversation

mshustov commented Oct 1, 2019

Summary

Checklist

For maintainers

elasticmachine commented Oct 1, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mshustov Oct 1, 2019 • edited Loading

Choose a reason for hiding this comment

mshustov Oct 1, 2019 • edited Loading

Choose a reason for hiding this comment

mshustov Oct 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sorenlouv left a comment

Choose a reason for hiding this comment

mshustov Oct 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Oct 1, 2019

💚 Build Succeeded

elasticmachine commented Oct 1, 2019

💔 Build Failed

mshustov commented Oct 1, 2019

elasticmachine commented Oct 1, 2019

💚 Build Succeeded

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mshustov commented Oct 4, 2019

elasticmachine commented Oct 4, 2019

💚 Build Succeeded

mshustov Oct 1, 2019 •

edited

Loading

mshustov Oct 1, 2019 •

edited

Loading

mshustov Oct 1, 2019 •

edited

Loading

mshustov Oct 1, 2019 •

edited

Loading