Don't treat close code 1005 as an error.

Fix #1260.
python-websockets · Nov 20, 2022 · 0f4ecfc · 0f4ecfc
1 parent 26e1946
commit 0f4ecfc
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 9 deletions.
diff --git a/docs/project/changelog.rst b/docs/project/changelog.rst
@@ -30,6 +30,20 @@ They may change at any time.
 
 *In development*
 
+Backwards-incompatible changes
+..............................
+
+.. admonition:: Closing a connection without an empty close frame is OK.
+    :class: note
+
+    Receiving an empty close frame now results in
+    :exc:`~exceptions.ConnectionClosedOK` instead of
+    :exc:`~exceptions.ConnectionClosedError`.
+
+    As a consequence, calling ``WebSocket.close()`` without arguments in a
+    browser isn't reported as an error anymore.
+
+
 New features
 ............
 

diff --git a/src/websockets/exceptions.py b/src/websockets/exceptions.py
@@ -135,8 +135,8 @@ class ConnectionClosedError(ConnectionClosed):
     """
     Like :exc:`ConnectionClosed`, when the connection terminated with an error.
 
-    A close code other than 1000 (OK) or 1001 (going away) was received or
-    sent, or the closing handshake didn't complete properly.
+    A close frame with a code other than 1000 (OK) or 1001 (going away) was
+    received or sent, or the closing handshake didn't complete properly.
 
     """
 
@@ -145,7 +145,8 @@ class ConnectionClosedOK(ConnectionClosed):
     """
     Like :exc:`ConnectionClosed`, when the connection terminated properly.
 
-    A close code 1000 (OK) or 1001 (going away) was received and sent.
+    A close code with code 1000 (OK) or 1001 (going away) or without a code was
+    received and sent.
 
     """
 

diff --git a/src/websockets/frames.py b/src/websockets/frames.py
@@ -90,7 +90,11 @@ class Opcode(enum.IntEnum):
     1014,
 }
 
-OK_CLOSE_CODES = {1000, 1001}
+OK_CLOSE_CODES = {
+    1000,
+    1001,
+    1005,
+}
 
 
 BytesLike = bytes, bytearray, memoryview

diff --git a/src/websockets/legacy/client.py b/src/websockets/legacy/client.py
@@ -65,7 +65,7 @@ class WebSocketClientProtocol(WebSocketCommonProtocol):
             await process(message)
 
     The iterator exits normally when the connection is closed with close code
-    1000 (OK) or 1001 (going away). It raises
+    1000 (OK) or 1001 (going away) or without a close code. It raises
     a :exc:`~websockets.exceptions.ConnectionClosedError` when the connection
     is closed with any other code.
 

diff --git a/src/websockets/legacy/protocol.py b/src/websockets/legacy/protocol.py
@@ -485,9 +485,9 @@ async def __aiter__(self) -> AsyncIterator[Data]:
         Iterate on incoming messages.
 
         The iterator  exits normally when the connection is closed with the
-        close code 1000 (OK) or 1001(going away). It raises
-        a :exc:`~websockets.exceptions.ConnectionClosedError` exception when
-        the connection is closed with any other code.
+        close code 1000 (OK) or 1001(going away) or without a close code. It
+        raises a :exc:`~websockets.exceptions.ConnectionClosedError` exception
+        when the connection is closed with any other code.
 
         """
         try:

diff --git a/src/websockets/legacy/server.py b/src/websockets/legacy/server.py
@@ -73,7 +73,7 @@ class WebSocketServerProtocol(WebSocketCommonProtocol):
             await process(message)
 
     The iterator exits normally when the connection is closed with close code
-    1000 (OK) or 1001 (going away). It raises
+    1000 (OK) or 1001 (going away) or without a close code. It raises
     a :exc:`~websockets.exceptions.ConnectionClosedError` when the connection
     is closed with any other code.