Breakout middleware into separate files

Author: alukach

src/stac_auth_proxy/app.py

@@ -10,15 +10,16 @@
 
 from fastapi import FastAPI
 
-from .auth import OpenIdConnectAuth
-from .config import Settings
-from .handlers import ReverseProxyHandler
 from .middleware import (
+    OpenApiMiddleware,
     AddProcessTimeHeaderMiddleware,
     EnforceAuthMiddleware,
-    OpenApiMiddleware,
 )
 
+from .auth import OpenIdConnectAuth
+from .config import Settings
+from .handlers import ReverseProxyHandler
+
 logger = logging.getLogger(__name__)
 
 

src/stac_auth_proxy/middleware/AddProcessTimeHeaderMiddleware.py

@@ -0,0 +1,17 @@
+from fastapi import Request, Response
+from starlette.middleware.base import BaseHTTPMiddleware
+
+
+import time
+
+
+class AddProcessTimeHeaderMiddleware(BaseHTTPMiddleware):
+    """Middleware to add a header with the process time to the response."""
+
+    async def dispatch(self, request: Request, call_next) -> Response:
+        """Add a header with the process time to the response."""
+        start_time = time.perf_counter()
+        response = await call_next(request)
+        process_time = time.perf_counter() - start_time
+        response.headers["X-Process-Time"] = f"{process_time:.3f}"
+        return response

src/stac_auth_proxy/middleware/EnforceAuthMiddleware.py

@@ -0,0 +1,11 @@
+# TODO
+from fastapi import Request, Response
+from starlette.middleware.base import BaseHTTPMiddleware
+
+
+class EnforceAuthMiddleware(BaseHTTPMiddleware):
+    """Middleware to enforce authentication."""
+
+    async def dispatch(self, request: Request, call_next) -> Response:
+        """Enforce authentication."""
+        return await call_next(request)

src/stac_auth_proxy/middleware.py renamed to src/stac_auth_proxy/middleware/OpenApiMiddleware.py

@@ -1,27 +1,13 @@
-"""Custom middleware."""
+from stac_auth_proxy.config import EndpointMethods
+from stac_auth_proxy.utils.requests import dict_to_bytes
 
-from dataclasses import dataclass
-from typing import Any
-import json
-import time
-
-from fastapi import Request, Response
-from starlette.middleware.base import BaseHTTPMiddleware
-from starlette.types import ASGIApp, Message, Scope, Receive, Send
 
-from .config import EndpointMethods
+from starlette.types import ASGIApp, Message, Receive, Scope, Send
 
 
-class AddProcessTimeHeaderMiddleware(BaseHTTPMiddleware):
-    """Middleware to add a header with the process time to the response."""
-
-    async def dispatch(self, request: Request, call_next) -> Response:
-        """Add a header with the process time to the response."""
-        start_time = time.perf_counter()
-        response = await call_next(request)
-        process_time = time.perf_counter() - start_time
-        response.headers["X-Process-Time"] = f"{process_time:.3f}"
-        return response
+import json
+from dataclasses import dataclass
+from typing import Any
 
 
 @dataclass(frozen=True)
@@ -71,17 +57,3 @@ def augment_spec(self, openapi_spec) -> dict[str, Any]:
                             {self.oidc_auth_scheme_name: []}
                         )
         return openapi_spec
-
-
-# TODO
-class EnforceAuthMiddleware(BaseHTTPMiddleware):
-    """Middleware to enforce authentication."""
-
-    async def dispatch(self, request: Request, call_next) -> Response:
-        """Enforce authentication."""
-        return await call_next(request)
-
-
-def dict_to_bytes(d: dict) -> bytes:
-    """Convert a dictionary to a body."""
-    return json.dumps(d, separators=(",", ":")).encode("utf-8")

src/stac_auth_proxy/middleware/__init__.py

@@ -0,0 +1,11 @@
+"""Custom middleware."""
+
+from .OpenApiMiddleware import OpenApiMiddleware
+from .AddProcessTimeHeaderMiddleware import AddProcessTimeHeaderMiddleware
+from .EnforceAuthMiddleware import EnforceAuthMiddleware
+
+__all__ = [
+    OpenApiMiddleware,
+    AddProcessTimeHeaderMiddleware,
+    EnforceAuthMiddleware,
+]

src/stac_auth_proxy/utils/requests.py

@@ -1,5 +1,6 @@
 """Utility functions for working with HTTP requests."""
 
+import json
 import re
 from urllib.parse import urlparse
 
@@ -29,3 +30,8 @@ def extract_variables(url: str) -> dict:
     pattern = r"^/collections/(?P<collection_id>[^/]+)(?:/(?:items|bulk_items)(?:/(?P<item_id>[^/]+))?)?/?$"
     match = re.match(pattern, path)
     return {k: v for k, v in match.groupdict().items() if v} if match else {}
+
+
+def dict_to_bytes(d: dict) -> bytes:
+    """Convert a dictionary to a body."""
+    return json.dumps(d, separators=(",", ":")).encode("utf-8")