From 87c7b3940b2774c36b94243e325a8f49a2094329 Mon Sep 17 00:00:00 2001 From: Marco Liberati Date: Fri, 18 Nov 2022 09:55:45 +0100 Subject: [PATCH] [Lens][Visualize][Embeddable] Optimize Lens embeddables on error (#144015) ## Summary Fixes #143552 In this PR there are some embeddable rendering optimizations for the error case. Lens handles error states internally without passing to default `EmbeddablePanel` flows - this has been made explicit in the Lens `Embeddable` component. The embeddable was triggering multiple time the `render` method in both successful and failure case: while the expression component renderer had some debouncing/memoize optimization to reduce the effective rerenders, the error route had none leading to a total of 3 rerenderings (loading + some changes detected). In this PR I've managed to reduce the rerenders to 2 (loading + final state) with some gatekeeping on the internal state reporting. As for the `data-rendering-complete` the logic has changed to set it to `true` also in Error state, but I would collect some feedback from @elastic/kibana-app-services on this side to better understand the impact. Before this change the `data-error` attribute could be checked to detect the final state of the panel, but that introduces some problems for Lens panels for the error reporting, hence the need to have the `complete` flag changed. ### 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) Co-authored-by: Uladzislau Lasitsa Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../render_complete/render_complete_dispatcher.ts | 9 ++++++--- .../plugins/lens/public/embeddable/embeddable.tsx | 15 ++++++++++++--- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts b/src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts index 7d6acf953d69b..8ae5cfbe0ca84 100644 --- a/src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts +++ b/src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts @@ -38,8 +38,10 @@ export class RenderCompleteDispatcher { } public setEl(el?: HTMLElement) { - this.el = el; - this.count = 0; + if (this.el !== el) { + this.el = el; + this.count = 0; + } if (el) this.dispatchInProgress(); } @@ -61,7 +63,8 @@ export class RenderCompleteDispatcher { public dispatchError() { if (!this.el) return; this.count++; - this.el.setAttribute('data-render-complete', 'false'); + this.el.setAttribute('data-render-complete', 'true'); + this.el.setAttribute('data-loading', 'false'); this.el.setAttribute('data-rendering-count', String(this.count)); } diff --git a/x-pack/plugins/lens/public/embeddable/embeddable.tsx b/x-pack/plugins/lens/public/embeddable/embeddable.tsx index d972d85476a17..5bfc0c7608db0 100644 --- a/x-pack/plugins/lens/public/embeddable/embeddable.tsx +++ b/x-pack/plugins/lens/public/embeddable/embeddable.tsx @@ -522,7 +522,9 @@ export class Embeddable } onContainerStateChanged(containerState: LensEmbeddableInput) { - if (this.handleContainerStateChanged(containerState) || this.errors?.length) this.reload(); + if (this.handleContainerStateChanged(containerState)) { + this.reload(); + } } handleContainerStateChanged(containerState: LensEmbeddableInput): boolean { @@ -705,12 +707,19 @@ export class Embeddable this.domNode.setAttribute('data-shared-item', ''); + const error = this.getError(); + this.updateOutput({ ...this.getOutput(), loading: true, - error: this.getError(), + error, }); - this.renderComplete.dispatchInProgress(); + + if (error) { + this.renderComplete.dispatchError(); + } else { + this.renderComplete.dispatchInProgress(); + } const input = this.getInput();