Support the connect_error event in the client (Fixes #344)

Author: miguelgrinberg

docs/client.rst

@@ -65,13 +65,18 @@ or can also be coroutines::
     async def message(data):
         print('I received a message!')
 
-The ``connect`` and ``disconnect`` events are special; they are invoked
-automatically when a client connects or disconnects from the server::
+The ``connect``, ``connect_error`` and ``disconnect`` events are special; they 
+are invoked automatically when a client connects or disconnects from the
+server::
 
     @sio.event
     def connect():
         print("I'm connected!")
 
+    @sio.event
+    def connect_error():
+        print("The connection failed!")
+
     @sio.event
     def disconnect():
         print("I'm disconnected!")

socketio/asyncio_client.py

@@ -348,10 +348,15 @@ async def _handle_ack(self, namespace, id, data):
             else:
                 callback(*data)
 
-    def _handle_error(self, namespace):
+    async def _handle_error(self, namespace, data):
         namespace = namespace or '/'
         self.logger.info('Connection to namespace {} was rejected'.format(
             namespace))
+        if data is None:
+            data = tuple()
+        elif not isinstance(data, (tuple, list)):
+            data = (data,)
+        await self._trigger_event('connect_error', namespace, *data)
         if namespace in self.namespaces:
             self.namespaces.remove(namespace)
         if namespace == '/':
@@ -445,7 +450,7 @@ async def _handle_eio_message(self, data):
                     pkt.packet_type == packet.BINARY_ACK:
                 self._binary_packet = pkt
             elif pkt.packet_type == packet.ERROR:
-                self._handle_error(pkt.namespace)
+                await self._handle_error(pkt.namespace, pkt.data)
             else:
                 raise ValueError('Unknown packet type.')
 

socketio/asyncio_server.py

@@ -403,7 +403,6 @@ async def _handle_connect(self, sid, namespace):
                     packet.ERROR, data=fail_reason, namespace=namespace))
             if sid in self.environ:  # pragma: no cover
                 del self.environ[sid]
-            return False
         elif not self.always_connect:
             await self._send_packet(sid, packet.Packet(packet.CONNECT,
                                                        namespace=namespace))

socketio/client.py

@@ -504,10 +504,15 @@ def _handle_ack(self, namespace, id, data):
         if callback is not None:
             callback(*data)
 
-    def _handle_error(self, namespace):
+    def _handle_error(self, namespace, data):
         namespace = namespace or '/'
         self.logger.info('Connection to namespace {} was rejected'.format(
             namespace))
+        if data is None:
+            data = tuple()
+        elif not isinstance(data, (tuple, list)):
+            data = (data,)
+        self._trigger_event('connect_error', namespace, *data)
         if namespace in self.namespaces:
             self.namespaces.remove(namespace)
         if namespace == '/':
@@ -591,7 +596,7 @@ def _handle_eio_message(self, data):
                     pkt.packet_type == packet.BINARY_ACK:
                 self._binary_packet = pkt
             elif pkt.packet_type == packet.ERROR:
-                self._handle_error(pkt.namespace)
+                self._handle_error(pkt.namespace, pkt.data)
             else:
                 raise ValueError('Unknown packet type.')
 

socketio/exceptions.py

@@ -16,7 +16,7 @@ class ConnectionRefusedError(ConnectionError):
     def __init__(self, *args):
         if len(args) == 0:
             self.error_args = None
-        elif len(args) == 1:
+        elif len(args) == 1 and not isinstance(args[0], list):
             self.error_args = args[0]
         else:
             self.error_args = args

socketio/server.py

@@ -613,7 +613,6 @@ def _handle_connect(self, sid, namespace):
                     packet.ERROR, data=fail_reason, namespace=namespace))
             if sid in self.environ:  # pragma: no cover
                 del self.environ[sid]
-            return False
         elif not self.always_connect:
             self._send_packet(sid, packet.Packet(packet.CONNECT,
                                                  namespace=namespace))

tests/asyncio/test_asyncio_client.py

@@ -551,24 +551,50 @@ def test_handle_ack_not_found(self):
     def test_handle_error(self):
         c = asyncio_client.AsyncClient()
         c.connected = True
+        c._trigger_event = AsyncMock()
+        c.namespaces = ['/foo', '/bar']
+        _run(c._handle_error('/', 'error'))
+        self.assertEqual(c.namespaces, [])
+        self.assertFalse(c.connected)
+        c._trigger_event.mock.assert_called_once_with('connect_error', '/',
+                                                      'error')
+
+    def test_handle_error_with_no_arguments(self):
+        c = asyncio_client.AsyncClient()
+        c.connected = True
+        c._trigger_event = AsyncMock()
         c.namespaces = ['/foo', '/bar']
-        c._handle_error('/')
+        _run(c._handle_error('/', None))
         self.assertEqual(c.namespaces, [])
         self.assertFalse(c.connected)
+        c._trigger_event.mock.assert_called_once_with('connect_error', '/')
 
     def test_handle_error_namespace(self):
         c = asyncio_client.AsyncClient()
         c.connected = True
         c.namespaces = ['/foo', '/bar']
-        c._handle_error('/bar')
+        c._trigger_event = AsyncMock()
+        _run(c._handle_error('/bar', ['error', 'message']))
+        self.assertEqual(c.namespaces, ['/foo'])
+        self.assertTrue(c.connected)
+        c._trigger_event.mock.assert_called_once_with('connect_error', '/bar',
+                                                      'error', 'message')
+
+    def test_handle_error_namespace_with_no_arguments(self):
+        c = asyncio_client.AsyncClient()
+        c.connected = True
+        c.namespaces = ['/foo', '/bar']
+        c._trigger_event = AsyncMock()
+        _run(c._handle_error('/bar', None))
         self.assertEqual(c.namespaces, ['/foo'])
         self.assertTrue(c.connected)
+        c._trigger_event.mock.assert_called_once_with('connect_error', '/bar')
 
     def test_handle_error_unknown_namespace(self):
         c = asyncio_client.AsyncClient()
         c.connected = True
         c.namespaces = ['/foo', '/bar']
-        c._handle_error('/baz')
+        _run(c._handle_error('/baz', 'error'))
         self.assertEqual(c.namespaces, ['/foo', '/bar'])
         self.assertTrue(c.connected)
 
@@ -685,7 +711,7 @@ def test_handle_eio_message(self):
         c._handle_disconnect = AsyncMock()
         c._handle_event = AsyncMock()
         c._handle_ack = AsyncMock()
-        c._handle_error = mock.MagicMock()
+        c._handle_error = AsyncMock()
 
         _run(c._handle_eio_message('0'))
         c._handle_connect.mock.assert_called_with(None)
@@ -700,9 +726,15 @@ def test_handle_eio_message(self):
         _run(c._handle_eio_message('3/foo,["bar"]'))
         c._handle_ack.mock.assert_called_with('/foo', None, ['bar'])
         _run(c._handle_eio_message('4'))
-        c._handle_error.assert_called_with(None)
+        c._handle_error.mock.assert_called_with(None, None)
+        _run(c._handle_eio_message('4"foo"'))
+        c._handle_error.mock.assert_called_with(None, 'foo')
+        _run(c._handle_eio_message('4["foo"]'))
+        c._handle_error.mock.assert_called_with(None, ['foo'])
         _run(c._handle_eio_message('4/foo'))
-        c._handle_error.assert_called_with('/foo')
+        c._handle_error.mock.assert_called_with('/foo', None)
+        _run(c._handle_eio_message('4/foo,["foo","bar"]'))
+        c._handle_error.mock.assert_called_with('/foo', ['foo', 'bar'])
         _run(c._handle_eio_message('51-{"_placeholder":true,"num":0}'))
         self.assertEqual(c._binary_packet.packet_type, packet.BINARY_EVENT)
         _run(c._handle_eio_message(b'foo'))

tests/common/test_client.py

@@ -660,23 +660,48 @@ def test_handle_error(self):
         c = client.Client()
         c.connected = True
         c.namespaces = ['/foo', '/bar']
-        c._handle_error('/')
+        c._trigger_event = mock.MagicMock()
+        c._handle_error('/', 'error')
+        self.assertEqual(c.namespaces, [])
+        self.assertFalse(c.connected)
+        c._trigger_event.assert_called_once_with('connect_error', '/', 'error')
+
+    def test_handle_error_with_no_arguments(self):
+        c = client.Client()
+        c.connected = True
+        c.namespaces = ['/foo', '/bar']
+        c._trigger_event = mock.MagicMock()
+        c._handle_error('/', None)
         self.assertEqual(c.namespaces, [])
         self.assertFalse(c.connected)
+        c._trigger_event.assert_called_once_with('connect_error', '/')
 
     def test_handle_error_namespace(self):
         c = client.Client()
         c.connected = True
         c.namespaces = ['/foo', '/bar']
-        c._handle_error('/bar')
+        c._trigger_event = mock.MagicMock()
+        c._handle_error('/bar', ['error', 'message'])
+        self.assertEqual(c.namespaces, ['/foo'])
+        self.assertTrue(c.connected)
+        c._trigger_event.assert_called_once_with('connect_error', '/bar',
+                                                 'error', 'message')
+
+    def test_handle_error_namespace_with_no_arguments(self):
+        c = client.Client()
+        c.connected = True
+        c.namespaces = ['/foo', '/bar']
+        c._trigger_event = mock.MagicMock()
+        c._handle_error('/bar', None)
         self.assertEqual(c.namespaces, ['/foo'])
         self.assertTrue(c.connected)
+        c._trigger_event.assert_called_once_with('connect_error', '/bar')
 
     def test_handle_error_unknown_namespace(self):
         c = client.Client()
         c.connected = True
         c.namespaces = ['/foo', '/bar']
-        c._handle_error('/baz')
+        c._handle_error('/baz', 'error')
         self.assertEqual(c.namespaces, ['/foo', '/bar'])
         self.assertTrue(c.connected)
 
@@ -809,9 +834,15 @@ def test_handle_eio_message(self):
         c._handle_eio_message('3/foo,["bar"]')
         c._handle_ack.assert_called_with('/foo', None, ['bar'])
         c._handle_eio_message('4')
-        c._handle_error.assert_called_with(None)
+        c._handle_error.assert_called_with(None, None)
+        c._handle_eio_message('4"foo"')
+        c._handle_error.assert_called_with(None, 'foo')
+        c._handle_eio_message('4["foo"]')
+        c._handle_error.assert_called_with(None, ['foo'])
         c._handle_eio_message('4/foo')
-        c._handle_error.assert_called_with('/foo')
+        c._handle_error.assert_called_with('/foo', None)
+        c._handle_eio_message('4/foo,["foo","bar"]')
+        c._handle_error.assert_called_with('/foo', ['foo', 'bar'])
         c._handle_eio_message('51-{"_placeholder":true,"num":0}')
         self.assertEqual(c._binary_packet.packet_type, packet.BINARY_EVENT)
         c._handle_eio_message(b'foo')

tests/common/test_server.py

@@ -341,7 +341,6 @@ def test_handle_connect_namespace_rejected_with_exception(self, eio):
         s._handle_eio_message('123', '0/foo')
         self.assertEqual(s.manager.connect.call_count, 2)
         self.assertEqual(s.manager.disconnect.call_count, 1)
-        print(s.eio.send.call_args)
         s.eio.send.assert_any_call('123', '4/foo,"fail_reason"', binary=False)
 
     def test_handle_disconnect(self, eio):