test(flaky): avoid relying on race condition for tested behavior #6452
Conversation
This file contains hidden or 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
jpinkney-aws
approved these changes
Jan 29, 2025
s7ab059789
pushed a commit
to s7ab059789/aws-toolkit-vscode
that referenced
this pull request
Feb 19, 2025
…6452 ## Problem aws#6451 This rename test relies on a specific result of a race condition for the expected result. - The test is checking for a telemetry result that is only emitted when `fs.exists` takes more than 1 attempt to resolve to true. - Therefore, it wants the first `fs.exists` check to fail, then a subsequent one to succeed. - It does this by not awaiting the result, and then writing the file to be renamed. Usually this is fine, but it is possible that the write (`toFile`) happens before the read (`fs.exists`) since neither is awaited. This behavior leads to a flaky test as described in the issue. ## Solution - use a stub to force the first call to `fs.exists` to fail. - allow all other calls to "go through" to the original function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem
#6451
This rename test relies on a specific result of a race condition for the expected result.
fs.existstakes more than 1 attempt to resolve to true.fs.existscheck to fail, then a subsequent one to succeed.Usually this is fine, but it is possible that the write (
toFile) happens before the read (fs.exists) since neither is awaited. This behavior leads to a flaky test as described in the issue.Solution
fs.existsto fail.feature/xbranches will not be squash-merged at release time.