fix respond() & readystatechange process flow #184
Merged
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
\### Rationale Added issue replication test for issue sinonjs#165 where readystatechange event is occuring after loadend event occurs.
\### Rationale The code was using fall through logic which caused the extra readystatechange event to be thrown after the loadend event. The logic was there to delinate from a finished XHR request and throw the loadend but not to stop processing. Note that a readystatechange did have to be added prior to the loadend otherwise some requests would not resolve and it was noticeable through other unit-tests. This commit has all passing tests to include the one designed to replicate the issue of Resolves sinonjs#165
Codecov Report
@@ Coverage Diff @@
## master #184 +/- ##
==========================================
+ Coverage 91.29% 91.31% +0.01%
==========================================
Files 13 13
Lines 609 610 +1
==========================================
+ Hits 556 557 +1
Misses 53 53
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
fatso83
reviewed
May 20, 2021
### Rationale Ensure logic is clear by avoiding empty return statements and fall-through logic
|
Perfect! |
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.
Purpose
Fix the process flow where a
readystatechangeevent should not be triggered afterloadendevent. When it does, it is incompatible with some network lib(likenatty-fetch) stated in issue #165.I found that the code was using fall through logic which caused the extra readystatechange event to be thrown after the loadend event inside of the
readyStateChange()function. There was logic added to delineate from a finished XHR request and throw the loadend but not to stop processing the fall through logic. I added a return statement to prevent the drop through but note that a readystatechange did have to be added prior to the loadend otherwise some requests would not resolve and it was noticeable through other unit-tests.I added 1 unit test to replicate the issue results.
Resolves: #165
How to verify
npm installgit reset --hard HEAD~1npm test. This branch includes 1 new unit test to accompany the error so during this test run 1 of the tests will fail.git pullnpm testagain. All tests will pass verifying there was no regression and the buggy scenarios were fixed.