Add NatsBroker.new_inbox() (#1543)

* docs: update CONTRIBUTING.md

Added missing 'and not confluent' to pytest command for running the
tests when no broker instances are present.

* feat: enable spy_decorator to wrap both async and non-async methods

* feat: add NatsBroker.new_inbox()

* chore: linting

* fix: raise error if new_inbox() is called before broker was started

* refactor: use assert statement instead of raising an exception

* docs: mention 'inbox_prefix' argument in docstring for 'new_inbox()'

docs/docs/en/getting-started/contributing/CONTRIBUTING.md

@@ -94,7 +94,7 @@ pytest -m 'all'
 If you don't have a local broker instance running, you can run tests without those dependencies:
 
 ```bash
-pytest -m 'not rabbit and not kafka and not nats and not redis'
+pytest -m 'not rabbit and not kafka and not nats and not redis and not confluent'
 ```
 
 To run tests based on RabbitMQ, Kafka, or other dependencies, the following dependencies are needed to be started as docker containers:

faststream/nats/broker/broker.py

@@ -901,3 +901,16 @@ async def wrapper() -> None:
                 self.__is_connected = True
 
         return wrapper
+
+    async def new_inbox(self) -> str:
+        """Return a unique inbox that can be used for NATS requests or subscriptions.
+
+        The inbox prefix can be customised by passing `inbox_prefix` when creating your `NatsBroker`.
+
+        This method calls `nats.aio.client.Client.new_inbox` [1] under the hood.
+
+        [1] https://nats-io.github.io/nats.py/modules.html#nats.aio.client.Client.new_inbox
+        """
+        assert self._connection  # nosec B101
+
+        return self._connection.new_inbox()

tests/brokers/nats/test_new_inbox.py

@@ -0,0 +1,23 @@
+from unittest.mock import patch
+
+import pytest
+from nats.aio.client import Client as NatsClient
+
+from faststream.nats import NatsBroker
+from tests.tools import spy_decorator
+
+
+@pytest.mark.asyncio()
+@pytest.mark.nats()
+async def test_new_inbox():
+    with patch.object(
+        NatsClient,
+        "new_inbox",
+        spy_decorator(NatsClient.new_inbox),
+    ) as m:
+        broker = NatsBroker(inbox_prefix="_FOO_TEST_INBOX")
+        await broker.connect()
+        inbox_name = await broker.new_inbox()
+
+        m.mock.assert_called_once()
+        assert inbox_name.startswith("_FOO_TEST_INBOX.")

tests/brokers/nats/test_test_client.py

@@ -91,7 +91,6 @@ async def test_inbox_prefix_with_real(
             assert br._connection._inbox_prefix == b"test"
             assert "test" in str(br._connection.new_inbox())
 
-
     async def test_respect_middleware(self, queue):
         routes = []
 

tests/tools.py

@@ -1,13 +1,21 @@
+import inspect
 from typing import Any, Iterable
 from unittest.mock import MagicMock
 
 
 def spy_decorator(method):
     mock = MagicMock()
 
-    async def wrapper(*args, **kwargs):
-        mock(*args, **kwargs)
-        return await method(*args, **kwargs)
+    if inspect.iscoroutinefunction(method):
+
+        async def wrapper(*args, **kwargs):
+            mock(*args, **kwargs)
+            return await method(*args, **kwargs)
+    else:
+
+        def wrapper(*args, **kwargs):
+            mock(*args, **kwargs)
+            return method(*args, **kwargs)
 
     wrapper.mock = mock
     return wrapper