Enable emitting to single client in managers with to=... (miguelgrinberg#1374)

rustworthy · web-flow · commit f1476041e5bb · 2024-08-20T23:45:51.000+01:00
* Enable emitting to single client in AsyncPubSubManager

* Handle `to` in async manager and sync versions

* Name tests consistently

* Rm extra blank line in test_pubsub_manager
diff --git a/src/socketio/async_manager.py b/src/socketio/async_manager.py
@@ -11,12 +11,13 @@ async def can_disconnect(self, sid, namespace):
         return self.is_connected(sid, namespace)
 
     async def emit(self, event, data, namespace, room=None, skip_sid=None,
-                   callback=None, **kwargs):
+                   callback=None, to=None, **kwargs):
         """Emit a message to a single client, a room, or all the clients
         connected to the namespace.
 
         Note: this method is a coroutine.
         """
+        room = to or room
         if namespace not in self.rooms:
             return
         if isinstance(data, tuple):
diff --git a/src/socketio/async_pubsub_manager.py b/src/socketio/async_pubsub_manager.py
@@ -38,7 +38,7 @@ def initialize(self):
         self._get_logger().info(self.name + ' backend initialized.')
 
     async def emit(self, event, data, namespace=None, room=None, skip_sid=None,
-                   callback=None, **kwargs):
+                   callback=None, to=None, **kwargs):
         """Emit a message to a single client, a room, or all the clients
         connected to the namespace.
 
@@ -49,6 +49,7 @@ async def emit(self, event, data, namespace=None, room=None, skip_sid=None,
 
         Note: this method is a coroutine.
         """
+        room = to or room
         if kwargs.get('ignore_queue'):
             return await super().emit(
                 event, data, namespace=namespace, room=room, skip_sid=skip_sid,
diff --git a/src/socketio/manager.py b/src/socketio/manager.py
@@ -20,9 +20,10 @@ def can_disconnect(self, sid, namespace):
         return self.is_connected(sid, namespace)
 
     def emit(self, event, data, namespace, room=None, skip_sid=None,
-             callback=None, **kwargs):
+             callback=None, to=None, **kwargs):
         """Emit a message to a single client, a room, or all the clients
         connected to the namespace."""
+        room = to or room
         if namespace not in self.rooms:
             return
         if isinstance(data, tuple):
diff --git a/src/socketio/pubsub_manager.py b/src/socketio/pubsub_manager.py
@@ -37,7 +37,7 @@ def initialize(self):
         self._get_logger().info(self.name + ' backend initialized.')
 
     def emit(self, event, data, namespace=None, room=None, skip_sid=None,
-             callback=None, **kwargs):
+             callback=None, to=None, **kwargs):
         """Emit a message to a single client, a room, or all the clients
         connected to the namespace.
 
@@ -46,6 +46,7 @@ def emit(self, event, data, namespace=None, room=None, skip_sid=None,
 
         The parameters are the same as in :meth:`.Server.emit`.
         """
+        room = to or room
         if kwargs.get('ignore_queue'):
             return super().emit(
                 event, data, namespace=namespace, room=room, skip_sid=skip_sid,
diff --git a/tests/async/test_manager.py b/tests/async/test_manager.py
@@ -205,7 +205,7 @@ def test_emit_to_sid(self):
         _run(self.bm.connect('456', '/foo'))
         _run(
             self.bm.emit(
-                'my event', {'foo': 'bar'}, namespace='/foo', room=sid
+                'my event', {'foo': 'bar'}, namespace='/foo', to=sid
             )
         )
         assert self.bm.server._send_eio_packet.mock.call_count == 1
diff --git a/tests/async/test_pubsub_manager.py b/tests/async/test_pubsub_manager.py
@@ -67,6 +67,22 @@ def test_emit(self):
             }
         )
 
+    def test_emit_with_to(self):
+        sid = 'room-mate'
+        _run(self.pm.emit('foo', 'bar', to=sid))
+        self.pm._publish.mock.assert_called_once_with(
+            {
+                'method': 'emit',
+                'event': 'foo',
+                'data': 'bar',
+                'namespace': '/',
+                'room': sid,
+                'skip_sid': None,
+                'callback': None,
+                'host_id': '123456',
+            }
+        )
+
     def test_emit_with_namespace(self):
         _run(self.pm.emit('foo', 'bar', namespace='/baz'))
         self.pm._publish.mock.assert_called_once_with(
diff --git a/tests/common/test_manager.py b/tests/common/test_manager.py
@@ -206,7 +206,7 @@ def test_rooms(self):
     def test_emit_to_sid(self):
         sid = self.bm.connect('123', '/foo')
         self.bm.connect('456', '/foo')
-        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo', room=sid)
+        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo', to=sid)
         assert self.bm.server._send_eio_packet.call_count == 1
         assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
         pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
diff --git a/tests/common/test_pubsub_manager.py b/tests/common/test_pubsub_manager.py
@@ -78,6 +78,22 @@ def test_emit(self):
             }
         )
 
+    def test_emit_with_to(self):
+        sid = "ferris"
+        self.pm.emit('foo', 'bar', to=sid)
+        self.pm._publish.assert_called_once_with(
+            {
+                'method': 'emit',
+                'event': 'foo',
+                'data': 'bar',
+                'namespace': '/',
+                'room': sid,
+                'skip_sid': None,
+                'callback': None,
+                'host_id': '123456',
+            }
+        )
+
     def test_emit_with_namespace(self):
         self.pm.emit('foo', 'bar', namespace='/baz')
         self.pm._publish.assert_called_once_with(

Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ def test_emit_to_sid(self):`
`205`	`205`	`_run(self.bm.connect('456', '/foo'))`
`206`	`206`	`_run(`
`207`	`207`	`self.bm.emit(`
`208`		`- 'my event', {'foo': 'bar'}, namespace='/foo', room=sid`
	`208`	`+ 'my event', {'foo': 'bar'}, namespace='/foo', to=sid`
`209`	`209`	`)`
`210`	`210`	`)`
`211`	`211`	`assert self.bm.server._send_eio_packet.mock.call_count == 1`