refactor types to support correct typing of incoming OrderRequest

Author: Phil Varner

bin/server.py

@@ -2,7 +2,7 @@
 
 from fastapi import FastAPI, Request
 from stapi_fastapi.backends.product_backend import ProductBackend
-from stapi_fastapi.exceptions import ConstraintsException, NotFoundException
+from stapi_fastapi.exceptions import NotFoundException
 from stapi_fastapi.models.opportunity import (
     Opportunity,
     OpportunityProperties,
@@ -62,23 +62,25 @@ async def create_order(
         """
         Create a new order.
         """
-        allowed: bool = any(allowed == payload for allowed in self._allowed_payloads)
-        allowed = True
-        if allowed:
-            order = Order(
-                id=str(uuid4()),
-                geometry=payload.geometry,
-                properties={
-                    "filter": payload.filter,
-                    "datetime": payload.datetime,
-                    "product_id": product_router.product.id,
-                    **dict(payload.order_parameters),
+        order = Order(
+            id=str(uuid4()),
+            geometry=payload.geometry,
+            properties={
+                "product_id": product_router.product.id,
+                "datetime": payload.datetime,
+                "geometry": payload.geometry,
+                "filter": payload.filter,
+                "order_parameters": payload.order_parameters,
+                "opportunity_properties": {
+                    "datetime": "2024-01-29T12:00:00Z/2024-01-30T12:00:00Z",
+                    "off_nadir": 10,
                 },
-                links=[],
-            )
-            self._orders[order.id] = order
-            return order
-        raise ConstraintsException("not allowed")
+            },
+            links=[],
+        )
+
+        self._orders[order.id] = order
+        return order
 
 
 class TestSpotlightProperties(OpportunityProperties):

src/stapi_fastapi/models/order.py

@@ -1,25 +1,45 @@
-from typing import Literal, TypeVar, Generic, Any
+from typing import Generic, Literal, TypeVar
 
 from geojson_pydantic import Feature, FeatureCollection
 from geojson_pydantic.geometries import Geometry
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 
-from stapi_fastapi.models.opportunity import OpportunityRequest, OpportunityProperties
+from stapi_fastapi.models.opportunity import OpportunityProperties
 from stapi_fastapi.models.shared import Link
+from stapi_fastapi.types.datetime_interval import DatetimeInterval
+from stapi_fastapi.types.filter import CQL2Filter
 
 
 class OrderParameters(BaseModel):
     model_config = ConfigDict(extra="allow")
 
-P = TypeVar("P", bound=OrderParameters)
-O = TypeVar("O", bound=OpportunityProperties)
 
-class OrderRequest(OpportunityRequest, Generic[P]):
-    order_parameters: P
+ORP = TypeVar("P", bound=OrderParameters)
+OPP = TypeVar("O", bound=OpportunityProperties)
 
-class OrderProperties(BaseModel, Generic[O]):
-    opportunity_properties: O
-    order_parameters: dict[str, Any]
+
+class OrderRequest(BaseModel, Generic[ORP]):
+    datetime: DatetimeInterval
+    geometry: Geometry
+    # TODO: validate the CQL2 filter?
+    filter: CQL2Filter | None = None
+
+    order_parameters: ORP
+
+    model_config = ConfigDict(strict=True)
+
+
+class OrderProperties(BaseModel, Generic[OPP, ORP]):
+    product_id: str
+    datetime: DatetimeInterval
+    geometry: Geometry
+    # TODO: validate the CQL2 filter?
+    filter: CQL2Filter | None = None
+
+    opportunity_properties: OPP
+    order_parameters: ORP
+
+    model_config = ConfigDict(extra="allow")
 
 
 class Order(Feature[Geometry, OrderProperties]):
@@ -29,6 +49,7 @@ class Order(Feature[Geometry, OrderProperties]):
     type: Literal["Feature"] = "Feature"
     links: list[Link] = Field(default_factory=list)
 
+
 class OrderCollection(FeatureCollection[Order]):
     type: Literal["FeatureCollection"] = "FeatureCollection"
     links: list[Link] = Field(default_factory=list)

src/stapi_fastapi/routers/product_router.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Self, Any
+from typing import TYPE_CHECKING, Self
 
 from fastapi import APIRouter, HTTPException, Request, Response, status
 from geojson_pydantic.geometries import Geometry
@@ -67,14 +67,27 @@ def __init__(
             summary="Get order parameters for the product",
         )
 
+        async def _create_order(
+            payload: OrderRequest,
+            request: Request,
+            response: Response,
+        ) -> Order:
+            return await self.create_order(payload, request, response)
+
+        _create_order.__annotations__["payload"] = OrderRequest[
+            product.order_parameters
+        ]
 
         self.add_api_route(
             path="/order",
-            endpoint=self.create_order,
+            endpoint=_create_order,
             name=f"{self.root_router.name}:{self.product.id}:create-order",
             methods=["POST"],
             response_class=GeoJSONResponse,
             status_code=status.HTTP_201_CREATED,
+            response_model=Order[
+                self.product.constraints, self.product.order_parameters
+            ],
             summary="Create an order for the product",
         )
 

tests/backends.py

@@ -60,14 +60,21 @@ async def create_order(
                 id=str(uuid4()),
                 geometry=payload.geometry,
                 properties={
-                    "filter": payload.filter,
-                    "datetime": payload.datetime,
                     "product_id": product_router.product.id,
-                    **dict(payload.order_parameters),
+                    "datetime": payload.datetime,
+                    "geometry": payload.geometry,
+                    "filter": payload.filter,
+                    "order_parameters": payload.order_parameters,
+                    "opportunity_properties": {
+                        "datetime": "2024-01-29T12:00:00Z/2024-01-30T12:00:00Z",
+                        "off_nadir": 10,
+                    },
                 },
                 links=[],
             )
             self._orders[order.id] = order
             return order
         else:
-            raise ConstraintsException(f"not allowed: payload {payload.model_dump_json()} not in {[p.model_dump_json() for p in self._allowed_payloads]}")
+            raise ConstraintsException(
+                f"not allowed: payload {payload.model_dump_json()} not in {[p.model_dump_json() for p in self._allowed_payloads]}"
+            )

tests/conftest.py

@@ -1,5 +1,5 @@
 from collections.abc import Iterator
-from datetime import UTC, datetime, timedelta, timezone
+from datetime import datetime, timedelta, timezone
 from typing import Callable
 from urllib.parse import urljoin
 from uuid import uuid4
@@ -24,7 +24,7 @@ class TestSpotlightProperties(OpportunityProperties):
     off_nadir: int
 
 
-class TestSpotlightOrderProperties(OrderParameters):
+class TestSpotlightOrderParameters(OrderParameters):
     s3_path: str | None = None
 
 
@@ -62,7 +62,7 @@ def mock_product_test_spotlight(
         providers=[mock_provider],
         links=[],
         constraints=TestSpotlightProperties,
-        order_parameters=TestSpotlightOrderProperties,
+        order_parameters=TestSpotlightOrderParameters,
         backend=product_backend,
     )
 
@@ -131,14 +131,17 @@ def mock_test_spotlight_opportunities() -> list[Opportunity]:
 
 
 @pytest.fixture
-def allowed_payloads() -> list[OrderRequest]:
+def create_order_allowed_payloads() -> list[OrderRequest]:
     return [
         OrderRequest(
             geometry=Point(
                 type="Point", coordinates=Position2D(longitude=13.4, latitude=52.5)
             ),
-            datetime=(datetime.now(UTC), datetime.now(UTC)),
-            filter={},
-            order_parameters=TestSpotlightOrderProperties(s3_path="BUCKET"),
+            datetime=(
+                datetime.fromisoformat("2024-11-11T18:55:33Z"),
+                datetime.fromisoformat("2024-11-15T18:55:33Z"),
+            ),
+            filter=None,
+            order_parameters=TestSpotlightOrderParameters(s3_path="BUCKET"),
         ),
     ]

tests/order_test.py

@@ -19,13 +19,13 @@ def new_order_response(
     product_id: str,
     product_backend: MockProductBackend,
     stapi_client: TestClient,
-    allowed_payloads: list[OrderRequest],
+    create_order_allowed_payloads: list[OrderRequest],
 ) -> Response:
-    product_backend._allowed_payloads = allowed_payloads
+    product_backend._allowed_payloads = create_order_allowed_payloads
 
     res = stapi_client.post(
         f"products/{product_id}/order",
-        json=allowed_payloads[0].model_dump(),
+        json=create_order_allowed_payloads[0].model_dump(),
     )
 
     assert res.status_code == status.HTTP_201_CREATED, res.text
@@ -56,14 +56,17 @@ def get_order_response(
 
 
 @pytest.mark.parametrize("product_id", ["test-spotlight"])
-def test_get_order_properties(get_order_response: Response, allowed_payloads) -> None:
+def test_get_order_properties(
+    get_order_response: Response, create_order_allowed_payloads
+) -> None:
     order = get_order_response.json()
 
     assert order["geometry"] == {
         "type": "Point",
-        "coordinates": list(allowed_payloads[0].geometry.coordinates),
+        "coordinates": list(create_order_allowed_payloads[0].geometry.coordinates),
     }
 
     assert (
-        order["properties"]["datetime"] == allowed_payloads[0].model_dump()["datetime"]
+        order["properties"]["datetime"]
+        == create_order_allowed_payloads[0].model_dump()["datetime"]
     )