Add transport.is_closing() guard on websocket.send in sansio implementation#2863
Closed
hrv-dys wants to merge 2 commits intoKludex:mainfrom
Closed
Add transport.is_closing() guard on websocket.send in sansio implementation#2863hrv-dys wants to merge 2 commits intoKludex:mainfrom
hrv-dys wants to merge 2 commits intoKludex:mainfrom
Conversation
…tation The websocket.send handler was writing to the transport without checking transport.is_closing(), while the websocket.close handler 10 lines below already performed this check. The wsproto implementation consistently checks at both points. This adds the same guard to prevent writing to a half-closed transport.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Summary
In
websockets_sansio_impl.py, thewebsocket.sendhandler writes to thetransport without checking
transport.is_closing(), while thewebsocket.closehandler in the same method (10 lines later) does perform this check. The
wsproto_impl.pyimplementation consistently checks at both points.This inconsistency means a
websocket.sendmessage arriving while thetransport is closing could result in writing to a half-closed transport.
This fix adds the same
is_closing()guard that's already used forwebsocket.closein this file and for both message types in wsproto.Belief that guided this fix: don't assume consistent behavior between
the wsproto and websockets implementations — they handle protocol states
differently. Cross-referencing all three implementations side by side
revealed this inconsistency.
Test plan
tests/protocols/test_websocket.pypasses