Make WireupTask a regular dependency

Author: maldoinc

docs/pages/integrations/fastapi/background_tasks.md

@@ -4,6 +4,7 @@ Use `WireupTask` when you want Wireup to resolve dependencies inside a FastAPI b
 
 ## Usage
 
+1. Add `wireup.integration.fastapi` to your Wireup injectables.
 1. Define your task function with `Injected[...]` parameters for any Wireup dependencies
 1. Inject `WireupTask` in your route handler: `wireup_task: Injected[WireupTask]`
 1. Wrap the task function before scheduling: `wireup_task(write_greeting)`

docs/pages/integrations/starlette/background_tasks.md

@@ -4,6 +4,7 @@ Use `WireupTask` when you want Wireup to resolve dependencies inside a Starlette
 
 ## Usage
 
+1. Add `wireup.integration.starlette` to your Wireup injectables.
 1. Define your task function with `Injected[...]` parameters for any Wireup dependencies
 1. Inject `WireupTask` in your route handler: `wireup_task: Injected[WireupTask]`
 1. Wrap the task function before scheduling: `wireup_task(write_greeting)`

test/integration/fastapi/test_fastapi_integration.py

@@ -600,6 +600,29 @@ async def hello(tasks: BackgroundTasks, wireup_task: Injected[WireupTask]) -> Di
     assert task_result == ["fastapi:4"]
 
 
+def test_setup_still_exposes_wireup_task_without_integration_module_registration() -> None:
+    task_result: list[str] = []
+
+    def write_logs(name: str, random_service: Injected[RandomService]) -> None:
+        task_result.append(f"{name}:{random_service.get_random()}")
+
+    app = FastAPI()
+    container = wireup.create_async_container(injectables=[shared_services])
+
+    @app.get("/")
+    async def hello(tasks: BackgroundTasks, wireup_task: Injected[WireupTask]) -> Dict[str, Any]:
+        tasks.add_task(wireup_task(write_logs), "fallback")
+        return {}
+
+    wireup.integration.fastapi.setup(container, app)
+
+    with TestClient(app) as client:
+        response = client.get("/")
+
+    assert response.status_code == 200
+    assert task_result == ["fallback:4"]
+
+
 def test_background_task_uses_different_scope_than_request() -> None:
     ids: dict[str, str] = {}
 

test/integration/starlette/test_starlette_integration.py

@@ -236,6 +236,42 @@ async def hello_with_background_task(
     assert task_result == ["Hello Async"]
 
 
+async def test_wireup_task_is_resolvable_from_integration_module_registration() -> None:
+    container = wireup.create_async_container(injectables=[shared_services, wireup.integration.starlette])
+
+    task = await container.get(WireupTask)
+
+    assert isinstance(task, WireupTask)
+    assert task.container is container
+
+
+def test_setup_still_exposes_wireup_task_without_integration_module_registration() -> None:
+    task_result: list[str] = []
+
+    def write_logs(name: str, greeter: Injected[GreeterService]) -> None:
+        task_result.append(greeter.greet(name))
+
+    @inject
+    async def hello_with_background_task(
+        _request: Request,
+        wireup_task: Injected[WireupTask],
+    ) -> PlainTextResponse:
+        return PlainTextResponse(
+            "ok",
+            background=BackgroundTask(wireup_task(write_logs), "Fallback"),
+        )
+
+    app = Starlette(routes=[Route("/hello_bg", hello_with_background_task, methods=["GET"])])
+    container = wireup.create_async_container(injectables=[shared_services])
+    wireup.integration.starlette.setup(container, app)
+
+    with TestClient(app) as client:
+        response = client.get("/hello_bg")
+
+    assert response.status_code == 200
+    assert task_result == ["Hello Fallback"]
+
+
 def test_background_task_uses_different_scope_than_request() -> None:
     ids: dict[str, str] = {}
 

wireup/integration/starlette.py

@@ -114,6 +114,7 @@ def get_request_container() -> ScopedAsyncContainer:
         raise WireupError(msg) from e
 
 
+@injectable
 class WireupTask:
     __slots__ = ("_get_injected_wrapper", "container")
 
@@ -138,6 +139,10 @@ def _expose_wireup_task(container: AsyncContainer) -> None:
     if container._registry.is_type_with_qualifier_known(WireupTask, None):
         return
 
+    # Keep the old behavior for WireupTask where it was exposed
+    # without adding the integration in injectables.
+    # Cannot properly raise a deprecation notice here but this is deprecated
+    # and marked for removal.
     def wireup_task_factory() -> WireupTask:
         return WireupTask(container)