[KibanaReact] Use settings service in useUiSetting hook #154710

majagrubic · 2023-04-11T10:03:51Z

Summary

This PR replaces deprecated uiSettings client with settings.client in useUiSetting hook. As a result, all consumers of the hook need to provide settings service to Kibana context. The majority of this PR is providing the settings as a dependency to affected plugins. It would be great if sometime in the future we could get rid of uiSettings entirely.

CodeEditor is one of the components relying on this hook, which caused a lot of the changes in this PR.

If you have been tagged for review it means your code is using useUiSetting hook directly, or is consuming CodeEditor component. I have been focused on updating plugins that had failing functional tests, but would appreciate a manual pass on this as well.

xoxo

Checklist

Delete any items that are not applicable to this PR.

~ [ ] 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
~~- [ ] Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)~~
~~- [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)~~
~~- [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
~~- [ ] This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)~~
~~- [ ] This was checked for cross-browser compatibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately

kibanamachine · 2023-04-11T10:03:55Z

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

stratoula · 2023-04-11T10:09:24Z

buildkite test this

…-ref HEAD~1..HEAD --fix'

…149347-2

majagrubic · 2023-04-12T07:56:30Z

@elasticmachine merge upstream

…lugin

…149347-2

stratoula · 2023-04-13T14:46:24Z

buildkite test this

…fix'

…-fix'

majagrubic · 2023-04-14T06:29:56Z

@elasticmachine merge upstream

stratoula · 2023-04-14T08:33:33Z

buildkite test this

stratoula · 2023-04-14T08:33:38Z

buildkite test this

…fix'

…149347-2

rudolf · 2023-04-17T09:39:24Z

buildkite test this

…fix'

stratoula · 2023-04-18T06:11:01Z

buildkite test this

…fix'

majagrubic · 2023-04-18T07:35:44Z

I have the synthetics tests in the exploratory_view constantly failing, but I can't figure out. They don't seem related to my changes and for me, they are failing locally in main.
There are no ui-settings related errors in the console, and both exploratory_view and synthetics plugins are already taking entire coreStart as a dependency, so switching to settings shouldn't bother them. Can someone from the team take a look? (I can't tag teams anymore 😅 )

patrykkopycinski · 2023-05-11T11:53:58Z

buildkite test this

…-ref HEAD~1..HEAD --fix'

stratoula · 2023-05-11T12:09:30Z

buildkite test this

patrykkopycinski · 2023-05-11T19:08:40Z

buildkite test this

kibana-ci · 2023-05-11T21:10:40Z

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`dataViewManagement`	118.6KB	118.6KB	+22.0B
`fileUpload`	852.8KB	852.8KB	+23.0B
`indexManagement`	525.9KB	525.9KB	+22.0B
`ingestPipelines`	453.4KB	453.4KB	+20.0B
`lens`	1.2MB	1.2MB	+54.0B
`painlessLab`	16.1KB	16.2KB	+22.0B
`savedObjectsManagement`	87.6KB	87.6KB	+42.0B
`snapshotRestore`	266.7KB	266.8KB	+22.0B
`transform`	386.6KB	386.6KB	+22.0B
`watcher`	162.7KB	162.7KB	+20.0B
total			+269.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`dataViewFieldEditor`	23.3KB	23.3KB	+22.0B
`discover`	27.9KB	27.9KB	+20.0B
`fileUpload`	7.2KB	7.2KB	+56.0B
`inspector`	21.7KB	21.7KB	+20.0B
`kibanaReact`	52.0KB	51.9KB	-132.0B
`painlessLab`	10.3KB	10.3KB	+22.0B
`runtimeFields`	11.0KB	11.0KB	+22.0B
`urlDrilldown`	15.4KB	15.4KB	-8.0B
`watcher`	13.4KB	13.5KB	+22.0B
total			+44.0B

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	19	21	+2
`securitySolution`	400	404	+4
total			+6

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	20	22	+2
`securitySolution`	480	484	+4
total			+6

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

patrykkopycinski · 2023-05-11T21:37:56Z

@elasticmachine run elasticsearch-ci/docs

patrykkopycinski · 2023-05-11T22:40:14Z

@majagrubic 🎉

majagrubic · 2023-05-12T06:20:19Z

Thanx @patrykkopycinski 🙌
If you could just ping someone from observabillity-ui for review and then we can merge this beastie 💪

dgieselaar

Hope you're well @majagrubic !

majagrubic · 2023-05-12T06:47:18Z

Thank you @dgieselaar 🙇‍♀️
@stratoula do you want to do the honours of merging this? :)

stratoula · 2023-05-12T07:47:52Z

Thanx @majagrubic, kibana team loves you ❤️

## Summary Fixes: #149347 This PR replaces deprecated `uiSettings` client with `settings.client` in `useUiSetting` hook. As a result, all consumers of the hook need to provide `settings` service to Kibana context. The majority of this PR is providing the `settings` as a dependency to affected plugins. It would be great if sometime in the future we could get rid of `uiSettings` entirely. `CodeEditor` is one of the components relying on this hook, which caused a lot of the changes in this PR. If you have been tagged for review it means your code is using `useUiSetting` hook directly, or is consuming `CodeEditor` component. I have been focused on updating plugins that had failing functional tests, but would appreciate a manual pass on this as well. xoxo ### Checklist Delete any items that are not applicable to this PR. ~ [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)~ ~- [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials~ - [X] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ~- [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/))~ ~- [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))~ ~- [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)~ ~- [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))~ ~- [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers)~ ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Maja Grubic <maja.grubic@elastic.co> Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com>

## Summary Fix #158193 #154710 changed a bit the context type to work with the Monaco CodeEditor and this example was not updated to use it. This PR should fix it. ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

) ## Summary Fix elastic#158193 elastic#154710 changed a bit the context type to work with the Monaco CodeEditor and this example was not updated to use it. This PR should fix it. ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

Fixes #158459 ## Summary This PR updates the `KibanaReactContextServices` type so that it corresponds to the context type that works with the Monaco CodeEditor and which was recently changed in #154710. **How to test** Verify that all CodeEditor components in Index Management work as expected: - `application/components/shared/components/wizard_steps/step_aliases.tsx` - `application/components/shared/components/wizard_steps/step_settings.tsx` - `application/components/component_templates/component_template_wizard/component_template_form/steps/step_logistics.tsx` - `application/components/mappings_editor/components/templates_form/templates_form.tsx` - `application/components/mappings_editor/components/load_mappings/load_mappings_provider.tsx` - `application/components/mappings_editor/components/document_fields/field_parameters/meta_parameter.tsx` - `application/components/mappings_editor/components/configuration_form/meta_field_section/meta_field_section.tsx` - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Fixes #158585 ## Summary This PR updates the context service type so that it corresponds to the context type that works with the Monaco CodeEditor and which was recently changed in #154710. **How to test** Verify that all CodeEditor components in Snapshot and Restore work as expected: - `application/components/restore_snapshot_form/steps/step_settings.tsx` - `application/components/repository_form/type_settings/hdfs_settings.tsx` <br> - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios (Added e2e tests that would catch this behaviour in case of any future changes to CodeEditor) --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Closes #167062 ## Summary * Adds "Features" section to Infra settings screen * Hooks changes to `uiSettings` into existing form in order to use the current "Discard" and "Apply" buttons logic * Replaces usage of `uiSettings` with `settings.client` as `uiSettings` seems to be [deprecated](#154710. Observables exposed by `uiSettings` do not seem to work anymore. * Deletes the Hosts landing screen * Revives the logic for showing/hiding Hosts nav item depending on the settings toggle https://github.com/elastic/kibana/assets/793851/767e69cc-98b1-4fe9-93d9-f39c08ac5c83 ## How to test * Checkout locally and run in stateful mode * Go to Infra Setttings screen and make sure Features section is present * Make sure that the "Infrastructure Hosts view" toggle shows/hides the Hosts nav item * Make sure that "Infrastructure Hosts view" in "Anvanced Settings" is synced with the the one in Infra settings --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

Closes elastic#167062 ## Summary * Adds "Features" section to Infra settings screen * Hooks changes to `uiSettings` into existing form in order to use the current "Discard" and "Apply" buttons logic * Replaces usage of `uiSettings` with `settings.client` as `uiSettings` seems to be [deprecated](elastic#154710. Observables exposed by `uiSettings` do not seem to work anymore. * Deletes the Hosts landing screen * Revives the logic for showing/hiding Hosts nav item depending on the settings toggle https://github.com/elastic/kibana/assets/793851/767e69cc-98b1-4fe9-93d9-f39c08ac5c83 ## How to test * Checkout locally and run in stateful mode * Go to Infra Setttings screen and make sure Features section is present * Make sure that the "Infrastructure Hosts view" toggle shows/hides the Hosts nav item * Make sure that "Infrastructure Hosts view" in "Anvanced Settings" is synced with the the one in Infra settings --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

[KibanaReact] Use settings service in useUiSetting hook

913d527

kibanamachine and others added 3 commits April 11, 2023 10:15

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

4638c37

…-ref HEAD~1..HEAD --fix'

Fix failing jest tests

79622b1

Merge branch 'fix-149347-2' of github.com:majagrubic/kibana into fix-…

9ea8d52

…149347-2

kibanamachine and others added 3 commits April 12, 2023 03:56

Merge branch 'main' into fix-149347-2

34b0032

Add settings dependency to lens, expressions_explorer and transform p…

003bce1

…lugin

Merge branch 'fix-149347-2' of github.com:majagrubic/kibana into fix-…

bc5deb9

…149347-2

kibanamachine and others added 5 commits April 13, 2023 14:52

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

f49d8ac

…fix'

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

68a31a8

…-fix'

Add settings dependency to url_drilldown

6df5e78

Add settings dependency to ingest_pipelines plugin

43330ac

Merge main

78ca5cd

Merge branch 'main' into fix-149347-2

8ca6ab8

kibanamachine and others added 3 commits April 14, 2023 08:38

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

10d68b8

…fix'

Linting

61301d8

Merge branch 'fix-149347-2' of github.com:majagrubic/kibana into fix-…

3923e03

…149347-2

kibanamachine and others added 3 commits April 17, 2023 09:46

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

6fe6b7e

…fix'

Merge branch 'main' into fix-149347-2

60c2dd9

Add settings as dependency to data_view_management

6cf83d7

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

3c8850f

…fix'

Fix remaining failing unit tests

5e0e33c

majagrubic requested a review from a team as a code owner May 11, 2023 10:07

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

e5509d8

…-ref HEAD~1..HEAD --fix'

Merge branch 'main' into fix-149347-2

3868340

dgieselaar approved these changes May 12, 2023

View reviewed changes

stratoula merged commit 069550d into elastic:main May 12, 2023

kibanamachine added the backport:skip This commit does not require backporting label May 12, 2023

dej611 mentioned this pull request May 22, 2023

[Lens][Example] Fix CodeEditor issue within Lens example #158198

Merged

9 tasks

mykolaharmash mentioned this pull request Oct 17, 2023

[Infra UI] Add Features section to Infra settings #168712

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[KibanaReact] Use settings service in useUiSetting hook #154710

[KibanaReact] Use settings service in useUiSetting hook #154710

majagrubic commented Apr 11, 2023 •

edited

Loading

kibanamachine commented Apr 11, 2023

stratoula commented Apr 11, 2023

majagrubic commented Apr 12, 2023

stratoula commented Apr 13, 2023

majagrubic commented Apr 14, 2023

stratoula commented Apr 14, 2023

stratoula commented Apr 14, 2023

rudolf commented Apr 17, 2023

stratoula commented Apr 18, 2023

majagrubic commented Apr 18, 2023

patrykkopycinski commented May 11, 2023

stratoula commented May 11, 2023

patrykkopycinski commented May 11, 2023

kibana-ci commented May 11, 2023

ESLint disabled line counts

Total ESLint disabled count

patrykkopycinski commented May 11, 2023

patrykkopycinski commented May 11, 2023

majagrubic commented May 12, 2023

dgieselaar left a comment

majagrubic commented May 12, 2023

stratoula commented May 12, 2023

[KibanaReact] Use settings service in useUiSetting hook #154710

[KibanaReact] Use settings service in useUiSetting hook #154710

Conversation

majagrubic commented Apr 11, 2023 • edited Loading

Summary

Checklist

For maintainers

kibanamachine commented Apr 11, 2023

stratoula commented Apr 11, 2023

majagrubic commented Apr 12, 2023

stratoula commented Apr 13, 2023

majagrubic commented Apr 14, 2023

stratoula commented Apr 14, 2023

stratoula commented Apr 14, 2023

rudolf commented Apr 17, 2023

stratoula commented Apr 18, 2023

majagrubic commented Apr 18, 2023

patrykkopycinski commented May 11, 2023

stratoula commented May 11, 2023

patrykkopycinski commented May 11, 2023

kibana-ci commented May 11, 2023

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

ESLint disabled line counts

Total ESLint disabled count

History

patrykkopycinski commented May 11, 2023

patrykkopycinski commented May 11, 2023

majagrubic commented May 12, 2023

dgieselaar left a comment

Choose a reason for hiding this comment

majagrubic commented May 12, 2023

stratoula commented May 12, 2023

majagrubic commented Apr 11, 2023 •

edited

Loading