Prevent AssertionError in the recv_events thread.

close_socket() was interacting with the protocol, namely calling
protocol.receive_of(), without locking the mutex. This created the
possibility of a race condition.

If two threads called receive_eof() concurrently, the second one
could return before the first one finished running it. This led to
receive_eof() returning (in the second thread) before the connection
state was CLOSED, breaking an invariant.

This race condition could be triggered reliably by shutting down the
network (e.g., turning wifi off), closing the connection, and waiting
for the timeout. Then, close() calls close_socket() — this happens in
the `raise_close_exc` branch of send_context(). This unblocks the read
in recv_events() which calls close_socket() in the `finally:` branch.

Fix #1558.

Author: aaugustin

src/websockets/sync/connection.py

@@ -923,8 +923,9 @@ def close_socket(self) -> None:
 
         # Calling protocol.receive_eof() is safe because it's idempotent.
         # This guarantees that the protocol state becomes CLOSED.
-        self.protocol.receive_eof()
-        assert self.protocol.state is CLOSED
+        with self.protocol_mutex:
+            self.protocol.receive_eof()
+            assert self.protocol.state is CLOSED
 
         # Abort recv() with a ConnectionClosed exception.
         self.recv_messages.close()

tests/sync/test_client.py

@@ -151,7 +151,7 @@ def test_connection_closed_during_handshake(self):
         """Client reads EOF before receiving handshake response from server."""
 
         def close_connection(self, request):
-            self.close_socket()
+            self.socket.close()
 
         with run_server(process_request=close_connection) as server:
             with self.assertRaises(InvalidMessage) as raised: