mirror
/
miguelgrinberg.python-socketio
mirror of https://github.com/miguelgrinberg/python-socketio
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

v5 protocol: do not connect the default namespace unless requested explicitly

pull/599/head
Miguel Grinberg 4 years ago
parent
798ab6abe1
commit
49822e6919
No known key found for this signature in database GPG Key ID: 36848B262DF5F06C
5 changed files with 53 additions and 54 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 0
      examples/client/javascript/latency-client.js
  2. 45
      socketio/asyncio_client.py
  3. 1
      socketio/asyncio_server.py
  4. 60
      socketio/client.py
  5. 1
      socketio/server.py

0
examples/client/javascript/latency_client.js → examples/client/javascript/latency-client.js
View File

45
socketio/asyncio_client.py
View File

@ -71,16 +71,19 @@ class AsyncClient(client.Client):
are ``'polling'`` and ``'websocket'``. If not are ``'polling'`` and ``'websocket'``. If not
given, the polling transport is connected first, given, the polling transport is connected first,
then an upgrade to websocket is attempted. then an upgrade to websocket is attempted.
:param namespaces: The list of custom namespaces to connect, in :param namespaces: The namespaces to connect as a string or list of
addition to the default namespace. If not given, strings. If not given, the namespaces that have
the namespace list is obtained from the registered registered event handlers are connected.
event handlers.
:param socketio_path: The endpoint where the Socket.IO server is :param socketio_path: The endpoint where the Socket.IO server is
installed. The default value is appropriate for installed. The default value is appropriate for
most cases. most cases.
Note: this method is a coroutine. 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:: Example usage::
sio = socketio.AsyncClient() sio = socketio.AsyncClient()
@ -97,8 +100,7 @@ class AsyncClient(client.Client):
set(self.namespace_handlers.keys())) set(self.namespace_handlers.keys()))
elif isinstance(namespaces, six.string_types): elif isinstance(namespaces, six.string_types):
namespaces = [namespaces] namespaces = [namespaces]
self.connection_namespaces = namespaces self.connection_namespaces = namespaces
self.namespaces = [n for n in namespaces if n != '/']
try: try:
await self.eio.connect(url, headers=headers, await self.eio.connect(url, headers=headers,
transports=transports, transports=transports,
@ -154,7 +156,7 @@ class AsyncClient(client.Client):
Note 2: this method is a coroutine. Note 2: this method is a coroutine.
""" """
namespace = namespace or '/' namespace = namespace or '/'
if namespace != '/' and namespace not in self.namespaces: if namespace not in self.namespaces:
raise exceptions.BadNamespaceError( raise exceptions.BadNamespaceError(
namespace + ' is not a connected namespace.') namespace + ' is not a connected namespace.')
self.logger.info('Emitting event "%s" [%s]', event, namespace) self.logger.info('Emitting event "%s" [%s]', event, namespace)
@ -248,8 +250,6 @@ class AsyncClient(client.Client):
for n in self.namespaces: for n in self.namespaces:
await self._send_packet(packet.Packet(packet.DISCONNECT, await self._send_packet(packet.Packet(packet.DISCONNECT,
namespace=n)) namespace=n))
await self._send_packet(packet.Packet(
packet.DISCONNECT, namespace='/'))
self.connected = False self.connected = False
await self.eio.disconnect(abort=True) await self.eio.disconnect(abort=True)
@ -291,30 +291,22 @@ class AsyncClient(client.Client):
else: else:
await self.eio.send(encoded_packet) await self.eio.send(encoded_packet)
async def _handle_connect(self, namespace): async def _handle_connect(self, namespace, data):
namespace = namespace or '/' namespace = namespace or '/'
self.logger.info('Namespace {} is connected'.format(namespace)) 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) 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): async def _handle_disconnect(self, namespace):
if not self.connected: if not self.connected:
return return
namespace = namespace or '/' 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) await self._trigger_event('disconnect', namespace=namespace)
if namespace in self.namespaces: if namespace in self.namespaces:
self.namespaces.remove(namespace) del self.namespaces[namespace]
if namespace == '/': if not self.namespaces:
self.connected = False await self.eio.disconnect(abort=True)
async def _handle_event(self, namespace, id, data): async def _handle_event(self, namespace, id, data):
namespace = namespace or '/' namespace = namespace or '/'
@ -422,10 +414,12 @@ class AsyncClient(client.Client):
break break
client.reconnecting_clients.remove(self) client.reconnecting_clients.remove(self)
def _handle_eio_connect(self): async def _handle_eio_connect(self):
"""Handle the Engine.IO connection event.""" """Handle the Engine.IO connection event."""
self.logger.info('Engine.IO connection established') self.logger.info('Engine.IO connection established')
self.sid = self.eio.sid 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): async def _handle_eio_message(self, data):
"""Dispatch Engine.IO messages.""" """Dispatch Engine.IO messages."""
@ -440,7 +434,7 @@ class AsyncClient(client.Client):
else: else:
pkt = packet.Packet(encoded_packet=data) pkt = packet.Packet(encoded_packet=data)
if pkt.packet_type == packet.CONNECT: 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: elif pkt.packet_type == packet.DISCONNECT:
await self._handle_disconnect(pkt.namespace) await self._handle_disconnect(pkt.namespace)
elif pkt.packet_type == packet.EVENT: elif pkt.packet_type == packet.EVENT:
@ -462,7 +456,6 @@ class AsyncClient(client.Client):
if self.connected: if self.connected:
for n in self.namespaces: for n in self.namespaces:
await self._trigger_event('disconnect', namespace=n) await self._trigger_event('disconnect', namespace=n)
await self._trigger_event('disconnect', namespace='/')
self.namespaces = [] self.namespaces = []
self.connected = False self.connected = False
self.callbacks = {} self.callbacks = {}

1
socketio/asyncio_server.py
View File

@ -515,7 +515,6 @@ class AsyncServer(server.Server):
self.manager_initialized = True self.manager_initialized = True
self.manager.initialize() self.manager.initialize()
self.environ[sid] = environ self.environ[sid] = environ
return await self._handle_connect(sid, '/')
async def _handle_eio_message(self, sid, data): async def _handle_eio_message(self, sid, data):
"""Dispatch Engine.IO messages.""" """Dispatch Engine.IO messages."""

60
socketio/client.py
View File

@ -124,7 +124,7 @@ class Client(object):
self.sid = None self.sid = None
self.connected = False self.connected = False
self.namespaces = [] self.namespaces = {}
self.handlers = {} self.handlers = {}
self.namespace_handlers = {} self.namespace_handlers = {}
self.callbacks = {} self.callbacks = {}
@ -242,14 +242,17 @@ class Client(object):
are ``'polling'`` and ``'websocket'``. If not are ``'polling'`` and ``'websocket'``. If not
given, the polling transport is connected first, given, the polling transport is connected first,
then an upgrade to websocket is attempted. then an upgrade to websocket is attempted.
:param namespaces: The list of custom namespaces to connect, in :param namespaces: The namespaces to connect as a string or list of
addition to the default namespace. If not given, strings. If not given, the namespaces that have
the namespace list is obtained from the registered registered event handlers are connected.
event handlers.
:param socketio_path: The endpoint where the Socket.IO server is :param socketio_path: The endpoint where the Socket.IO server is
installed. The default value is appropriate for installed. The default value is appropriate for
most cases. 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:: Example usage::
sio = socketio.Client() sio = socketio.Client()
@ -266,8 +269,7 @@ class Client(object):
set(self.namespace_handlers.keys())) set(self.namespace_handlers.keys()))
elif isinstance(namespaces, six.string_types): elif isinstance(namespaces, six.string_types):
namespaces = [namespaces] namespaces = [namespaces]
self.connection_namespaces = namespaces self.connection_namespaces = namespaces
self.namespaces = [n for n in namespaces if n != '/']
try: try:
self.eio.connect(url, headers=headers, transports=transports, self.eio.connect(url, headers=headers, transports=transports,
engineio_path=socketio_path) engineio_path=socketio_path)
@ -318,7 +320,7 @@ class Client(object):
situation. situation.
""" """
namespace = namespace or '/' namespace = namespace or '/'
if namespace != '/' and namespace not in self.namespaces: if namespace not in self.namespaces:
raise exceptions.BadNamespaceError( raise exceptions.BadNamespaceError(
namespace + ' is not a connected namespace.') namespace + ' is not a connected namespace.')
self.logger.info('Emitting event "%s" [%s]', event, 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 # later in _handle_eio_disconnect we invoke the disconnect handler
for n in self.namespaces: for n in self.namespaces:
self._send_packet(packet.Packet(packet.DISCONNECT, namespace=n)) self._send_packet(packet.Packet(packet.DISCONNECT, namespace=n))
self._send_packet(packet.Packet(
packet.DISCONNECT, namespace='/'))
self.connected = False self.connected = False
self.eio.disconnect(abort=True) 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): def transport(self):
"""Return the name of the transport used by the client. """Return the name of the transport used by the client.
@ -460,29 +474,22 @@ class Client(object):
self.callbacks[namespace][id] = callback self.callbacks[namespace][id] = callback
return id return id
def _handle_connect(self, namespace): def _handle_connect(self, namespace, data):
namespace = namespace or '/' namespace = namespace or '/'
self.logger.info('Namespace {} is connected'.format(namespace)) 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) 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): def _handle_disconnect(self, namespace):
if not self.connected: if not self.connected:
return return
namespace = namespace or '/' namespace = namespace or '/'
if namespace == '/':
for n in self.namespaces:
self._trigger_event('disconnect', namespace=n)
self.namespaces = []
self._trigger_event('disconnect', namespace=namespace) self._trigger_event('disconnect', namespace=namespace)
if namespace in self.namespaces: if namespace in self.namespaces:
self.namespaces.remove(namespace) del self.namespaces[namespace]
if namespace == '/': if not self.namespaces:
self.connected = False self.eio.disconnect(abort=True)
def _handle_event(self, namespace, id, data): def _handle_event(self, namespace, id, data):
namespace = namespace or '/' namespace = namespace or '/'
@ -524,7 +531,7 @@ class Client(object):
data = (data,) data = (data,)
self._trigger_event('connect_error', namespace, *data) self._trigger_event('connect_error', namespace, *data)
if namespace in self.namespaces: if namespace in self.namespaces:
self.namespaces.remove(namespace) del self.namespaces[namespace]
if namespace == '/': if namespace == '/':
self.namespaces = [] self.namespaces = []
self.connected = False self.connected = False
@ -581,6 +588,8 @@ class Client(object):
"""Handle the Engine.IO connection event.""" """Handle the Engine.IO connection event."""
self.logger.info('Engine.IO connection established') self.logger.info('Engine.IO connection established')
self.sid = self.eio.sid 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): def _handle_eio_message(self, data):
"""Dispatch Engine.IO messages.""" """Dispatch Engine.IO messages."""
@ -595,7 +604,7 @@ class Client(object):
else: else:
pkt = packet.Packet(encoded_packet=data) pkt = packet.Packet(encoded_packet=data)
if pkt.packet_type == packet.CONNECT: if pkt.packet_type == packet.CONNECT:
self._handle_connect(pkt.namespace) self._handle_connect(pkt.namespace, pkt.data)
elif pkt.packet_type == packet.DISCONNECT: elif pkt.packet_type == packet.DISCONNECT:
self._handle_disconnect(pkt.namespace) self._handle_disconnect(pkt.namespace)
elif pkt.packet_type == packet.EVENT: elif pkt.packet_type == packet.EVENT:
@ -616,7 +625,6 @@ class Client(object):
if self.connected: if self.connected:
for n in self.namespaces: for n in self.namespaces:
self._trigger_event('disconnect', namespace=n) self._trigger_event('disconnect', namespace=n)
self._trigger_event('disconnect', namespace='/')
self.namespaces = [] self.namespaces = []
self.connected = False self.connected = False
self.callbacks = {} self.callbacks = {}

1
socketio/server.py
View File

@ -705,7 +705,6 @@ class Server(object):
self.manager_initialized = True self.manager_initialized = True
self.manager.initialize() self.manager.initialize()
self.environ[sid] = environ self.environ[sid] = environ
return self._handle_connect(sid, '/')
def _handle_eio_message(self, sid, data): def _handle_eio_message(self, sid, data):
"""Dispatch Engine.IO messages.""" """Dispatch Engine.IO messages."""

Write Preview
Loading…
Cancel
Save