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

[8.13] Fix how sample data test install state is determined in test (#178529) #178601

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

eokoneyo
Copy link
Contributor

Backport

This will backport the following commits from main to 8.13:

Questions ?

Please refer to the Backport tool documentation

\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n","sha":"910188e4e0baf6b2dbfbab88f4f4466a077f87c2","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","backport:skip","Team:SharedUX","v8.13.0","v8.14.0"],"number":178529,"url":"https://github.com//pull/178529","mergeCommit":{"message":"Fix how sample data test install state is determined in test (#178529)\n\n## Summary\r\nCloses https://github.com//issues/112103\r\n\r\nMake sample data install status available to be read by test util, as\r\ndocumented by @gsoldevila in the issue referenced above. The issue\r\nhappens because there's a slight delay that really can't be walked\r\naround where the install status in this particular instance is still\r\n'installed' but the call to mark the sample data completes so there's\r\nthat flicker where the `remove` element is displayed momentarily because\r\nthe component doesn't quite received the update to the sample data's\r\ninstall status immediately.\r\n\r\nThe proposed fix opts to complement the current way of determining if\r\nany sample data is installed using the newly introduced `data-status`\r\nattribute, here we wait till the result of clicking the remove button\r\nactually triggers a change in the value of the install state of said\r\nsample data, which in turn is reflected in the value of `data-status`\r\nalongside checking that the remove button exists.\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n","sha":"910188e4e0baf6b2dbfbab88f4f4466a077f87c2"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.14.0","labelRegex":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com//pull/178529","number":178529,"mergeCommit":{"message":"Fix how sample data test install state is determined in test (#178529)\n\n## Summary\r\nCloses https://github.com//issues/112103\r\n\r\nMake sample data install status available to be read by test util, as\r\ndocumented by @gsoldevila in the issue referenced above. The issue\r\nhappens because there's a slight delay that really can't be walked\r\naround where the install status in this particular instance is still\r\n'installed' but the call to mark the sample data completes so there's\r\nthat flicker where the `remove` element is displayed momentarily because\r\nthe component doesn't quite received the update to the sample data's\r\ninstall status immediately.\r\n\r\nThe proposed fix opts to complement the current way of determining if\r\nany sample data is installed using the newly introduced `data-status`\r\nattribute, here we wait till the result of clicking the remove button\r\nactually triggers a change in the value of the install state of said\r\nsample data, which in turn is reflected in the value of `data-status`\r\nalongside checking that the remove button exists.\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n","sha":"910188e4e0baf6b2dbfbab88f4f4466a077f87c2"}}]}] BACKPORT-->

…#178529)

## Summary
Closes elastic#112103

Make sample data install status available to be read by test util, as
documented by @gsoldevila in the issue referenced above. The issue
happens because there's a slight delay that really can't be walked
around where the install status in this particular instance is still
'installed' but the call to mark the sample data completes so there's
that flicker where the `remove` element is displayed momentarily because
the component doesn't quite received the update to the sample data's
install status immediately.

The proposed fix opts to complement the current way of determining if
any sample data is installed using the newly introduced `data-status`
attribute, here we wait till the result of clicking the remove button
actually triggers a change in the value of the install state of said
sample data, which in turn is reflected in the value of `data-status`
alongside checking that the remove button exists.

### 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
- [x] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
<!--
- [ ] 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&mdash;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&mdash;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)
-->

(cherry picked from commit 910188e)
@eokoneyo eokoneyo force-pushed the backport/8.13/pr-178529 branch from 09aa06d to f319a02 Compare March 13, 2024 10:49
@eokoneyo eokoneyo self-assigned this Mar 13, 2024
@kibana-ci
Copy link
Collaborator

💚 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
home 137.7KB 137.8KB +129.0B

History

  • 💔 Build #197372 failed 09aa06d168707dff4246287b7e6561b5270a2e68
  • 💔 Build #197352 failed 09aa06d168707dff4246287b7e6561b5270a2e68

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

cc @eokoneyo

@eokoneyo eokoneyo added the Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) label Mar 13, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-sharedux (Team:SharedUX)

Copy link
Member

@tsullivan tsullivan left a comment

Choose a reason for hiding this comment

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

LGTM

@eokoneyo eokoneyo merged commit daffde5 into elastic:8.13 Mar 13, 2024
18 checks passed
@eokoneyo eokoneyo deleted the backport/8.13/pr-178529 branch March 13, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants