Suppress "socket is closed" stack trace from logs

Fixes #57
miguelgrinberg · Jan 4, 2018 · 7dfc60e · 7dfc60e
1 parent 4a33200
commit 7dfc60e
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 6 deletions.
diff --git a/engineio/asyncio_socket.py b/engineio/asyncio_socket.py
@@ -53,7 +53,7 @@ async def receive(self, pkt):
     async def send(self, pkt):
         """Send a packet to the client."""
         if self.closed:
-            raise IOError('Socket is closed')
+            raise exceptions.SocketIsClosedError()
         if time.time() - self.last_ping > self.server.ping_timeout:
             self.server.logger.info('%s: Client is gone, closing socket',
                                     self.sid)
@@ -200,10 +200,13 @@ async def writer():
                 await self.receive(pkt)
             except exceptions.UnknownPacketError:
                 pass
+            except exceptions.SocketIsClosedError:
+                self.server.logger.info('Receive error -- socket is closed')
+                break
             except:  # pragma: no cover
                 # if we get an unexpected exception we log the error and exit
                 # the connection properly
-                self.server.logger.exception('Receive error')
+                self.server.logger.exception('Unknown receive error')
 
         await self.queue.put(None)  # unlock the writer task so it can exit
         await asyncio.wait_for(writer_task, timeout=None)

diff --git a/engineio/exceptions.py b/engineio/exceptions.py
@@ -12,3 +12,7 @@ class UnknownPacketError(EngineIOError):
 
 class QueueEmpty(EngineIOError):
     pass
+
+
+class SocketIsClosedError(EngineIOError):
+    pass
diff --git a/engineio/socket.py b/engineio/socket.py
@@ -66,7 +66,7 @@ def receive(self, pkt):
     def send(self, pkt):
         """Send a packet to the client."""
         if self.closed:
-            raise IOError('Socket is closed')
+            raise exceptions.SocketIsClosedError()
         if time.time() - self.last_ping > self.server.ping_timeout:
             self.server.logger.info('%s: Client is gone, closing socket',
                                     self.sid)
@@ -212,10 +212,13 @@ def writer():
                 self.receive(pkt)
             except exceptions.UnknownPacketError:
                 pass
+            except exceptions.SocketIsClosedError:
+                self.server.logger.info('Receive error -- socket is closed')
+                break
             except:  # pragma: no cover
                 # if we get an unexpected exception we log the error and exit
                 # the connection properly
-                self.server.logger.exception('Receive error')
+                self.server.logger.exception('Unknown receive error')
                 break
 
         self.queue.put(None)  # unlock the writer task so that it can exit

diff --git a/tests/test_asyncio_socket.py b/tests/test_asyncio_socket.py
@@ -388,7 +388,7 @@ def test_send_after_close(self):
         mock_server = self._get_mock_server()
         s = asyncio_socket.AsyncSocket(mock_server, 'sid')
         _run(s.close(wait=False))
-        self.assertRaises(IOError, _run,
+        self.assertRaises(exceptions.SocketIsClosedError, _run,
                           s.send(packet.Packet(packet.NOOP)))
 
     def test_close_after_close(self):

diff --git a/tests/test_socket.py b/tests/test_socket.py
@@ -372,7 +372,8 @@ def test_send_after_close(self):
         mock_server = self._get_mock_server()
         s = socket.Socket(mock_server, 'sid')
         s.close(wait=False)
-        self.assertRaises(IOError, s.send, packet.Packet(packet.NOOP))
+        self.assertRaises(exceptions.SocketIsClosedError, s.send,
+                          packet.Packet(packet.NOOP))
 
     def test_close_after_close(self):
         mock_server = self._get_mock_server()