UI settings move to NP #47590

mshustov · 2019-10-08T14:42:26Z

Summary

This PR moves UiSettingsClient creation to the NP API. We don't expose this API to the plugins, the only Legacy platform uses it under the hood.
If SavedObjectsClient is not available in the NP we can work around it and use one from LP. As suggested here.
That unblocks exposing UiSettings client via RequestHandlerContext.
Objections @elastic/kibana-platform ?

I'm going to move uiSettings routes to NP in the following PR

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-08T14:42:55Z

Pinging @elastic/kibana-platform (Team:Platform)

...ore/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts

mshustov · 2019-10-08T15:01:55Z

src/core/server/ui_settings/ui_settings_client.test.ts

Not sure why it was done in this manner. Probably for the sake of consistency with other accessing methods.

mshustov · 2019-10-08T15:07:25Z

src/core/server/ui_settings/ui_settings_client.ts

It looks like a misleading comment. The platform calculates values once https://github.com/restrry/kibana/blob/b7114c7df6a547fbab769079589b5f755dc709bf/src/legacy/ui/ui_settings/ui_settings_mixin.js#L31
Dynamic behavior removed in c65da14#diff-a23948121f4bc50ced65723c687f343d

mshustov · 2019-10-08T15:09:35Z

src/legacy/ui/ui_settings/ui_settings_mixin.js

I found only savedObjectsClient passed as a parameter in the plugins code

elasticmachine · 2019-10-08T15:56:36Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: b7114c7df6a547fbab769079589b5f755dc709bf

elasticmachine · 2019-10-09T09:54:46Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 7a6b1e61231c25ee1e9c947e77b9b2c7de5f9cbc

elasticmachine · 2019-10-09T15:33:29Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 72305fc

eliperelman

Looks good, just a couple minor notes.

src/core/server/ui_settings/create_objects_client_stub.ts

...ore/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts

eliperelman · 2019-10-14T15:31:09Z

src/core/server/ui_settings/ui_settings_service.ts

+   * Sets the parameters with default values for the uiSettings.
+   * @param values
+   */
+  setDefaults(values: Record<string, UiSettingsParams>): void;


This makes sense to me 👍

eliperelman · 2019-10-14T15:33:13Z

src/core/server/ui_settings/ui_settings_service.ts

+
+    return {
+      setDefaults: this.setDefaults.bind(this),
+      asScopedToClient: (savedObjectsClient: SavedObjectsClientContract) => {


Since this is an arrow function, you can use an implicit return:

asScopedToClient: (savedObjectsClient: SavedObjectsClientContract) => new UiSettingsClient({ type: 'config', id: version, buildNum, savedObjectsClient, defaults: mapToObject(this.uiSettingsDefaults), overrides, log: this.log, }),

sorenlouv

apm changes lgtm

mshustov · 2019-10-15T07:33:09Z

@elasticmachine merge upstream

elasticmachine · 2019-10-15T08:57:23Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 02d965749d5294dc55baed43e2a4da44b884114d

...ore/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts

joshdover

Just a couple docs suggestions 👍

src/core/server/ui_settings/ui_settings_client.ts

src/core/server/ui_settings/ui_settings_service.ts

walterra

ML changes LGTM

elasticmachine · 2019-10-16T09:54:50Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 22b123c

elasticmachine · 2019-10-16T11:57:47Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: bebf920

* add tests for logWithMetadata in LP * allow passing metadata to log in NP & LP * move ui_settings_client to NP * add ui_settings config * add ui_settings_service * switch to NP logging * export types * bootstrap uiSettings service in NP * pass NP uiSettings to LP * move ui_settings mock to NP * add test for mixin and switch to NP logger * make UiSettingsClient.getDefaults sync as it is * ui_settings_client uses private fields * ui_settings_client uses private methods * keep uiSettings config validation in NP only * update mocks * core context should know it is mocked * add tests for ui_settings_service * remove unused code from ui_settings_mixin test * improve types in ui_settings_mixin test * gen docs * test moved to NP * set pkg version in tests explicitly * update mocks in tests * UiSettingsServiceSetup --> InternalUiSettingsServiceSetup * add links to types * address eli comment * regen docs * remove unused types

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

mshustov commented Oct 8, 2019

View reviewed changes

...ore/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts Outdated Show resolved Hide resolved

mshustov commented Oct 8, 2019

View reviewed changes

mshustov added 19 commits October 9, 2019 13:39

add tests for logWithMetadata in LP

7d67d1c

allow passing metadata to log in NP & LP

9d716d8

move ui_settings_client to NP

9de2388

add ui_settings config

846a19a

add ui_settings_service

890f932

switch to NP logging

7ab41d5

export types

ca428cf

bootstrap uiSettings service in NP

a302ee0

pass NP uiSettings to LP

9a5b3bc

move ui_settings mock to NP

34c30fa

add test for mixin and switch to NP logger

3fde85f

make UiSettingsClient.getDefaults sync as it is

625d1e7

ui_settings_client uses private fields

0bbd53b

ui_settings_client uses private methods

c5c790e

keep uiSettings config validation in NP only

0b3c60d

update mocks

081ddad

core context should know it is mocked

03edda9

add tests for ui_settings_service

4169d5c

remove unused code from ui_settings_mixin test

a515643

eliperelman approved these changes Oct 14, 2019

View reviewed changes

sorenlouv approved these changes Oct 14, 2019

View reviewed changes

mshustov requested a review from rudolf October 15, 2019 07:33

rudolf approved these changes Oct 15, 2019

View reviewed changes

...ore/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts Outdated Show resolved Hide resolved

joshdover approved these changes Oct 15, 2019

View reviewed changes

src/core/server/ui_settings/ui_settings_client.ts Outdated Show resolved Hide resolved

src/core/server/ui_settings/ui_settings_service.ts Outdated Show resolved Hide resolved

src/core/server/ui_settings/ui_settings_service.ts Outdated Show resolved Hide resolved

Merge branch 'master' into ui-settings-move-np

1090981

mshustov force-pushed the ui-settings-move-np branch from 02d9657 to 1090981 Compare October 16, 2019 07:15

mshustov requested a review from a team as a code owner October 16, 2019 07:15

walterra approved these changes Oct 16, 2019

View reviewed changes

mshustov added 5 commits October 16, 2019 09:41

UiSettingsServiceSetup --> InternalUiSettingsServiceSetup

c5ddad4

add links to types

cfd156e

address eli comment

b4b081b

Merge branch 'master' into ui-settings-move-np

22b123c

regen docs

11bc4a9

remove unused types

bebf920

mshustov merged commit 5676ac0 into elastic:master Oct 16, 2019

mshustov deleted the ui-settings-move-np branch October 16, 2019 12:18

mshustov mentioned this pull request Oct 16, 2019

[7.x] UI settings move to NP (#47590) #48395

Merged

mshustov added backported and removed review labels Oct 16, 2019

mshustov mentioned this pull request Nov 21, 2019

[meta] uiSettings service improvements #48925

Open

21 tasks

mshustov mentioned this pull request Dec 6, 2019

make defaultRoute accessible in NP Config #52308

Merged

3 tasks

mshustov mentioned this pull request Dec 23, 2019

use NP deprecations in uiSettings #53755

Merged

3 tasks

UI settings move to NP #47590

UI settings move to NP #47590

Uh oh!

Conversation

mshustov commented Oct 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Uh oh!

elasticmachine commented Oct 8, 2019

Uh oh!

Uh oh!

mshustov Oct 8, 2019

Choose a reason for hiding this comment

Uh oh!

mshustov Oct 8, 2019

Choose a reason for hiding this comment

Uh oh!

mshustov Oct 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Oct 8, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Oct 9, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Oct 9, 2019

💚 Build Succeeded

Uh oh!

eliperelman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

eliperelman Oct 14, 2019

Choose a reason for hiding this comment

Uh oh!

eliperelman Oct 14, 2019

Choose a reason for hiding this comment

Uh oh!

sorenlouv left a comment

Choose a reason for hiding this comment

Uh oh!

mshustov commented Oct 15, 2019

Uh oh!

elasticmachine commented Oct 15, 2019

💚 Build Succeeded

Uh oh!

Uh oh!

joshdover left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

walterra left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Oct 16, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Oct 16, 2019

💚 Build Succeeded

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mshustov commented Oct 8, 2019 •

edited

Loading

mshustov Oct 8, 2019 •

edited

Loading