expose the sid for the connection

miguelgrinberg · miguelgrinberg · commit 3b32dbde8d59 · 2019-05-26T11:08:03.000+01:00
diff --git a/docs/client.rst b/docs/client.rst
@@ -92,6 +92,11 @@ In the case of the ``asyncio`` client, the method is a coroutine::
 
     await sio.connect('http://localhost:5000')
 
+Upon connection, the server assigns the client a unique session identifier.
+The applicaction can find this identifier in the ``sid`` attribute::
+
+    print('my sid is', sio.sid)
+
 Emitting Events
 ---------------
 
diff --git a/socketio/asyncio_client.py b/socketio/asyncio_client.py
@@ -386,9 +386,10 @@ async def _handle_reconnect(self):
                     'Maximum reconnection attempts reached, giving up')
                 break
 
-    def _handle_eio_connect(self):  # pragma: no cover
+    def _handle_eio_connect(self):
         """Handle the Engine.IO connection event."""
         self.logger.info('Engine.IO connection established')
+        self.sid = self.eio.sid
 
     async def _handle_eio_message(self, data):
         """Dispatch Engine.IO messages."""
@@ -426,6 +427,7 @@ async def _handle_eio_disconnect(self):
         await self._trigger_event('disconnect', namespace='/')
         self.callbacks = {}
         self._binary_packet = None
+        self.sid = None
         if self.eio.state == 'connected' and self.reconnection:
             self._reconnect_task = self.start_background_task(
                 self._handle_reconnect)
diff --git a/socketio/client.py b/socketio/client.py
@@ -94,6 +94,7 @@ def __init__(self, reconnection=True, reconnection_attempts=0,
         self.connection_transports = None
         self.connection_namespaces = None
         self.socketio_path = None
+        self.sid = None
 
         self.namespaces = []
         self.handlers = {}
@@ -481,9 +482,10 @@ def _handle_reconnect(self):
                     'Maximum reconnection attempts reached, giving up')
                 break
 
-    def _handle_eio_connect(self):  # pragma: no cover
+    def _handle_eio_connect(self):
         """Handle the Engine.IO connection event."""
         self.logger.info('Engine.IO connection established')
+        self.sid = self.eio.sid
 
     def _handle_eio_message(self, data):
         """Dispatch Engine.IO messages."""
@@ -521,6 +523,7 @@ def _handle_eio_disconnect(self):
         self._trigger_event('disconnect', namespace='/')
         self.callbacks = {}
         self._binary_packet = None
+        self.sid = None
         if self.eio.state == 'connected' and self.reconnection:
             self._reconnect_task = self.start_background_task(
                 self._handle_reconnect)
diff --git a/tests/asyncio/test_asyncio_client.py b/tests/asyncio/test_asyncio_client.py
@@ -589,6 +589,13 @@ def test_handle_reconnect_max_attempts(self, random):
         ])
         self.assertEqual(c._reconnect_task, 'foo')
 
+    def test_eio_connect(self):
+        c = asyncio_client.AsyncClient()
+        c.eio.sid = 'foo'
+        self.assertIsNone(c.sid)
+        c._handle_eio_connect()
+        self.assertEqual(c.sid, 'foo')
+
     def test_handle_eio_message(self):
         c = asyncio_client.AsyncClient()
         c._handle_connect = AsyncMock()
@@ -630,20 +637,24 @@ def test_handle_eio_message(self):
     def test_eio_disconnect(self):
         c = asyncio_client.AsyncClient()
         c._trigger_event = AsyncMock()
+        c.sid = 'foo'
         c.eio.state = 'connected'
         _run(c._handle_eio_disconnect())
         c._trigger_event.mock.assert_called_once_with(
             'disconnect', namespace='/')
+        self.assertIsNone(c.sid)
 
     def test_eio_disconnect_namespaces(self):
         c = asyncio_client.AsyncClient()
         c.namespaces = ['/foo', '/bar']
         c._trigger_event = AsyncMock()
+        c.sid = 'foo'
         c.eio.state = 'connected'
         _run(c._handle_eio_disconnect())
         c._trigger_event.mock.assert_any_call('disconnect', namespace='/foo')
         c._trigger_event.mock.assert_any_call('disconnect', namespace='/bar')
         c._trigger_event.mock.assert_any_call('disconnect', namespace='/')
+        self.assertIsNone(c.sid)
 
     def test_eio_disconnect_reconnect(self):
         c = asyncio_client.AsyncClient(reconnection=True)
diff --git a/tests/common/test_client.py b/tests/common/test_client.py
@@ -43,6 +43,7 @@ def test_create(self, engineio_client_class):
         self.assertEqual(c.connection_transports, None)
         self.assertEqual(c.connection_namespaces, None)
         self.assertEqual(c.socketio_path, None)
+        self.assertEqual(c.sid, None)
 
         self.assertEqual(c.namespaces, [])
         self.assertEqual(c.handlers, {})
@@ -689,6 +690,13 @@ def test_handle_reconnect_max_attempts(self, random):
         ])
         self.assertEqual(c._reconnect_task, 'foo')
 
+    def test_handle_eio_connect(self):
+        c = client.Client()
+        c.eio.sid = 'foo'
+        self.assertIsNone(c.sid)
+        c._handle_eio_connect()
+        self.assertEqual(c.sid, 'foo')
+
     def test_handle_eio_message(self):
         c = client.Client()
         c._handle_connect = mock.MagicMock()
@@ -730,20 +738,24 @@ def test_eio_disconnect(self):
         c = client.Client()
         c._trigger_event = mock.MagicMock()
         c.start_background_task = mock.MagicMock()
+        c.sid = 'foo'
         c.eio.state = 'connected'
         c._handle_eio_disconnect()
         c._trigger_event.assert_called_once_with('disconnect', namespace='/')
+        self.assertIsNone(c.sid)
 
     def test_eio_disconnect_namespaces(self):
         c = client.Client()
         c.namespaces = ['/foo', '/bar']
         c._trigger_event = mock.MagicMock()
         c.start_background_task = mock.MagicMock()
+        c.sid = 'foo'
         c.eio.state = 'connected'
         c._handle_eio_disconnect()
         c._trigger_event.assert_any_call('disconnect', namespace='/foo')
         c._trigger_event.assert_any_call('disconnect', namespace='/bar')
         c._trigger_event.assert_any_call('disconnect', namespace='/')
+        self.assertIsNone(c.sid)
 
     def test_eio_disconnect_reconnect(self):
         c = client.Client(reconnection=True)
