Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Lens][Embeddable] Make Embeddable resilient when toggling actions #126558

Merged
merged 8 commits into from
Mar 7, 2022

Conversation

dej611
Copy link
Contributor

@dej611 dej611 commented Mar 1, 2022

Summary

Fix #125262

This PR changes the way the useEmbeddableFactory hook was called when creating the Lens embeddable: the transition between EmbeddableRoot to EmbeddablePanel (and viceversa) was triggering an unmount event which was destroying the inner embeddable object, with no clear way to detect whether it was a transition or a real destroying event because the page was unmounted.

Pushing down the embeddable creation code automatically handles the transition phase as the inner component lifecycle events make it work correctly in case of transition.

embeddable_actions_bug

Checklist

Delete any items that are not applicable to this PR.

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

For maintainers

@dej611 dej611 added release_note:fix Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Lens backport:skip This commit does not require backporting v8.2.0 labels Mar 1, 2022
@dej611 dej611 marked this pull request as ready for review March 1, 2022 10:22
@dej611 dej611 requested a review from a team as a code owner March 1, 2022 10:22
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-vis-editors @elastic/kibana-vis-editors-external (Team:VisEditors)

@dej611
Copy link
Contributor Author

dej611 commented Mar 2, 2022

@elasticmachine merge upstream

@dej611
Copy link
Contributor Author

dej611 commented Mar 3, 2022

@elasticmachine merge upstream

@dej611
Copy link
Contributor Author

dej611 commented Mar 4, 2022

@elasticmachine merge upstream

@dej611
Copy link
Contributor Author

dej611 commented Mar 7, 2022

@elasticmachine merge upstream

Copy link
Contributor

@flash1293 flash1293 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested and works, LGTM

@@ -10,7 +10,10 @@ import type { CoreStart, ThemeServiceStart } from 'kibana/public';
import type { Action, UiActionsStart } from 'src/plugins/ui_actions/public';
import type { Start as InspectorStartContract } from 'src/plugins/inspector/public';
import { EuiLoadingChart } from '@elastic/eui';
// import useUnmount from 'react-use/lib/useUnmount';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit unused import

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Test Failures

  • [job] [logs] Default CI Group #16 / lens app lens runtime fields should be able to add runtime field and use it

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
lens 1.1MB 1.1MB +1.0B

Page load bundle

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

id before after diff
lens 43.6KB 43.8KB +195.0B

History

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

@dej611 dej611 merged commit 3fe1270 into elastic:main Mar 7, 2022
lucasfcosta pushed a commit to lucasfcosta/kibana that referenced this pull request Mar 8, 2022
…lastic#126558)

* 🐛 Push to the bottom embeddable creation to better handle lifecycles

* Update x-pack/plugins/lens/public/embeddable/embeddable_component.tsx

* Update x-pack/plugins/lens/public/embeddable/embeddable_component.tsx

* Update x-pack/plugins/lens/public/embeddable/embeddable_component.tsx

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
lucasfcosta pushed a commit to lucasfcosta/kibana that referenced this pull request Mar 8, 2022
…lastic#126558)

* 🐛 Push to the bottom embeddable creation to better handle lifecycles

* Update x-pack/plugins/lens/public/embeddable/embeddable_component.tsx

* Update x-pack/plugins/lens/public/embeddable/embeddable_component.tsx

* Update x-pack/plugins/lens/public/embeddable/embeddable_component.tsx

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Lens release_note:fix Team:Visualizations Visualization editors, elastic-charts and infrastructure v8.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Lens][Embeddable] Dynamically change embeddable actions crashes the embeddable
5 participants