[FS-2158] Explicit error in case of mixed up fastapi.Depends and faststream.Depends (#2160)

* tests(fastapi): added test for incorrect Depends

* Update fastapi.py

* feat(depends): added wrong depends exception

* docs: generate API References

* fix(fastapi_tests): fixed 3.8 compatibility

* docs: generate API References

---------

Co-authored-by: Pastukhov Nikita <[email protected]>

Author: NelsonNotes

docs/docs/SUMMARY.md

@@ -374,6 +374,7 @@ search:
                     - get_dependant
                         - [get_fastapi_dependant](api/faststream/broker/fastapi/get_dependant/get_fastapi_dependant.md)
                         - [get_fastapi_native_dependant](api/faststream/broker/fastapi/get_dependant/get_fastapi_native_dependant.md)
+                        - [has_faststream_depends](api/faststream/broker/fastapi/get_dependant/has_faststream_depends.md)
                         - [is_faststream_decorated](api/faststream/broker/fastapi/get_dependant/is_faststream_decorated.md)
                         - [mark_faststream_decorated](api/faststream/broker/fastapi/get_dependant/mark_faststream_decorated.md)
                     - route

docs/docs/en/api/faststream/broker/fastapi/get_dependant/has_faststream_depends.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.broker.fastapi.get_dependant.has_faststream_depends

faststream/broker/fastapi/get_dependant.py

@@ -1,7 +1,14 @@
+import inspect
 from typing import TYPE_CHECKING, Any, Callable, Iterable, cast
 
+from fast_depends.dependencies import model
 from fast_depends.utils import get_typed_annotation
-from fastapi.dependencies.utils import get_dependant, get_parameterless_sub_dependant
+from fastapi.dependencies.utils import (
+    get_dependant,
+    get_parameterless_sub_dependant,
+    get_typed_signature,
+)
+from typing_extensions import Annotated, get_args, get_origin
 
 from faststream._compat import PYDANTIC_V2
 
@@ -133,6 +140,22 @@ def _patch_fastapi_dependent(dependant: "Dependant") -> "Dependant":
     return dependant
 
 
+def has_faststream_depends(orig_call: Callable[..., Any]) -> bool:
+    """Check if faststream.Depends is used in the handler."""
+    endpoint_signature = get_typed_signature(orig_call)
+    signature_params = endpoint_signature.parameters
+    for param in signature_params.values():
+        ann = param.annotation
+        if ann is not inspect.Signature.empty and get_origin(ann) is Annotated:
+            annotated_args = get_args(ann)
+            for arg in annotated_args:
+                if isinstance(arg, model.Depends):
+                    return True
+        if isinstance(param.default, model.Depends):
+            return True
+    return False
+
+
 FASTSTREAM_FASTAPI_PLUGIN_DECORATOR_MARKER = "__faststream_consumer__"
 
 

faststream/broker/fastapi/route.py

@@ -19,11 +19,13 @@
 
 from faststream.broker.fastapi.get_dependant import (
     get_fastapi_native_dependant,
+    has_faststream_depends,
     is_faststream_decorated,
     mark_faststream_decorated,
 )
 from faststream.broker.response import Response, ensure_response
 from faststream.broker.types import P_HandlerParams, T_HandlerReturn
+from faststream.exceptions import SetupError
 
 from ._compat import (
     FASTAPI_V106,
@@ -80,6 +82,10 @@ def wrap_callable_to_fastapi_compatible(
     response_model_exclude_defaults: bool,
     response_model_exclude_none: bool,
 ) -> Callable[["NativeMessage[Any]"], Awaitable[Any]]:
+    if has_faststream_depends(user_callable):
+        msg = f"Incorrect `faststream.Depends` usage at `{user_callable.__name__}`. For FastAPI integration use `fastapi.Depends`"
+        raise SetupError(msg)
+
     if is_faststream_decorated(user_callable):
         return user_callable  # type: ignore[return-value]
 

tests/brokers/base/fastapi.py

@@ -1,18 +1,21 @@
 import asyncio
 from contextlib import asynccontextmanager
-from typing import Any, Callable, Type, TypeVar
+from typing import Callable, Type
 from unittest.mock import Mock
 
 import pytest
 from fastapi import BackgroundTasks, Depends, FastAPI, Header
 from fastapi.exceptions import RequestValidationError
 from fastapi.testclient import TestClient
+from typing_extensions import Annotated, Any, TypeVar
 
+from faststream import Depends as FSDepends
 from faststream import Response, context
 from faststream.broker.core.usecase import BrokerUsecase
 from faststream.broker.fastapi.context import Context
 from faststream.broker.fastapi.router import StreamRouter
 from faststream.broker.router import BrokerRouter
+from faststream.exceptions import SetupError
 from faststream.types import AnyCallable
 
 from .basic import BaseTestcaseConfig
@@ -333,6 +336,38 @@ async def hello(a, w=Depends(dep)):
 
         mock.assert_called_once_with("hi")
 
+    async def test_depends_from_fastdepends_default(self, queue: str):
+        router = self.router_class()
+
+        args, kwargs = self.get_subscriber_params(queue)
+
+        subscriber = router.subscriber(*args, **kwargs)
+
+        @subscriber
+        def sub(d: Any = FSDepends(lambda: 1)) -> None: ...
+
+        app = FastAPI()
+        app.include_router(router)
+
+        with pytest.raises(SetupError), TestClient(app):
+            ...
+
+    async def test_depends_from_fastdepends_annotated(self, queue: str):
+        router = self.router_class()
+
+        args, kwargs = self.get_subscriber_params(queue)
+
+        subscriber = router.subscriber(*args, **kwargs)
+
+        @subscriber
+        def sub(d: Annotated[Any, FSDepends(lambda: 1)]) -> None: ...
+
+        app = FastAPI()
+        app.include_router(router)
+
+        with pytest.raises(SetupError), TestClient(app):
+            ...
+
     async def test_yield_depends(self, mock: Mock, queue: str):
         router = self.router_class()