chore: separate CQL2 filter middelware into separate files

Author: alukach

src/stac_auth_proxy/middleware/ApplyCql2FilterMiddleware.py

@@ -0,0 +1,61 @@
+"""Middleware to build and apply CQL2 filters."""
+
+import json
+from dataclasses import dataclass
+from logging import getLogger
+
+from starlette.requests import Request
+from starlette.types import ASGIApp, Message, Receive, Scope, Send
+
+from ..utils import filters
+
+logger = getLogger(__name__)
+
+
+@dataclass(frozen=True)
+class ApplyCql2FilterMiddleware:
+    """Middleware to apply the Cql2Filter to the request."""
+
+    app: ASGIApp
+
+    state_key: str = "cql2_filter"
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        """Add the Cql2Filter to the request."""
+        if scope["type"] != "http":
+            return await self.app(scope, receive, send)
+
+        request = Request(scope)
+
+        if request.method == "GET":
+            cql2_filter = getattr(request.state, self.state_key, None)
+            if cql2_filter:
+                # TODO: Differentiate between list/search and lookup
+                scope["query_string"] = filters.append_qs_filter(
+                    request.url.query, cql2_filter
+                )
+            return await self.app(scope, receive, send)
+
+        elif request.method in ["POST", "PUT", "PATCH"]:
+
+            async def receive_and_apply_filter() -> Message:
+                message = await receive()
+                if message["type"] != "http.request":
+                    return message
+
+                cql2_filter = getattr(request.state, self.state_key, None)
+                if cql2_filter:
+                    try:
+                        body = message.get("body", b"{}")
+                    except json.JSONDecodeError as e:
+                        logger.warning("Failed to parse request body as JSON")
+                        # TODO: Return a 400 error
+                        raise e
+
+                    new_body = filters.append_body_filter(json.loads(body), cql2_filter)
+                    message["body"] = json.dumps(new_body).encode("utf-8")
+                return message
+
+            return await self.app(scope, receive_and_apply_filter, send)
+
+        return await self.app(scope, receive, send)

src/stac_auth_proxy/middleware/Cql2FilterMiddleware.py renamed to src/stac_auth_proxy/middleware/BuildCql2FilterMiddleware.py

@@ -1,8 +1,7 @@
-"""Middleware to build and apply CQL2 filters."""
+"""Middleware to build the Cql2Filter."""
 
 import json
 from dataclasses import dataclass
-from logging import getLogger
 from typing import Callable, Optional
 
 from cql2 import Expr
@@ -11,21 +10,19 @@
 
 from ..utils import filters, requests
 
-logger = getLogger(__name__)
-
 
 @dataclass(frozen=True)
 class BuildCql2FilterMiddleware:
     """Middleware to build the Cql2Filter."""
 
     app: ASGIApp
 
+    state_key: str = "cql2_filter"
+
     # Filters
     collections_filter: Optional[Callable] = None
     items_filter: Optional[Callable] = None
 
-    state_key: str = "cql2_filter"
-
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
         """Build the CQL2 filter, place on the request state."""
         if scope["type"] != "http":
@@ -87,51 +84,3 @@ def _get_filter(self, path: str) -> Optional[Callable[..., Expr]]:
             if check(path):
                 return builder
         return None
-
-
-@dataclass(frozen=True)
-class ApplyCql2FilterMiddleware:
-    """Middleware to apply the Cql2Filter to the request."""
-
-    app: ASGIApp
-
-    state_key: str = "cql2_filter"
-
-    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
-        """Add the Cql2Filter to the request."""
-        if scope["type"] != "http":
-            return await self.app(scope, receive, send)
-
-        request = Request(scope)
-
-        if request.method == "GET":
-            cql2_filter = getattr(request.state, self.state_key, None)
-            if cql2_filter:
-                scope["query_string"] = filters.append_qs_filter(
-                    request.url.query, cql2_filter
-                )
-            return await self.app(scope, receive, send)
-
-        elif request.method in ["POST", "PUT", "PATCH"]:
-
-            async def receive_and_apply_filter() -> Message:
-                message = await receive()
-                if message["type"] != "http.request":
-                    return message
-
-                cql2_filter = getattr(request.state, self.state_key, None)
-                if cql2_filter:
-                    try:
-                        body = message.get("body", b"{}")
-                    except json.JSONDecodeError as e:
-                        logger.warning("Failed to parse request body as JSON")
-                        # TODO: Return a 400 error
-                        raise e
-
-                    new_body = filters.append_body_filter(json.loads(body), cql2_filter)
-                    message["body"] = json.dumps(new_body).encode("utf-8")
-                return message
-
-            return await self.app(scope, receive_and_apply_filter, send)
-
-        return await self.app(scope, receive, send)

src/stac_auth_proxy/middleware/__init__.py

@@ -1,7 +1,8 @@
 """Custom middleware."""
 
 from .AddProcessTimeHeaderMiddleware import AddProcessTimeHeaderMiddleware
-from .Cql2FilterMiddleware import ApplyCql2FilterMiddleware, BuildCql2FilterMiddleware
+from .ApplyCql2FilterMiddleware import ApplyCql2FilterMiddleware
+from .BuildCql2FilterMiddleware import BuildCql2FilterMiddleware
 from .EnforceAuthMiddleware import EnforceAuthMiddleware
 from .UpdateOpenApiMiddleware import OpenApiMiddleware