fix(middleware): enhance JSON parsing error handling (#73)

Added logging for JSON parsing errors in the JsonResponseMiddleware. If
an invalid JSON is received, a 502 response is returned with an error
message, improving error visibility and response management.

closes #72

Author: alukach

src/stac_auth_proxy/utils/middleware.py

@@ -1,13 +1,17 @@
 """Utilities for middleware response handling."""
 
 import json
+import logging
 from abc import ABC, abstractmethod
 from typing import Any, Optional
 
 from starlette.datastructures import MutableHeaders
 from starlette.requests import Request
+from starlette.responses import JSONResponse
 from starlette.types import ASGIApp, Message, Receive, Scope, Send
 
+logger = logging.getLogger(__name__)
+
 
 class JsonResponseMiddleware(ABC):
     """Base class for middleware that transforms JSON response bodies."""
@@ -78,7 +82,18 @@ async def transform_response(message: Message) -> None:
 
             # Transform the JSON body
             if body:
-                data = json.loads(body)
+                try:
+                    data = json.loads(body)
+                except json.JSONDecodeError as e:
+                    logger.error("Error parsing JSON: %s", e)
+                    logger.error("Body: %s", body)
+                    logger.error("Response scope: %s", scope)
+                    response = JSONResponse(
+                        {"error": "Received invalid JSON from upstream server"},
+                        status_code=502,
+                    )
+                    await response(scope, receive, send)
+                    return
                 transformed = self.transform_json(data, request=request)
                 body = json.dumps(transformed).encode()
 

tests/test_middleware.py

@@ -101,3 +101,21 @@ async def test_endpoint():
     assert response.status_code == 200
     assert "text/plain" in response.headers["content-type"]
     assert response.text == "invalid json"
+
+
+def test_json_response_middleware_invalid_json_upstream():
+    """Test that invalid JSON from upstream server returns 502 error."""
+    app = FastAPI()
+    app.add_middleware(ExampleJsonResponseMiddleware)
+
+    @app.get("/test")
+    async def test_endpoint():
+        # Return invalid JSON with JSON content type to trigger the error handling
+        return Response(content="invalid json content", media_type="application/json")
+
+    client = TestClient(app)
+    response = client.get("/test")
+    assert response.status_code == 502
+    assert response.headers["content-type"] == "application/json"
+    data = response.json()
+    assert data == {"error": "Received invalid JSON from upstream server"}