From f1476041e5bb0857a99024c9a38203edfc974bdf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pavie=C5=82=20Michalkievi=C4=8D?= <117771945+rustworthy@users.noreply.github.com> Date: Wed, 21 Aug 2024 03:45:51 +0500 Subject: [PATCH] Enable emitting to single client in managers with to=... (#1374) * 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 --- src/socketio/async_manager.py | 3 ++- src/socketio/async_pubsub_manager.py | 3 ++- src/socketio/manager.py | 3 ++- src/socketio/pubsub_manager.py | 3 ++- tests/async/test_manager.py | 2 +- tests/async/test_pubsub_manager.py | 16 ++++++++++++++++ tests/common/test_manager.py | 2 +- tests/common/test_pubsub_manager.py | 16 ++++++++++++++++ 8 files changed, 42 insertions(+), 6 deletions(-) diff --git a/src/socketio/async_manager.py b/src/socketio/async_manager.py index dcf79cf..47e7a79 100644 --- a/src/socketio/async_manager.py +++ b/src/socketio/async_manager.py @@ -11,12 +11,13 @@ class AsyncManager(BaseManager): 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 index 3e11f1e..72946eb 100644 --- a/src/socketio/async_pubsub_manager.py +++ b/src/socketio/async_pubsub_manager.py @@ -38,7 +38,7 @@ class AsyncPubSubManager(AsyncManager): 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 @@ class AsyncPubSubManager(AsyncManager): 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 index 813c4af..3ebf676 100644 --- a/src/socketio/manager.py +++ b/src/socketio/manager.py @@ -20,9 +20,10 @@ class Manager(base_manager.BaseManager): 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 index 5ca7619..3270b4c 100644 --- a/src/socketio/pubsub_manager.py +++ b/src/socketio/pubsub_manager.py @@ -37,7 +37,7 @@ class PubSubManager(Manager): 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 @@ class PubSubManager(Manager): 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 index 90d4ad1..83f6475 100644 --- a/tests/async/test_manager.py +++ b/tests/async/test_manager.py @@ -205,7 +205,7 @@ class TestAsyncManager(unittest.TestCase): _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 index 2881299..c7aeb6e 100644 --- a/tests/async/test_pubsub_manager.py +++ b/tests/async/test_pubsub_manager.py @@ -67,6 +67,22 @@ class TestAsyncPubSubManager(unittest.TestCase): } ) + 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 index 8bb826a..571d2fd 100644 --- a/tests/common/test_manager.py +++ b/tests/common/test_manager.py @@ -206,7 +206,7 @@ class TestBaseManager(unittest.TestCase): 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 index 4e97214..5a4653e 100644 --- a/tests/common/test_pubsub_manager.py +++ b/tests/common/test_pubsub_manager.py @@ -78,6 +78,22 @@ class TestPubSubManager(unittest.TestCase): } ) + 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(