fix: WebSocket readyState should not revert from CLOSED to CLOSING #4752
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
When calling close() on a CONNECTING WebSocket, the readyState was correctly set to CLOSED during the close event handler, but incorrectly reverted to CLOSING after the handler returned. The issue was that failWebsocketConnection() called onSocketClose() synchronously, which set readyState to CLOSED and fired the close event. After returning, closeWebSocketConnection() would then overwrite the state back to CLOSING. Fix by using queueMicrotask() to defer onSocketClose(), ensuring the close event fires after closeWebSocketConnection() completes. Also add a guard to prevent duplicate onSocketClose() calls. Fixes: #4742
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4752 +/- ##
==========================================
- Coverage 93.22% 93.22% -0.01%
==========================================
Files 109 109
Lines 34024 34032 +8
==========================================
+ Hits 31720 31726 +6
- Misses 2304 2306 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
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.
Summary
readyStateincorrectly reverting from CLOSED (3) to CLOSING (2) after close event firesqueueMicrotask()to deferonSocketClose()call, ensuring close event fires after state transition completesonSocketClose()callsTest plan
close-connectingtest now passes (was failing with "assert_unreached")close-connecting-asynctest passesFixes: #4742