From 1cadada02dd7dc1eb96f45e88cbec67e1a393db3 Mon Sep 17 00:00:00 2001
From: Miguel Grinberg <miguel.grinberg@gmail.com>
Date: Sat, 21 Jan 2023 11:38:38 +0000
Subject: [PATCH] Expose the ignore_queue option in namespaces (Fixes #1103)

---
 src/socketio/asyncio_namespace.py       | 15 +++++++++------
 src/socketio/asyncio_server.py          | 12 ++++++------
 src/socketio/namespace.py               | 12 ++++++------
 src/socketio/server.py                  | 14 ++++++++------
 tests/asyncio/test_asyncio_namespace.py | 10 +++++++++-
 tests/asyncio/test_asyncio_server.py    |  9 +++++++++
 tests/common/test_namespace.py          |  9 +++++++++
 tests/common/test_server.py             | 14 +++++++++++++-
 8 files changed, 69 insertions(+), 26 deletions(-)

diff --git a/src/socketio/asyncio_namespace.py b/src/socketio/asyncio_namespace.py
index 1ab38a9..4baf28f 100644
--- a/src/socketio/asyncio_namespace.py
+++ b/src/socketio/asyncio_namespace.py
@@ -42,7 +42,7 @@ class AsyncNamespace(namespace.Namespace):
             return ret
 
     async def emit(self, event, data=None, to=None, room=None, skip_sid=None,
-                   namespace=None, callback=None):
+                   namespace=None, callback=None, ignore_queue=False):
         """Emit a custom event to one or more connected clients.
 
         The only difference with the :func:`socketio.Server.emit` method is
@@ -54,10 +54,11 @@ class AsyncNamespace(namespace.Namespace):
         return await self.server.emit(event, data=data, to=to, room=room,
                                       skip_sid=skip_sid,
                                       namespace=namespace or self.namespace,
-                                      callback=callback)
+                                      callback=callback,
+                                      ignore_queue=ignore_queue)
 
     async def send(self, data, to=None, room=None, skip_sid=None,
-                   namespace=None, callback=None):
+                   namespace=None, callback=None, ignore_queue=False):
         """Send a message to one or more connected clients.
 
         The only difference with the :func:`socketio.Server.send` method is
@@ -69,10 +70,11 @@ class AsyncNamespace(namespace.Namespace):
         return await self.server.send(data, to=to, room=room,
                                       skip_sid=skip_sid,
                                       namespace=namespace or self.namespace,
-                                      callback=callback)
+                                      callback=callback,
+                                      ignore_queue=ignore_queue)
 
     async def call(self, event, data=None, to=None, sid=None, namespace=None,
-                   timeout=None):
+                   timeout=None, ignore_queue=False):
         """Emit a custom event to a client and wait for the response.
 
         The only difference with the :func:`socketio.Server.call` method is
@@ -81,7 +83,8 @@ class AsyncNamespace(namespace.Namespace):
         """
         return await self.server.call(event, data=data, to=to, sid=sid,
                                       namespace=namespace or self.namespace,
-                                      timeout=timeout)
+                                      timeout=timeout,
+                                      ignore_queue=ignore_queue)
 
     async def close_room(self, room, namespace=None):
         """Close a room.
diff --git a/src/socketio/asyncio_server.py b/src/socketio/asyncio_server.py
index eb708b2..fe193d2 100644
--- a/src/socketio/asyncio_server.py
+++ b/src/socketio/asyncio_server.py
@@ -117,7 +117,7 @@ class AsyncServer(server.Server):
         self.eio.attach(app, socketio_path)
 
     async def emit(self, event, data=None, to=None, room=None, skip_sid=None,
-                   namespace=None, callback=None, **kwargs):
+                   namespace=None, callback=None, ignore_queue=False):
         """Emit a custom event to one or more connected clients.
 
         :param event: The event name. It can be any string. The event names
@@ -167,10 +167,10 @@ class AsyncServer(server.Server):
                          room or 'all', namespace)
         await self.manager.emit(event, data, namespace, room=room,
                                 skip_sid=skip_sid, callback=callback,
-                                **kwargs)
+                                ignore_queue=ignore_queue)
 
     async def send(self, data, to=None, room=None, skip_sid=None,
-                   namespace=None, callback=None, **kwargs):
+                   namespace=None, callback=None, ignore_queue=False):
         """Send a message to one or more connected clients.
 
         This function emits an event with the name ``'message'``. Use
@@ -210,10 +210,10 @@ class AsyncServer(server.Server):
         """
         await self.emit('message', data=data, to=to, room=room,
                         skip_sid=skip_sid, namespace=namespace,
-                        callback=callback, **kwargs)
+                        callback=callback, ignore_queue=ignore_queue)
 
     async def call(self, event, data=None, to=None, sid=None, namespace=None,
-                   timeout=60, **kwargs):
+                   timeout=60, ignore_queue=False):
         """Emit a custom event to a client and wait for the response.
 
         This method issues an emit with a callback and waits for the callback
@@ -266,7 +266,7 @@ class AsyncServer(server.Server):
             callback_event.set()
 
         await self.emit(event, data=data, room=to or sid, namespace=namespace,
-                        callback=event_callback, **kwargs)
+                        callback=event_callback, ignore_queue=ignore_queue)
         try:
             await asyncio.wait_for(callback_event.wait(), timeout)
         except asyncio.TimeoutError:
diff --git a/src/socketio/namespace.py b/src/socketio/namespace.py
index 0d9dd98..c0fddd1 100644
--- a/src/socketio/namespace.py
+++ b/src/socketio/namespace.py
@@ -38,7 +38,7 @@ class Namespace(BaseNamespace):
         self.server = server
 
     def emit(self, event, data=None, to=None, room=None, skip_sid=None,
-             namespace=None, callback=None):
+             namespace=None, callback=None, ignore_queue=False):
         """Emit a custom event to one or more connected clients.
 
         The only difference with the :func:`socketio.Server.emit` method is
@@ -48,10 +48,10 @@ class Namespace(BaseNamespace):
         return self.server.emit(event, data=data, to=to, room=room,
                                 skip_sid=skip_sid,
                                 namespace=namespace or self.namespace,
-                                callback=callback)
+                                callback=callback, ignore_queue=ignore_queue)
 
     def send(self, data, to=None, room=None, skip_sid=None, namespace=None,
-             callback=None):
+             callback=None, ignore_queue=False):
         """Send a message to one or more connected clients.
 
         The only difference with the :func:`socketio.Server.send` method is
@@ -60,10 +60,10 @@ class Namespace(BaseNamespace):
         """
         return self.server.send(data, to=to, room=room, skip_sid=skip_sid,
                                 namespace=namespace or self.namespace,
-                                callback=callback)
+                                callback=callback, ignore_queue=ignore_queue)
 
     def call(self, event, data=None, to=None, sid=None, namespace=None,
-             timeout=None):
+             timeout=None, ignore_queue=False):
         """Emit a custom event to a client and wait for the response.
 
         The only difference with the :func:`socketio.Server.call` method is
@@ -72,7 +72,7 @@ class Namespace(BaseNamespace):
         """
         return self.server.call(event, data=data, to=to, sid=sid,
                                 namespace=namespace or self.namespace,
-                                timeout=timeout)
+                                timeout=timeout, ignore_queue=ignore_queue)
 
     def enter_room(self, sid, room, namespace=None):
         """Enter a room.
diff --git a/src/socketio/server.py b/src/socketio/server.py
index daa1c0d..efd8187 100644
--- a/src/socketio/server.py
+++ b/src/socketio/server.py
@@ -269,7 +269,7 @@ class Server(object):
             namespace_handler
 
     def emit(self, event, data=None, to=None, room=None, skip_sid=None,
-             namespace=None, callback=None, **kwargs):
+             namespace=None, callback=None, ignore_queue=False):
         """Emit a custom event to one or more connected clients.
 
         :param event: The event name. It can be any string. The event names
@@ -317,10 +317,11 @@ class Server(object):
         self.logger.info('emitting event "%s" to %s [%s]', event,
                          room or 'all', namespace)
         self.manager.emit(event, data, namespace, room=room,
-                          skip_sid=skip_sid, callback=callback, **kwargs)
+                          skip_sid=skip_sid, callback=callback,
+                          ignore_queue=ignore_queue)
 
     def send(self, data, to=None, room=None, skip_sid=None, namespace=None,
-             callback=None, **kwargs):
+             callback=None, ignore_queue=False):
         """Send a message to one or more connected clients.
 
         This function emits an event with the name ``'message'``. Use
@@ -358,10 +359,11 @@ class Server(object):
                              value of ``False``.
         """
         self.emit('message', data=data, to=to, room=room, skip_sid=skip_sid,
-                  namespace=namespace, callback=callback, **kwargs)
+                  namespace=namespace, callback=callback,
+                  ignore_queue=ignore_queue)
 
     def call(self, event, data=None, to=None, sid=None, namespace=None,
-             timeout=60, **kwargs):
+             timeout=60, ignore_queue=False):
         """Emit a custom event to a client and wait for the response.
 
         This method issues an emit with a callback and waits for the callback
@@ -412,7 +414,7 @@ class Server(object):
             callback_event.set()
 
         self.emit(event, data=data, room=to or sid, namespace=namespace,
-                  callback=event_callback, **kwargs)
+                  callback=event_callback, ignore_queue=ignore_queue)
         if not callback_event.wait(timeout=timeout):
             raise exceptions.TimeoutError()
         return callback_args[0] if len(callback_args[0]) > 1 \
diff --git a/tests/asyncio/test_asyncio_namespace.py b/tests/asyncio/test_asyncio_namespace.py
index 2bf2ffd..fa833e0 100644
--- a/tests/asyncio/test_asyncio_namespace.py
+++ b/tests/asyncio/test_asyncio_namespace.py
@@ -104,6 +104,7 @@ class TestAsyncNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/foo',
             callback='cb',
+            ignore_queue=False,
         )
         _run(
             ns.emit(
@@ -113,6 +114,7 @@ class TestAsyncNamespace(unittest.TestCase):
                 skip_sid='skip',
                 namespace='/bar',
                 callback='cb',
+                ignore_queue=True,
             )
         )
         ns.server.emit.mock.assert_called_with(
@@ -123,6 +125,7 @@ class TestAsyncNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/bar',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_send(self):
@@ -138,6 +141,7 @@ class TestAsyncNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/foo',
             callback='cb',
+            ignore_queue=False,
         )
         _run(
             ns.send(
@@ -146,6 +150,7 @@ class TestAsyncNamespace(unittest.TestCase):
                 skip_sid='skip',
                 namespace='/bar',
                 callback='cb',
+                ignore_queue=True,
             )
         )
         ns.server.send.mock.assert_called_with(
@@ -155,6 +160,7 @@ class TestAsyncNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/bar',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_call(self):
@@ -170,9 +176,10 @@ class TestAsyncNamespace(unittest.TestCase):
             sid=None,
             namespace='/foo',
             timeout=None,
+            ignore_queue=False,
         )
         _run(ns.call('ev', data='data', sid='sid', namespace='/bar',
-                     timeout=45))
+                     timeout=45, ignore_queue=True))
         ns.server.call.mock.assert_called_with(
             'ev',
             data='data',
@@ -180,6 +187,7 @@ class TestAsyncNamespace(unittest.TestCase):
             sid='sid',
             namespace='/bar',
             timeout=45,
+            ignore_queue=True,
         )
 
     def test_enter_room(self):
diff --git a/tests/asyncio/test_asyncio_server.py b/tests/asyncio/test_asyncio_server.py
index b9e4d7e..27d8b37 100644
--- a/tests/asyncio/test_asyncio_server.py
+++ b/tests/asyncio/test_asyncio_server.py
@@ -101,6 +101,7 @@ class TestAsyncServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=False,
         )
         _run(
             s.emit(
@@ -110,6 +111,7 @@ class TestAsyncServer(unittest.TestCase):
                 skip_sid='123',
                 namespace='/foo',
                 callback='cb',
+                ignore_queue=True,
             )
         )
         s.manager.emit.mock.assert_called_with(
@@ -119,6 +121,7 @@ class TestAsyncServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_emit_default_namespace(self, eio):
@@ -140,6 +143,7 @@ class TestAsyncServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=False,
         )
         _run(
             s.emit(
@@ -148,6 +152,7 @@ class TestAsyncServer(unittest.TestCase):
                 room='room',
                 skip_sid='123',
                 callback='cb',
+                ignore_queue=True,
             )
         )
         s.manager.emit.mock.assert_called_with(
@@ -157,6 +162,7 @@ class TestAsyncServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_send(self, eio):
@@ -178,6 +184,7 @@ class TestAsyncServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=False,
         )
         _run(
             s.send(
@@ -186,6 +193,7 @@ class TestAsyncServer(unittest.TestCase):
                 skip_sid='123',
                 namespace='/foo',
                 callback='cb',
+                ignore_queue=True,
             )
         )
         s.manager.emit.mock.assert_called_with(
@@ -195,6 +203,7 @@ class TestAsyncServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_call(self, eio):
diff --git a/tests/common/test_namespace.py b/tests/common/test_namespace.py
index f096111..eb5c970 100644
--- a/tests/common/test_namespace.py
+++ b/tests/common/test_namespace.py
@@ -65,6 +65,7 @@ class TestNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/foo',
             callback='cb',
+            ignore_queue=False,
         )
         ns.emit(
             'ev',
@@ -73,6 +74,7 @@ class TestNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/bar',
             callback='cb',
+            ignore_queue=True,
         )
         ns.server.emit.assert_called_with(
             'ev',
@@ -82,6 +84,7 @@ class TestNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/bar',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_send(self):
@@ -95,6 +98,7 @@ class TestNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/foo',
             callback='cb',
+            ignore_queue=False,
         )
         ns.send(
             data='data',
@@ -102,6 +106,7 @@ class TestNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/bar',
             callback='cb',
+            ignore_queue=True,
         )
         ns.server.send.assert_called_with(
             'data',
@@ -110,6 +115,7 @@ class TestNamespace(unittest.TestCase):
             skip_sid='skip',
             namespace='/bar',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_call(self):
@@ -123,6 +129,7 @@ class TestNamespace(unittest.TestCase):
             sid=None,
             namespace='/foo',
             timeout=None,
+            ignore_queue=False,
         )
         ns.call(
             'ev',
@@ -130,6 +137,7 @@ class TestNamespace(unittest.TestCase):
             sid='sid',
             namespace='/bar',
             timeout=45,
+            ignore_queue=True,
         )
         ns.server.call.assert_called_with(
             'ev',
@@ -138,6 +146,7 @@ class TestNamespace(unittest.TestCase):
             sid='sid',
             namespace='/bar',
             timeout=45,
+            ignore_queue=True,
         )
 
     def test_enter_room(self):
diff --git a/tests/common/test_server.py b/tests/common/test_server.py
index ef50897..7d06c93 100644
--- a/tests/common/test_server.py
+++ b/tests/common/test_server.py
@@ -91,6 +91,7 @@ class TestServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=False,
         )
         s.emit(
             'my event',
@@ -99,6 +100,7 @@ class TestServer(unittest.TestCase):
             skip_sid='123',
             namespace='/foo',
             callback='cb',
+            ignore_queue=True,
         )
         s.manager.emit.assert_called_with(
             'my event',
@@ -107,6 +109,7 @@ class TestServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_emit_default_namespace(self, eio):
@@ -126,6 +129,7 @@ class TestServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=False,
         )
         s.emit(
             'my event',
@@ -133,6 +137,7 @@ class TestServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=True,
         )
         s.manager.emit.assert_called_with(
             'my event',
@@ -141,6 +146,7 @@ class TestServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_send(self, eio):
@@ -156,9 +162,14 @@ class TestServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=False,
         )
         s.send(
-            'foo', room='room', skip_sid='123', namespace='/foo', callback='cb'
+            'foo', room='room',
+            skip_sid='123',
+            namespace='/foo',
+            callback='cb',
+            ignore_queue=True,
         )
         s.manager.emit.assert_called_with(
             'message',
@@ -167,6 +178,7 @@ class TestServer(unittest.TestCase):
             room='room',
             skip_sid='123',
             callback='cb',
+            ignore_queue=True,
         )
 
     def test_call(self, eio):