simple-module-hosting 0.0.14__tar.gz → 0.0.15__tar.gz

{simple_module_hosting-0.0.14 → simple_module_hosting-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simple_module_hosting
-Version: 0.0.14
+Version: 0.0.15
 Summary: FastAPI + Inertia.js host runtime for simple_module — app_builder, middleware stack, CLI (sm / simple-module), scaffolding
 Project-URL: Homepage, https://github.com/antosubash/simple_module_python
 Project-URL: Repository, https://github.com/antosubash/simple_module_python
@@ -26,8 +26,8 @@ Requires-Dist: fastapi-inertia>=1.0
 Requires-Dist: fastapi>=0.115
 Requires-Dist: httpx>=0.27
 Requires-Dist: jinja2>=3.1
-Requires-Dist: simple-module-core==0.0.14
-Requires-Dist: simple-module-db==0.0.14
+Requires-Dist: simple-module-core==0.0.15
+Requires-Dist: simple-module-db==0.0.15
 Requires-Dist: starlette>=0.44
 Requires-Dist: tomlkit>=0.13
 Requires-Dist: uvicorn[standard]>=0.34

{simple_module_hosting-0.0.14 → simple_module_hosting-0.0.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simple_module_hosting"
-version = "0.0.14"
+version = "0.0.15"
 description = "FastAPI + Inertia.js host runtime for simple_module — app_builder, middleware stack, CLI (sm / simple-module), scaffolding"
 readme = "README.md"
 license = "MIT"
@@ -26,8 +26,8 @@ dependencies = [
     "fastapi-inertia>=1.0",
     "httpx>=0.27",
     "jinja2>=3.1",
-    "simple_module_core==0.0.14",
-    "simple_module_db==0.0.14",
+    "simple_module_core==0.0.15",
+    "simple_module_db==0.0.15",
     "starlette>=0.44",
     "tomlkit>=0.13",
     "uvicorn[standard]>=0.34",

{simple_module_hosting-0.0.14 → simple_module_hosting-0.0.15}/simple_module_hosting/_observability.py

@@ -26,10 +26,16 @@ _QUIET_PREFIXES = ("/health", "/static/")
 class CorrelationIdMiddleware:
     """Generate or propagate a correlation ID for every request.
 
-    Reads the incoming ``X-Correlation-ID`` header (or generates a UUID4) and
-    stores it in a :class:`~contextvars.ContextVar` so that every log record
-    emitted during the request automatically includes the ID.  The same value
-    is echoed back in the response header.
+    Reads the incoming ``X-Correlation-ID`` header (or generates a UUID4) and:
+
+    * stores it in the ``simple_module_hosting.logging.correlation_id``
+      ContextVar so the stdlib logging filter (or a user-supplied structlog
+      processor — see ``docs/framework/middleware.md``) picks it up with no
+      per-handler plumbing;
+    * exposes it on ``request.state.correlation_id`` for handlers that
+      prefer the request object over the contextvar;
+    * echoes the value back as the ``X-Correlation-ID`` response header so
+      clients can cross-reference their request with server-side logs.
     """
 
     HEADER = "X-Correlation-ID"
@@ -43,6 +49,8 @@ class CorrelationIdMiddleware:
             return
 
         cid = Headers(scope=scope).get(self.HEADER) or uuid.uuid4().hex
+        # Skip allocating a Request wrapper — downstream Request(scope).state reads this same dict.
+        scope.setdefault("state", {})["correlation_id"] = cid
 
         async def send_with_header(message: Message) -> None:
             if message["type"] == _MSG_RESPONSE_START:

{simple_module_hosting-0.0.14 → simple_module_hosting-0.0.15}/simple_module_hosting/logging.py

@@ -38,6 +38,9 @@ class JsonFormatter(logging.Formatter):
         "entity",
         "entity_id",
         "db_duration_ms",
+        # Bound by log filters on Celery / job-runner workers.
+        "task_id",
+        "task_name",
     )
 
     def format(self, record: logging.LogRecord) -> str:

{simple_module_hosting-0.0.14 → simple_module_hosting-0.0.15}/tests/test_logging.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import json
 import logging
+from typing import TYPE_CHECKING
 
 import httpx
 from simple_module_hosting.logging import (
@@ -12,6 +13,13 @@ from simple_module_hosting.logging import (
     correlation_id,
     setup_logging,
 )
+from simple_module_hosting.middleware import CorrelationIdMiddleware
+from starlette.applications import Starlette
+from starlette.responses import JSONResponse
+from starlette.routing import Route
+
+if TYPE_CHECKING:
+    from starlette.requests import Request
 
 # ── JsonFormatter ──────────────────────────────────────────────────────
 
@@ -174,6 +182,29 @@ class TestCorrelationIdMiddleware:
         r2 = await client.get("/health")
         assert r1.headers["x-correlation-id"] != r2.headers["x-correlation-id"]
 
+    async def test_state_contextvar_and_header_agree(self):
+        # Background tasks read the ContextVar; handlers read request.state;
+        # clients read the response header — all three must agree per request.
+        async def echo(request: Request) -> JSONResponse:
+            return JSONResponse(
+                {
+                    "state": request.state.correlation_id,
+                    "contextvar": correlation_id.get(""),
+                }
+            )
+
+        app = Starlette(routes=[Route("/echo", echo)])
+        app.add_middleware(CorrelationIdMiddleware)
+
+        transport = httpx.ASGITransport(app=app)
+        async with httpx.AsyncClient(transport=transport, base_url="http://testserver") as c:
+            resp = await c.get("/echo", headers={CorrelationIdMiddleware.HEADER: "trace-xyz"})
+
+        assert resp.headers[CorrelationIdMiddleware.HEADER] == "trace-xyz"
+        body = resp.json()
+        assert body["state"] == "trace-xyz"
+        assert body["contextvar"] == "trace-xyz"
+
 
 # ── Request logging middleware (integration) ────────────────────────────