[Fix] WebSocket Close #44
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
🦋 Changeset detectedLatest commit: ed9a80b The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
rkistner
approved these changes
Jul 18, 2024
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.
Overview
When closing a WebSocket connection, e.g. by closing a web tab, the router did not immediately detect that the connection has been closed.
The connection would close when the keep-alive ping-pong check failed, but the delay could cause the number of concurrent connections and active streams to accumulate for short periods.
This bubbles the WebSocket
closeevent through the WebSocket Duplex connection and router endpoint handlers.Thanks @rkistner for finding the issue and providing a fix.
Testing
This was tested locally with web and React Native. See screenshots below where the
STREAMlog duration is below the keep-alive period of 30_000ms.The close unit test was updated to ensure that the cancel event is called correctly. Oddly enough this extended test actually would pass with the previous code - the bug is only reproducible with an actual connection.