[Controls] Fix flaky a11y test
#169559
Merged
[Controls] Fix flaky a11y test
#169559
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Heenawter
added
Team:Presentation
Heenawter
force-pushed
the
fix-flaky-169542_controls-a11y_2023-10-23
branch
from
8a840d5 to
459f387
Compare
Heenawter
force-pushed
the
fix-flaky-169542_controls-a11y_2023-10-23
branch
from
459f387 to
b162e61
Compare
|
Pinging @elastic/kibana-presentation (Team:Presentation) |
Heenawter
changed the title
a11y testsa11y test
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: |
bhavyarm
approved these changes
Oct 24, 2023
kibanamachine
added
v8.12.0
backport:skip
Heenawter
added
backport:prev-minor
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 7, 2023
Closes elastic#169542 ## Summary For some reason, the search session popover was being opened, which blocked the controls button from being clickable:  I'm unsure why this popover is open to begin with; this should **only** happen when the `searchSessionIndicator` button is clicked, but this button is **not** interacted with in **any** of the accessibility tests (that I could find). This makes me suspicious that this is actually a **misclick** - i.e. the element that was meant to be clicked gets moved (possibly the Dashboard "edit" button?), which causes the `searchSessionIndicator` button to be clicked instead. Going off this theory, I've switched the controls `a11y` tests to use the Dashboard page's methods (which have more safeguards in place) to navigate to the desired dashboard rather than clicking elements solely based off of the `data-test-subj` like we were previously. ### [Flaky Test Runner](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/3686)  ### Checklist - [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 ### 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 ad932ec)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Nov 7, 2023
# Backport This will backport the following commits from `main` to `8.11`: - [[Controls] Fix flaky `a11y` test (#169559)](#169559) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Hannah Mudge","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-10-24T15:48:16Z","message":"[Controls] Fix flaky `a11y` test (#169559)\n\nCloses https://github.com/elastic/kibana/issues/169542\r\n\r\n## Summary\r\n\r\nFor some reason, the search session popover was being opened, which\r\nblocked the controls button from being clickable:\r\n\r\n\r\n\r\n\r\nI'm unsure why this popover is open to begin with; this should **only**\r\nhappen when the `searchSessionIndicator` button is clicked, but this\r\nbutton is **not** interacted with in **any** of the accessibility tests\r\n(that I could find). This makes me suspicious that this is actually a\r\n**misclick** - i.e. the element that was meant to be clicked gets moved\r\n(possibly the Dashboard \"edit\" button?), which causes the\r\n`searchSessionIndicator` button to be clicked instead.\r\n\r\nGoing off this theory, I've switched the controls `a11y` tests to use\r\nthe Dashboard page's methods (which have more safeguards in place) to\r\nnavigate to the desired dashboard rather than clicking elements solely\r\nbased off of the `data-test-subj` like we were previously.\r\n\r\n### [Flaky Test\r\nRunner](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/3686)\r\n\r\n\r\n\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\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"ad932ec5d5c71c33f11cdf29dd5faa10123e1ca9","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Presentation","loe:small","release_note:skip","impact:critical","backport:prev-minor","v8.11.0","v8.12.0"],"number":169559,"url":"https://github.com/elastic/kibana/pull/169559","mergeCommit":{"message":"[Controls] Fix flaky `a11y` test (#169559)\n\nCloses https://github.com/elastic/kibana/issues/169542\r\n\r\n## Summary\r\n\r\nFor some reason, the search session popover was being opened, which\r\nblocked the controls button from being clickable:\r\n\r\n\r\n\r\n\r\nI'm unsure why this popover is open to begin with; this should **only**\r\nhappen when the `searchSessionIndicator` button is clicked, but this\r\nbutton is **not** interacted with in **any** of the accessibility tests\r\n(that I could find). This makes me suspicious that this is actually a\r\n**misclick** - i.e. the element that was meant to be clicked gets moved\r\n(possibly the Dashboard \"edit\" button?), which causes the\r\n`searchSessionIndicator` button to be clicked instead.\r\n\r\nGoing off this theory, I've switched the controls `a11y` tests to use\r\nthe Dashboard page's methods (which have more safeguards in place) to\r\nnavigate to the desired dashboard rather than clicking elements solely\r\nbased off of the `data-test-subj` like we were previously.\r\n\r\n### [Flaky Test\r\nRunner](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/3686)\r\n\r\n\r\n\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\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"ad932ec5d5c71c33f11cdf29dd5faa10123e1ca9"}},"sourceBranch":"main","suggestedTargetBranches":["8.11"],"targetPullRequestStates":[{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/169559","number":169559,"mergeCommit":{"message":"[Controls] Fix flaky `a11y` test (#169559)\n\nCloses https://github.com/elastic/kibana/issues/169542\r\n\r\n## Summary\r\n\r\nFor some reason, the search session popover was being opened, which\r\nblocked the controls button from being clickable:\r\n\r\n\r\n\r\n\r\nI'm unsure why this popover is open to begin with; this should **only**\r\nhappen when the `searchSessionIndicator` button is clicked, but this\r\nbutton is **not** interacted with in **any** of the accessibility tests\r\n(that I could find). This makes me suspicious that this is actually a\r\n**misclick** - i.e. the element that was meant to be clicked gets moved\r\n(possibly the Dashboard \"edit\" button?), which causes the\r\n`searchSessionIndicator` button to be clicked instead.\r\n\r\nGoing off this theory, I've switched the controls `a11y` tests to use\r\nthe Dashboard page's methods (which have more safeguards in place) to\r\nnavigate to the desired dashboard rather than clicking elements solely\r\nbased off of the `data-test-subj` like we were previously.\r\n\r\n### [Flaky Test\r\nRunner](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/3686)\r\n\r\n\r\n\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\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"ad932ec5d5c71c33f11cdf29dd5faa10123e1ca9"}}]}] BACKPORT--> Co-authored-by: Hannah Mudge <[email protected]>
|
This PR didn't make it into the last BC of 8.11.0. Updating the labels. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #169542
Summary
For some reason, the search session popover was being opened, which blocked the controls button from being clickable:
I'm unsure why this popover is open to begin with; this should only happen when the
searchSessionIndicatorbutton is clicked, but this button is not interacted with in any of the accessibility tests (that I could find). This makes me suspicious that this is actually a misclick - i.e. the element that was meant to be clicked gets moved (possibly the Dashboard "edit" button?), which causes thesearchSessionIndicatorbutton to be clicked instead.Going off this theory, I've switched the controls
a11ytests to use the Dashboard page's methods (which have more safeguards in place) to navigate to the desired dashboard rather than clicking elements solely based off of thedata-test-subjlike we were previously.Flaky Test Runner
Checklist
For maintainers