UI Settings should be disabled when elasticsearch is not available by kobelb · Pull Request #8764 · elastic/kibana

kobelb · 2016-10-19T20:50:12Z

Resolves the console error being logged on startup and plugin installation:

UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): TypeError: Cannot read property 'state' of undefined

spalger · 2016-10-19T21:12:28Z

src/ui/settings/index.js


+  function setStatus() {
+    if (!kbnServer.config.get('plugins.initialize')) {
+      status.disabled('Disabled because plugins are disabled');


Nice! Didn't realize this existed

spalger · 2016-10-19T21:13:25Z

src/ui/settings/index.js

  }

+  function setStatus() {
+    if (!kbnServer.config.get('plugins.initialize')) {


We should probably move this check to the top of the mixin so that we don't expose the API or really do anything when we are disabled.

kobelb · 2016-10-19T21:26:28Z

Good call! Changes made.

Bargs · 2016-10-19T21:30:48Z

Checking plugins.initialize in this file feels kind of dirty to me. The root issue is that esStatus is undefined, no? Couldn't we just disable the uisettings when that's the case?

spalger · 2016-10-19T21:36:44Z

I agree that using plugins.initialize is kind of dirty. Disabling based on the existence of the elasticsearch plugin won't work though, as we can only know if it's loaded after the server has loaded up all of the plugins, which is after we have already exposed the uiSettings API. The only proper way to react to the elasticsearch plugin not being available is setting the status to red.

Perhaps we could add a uiSettings.enabled setting which would be flipped off by the dev cli? Then we aren't correlating two unrelated things (plugin initialization and the uiSettings) and we can also update the our status to "red" when the elasticseach plugin is not available.

Bargs · 2016-10-19T21:43:44Z

we can only know if it's loaded after the server has loaded up all of the plugins, which is after we as supposed to have exposed the uiSettings API.

How does this work on normal server startup then? Or is there a race condition where this error might get thrown on normal server startup? If so, how does uisettings get re-enabled once the ES plugin becomes available?

spalger · 2016-10-19T21:59:45Z

On normal server startup the uiSettings exposes it's API and then waits for the server to finish initialization. Once initialization is complete the kibana.ready() promise resolves and the uiSettings begin mirroring the status of the elasticsearch plugin. This is the only time where we learn that the elasticsearch plugin is not included/enabled, so we should permanently set the uiSettings status to "red". There is no way for the elasticsearch plugin to be re-enabled without a server restart.

Now, if we wanted to prevent the uiSettings module from going red in a specific situation, like in the optimizer half of the dev server, we could additionally pass the --uiSettings.enabled=false flag and it won't even try to start up.

Bargs · 2016-10-19T22:22:09Z

@spalger and I chatted and we agreed implementing --uiSettings.enabled=false is the best we can do for now. The main issue with just letting uiSettings go red in the dev server scenario is that it'll print out a scary message about it in the console, and we want that to be the exception not the rule. It would be nice if uiSettings was actually a plugin so it could participate in the normal plugin lifecycle, but it's not, so we'll go with the flag for now.

kobelb · 2016-10-19T22:29:44Z

Does that mean we shouldn't be doing the status.disabled when it's disabled, and just "short-circuiting" and not setting up the uiSettings module?

spalger · 2016-10-19T22:34:24Z

I think that status.disabled() is the correct thing to do when we are short-curcuiting

in response to matt's comment that relying on `plugins.initialize` is kinda dirty (with which we all agree) we're adding an undocumented config value that the dev cli can use to put prevent the optimizr server from logging meaningless warnings

tylersmalley · 2016-10-19T23:33:32Z

There are 27 failing tests on this PR:

2) ui settings #setMany() returns a promise:
     TypeError: Cannot read property 'get' of undefined
      at setupSettings (src/ui/settings/index.js:7:24)
      at instantiate (src/ui/settings/__tests__/index.js:328:25)
      at Context.<anonymous> (src/ui/settings/__tests__/index.js:25:30)

tylersmalley

LGTM, though it would be amazing if we could get some documentation for uiSettings.enabled as it's bound to bring up questions in the future.

--------- **Commit 1:** UI Settings disabled when plugins.initialize is false * Original sha: c6f90e2 * Authored by = <brandon.kobel@elastic.co> on 2016-10-19T20:47:05Z **Commit 2:** Moving where we're disabling the ui settings * Original sha: e66c7e7 * Authored by = <brandon.kobel@elastic.co> on 2016-10-19T21:22:52Z **Commit 3:** [server/uiSettings] add enabled config in response to matt's comment that relying on `plugins.initialize` is kinda dirty (with which we all agree) we're adding an undocumented config value that the dev cli can use to put prevent the optimizr server from logging meaningless warnings * Original sha: 40ffd12 * Authored by spalger <email@spalger.com> on 2016-10-19T23:24:55Z **Commit 4:** [server/uiSettings] react to missing elasticsearch plugin * Original sha: 7feacf6 * Authored by spalger <email@spalger.com> on 2016-10-19T23:26:44Z **Commit 5:** [server/uiSettings] fix da tests * Original sha: c2d7d01 * Authored by spalger <email@spalger.com> on 2016-10-19T23:36:11Z **Commit 6:** [server/uiSettings] document enabled config * Original sha: f9bd154 * Authored by Spencer <spalger@users.noreply.github.com> on 2016-10-19T23:52:28Z * Committed by GitHub <noreply@github.com> on 2016-10-19T23:52:28Z

[backport] PR #8764 to 5.0 - UI Settings should be disabled when elasticsearch is not available

[backport] PR #8764 to 5.x - UI Settings should be disabled when elasticsearch is not available

--------- **Commit 1:** UI Settings disabled when plugins.initialize is false * Original sha: d462ebd049977d8a43b439dd2b9536f1d8b425a3 [formerly c6f90e2] * Authored by = <brandon.kobel@elastic.co> on 2016-10-19T20:47:05Z **Commit 2:** Moving where we're disabling the ui settings * Original sha: ae163ee4464bcf75f759ce97d95ebf6e22b77bb0 [formerly e66c7e7] * Authored by = <brandon.kobel@elastic.co> on 2016-10-19T21:22:52Z **Commit 3:** [server/uiSettings] add enabled config in response to matt's comment that relying on `plugins.initialize` is kinda dirty (with which we all agree) we're adding an undocumented config value that the dev cli can use to put prevent the optimizr server from logging meaningless warnings * Original sha: 89d2448797fc0c9cde3050ef952bf76ac3267f59 [formerly 40ffd12] * Authored by spalger <email@spalger.com> on 2016-10-19T23:24:55Z **Commit 4:** [server/uiSettings] react to missing elasticsearch plugin * Original sha: 9782961657aacbe576788738bcdaa48e2fadde3b [formerly 7feacf6] * Authored by spalger <email@spalger.com> on 2016-10-19T23:26:44Z **Commit 5:** [server/uiSettings] fix da tests * Original sha: 54641b772af42d1c5bb57e3a7547a9fc28432987 [formerly c2d7d01] * Authored by spalger <email@spalger.com> on 2016-10-19T23:36:11Z **Commit 6:** [server/uiSettings] document enabled config * Original sha: 766a96cab2f35a51ba6c72c472b452cf50f8b027 [formerly f9bd154] * Authored by Spencer <spalger@users.noreply.github.com> on 2016-10-19T23:52:28Z * Committed by GitHub <noreply@github.com> on 2016-10-19T23:52:28Z Former-commit-id: 533ac98

[backport] PR elastic#8764 to 5.x - UI Settings should be disabled when elasticsearch is not available Former-commit-id: 07b6453

`102.3.0` ⏩ `103.0.0` [Questions? Please see our Kibana upgrade FAQ.](https://github.com/elastic/eui/blob/main/wiki/eui-team-processes/upgrading-kibana.md#faq-for-kibana-teams) ## Changes [#8736](elastic/eui#8736), [#8732](elastic/eui#8732), and [#8732](elastic/eui#8732) include a number of small style tweaks `EuiResizableCollapseButton`, `EuiTitle`, and `EuiListGroupItem`. [#8756](elastic/eui#8756) and [#8744](elastic/eui#8744) rename a couple of icons: `questionInCircle` -> `question` `iInCircle` > `info` In both cases, the old name is **backwards-compatible** (unless importing directly from `assets` folder (see more in the release notes regarding that). However, the old name will eventually be deprecated as a part of a larger set of deprecations. **No action is required at this time to handle this renaming. We will issue a dedicated PR to Kibana to replace the old names with the new names in the future** [#8725](elastic/eui#8725) adds Sky Blue, Yellow, and Orange palettes to EUI's [color palettes](https://eui.elastic.co/docs/utilities/color-palettes/#recommended-quantitative-palettes), as well as new tokens for Risk, Neutral, and Warning. **[Breaking change]** Please note that as part of this change, the following tokens have been renamed: `euiColorVisNeutral0` -> `euiColorVisBase0` `euiColorVisWarning0` -> `euiColorVisWarning1` The original tokens still exist, but have been updated to use new colors in a way that would be breaking. This PR updates the existing references in 0b21d2d. ## Package updates ### `@elastic/eui` ## [`v103.0.0`](https://github.com/elastic/eui/releases/v103.0.0) - Replaced `question` icon glyph ([#8756](elastic/eui#8756)) - Updated `EuiResizableCollapseButton` to use an empty button ([#8736](elastic/eui#8736)) - Added `info` icon glyph ([#8744](elastic/eui#8744)) - Removed uppercase styling from `EuiText` `h6` headings to match `EuiTitle` ([#8732](elastic/eui#8732)) - Removed heavier font weight from `xs` and `s` `EuiListGroupItem` sizes for consistency ([#8732](elastic/eui#8732)) - Updated the `font-weight` of default `EuiFilterButton` and `EuiButtonGroupButton` to `450` ([#8734](elastic/eui#8734)) - Added color pallete functions and related hooks: ([#8725](elastic/eui#8725)) - `euiPaletteSkyBlue`, `useEuiPaletteSkyBlue` - `euiPaletteYellow`, `useEuiPaletteYellow` - `euiPaletteOrange`, `useEuiPaletteOrange` - Added new tokens on `colors.vis`: ([#8725](elastic/eui#8725)) - `euiColorVisNeutral0` - `euiColorVisNeutral1` - `euiColorVisWarning1` - `euiColorVisRisk0` - `euiColorVisRisk1` - Updated the value of token `colors.vis.euiColorVisWarning0` ([#8725](elastic/eui#8725)) - Updated EuiFilterButton's `numActiveFilters` prop to accept percentage values ([#8705](elastic/eui#8705)) **Bug fixes** - Fixed visual positioning issue for notifications in `EuiHeaderSectionItemButton` ([#8736](elastic/eui#8736)) - Fixed a visual issue where `EuiCollabsibleNavItem` did not have a visible selected state ([#8736](elastic/eui#8736)) - Fixed handling of unregistered code block languages in `EuiMarkdownFormat` ([#8729](elastic/eui#8729)) **Breaking changes** - Renamed `colors.vis.euiColorVisNeutral0` to `euiColorVisBase0` ([#8725](elastic/eui#8725)) ### `@elastic/eui-theme-borealis` ## [`v2.0.0`](https://github.com/elastic/eui/blob/main/packages/eui-theme-borealis/changelogs/CHANGELOG_2025.md#v200) - Added new tokens on `colors.vis`: ([#8725](elastic/eui#8725)) - `euiColorVisNeutral0` - `euiColorVisNeutral1` - `euiColorVisWarning1` - `euiColorVisRisk0` - `euiColorVisRisk1` - Updated the value of token `colors.vis.euiColorVisWarning0` ([#8725](elastic/eui#8725)) **Bug fixes** - Fixed missing source map warnings emitted by some bundlers by excluding source maps from being published ([#8764](elastic/eui#8764)) - To align with `@elastic/eui` and many other popular packages, we made a call to not ship source maps anymore **Breaking changes** - Renamed `colors.vis.euiColorVisNeutral0` to `euiColorVisBase0` ([#8725](elastic/eui#8725))  --------- Co-authored-by: Lene Gadewoll <lene.gadewoll@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

# Backport This will backport the following commits from `main` to `8.19`: - [Upgrade EUI to v103.0.0 (#223414)](#223414)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

UI Settings disabled when plugins.initialize is false

c6f90e2

kobelb added v5.0.0 v5.1.0 v6.0.0 review labels Oct 19, 2016

kobelb assigned spalger Oct 19, 2016

spalger suggested changes Oct 19, 2016

View reviewed changes

Bargs self-assigned this Oct 19, 2016

Moving where we're disabling the ui settings

e66c7e7

spalger approved these changes Oct 19, 2016

View reviewed changes

spalger added 2 commits October 19, 2016 16:24

[server/uiSettings] add enabled config

40ffd12

in response to matt's comment that relying on `plugins.initialize` is kinda dirty (with which we all agree) we're adding an undocumented config value that the dev cli can use to put prevent the optimizr server from logging meaningless warnings

[server/uiSettings] react to missing elasticsearch plugin

7feacf6

spalger assigned tylersmalley Oct 19, 2016

[server/uiSettings] fix da tests

c2d7d01

tylersmalley approved these changes Oct 19, 2016

View reviewed changes

[server/uiSettings] document enabled config

f9bd154

spalger merged commit 1ff971a into elastic:master Oct 19, 2016

This was referenced Oct 19, 2016

[backport] PR #8764 to 5.0 - UI Settings should be disabled when elasticsearch is not available #8769

Merged

[backport] PR #8764 to 5.x - UI Settings should be disabled when elasticsearch is not available #8770

Merged

spalger changed the title ~~UI Settings disabled when plugins.initialize is false~~ UI Settings should be disabled when elasticsearch is not available Oct 19, 2016

spalger added a commit that referenced this pull request Oct 20, 2016

Merge pull request #8769 from elastic/jasper/backport/8764/5.0

342bf5c

[backport] PR #8764 to 5.0 - UI Settings should be disabled when elasticsearch is not available

spalger added a commit that referenced this pull request Oct 20, 2016

Merge pull request #8770 from elastic/jasper/backport/8764/5.x

07b6453

[backport] PR #8764 to 5.x - UI Settings should be disabled when elasticsearch is not available

kobelb deleted the ui-settings-disabled branch October 20, 2016 10:53

epixa added v5.1.1 and removed v5.1.0 labels Dec 8, 2016

airow pushed a commit to airow/kibana that referenced this pull request Feb 16, 2017

Merge pull request elastic#8770 from elastic/jasper/backport/8764/5.x

23a410a

[backport] PR elastic#8764 to 5.x - UI Settings should be disabled when elasticsearch is not available Former-commit-id: 07b6453

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UI Settings should be disabled when elasticsearch is not available#8764

UI Settings should be disabled when elasticsearch is not available#8764
spalger merged 6 commits intoelastic:masterfrom
kobelb:ui-settings-disabled

kobelb commented Oct 19, 2016 •

edited by epixa

Loading

Uh oh!

spalger Oct 19, 2016

Uh oh!

spalger Oct 19, 2016

Uh oh!

kobelb commented Oct 19, 2016

Uh oh!

Bargs commented Oct 19, 2016 •

edited

Loading

Uh oh!

spalger commented Oct 19, 2016 •

edited

Loading

Uh oh!

Bargs commented Oct 19, 2016

Uh oh!

spalger commented Oct 19, 2016 •

edited

Loading

Uh oh!

Bargs commented Oct 19, 2016

Uh oh!

kobelb commented Oct 19, 2016

Uh oh!

spalger commented Oct 19, 2016

Uh oh!

tylersmalley commented Oct 19, 2016

Uh oh!

tylersmalley left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

kobelb commented Oct 19, 2016 • edited by epixa Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spalger Oct 19, 2016

Choose a reason for hiding this comment

Uh oh!

spalger Oct 19, 2016

Choose a reason for hiding this comment

Uh oh!

kobelb commented Oct 19, 2016

Uh oh!

Bargs commented Oct 19, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spalger commented Oct 19, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bargs commented Oct 19, 2016

Uh oh!

spalger commented Oct 19, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bargs commented Oct 19, 2016

Uh oh!

kobelb commented Oct 19, 2016

Uh oh!

spalger commented Oct 19, 2016

Uh oh!

tylersmalley commented Oct 19, 2016

Uh oh!

tylersmalley left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kobelb commented Oct 19, 2016 •

edited by epixa

Loading

Bargs commented Oct 19, 2016 •

edited

Loading

spalger commented Oct 19, 2016 •

edited

Loading

spalger commented Oct 19, 2016 •

edited

Loading