fix: avoid WebSocket reconnect deadlock - #1161
Open
mikamikasuki wants to merge 1 commit into
Open
mikamikasuki wants to merge 1 commit into
mikamikasuki wants to merge 1 commit into
Conversation
Contributor
Reviewer's GuideThe PR prevents a WebSocket send/reconnect deadlock by separating lock acquisition from reconnection work and using the lock-safe helper from send(), with a regression test covering sends initiated while disconnected. Sequence diagram for deadlock-free WebSocket send reconnectsequenceDiagram
participant Caller
participant Client
participant WebSocket
Caller->>Client: send(msg_type, kwargs)
Client->>Client: acquire _lock
alt disconnected
Client->>Client: _reconnect_locked()
Client->>WebSocket: _cleanup()
Client->>WebSocket: _connect()
WebSocket-->>Client: connected
end
Client->>Client: _next_id()
Client->>WebSocket: send command
WebSocket-->>Client: response
Client-->>Caller: response
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This branch has not been deployed
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
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
asyncio.Lockwhensend()reconnects a disconnected client.Fixes #1140
Validation
pytest tests/test_websocket_client.py -q— 8 passed.pytest tests/ -q— 1254 passed, 1 skipped, 32 xfailed, and 56 subtests passed. One existing failure and its teardown error inTestConnectionManager.test_lock_prevents_race_conditionsalso reproduce on the base commit.ruff check .andruff format --checkpassed.Summary by Sourcery
Prevent WebSocket send operations from deadlocking during automatic reconnection.
Bug Fixes:
Enhancements:
Tests: