sketch of constraints/opportunity properties split

Author: jkeifer

README.md

@@ -36,12 +36,12 @@ command `pytest`.
 
 This project cannot be run on its own because it does not have any backend
 implementations. However, a minimal test implementation is provided in
-[`./bin/server.py`](./bin/server.py). It can be run with `uvicorn` as a way to
-interact with the API and to view the OpenAPI documentation. Run it like so
-from the project root:
+[`./tests/application.py`](./tests/application.py). It can be run with
+`uvicorn` as a way to interact with the API and to view the OpenAPI
+documentation. Run it like so from the project root:
 
 ```commandline
-uvicorn server:app --app-dir ./bin --reload
+uvicorn application:app --app-dir ./tests --reload
 ```
 
 With the `uvicorn` defaults the app should be accessible at

src/stapi_fastapi/models/opportunity.py

@@ -12,6 +12,7 @@
 # Copied and modified from https://github.com/stac-utils/stac-pydantic/blob/main/stac_pydantic/item.py#L11
 class OpportunityProperties(BaseModel):
     datetime: DatetimeInterval
+    product_id: str
     model_config = ConfigDict(extra="allow")
 
 

src/stapi_fastapi/models/product.py

@@ -13,6 +13,9 @@
     from stapi_fastapi.backends.product_backend import ProductBackend
 
 
+type Constraints = BaseModel
+
+
 class ProviderRole(str, Enum):
     licensor = "licensor"
     producer = "producer"
@@ -28,7 +31,7 @@ class Provider(BaseModel):
 
     # redefining init is a hack to get str type to validate for `url`,
     # as str is ultimately coerced into an AnyHttpUrl automatically anyway
-    def __init__(self, url: AnyHttpUrl | str, **kwargs):
+    def __init__(self, url: AnyHttpUrl | str, **kwargs) -> None:
         super().__init__(url=url, **kwargs)
 
 
@@ -44,31 +47,38 @@ class Product(BaseModel):
     links: list[Link] = Field(default_factory=list)
 
     # we don't want to include these in the model fields
-    _constraints: type[OpportunityProperties]
+    _constraints: type[Constraints]
+    _opportunity_properties: type[OpportunityProperties]
     _order_parameters: type[OrderParameters]
     _backend: ProductBackend
 
     def __init__(
         self,
         *args,
         backend: ProductBackend,
-        constraints: type[OpportunityProperties],
+        constraints: type[Constraints],
+        opportunity_properties: type[OpportunityProperties],
         order_parameters: type[OrderParameters],
         **kwargs,
     ) -> None:
         super().__init__(*args, **kwargs)
         self._backend = backend
         self._constraints = constraints
+        self._opportunity_properties = opportunity_properties
         self._order_parameters = order_parameters
 
     @property
     def backend(self: Self) -> ProductBackend:
         return self._backend
 
     @property
-    def constraints(self: Self) -> type[OpportunityProperties]:
+    def constraints(self: Self) -> type[Constraints]:
         return self._constraints
 
+    @property
+    def opportunity_properties(self: Self) -> type[OpportunityProperties]:
+        return self._opportunity_properties
+
     @property
     def order_parameters(self: Self) -> type[OrderParameters]:
         return self._order_parameters

src/stapi_fastapi/routers/product_router.py

@@ -51,7 +51,10 @@ def __init__(
             methods=["POST"],
             response_class=GeoJSONResponse,
             # unknown why mypy can't see the constraints property on Product, ignoring
-            response_model=OpportunityCollection[Geometry, self.product.constraints],  # type: ignore
+            response_model=OpportunityCollection[
+                Geometry,
+                self.product.opportunity_properties,  # type: ignore
+            ],
             summary="Search Opportunities for the product",
             tags=["Products"],
         )

bin/server.py tests/application.pybin/server.py renamed to tests/application.py

@@ -1,7 +1,9 @@
 from datetime import datetime, timezone
+from typing import Literal, Self
 from uuid import uuid4
 
 from fastapi import FastAPI, Request
+from pydantic import BaseModel, Field, model_validator
 from returns.maybe import Maybe
 from returns.result import Failure, Result, Success
 
@@ -110,10 +112,27 @@ async def create_order(
             return Failure(e)
 
 
-class MyOpportunityProperties(OpportunityProperties):
+class MyProductConstraints(BaseModel):
     off_nadir: int
 
 
+class OffNadirRange(BaseModel):
+    minimum: int = Field(ge=0, le=45)
+    maximum: int = Field(ge=0, le=45)
+
+    @model_validator(mode="after")
+    def validate_range(self) -> Self:
+        if self.minimum > self.maximum:
+            raise ValueError("range minimum cannot be greater than maximum")
+        return self
+
+
+class MyOpportunityProperties(OpportunityProperties):
+    off_nadir: OffNadirRange
+    vehicle_id: list[Literal[1, 2, 5, 7, 8]]
+    platform: Literal["platform_id"]
+
+
 class MyOrderParameters(OrderParameters):
     s3_path: str | None = None
 
@@ -137,7 +156,8 @@ class MyOrderParameters(OrderParameters):
     keywords=["test", "satellite"],
     providers=[provider],
     links=[],
-    constraints=MyOpportunityProperties,
+    constraints=MyProductConstraints,
+    opportunity_properties=MyOpportunityProperties,
     order_parameters=MyOrderParameters,
     backend=product_backend,
 )

tests/conftest.py

@@ -14,19 +14,21 @@
     Opportunity,
 )
 from stapi_fastapi.models.product import (
-    OrderParameters,
     Product,
     Provider,
     ProviderRole,
 )
 from stapi_fastapi.routers.root_router import RootRouter
 
-from .backends import MockOrderDB, MockProductBackend, MockRootBackend
-from .shared import SpotlightOpportunityProperties, SpotlightOrderParameters, find_link
-
-
-class TestSpotlightOrderParameters(OrderParameters):
-    s3_path: str | None = None
+from .application import (
+    MockOrderDB,
+    MockProductBackend,
+    MockRootBackend,
+    MyOpportunityProperties,
+    MyOrderParameters,
+    MyProductConstraints,
+)
+from .shared import find_link
 
 
 @pytest.fixture(scope="session")
@@ -62,8 +64,9 @@ def mock_product_test_spotlight(
         keywords=["test", "satellite"],
         providers=[mock_provider],
         links=[],
-        constraints=SpotlightOpportunityProperties,
-        order_parameters=SpotlightOrderParameters,
+        constraints=MyProductConstraints,
+        opportunity_properties=MyOpportunityProperties,
+        order_parameters=MyOrderParameters,
         backend=product_backend,
     )
 
@@ -140,10 +143,13 @@ def mock_test_spotlight_opportunities() -> list[Opportunity]:
                 type="Point",
                 coordinates=Position2D(longitude=0.0, latitude=0.0),
             ),
-            properties=SpotlightOpportunityProperties(
+            properties=MyOpportunityProperties(
                 product_id="xyz123",
                 datetime=(start, end),
-                off_nadir=20,
+                off_nadir={"minimum": 20, "maximum": 22},
+                vehicle_id=[1],
+                platform="platform_id",
+                other_thing="abcd1234",
             ),
         ),
     ]

tests/order_test.py

@@ -9,8 +9,9 @@
 
 from stapi_fastapi.models.order import OrderRequest
 
+from .application import MyOrderParameters
 from .backends import MockProductBackend
-from .shared import SpotlightOrderParameters, find_link
+from .shared import find_link
 
 NOW = datetime.now(UTC)
 START = NOW
@@ -29,7 +30,7 @@ def create_order_allowed_payloads() -> list[OrderRequest]:
                 datetime.fromisoformat("2024-11-15T18:55:33Z"),
             ),
             filter=None,
-            order_parameters=SpotlightOrderParameters(s3_path="s3://my-bucket"),
+            order_parameters=MyOrderParameters(s3_path="s3://my-bucket"),
         ),
     ]
 

tests/product_test.py

@@ -48,7 +48,6 @@ def test_product_constraints_response(
 
     json_schema = res.json()
     assert "properties" in json_schema
-    assert "datetime" in json_schema["properties"]
     assert "off_nadir" in json_schema["properties"]
 
 

tests/shared.py

@@ -1,17 +1,5 @@
 from typing import Any
 
-from stapi_fastapi.models.opportunity import OpportunityProperties
-from stapi_fastapi.models.order import OrderParameters
-
-
-class SpotlightOpportunityProperties(OpportunityProperties):
-    off_nadir: int
-
-
-class SpotlightOrderParameters(OrderParameters):
-    s3_path: str | None = None
-
-
 type link_dict = dict[str, Any]