fix(await-async-events): false positives for userEvent.setup() returned #895
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #895 +/- ##
==========================================
+ Coverage 96.23% 96.31% +0.08%
==========================================
Files 44 44
Lines 2419 2445 +26
Branches 1000 1023 +23
==========================================
+ Hits 2328 2355 +27
+ Misses 91 90 -1 ☔ View full report in Codecov by Sentry. |
Belco90
approved these changes
Apr 15, 2024
Belco90
changed the title
|
@all-contributors please add @Chamion for code, test |
|
I've put up a pull request to add @Chamion! 🎉 |
|
🎉 This PR is included in version 6.2.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Checks
Changes
The circuit-breaker checking for
userEvent.setup()was executed afterdetectEventMethodWrapperso the circuit-breaking only applied to cases where the expression is not returned. It's intended to be applied generally so this PR moves it to the top of its code block.Context
My last contribution was received well so I picked another open issue.
Fixes #881
This is another false-positive where the root problem is defaulting to report unless a reason not to report is found. If new methods are introduced to
userEventthe rule will assume they return promises. I'd like to change the behaviour to check for an allow-list of method names instead of checking it's not specificallysetupso future bugs would be false negatives instead of false positives. I didn't do that in this PR because maybe it's the way it is by design.