This repository has been archived by the owner on Jul 2, 2024. It is now read-only.
DEVPROD-1904 Fix flaky test caused by racing assertions and Introduce realClick for clipboard events #438
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
Passing run #4101 ↗︎
Details:
Review all test suite changes for PR #438 ↗︎ |
||||||||||||||||||||
SupaJoon
approved these changes
Nov 16, 2023
package.json
Outdated
| @@ -117,6 +117,7 @@ | |||
| "babel-loader": "8.2.5", | |||
| "babel-plugin-import-graphql": "2.8.1", | |||
| "cypress": "12.7.0", | |||
| "cypress-real-events": "^1.11.0", | |||
There was a problem hiding this comment.
You can avoid the caret by setting npm config set save-exact true
SupaJoon
reviewed
Nov 17, 2023
| }); | ||
| cy.toggleDetailsPanel(true); | ||
| // Need to fire a real click here because the copy to clipboard | ||
| cy.dataCy("jira-button").realClick(); |
There was a problem hiding this comment.
It makes sense to create a clipboard interaction helper command that calls realClick and asserts the value. I can tell the logic should be consolidated because of the repeated comment that explains special usage
SupaJoon
approved these changes
Nov 17, 2023
| @@ -1,3 +1,4 @@ | |||
| import "cypress-real-events"; | |||
There was a problem hiding this comment.
This is required and initializes the package for the entire test suite.
| }); | ||
| // This wait is necessary to ensure the clipboard has time to be read | ||
| // eslint-disable-next-line cypress/no-unnecessary-waiting | ||
| cy.wait(50); |
khelif96
commented
Nov 17, 2023
| @@ -1,3 +1,4 @@ | |||
| import "cypress-real-events"; | |||
There was a problem hiding this comment.
This is required and initializes the package for the entire test suite.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
DEVPROD-1904
Description
The test flake here seems to have been caused by an assertion that would sometimes race with the click because it wasn't checking if the element existed.
There were also some silent uncaught exceptions that were caused by clicking on a copy to clipboard button because the cypress click event isn't a real click and the browser prevents copying to the clipboard without a real user interaction.
It also looks like the actual copy assertions themselves weren't being resolved during the test and would leak into the next test run causing unpredictable behavior. I moved the the copy assertion to a util function and added a wait to ensure it gets run before the test completes