From 49822e6919d3de9d52f6dde32c7f04ad62d73990 Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Wed, 2 Dec 2020 08:46:25 +0000 Subject: [PATCH] v5 protocol: do not connect the default namespace unless requested explicitly --- .../{latency_client.js => latency-client.js} | 0 socketio/asyncio_client.py | 45 ++++++-------- socketio/asyncio_server.py | 1 - socketio/client.py | 60 +++++++++++-------- socketio/server.py | 1 - 5 files changed, 53 insertions(+), 54 deletions(-) rename examples/client/javascript/{latency_client.js => latency-client.js} (100%) diff --git a/examples/client/javascript/latency_client.js b/examples/client/javascript/latency-client.js similarity index 100% rename from examples/client/javascript/latency_client.js rename to examples/client/javascript/latency-client.js diff --git a/socketio/asyncio_client.py b/socketio/asyncio_client.py index 85ea3c2..615c7c0 100644 --- a/socketio/asyncio_client.py +++ b/socketio/asyncio_client.py @@ -71,16 +71,19 @@ class AsyncClient(client.Client): are ``'polling'`` and ``'websocket'``. If not given, the polling transport is connected first, then an upgrade to websocket is attempted. - :param namespaces: The list of custom namespaces to connect, in - addition to the default namespace. If not given, - the namespace list is obtained from the registered - event handlers. + :param namespaces: The namespaces to connect as a string or list of + strings. If not given, the namespaces that have + registered event handlers are connected. :param socketio_path: The endpoint where the Socket.IO server is installed. The default value is appropriate for most cases. Note: this method is a coroutine. + Note: The connection mechannism occurs in the background and will + complete at some point after this function returns. The connection + will be established when the ``connect`` event is invoked. + Example usage:: sio = socketio.AsyncClient() @@ -97,8 +100,7 @@ class AsyncClient(client.Client): set(self.namespace_handlers.keys())) elif isinstance(namespaces, six.string_types): namespaces = [namespaces] - self.connection_namespaces = namespaces - self.namespaces = [n for n in namespaces if n != '/'] + self.connection_namespaces = namespaces try: await self.eio.connect(url, headers=headers, transports=transports, @@ -154,7 +156,7 @@ class AsyncClient(client.Client): Note 2: this method is a coroutine. """ namespace = namespace or '/' - if namespace != '/' and namespace not in self.namespaces: + if namespace not in self.namespaces: raise exceptions.BadNamespaceError( namespace + ' is not a connected namespace.') self.logger.info('Emitting event "%s" [%s]', event, namespace) @@ -248,8 +250,6 @@ class AsyncClient(client.Client): for n in self.namespaces: await self._send_packet(packet.Packet(packet.DISCONNECT, namespace=n)) - await self._send_packet(packet.Packet( - packet.DISCONNECT, namespace='/')) self.connected = False await self.eio.disconnect(abort=True) @@ -291,30 +291,22 @@ class AsyncClient(client.Client): else: await self.eio.send(encoded_packet) - async def _handle_connect(self, namespace): + async def _handle_connect(self, namespace, data): namespace = namespace or '/' self.logger.info('Namespace {} is connected'.format(namespace)) + if namespace not in self.namespaces: + self.namespaces[namespace] = (data or {}).get('sid', self.sid) await self._trigger_event('connect', namespace=namespace) - if namespace == '/': - for n in self.namespaces: - await self._send_packet(packet.Packet(packet.CONNECT, - namespace=n)) - elif namespace not in self.namespaces: - self.namespaces.append(namespace) async def _handle_disconnect(self, namespace): if not self.connected: return namespace = namespace or '/' - if namespace == '/': - for n in self.namespaces: - await self._trigger_event('disconnect', namespace=n) - self.namespaces = [] await self._trigger_event('disconnect', namespace=namespace) if namespace in self.namespaces: - self.namespaces.remove(namespace) - if namespace == '/': - self.connected = False + del self.namespaces[namespace] + if not self.namespaces: + await self.eio.disconnect(abort=True) async def _handle_event(self, namespace, id, data): namespace = namespace or '/' @@ -422,10 +414,12 @@ class AsyncClient(client.Client): break client.reconnecting_clients.remove(self) - def _handle_eio_connect(self): + async def _handle_eio_connect(self): """Handle the Engine.IO connection event.""" self.logger.info('Engine.IO connection established') self.sid = self.eio.sid + for n in self.connection_namespaces: + await self._send_packet(packet.Packet(packet.CONNECT, namespace=n)) async def _handle_eio_message(self, data): """Dispatch Engine.IO messages.""" @@ -440,7 +434,7 @@ class AsyncClient(client.Client): else: pkt = packet.Packet(encoded_packet=data) if pkt.packet_type == packet.CONNECT: - await self._handle_connect(pkt.namespace) + await self._handle_connect(pkt.namespace, pkt.data) elif pkt.packet_type == packet.DISCONNECT: await self._handle_disconnect(pkt.namespace) elif pkt.packet_type == packet.EVENT: @@ -462,7 +456,6 @@ class AsyncClient(client.Client): if self.connected: for n in self.namespaces: await self._trigger_event('disconnect', namespace=n) - await self._trigger_event('disconnect', namespace='/') self.namespaces = [] self.connected = False self.callbacks = {} diff --git a/socketio/asyncio_server.py b/socketio/asyncio_server.py index 7a7e324..2cf5d4c 100644 --- a/socketio/asyncio_server.py +++ b/socketio/asyncio_server.py @@ -515,7 +515,6 @@ class AsyncServer(server.Server): self.manager_initialized = True self.manager.initialize() self.environ[sid] = environ - return await self._handle_connect(sid, '/') async def _handle_eio_message(self, sid, data): """Dispatch Engine.IO messages.""" diff --git a/socketio/client.py b/socketio/client.py index 7b26358..5873a5b 100644 --- a/socketio/client.py +++ b/socketio/client.py @@ -124,7 +124,7 @@ class Client(object): self.sid = None self.connected = False - self.namespaces = [] + self.namespaces = {} self.handlers = {} self.namespace_handlers = {} self.callbacks = {} @@ -242,14 +242,17 @@ class Client(object): are ``'polling'`` and ``'websocket'``. If not given, the polling transport is connected first, then an upgrade to websocket is attempted. - :param namespaces: The list of custom namespaces to connect, in - addition to the default namespace. If not given, - the namespace list is obtained from the registered - event handlers. + :param namespaces: The namespaces to connect as a string or list of + strings. If not given, the namespaces that have + registered event handlers are connected. :param socketio_path: The endpoint where the Socket.IO server is installed. The default value is appropriate for most cases. + Note: The connection mechannism occurs in the background and will + complete at some point after this function returns. The connection + will be established when the ``connect`` event is invoked. + Example usage:: sio = socketio.Client() @@ -266,8 +269,7 @@ class Client(object): set(self.namespace_handlers.keys())) elif isinstance(namespaces, six.string_types): namespaces = [namespaces] - self.connection_namespaces = namespaces - self.namespaces = [n for n in namespaces if n != '/'] + self.connection_namespaces = namespaces try: self.eio.connect(url, headers=headers, transports=transports, engineio_path=socketio_path) @@ -318,7 +320,7 @@ class Client(object): situation. """ namespace = namespace or '/' - if namespace != '/' and namespace not in self.namespaces: + if namespace not in self.namespaces: raise exceptions.BadNamespaceError( namespace + ' is not a connected namespace.') self.logger.info('Emitting event "%s" [%s]', event, namespace) @@ -402,11 +404,23 @@ class Client(object): # later in _handle_eio_disconnect we invoke the disconnect handler for n in self.namespaces: self._send_packet(packet.Packet(packet.DISCONNECT, namespace=n)) - self._send_packet(packet.Packet( - packet.DISCONNECT, namespace='/')) self.connected = False self.eio.disconnect(abort=True) + def get_sid(self, namespace=None): + """Return the ``sid`` associated with a connection. + + :param namespace: The Socket.IO namespace. If this argument is omitted + the handler is associated with the default + namespace. Note that unlike previous versions, the + current version of the Socket.IO protocol uses + different ``sid`` values per namespace. + + This method returns the ``sid`` for the requested namespace as a + string. + """ + return self.namespaces.get(namespace or '/') + def transport(self): """Return the name of the transport used by the client. @@ -460,29 +474,22 @@ class Client(object): self.callbacks[namespace][id] = callback return id - def _handle_connect(self, namespace): + def _handle_connect(self, namespace, data): namespace = namespace or '/' self.logger.info('Namespace {} is connected'.format(namespace)) + if namespace not in self.namespaces: + self.namespaces[namespace] = (data or {}).get('sid', self.sid) self._trigger_event('connect', namespace=namespace) - if namespace == '/': - for n in self.namespaces: - self._send_packet(packet.Packet(packet.CONNECT, namespace=n)) - elif namespace not in self.namespaces: - self.namespaces.append(namespace) def _handle_disconnect(self, namespace): if not self.connected: return namespace = namespace or '/' - if namespace == '/': - for n in self.namespaces: - self._trigger_event('disconnect', namespace=n) - self.namespaces = [] self._trigger_event('disconnect', namespace=namespace) if namespace in self.namespaces: - self.namespaces.remove(namespace) - if namespace == '/': - self.connected = False + del self.namespaces[namespace] + if not self.namespaces: + self.eio.disconnect(abort=True) def _handle_event(self, namespace, id, data): namespace = namespace or '/' @@ -524,7 +531,7 @@ class Client(object): data = (data,) self._trigger_event('connect_error', namespace, *data) if namespace in self.namespaces: - self.namespaces.remove(namespace) + del self.namespaces[namespace] if namespace == '/': self.namespaces = [] self.connected = False @@ -581,6 +588,8 @@ class Client(object): """Handle the Engine.IO connection event.""" self.logger.info('Engine.IO connection established') self.sid = self.eio.sid + for n in self.connection_namespaces: + self._send_packet(packet.Packet(packet.CONNECT, namespace=n)) def _handle_eio_message(self, data): """Dispatch Engine.IO messages.""" @@ -595,7 +604,7 @@ class Client(object): else: pkt = packet.Packet(encoded_packet=data) if pkt.packet_type == packet.CONNECT: - self._handle_connect(pkt.namespace) + self._handle_connect(pkt.namespace, pkt.data) elif pkt.packet_type == packet.DISCONNECT: self._handle_disconnect(pkt.namespace) elif pkt.packet_type == packet.EVENT: @@ -616,7 +625,6 @@ class Client(object): if self.connected: for n in self.namespaces: self._trigger_event('disconnect', namespace=n) - self._trigger_event('disconnect', namespace='/') self.namespaces = [] self.connected = False self.callbacks = {} diff --git a/socketio/server.py b/socketio/server.py index eb8ae42..d6bc7e3 100644 --- a/socketio/server.py +++ b/socketio/server.py @@ -705,7 +705,6 @@ class Server(object): self.manager_initialized = True self.manager.initialize() self.environ[sid] = environ - return self._handle_connect(sid, '/') def _handle_eio_message(self, sid, data): """Dispatch Engine.IO messages."""