mockstack 0.4.1__tar.gz → 0.4.2__tar.gz

{mockstack-0.4.1/mockstack.egg-info → mockstack-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.4.1
+Version: 0.4.2
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack

mockstack-0.4.2/mockstack/middleware.py

@@ -0,0 +1,55 @@
+"""Middleware definitionsfor the mockstack app."""
+
+import time
+
+from fastapi import FastAPI, Request, Response
+from opentelemetry import trace
+from opentelemetry.propagate import extract
+
+from mockstack.config import Settings
+from mockstack.telemetry import extract_body, span_name_for
+
+
+def middleware_provider(app: FastAPI, settings: Settings) -> None:
+    """Instrument the middlewares to the mockstack app."""
+
+    @app.middleware("http")
+    async def add_process_time_header(request: Request, call_next):
+        start_time = time.time()
+        response = await call_next(request)
+        process_time = time.time() - start_time
+        response.headers["X-Process-Time"] = str(process_time)
+        return response
+
+    @app.middleware("http")
+    async def instrument_opentelemetry(request: Request, call_next):
+        tracer = trace.get_tracer(__name__)
+        ctx = extract(request.headers)
+        with tracer.start_as_current_span(span_name_for(request), context=ctx) as span:
+            span.set_attribute("http.method", request.method)
+            span.set_attribute("http.url", str(request.url))
+
+            response = await call_next(request)
+
+            span.set_attribute("http.status_code", response.status_code)
+
+            # Nb. persisting response body can hamper performance,
+            # expose sensitive / PII data, and / or may not be needed.
+            # it is therefore an opt-in setting.
+            if settings.opentelemetry.capture_response_body:
+                body = await extract_body(response)
+
+                # for semantics of payload collection see:
+                # https://github.com/open-telemetry/oteps/pull/234
+                span.set_attribute("http.response.body", body)
+
+                # recreate response with the same body since when consuming it to log it above
+                # we effectively "deplete" the iterator.
+                response = Response(
+                    content=body,
+                    status_code=response.status_code,
+                    headers=dict(response.headers),
+                    media_type=response.media_type,
+                )
+
+            return response

mockstack-0.4.2/mockstack/routers/catchall.py

@@ -0,0 +1,14 @@
+"""Routes for the mockstack app."""
+
+from fastapi import FastAPI, Request
+
+from mockstack.config import Settings
+
+
+def catchall_router_provider(app: FastAPI, settings: Settings) -> None:
+    """Create the catch-all routes for the mockstack app."""
+
+    @app.route("/{full_path:path}", methods=["GET", "PATCH", "POST", "PUT", "DELETE"])
+    async def catch_all(request: Request):
+        """Catch all requests and delegate to the strategy."""
+        return await app.state.strategy.apply(request)

{mockstack-0.4.1 → mockstack-0.4.2}/mockstack/telemetry.py

@@ -8,6 +8,7 @@ from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExport
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from starlette.responses import StreamingResponse
 
 from mockstack.config import Settings
 
@@ -17,6 +18,24 @@ def span_name_for(request: Request) -> str:
     return f"{request.method.upper()} {request.url.path}"
 
 
+async def extract_body(response: StreamingResponse) -> str:
+    """Extract the body of a response."""
+
+    async def read_response_body(response: StreamingResponse) -> bytes:
+        """Helper function to read response body asynchronously into memory."""
+        body = b""
+        async for chunk in response.body_iterator:
+            if isinstance(chunk, str):
+                body += chunk.encode()
+            else:
+                body += chunk
+        return body
+
+    body = await read_response_body(response)
+
+    return body.decode()
+
+
 def opentelemetry_provider(app: FastAPI, settings: Settings) -> None:
     """Initialize OpenTelemetry for the mockstack app."""
     if not settings.opentelemetry.enabled:

{mockstack-0.4.1 → mockstack-0.4.2/mockstack.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.4.1
+Version: 0.4.2
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack

mockstack-0.4.1/mockstack/middleware.py

@@ -1,19 +0,0 @@
-"""Middleware definitionsfor the mockstack app."""
-
-import time
-
-from fastapi import FastAPI, Request
-
-from mockstack.config import Settings
-
-
-def middleware_provider(app: FastAPI, settings: Settings) -> None:
-    """Instrument the middlewares to the mockstack app."""
-
-    @app.middleware("http")
-    async def add_process_time_header(request: Request, call_next):
-        start_time = time.time()
-        response = await call_next(request)
-        process_time = time.time() - start_time
-        response.headers["X-Process-Time"] = str(process_time)
-        return response

mockstack-0.4.1/mockstack/routers/catchall.py

@@ -1,33 +0,0 @@
-"""Routes for the mockstack app."""
-
-from fastapi import FastAPI, Request
-from opentelemetry import trace
-from opentelemetry.propagate import extract
-
-from mockstack.config import Settings
-from mockstack.telemetry import span_name_for
-
-
-def catchall_router_provider(app: FastAPI, settings: Settings) -> None:
-    """Create the catch-all routes for the mockstack app."""
-
-    @app.route("/{full_path:path}", methods=["GET", "PATCH", "POST", "PUT", "DELETE"])
-    async def catch_all(request: Request):
-        """Catch all requests and delegate to the strategy."""
-        tracer = trace.get_tracer(__name__)
-        ctx = extract(request.headers)
-        with tracer.start_as_current_span(span_name_for(request), context=ctx) as span:
-            span.set_attribute("http.method", request.method)
-            span.set_attribute("http.url", str(request.url))
-
-            response = await app.state.strategy.apply(request)
-
-            span.set_attribute("http.status_code", response.status_code)
-
-            # Nb. persisting response body can hamper performance,
-            # expose sensitive / PII data, and / or may not be needed.
-            # it is therefore an opt-in setting.
-            if settings.opentelemetry.capture_response_body:
-                span.set_attribute("response", response.body)
-
-            return response