stac-fastapi.api 6.1.3__tar.gz → 6.1.5__tar.gz

{stac_fastapi_api-6.1.3 → stac_fastapi_api-6.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stac-fastapi-api
-Version: 6.1.3
+Version: 6.1.5
 Summary: An implementation of STAC API based on the FastAPI framework.
 Project-URL: Homepage, https://github.com/stac-utils/stac-fastapi
 Author-email: ArturoAI <engineering@arturo.ai>

{stac_fastapi_api-6.1.3 → stac_fastapi_api-6.1.5}/stac_fastapi/api/app.py

@@ -8,6 +8,7 @@ import attr
 from brotli_asgi import BrotliMiddleware
 from fastapi import APIRouter, FastAPI
 from fastapi.params import Depends
+from pydantic import BaseModel
 from stac_pydantic import api
 from stac_pydantic.shared import MimeTypes
 from stac_pydantic.version import STAC_VERSION
@@ -114,12 +115,8 @@ class StacApi:
         converter=update_openapi,  # type: ignore
     )
     router: APIRouter = attr.ib(default=attr.Factory(APIRouter))
-    search_get_request_model: Type[BaseSearchGetRequest] = attr.ib(
-        default=BaseSearchGetRequest
-    )
-    search_post_request_model: Type[BaseSearchPostRequest] = attr.ib(
-        default=BaseSearchPostRequest
-    )
+    search_get_request_model: Type[APIRequest] = attr.ib(default=BaseSearchGetRequest)
+    search_post_request_model: Type[BaseModel] = attr.ib(default=BaseSearchPostRequest)
     collections_get_request_model: Type[APIRequest] = attr.ib(default=EmptyRequest)
     collection_get_request_model: Type[APIRequest] = attr.ib(default=CollectionUri)
     items_get_request_model: Type[APIRequest] = attr.ib(default=ItemCollectionUri)

{stac_fastapi_api-6.1.3 → stac_fastapi_api-6.1.5}/stac_fastapi/api/errors.py

@@ -96,5 +96,5 @@ def add_exception_handlers(
     # TODO: Argument 2 to "add_exception_handler" of "Starlette" has incompatible type
     app.add_exception_handler(
         RequestValidationError,
-        request_validation_exception_handler,  # type: ignore
+        request_validation_exception_handler,  # type: ignore [arg-type]
     )

{stac_fastapi_api-6.1.3 → stac_fastapi_api-6.1.5}/stac_fastapi/api/middleware.py

@@ -82,20 +82,33 @@ class ProxyHeaderMiddleware:
 
         await self.app(scope, receive, send)
 
-    def _get_forwarded_url_parts(self, scope: Scope) -> Tuple[str, str, str]:
+    def _get_forwarded_url_parts(self, scope: Scope) -> Tuple[str, str, int]:
         proto = scope.get("scheme", "http")
-        header_host = self._get_header_value_by_name(scope, "host")
-        if header_host is None:
-            domain, port = scope["server"]
-        else:
+        # Assume default port based on protocol, can be overridden later
+        port = 443 if proto == "https" else 80
+
+        if header_host := self._get_header_value_by_name(scope, "host"):
             header_host_parts = header_host.split(":")
+            domain = header_host_parts[0]
             if len(header_host_parts) == 2:
-                domain, port = header_host_parts
-            else:
-                domain = header_host_parts[0]
-                port = None
-
-        port_str = None  # make sure it is defined in all paths since we access it later
+                with contextlib.suppress(ValueError):
+                    port = int(header_host_parts[1])
+        else:
+            # Not sure when we would not have a host header, but fallback to server info
+            domain, port = scope["server"]
+            port = int(port)
+
+        forwarded_port: Optional[str] = None
+        forwarding_occurred = any(
+            key
+            in [
+                b"forwarded",
+                b"x-forwarded-proto",
+                b"x-forwarded-host",
+                b"x-forwarded-port",
+            ]
+            for key, _ in scope["headers"]
+        )
 
         if forwarded := self._get_header_value_by_name(scope, "forwarded"):
             for proxy in forwarded.split(","):
@@ -103,15 +116,21 @@ class ProxyHeaderMiddleware:
                     proto = proto_expr.group("proto")
                 if host_expr := _HOST_HEADER_REGEX.search(proxy):
                     domain = host_expr.group("host")
-                    port_str = host_expr.group("port")  # None if not present in the match
+                    forwarded_port = host_expr.group("port")  # None if not present
 
         else:
-            domain = self._get_header_value_by_name(scope, "x-forwarded-host", domain)
-            proto = self._get_header_value_by_name(scope, "x-forwarded-proto", proto)
-            port_str = self._get_header_value_by_name(scope, "x-forwarded-port", port)
-
-        with contextlib.suppress(ValueError):  # ignore ports that are not valid integers
-            port = int(port_str) if port_str is not None else port
+            domain = self._get_header_value_by_name(scope, "x-forwarded-host") or domain
+            proto = self._get_header_value_by_name(scope, "x-forwarded-proto") or proto
+            forwarded_port = self._get_header_value_by_name(scope, "x-forwarded-port")
+
+        if forwarding_occurred and not forwarded_port:
+            # If forwarding occurred but no port was specified, use protocol default
+            forwarded_port = "443" if proto == "https" else "80"
+
+        if forwarded_port:
+            # ignore ports that are not valid integers
+            with contextlib.suppress(ValueError):
+                port = int(forwarded_port)
 
         return (proto, domain, port)
 

{stac_fastapi_api-6.1.3 → stac_fastapi_api-6.1.5}/stac_fastapi/api/models.py

@@ -1,6 +1,6 @@
 """Api request/response models."""
 
-from typing import List, Literal, Optional, Type, Union
+from typing import List, Literal, Optional, Type, Union, cast
 
 import attr
 from fastapi import Path, Query
@@ -24,7 +24,7 @@ try:
     import orjson  # noqa
     from fastapi.responses import ORJSONResponse as JSONResponse
 except ImportError:  # pragma: nocover
-    from starlette.responses import JSONResponse  # type: ignore
+    from starlette.responses import JSONResponse  # type: ignore [assignment]
 
 
 def create_request_model(
@@ -49,7 +49,8 @@ def create_request_model(
 
     # Handle GET requests
     if all([issubclass(m, APIRequest) for m in models]):
-        return attr.make_class(model_name, attrs={}, bases=tuple(models))
+        get_model = attr.make_class(model_name, attrs={}, bases=tuple(models))
+        return cast(Type[APIRequest], get_model)
 
     # Handle POST requests
     elif all([issubclass(m, BaseModel) for m in models]):
@@ -57,35 +58,38 @@ def create_request_model(
             for k, field_info in model.model_fields.items():  # type: ignore
                 fields[k] = (field_info.annotation, field_info)
 
-        return create_model(model_name, **fields, __base__=base_model)  # type: ignore
+        post_model = create_model(model_name, **fields, __base__=base_model)  # type: ignore
+        return cast(Type[BaseModel], post_model)
 
     raise TypeError("Mixed Request Model types. Check extension request types.")
 
 
 def create_get_request_model(
     extensions: Optional[List[ApiExtension]],
-    base_model: Type[BaseSearchGetRequest] = BaseSearchGetRequest,
+    base_model: Type[APIRequest] = BaseSearchGetRequest,
 ) -> Type[APIRequest]:
     """Wrap create_request_model to create the GET request model."""
-    return create_request_model(  # type: ignore
+    model = create_request_model(
         "SearchGetRequest",
         base_model=base_model,
         extensions=extensions,
         request_type="GET",
     )
+    return cast(Type[APIRequest], model)
 
 
 def create_post_request_model(
     extensions: Optional[List[ApiExtension]],
-    base_model: Type[BaseSearchPostRequest] = BaseSearchPostRequest,
+    base_model: Type[BaseModel] = BaseSearchPostRequest,
 ) -> Type[BaseModel]:
     """Wrap create_request_model to create the POST request model."""
-    return create_request_model(  # type: ignore
+    model = create_request_model(
         "SearchPostRequest",
         base_model=base_model,
         extensions=extensions,
         request_type="POST",
     )
+    return cast(Type[BaseModel], model)
 
 
 @attr.s
@@ -121,7 +125,7 @@ class ItemCollectionUri(APIRequest, DatetimeMixin):
             description="Limits the number of results that are included in each page of the response (capped to 10_000)."  # noqa: E501
         ),
     ] = attr.ib(default=10)
-    bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)  # type: ignore
+    bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)  # type: ignore [misc]
     datetime: DateTimeQueryType = attr.ib(default=None, validator=_validate_datetime)
 
 

{stac_fastapi_api-6.1.3 → stac_fastapi_api-6.1.5}/stac_fastapi/api/version.py

@@ -1,3 +1,3 @@
 """Library version."""
 
-__version__ = "6.1.3"
+__version__ = "6.1.5"