fix: fix db mutation bug, sundry fixes

Author: pjhartzell

src/stapi_fastapi/backends/root_backend.py

@@ -50,7 +50,7 @@
 
 GetOrderStatuses = Callable[
     [str, str | None, int, Request],
-    Coroutine[Any, Any, ResultE[tuple[list[T], Maybe[str]]]],
+    Coroutine[Any, Any, ResultE[Maybe[tuple[list[T], Maybe[str]]]]],
 ]
 """
 Type alias for an async function that gets statuses for the order with `order_id`.
@@ -64,9 +64,9 @@
 Returns:
     A tuple containing a list of order statuses and a pagination token.
 
-    - Should return returns.result.Success[tuple[list[OrderStatus], returns.maybe.Some[str]] if order is found and including a pagination token.
-    - Should return returns.result.Success[tuple[list[OrderStatus], returns.maybe.Nothing]] if order is found and not including a pagination token.
-    - Should return returns.result.Failure[Exception] if the order is not found or if access is denied.
+    - Should return returns.result.Success[returns.maybe.Some[tuple[list[OrderStatus], returns.maybe.Some[str]]] if order is found and including a pagination token.
+    - Should return returns.result.Success[returns.maybe.Some[tuple[list[OrderStatus], returns.maybe.Nothing]]] if order is found and not including a pagination token.
+    - Should return returns.result.Success[returns.maybe.Nothing] if the order is not found or if access is denied.
     - Returning returns.result.Failure[Exception] will result in a 500.
 """
 

src/stapi_fastapi/routers/product_router.py

@@ -160,6 +160,7 @@ async def _create_order(
                 endpoint=self.get_opportunity_collection,
                 name=f"{self.root_router.name}:{self.product.id}:get-opportunity-collection",
                 methods=["GET"],
+                response_class=GeoJSONResponse,
                 summary="Get an Opportunity Collection by ID",
                 tags=["Products"],
             )
@@ -268,11 +269,13 @@ async def search_opportunities_sync(
             search.limit,
             request,
         ):
-            case Success((features, Some(pagination_token))):
-                links.append(self.order_link(request, search))
-                links.append(self.pagination_link(request, search, pagination_token))
-            case Success((features, Nothing)):  # noqa: F841
+            case Success((features, maybe_pagination_token)):
                 links.append(self.order_link(request, search))
+                match maybe_pagination_token:
+                    case Some(x):
+                        links.append(self.pagination_link(request, search, x))
+                    case Maybe.empty:
+                        pass
             case Failure(e) if isinstance(e, ConstraintsException):
                 raise e
             case Failure(e):
@@ -402,7 +405,7 @@ def pagination_link(
 
     async def get_opportunity_collection(
         self: Self, opportunity_collection_id: str, request: Request
-    ) -> Response:
+    ) -> OpportunityCollection:
         """
         Fetch an opportunity collection generated by an asynchronous opportunity search.
         """
@@ -424,9 +427,7 @@ async def get_opportunity_collection(
                         type=TYPE_JSON,
                     ),
                 )
-                return GeoJSONResponse(
-                    content=opportunity_collection.model_dump(mode="json")
-                )
+                return opportunity_collection
             case Success(Maybe.empty):
                 raise NotFoundException("Opportunity Collection not found")
             case Failure(e):

src/stapi_fastapi/routers/root_router.py

@@ -299,12 +299,16 @@ async def get_order_statuses(
     ) -> OrderStatuses:
         links: list[Link] = []
         match await self._get_order_statuses(order_id, next, limit, request):
-            case Success((statuses, Some(pagination_token))):
+            case Success(Some((statuses, maybe_pagination_token))):
                 links.append(self.order_statuses_link(request, order_id))
-                links.append(self.pagination_link(request, pagination_token, limit))
-            case Success((statuses, Nothing)):  # noqa: F841
-                links.append(self.order_statuses_link(request, order_id))
-            case Failure(KeyError()):
+                match maybe_pagination_token:
+                    case Some(x):
+                        links.append(self.pagination_link(request, x, limit))
+                    case Maybe.empty:
+                        pass
+            case Success(Maybe.empty):
+                raise NotFoundException("Order not found")
+            case Failure(ValueError()):
                 raise NotFoundException("Error finding pagination token")
             case Failure(e):
                 logger.error(
@@ -374,17 +378,16 @@ async def get_opportunity_search_records(
     ) -> OpportunitySearchRecords:
         links: list[Link] = []
         match await self._get_opportunity_search_records(next, limit, request):
-            case Success((records, Some(pagination_token))):
-                for record in records:
-                    record.links.append(
-                        self.opportunity_search_record_self_link(record, request)
-                    )
-                links.append(self.pagination_link(request, pagination_token, limit))
-            case Success((records, Nothing)):  # noqa: F841
+            case Success((records, maybe_pagination_token)):
                 for record in records:
                     record.links.append(
                         self.opportunity_search_record_self_link(record, request)
                     )
+                match maybe_pagination_token:
+                    case Some(x):
+                        links.append(self.pagination_link(request, x, limit))
+                    case Maybe.empty:
+                        pass
             case Failure(ValueError()):
                 raise NotFoundException(detail="Error finding pagination token")
             case Failure(e):

tests/backends.py

@@ -39,7 +39,7 @@ async def mock_get_orders(
             start = order_ids.index(next)
         end = start + limit
         ids = order_ids[start:end]
-        orders = [request.state._orders_db._orders[order_id] for order_id in ids]
+        orders = [request.state._orders_db.get_order(order_id) for order_id in ids]
 
         if end > 0 and end < len(order_ids):
             return Success(
@@ -54,26 +54,32 @@ async def mock_get_order(order_id: str, request: Request) -> ResultE[Maybe[Order
     """
     Show details for order with `order_id`.
     """
-
-    return Success(Maybe.from_optional(request.state._orders_db._orders.get(order_id)))
+    try:
+        return Success(
+            Maybe.from_optional(request.state._orders_db.get_order(order_id))
+        )
+    except Exception as e:
+        return Failure(e)
 
 
 async def mock_get_order_statuses(
     order_id: str, next: str | None, limit: int, request: Request
-) -> ResultE[tuple[list[OrderStatus], Maybe[str]]]:
+) -> ResultE[Maybe[tuple[list[OrderStatus], Maybe[str]]]]:
     try:
         start = 0
         limit = min(limit, 100)
-        statuses = request.state._orders_db._statuses[order_id]
+        statuses = request.state._orders_db.get_order_statuses(order_id)
+        if statuses is None:
+            return Success(Nothing)
 
         if next:
             start = int(next)
         end = start + limit
         stati = statuses[start:end]
 
         if end > 0 and end < len(statuses):
-            return Success((stati, Some(str(end))))
-        return Success((stati, Nothing))
+            return Success(Some((stati, Some(str(end)))))
+        return Success(Some((stati, Nothing)))
     except Exception as e:
         return Failure(e)
 
@@ -110,8 +116,8 @@ async def mock_create_order(
             links=[],
         )
 
-        request.state._orders_db._orders[order.id] = order
-        request.state._orders_db._statuses[order.id].insert(0, status)
+        request.state._orders_db.put_order(order)
+        request.state._orders_db.put_order_status(order.id, status)
         return Success(order)
     except Exception as e:
         return Failure(e)

tests/shared.py

@@ -49,6 +49,21 @@ def __init__(self) -> None:
         self._orders: dict[str, Order] = {}
         self._statuses: dict[str, list[OrderStatus]] = defaultdict(list)
 
+    def get_order(self, order_id: str) -> Order | None:
+        return deepcopy(self._orders.get(order_id))
+
+    def get_orders(self) -> list[Order]:
+        return deepcopy(list(self._orders.values()))
+
+    def put_order(self, order: Order) -> None:
+        self._orders[order.id] = deepcopy(order)
+
+    def get_order_statuses(self, order_id: str) -> list[OrderStatus] | None:
+        return deepcopy(self._statuses.get(order_id))
+
+    def put_order_status(self, order_id: str, status: OrderStatus) -> None:
+        self._statuses[order_id].append(deepcopy(status))
+
 
 class InMemoryOpportunityDB:
     def __init__(self) -> None:
@@ -275,7 +290,7 @@ def make_request(
             o = urlparse(url)
             base_url = f"{o.scheme}://{o.netloc}{o.path}"
             parsed_qs = parse_qs(o.query)
-            params = {}
+            params: dict[str, Any] = {}
             if "next" in parsed_qs:
                 params["next"] = parsed_qs["next"][0]
             params["limit"] = int(parsed_qs.get("limit", [None])[0] or limit)

tests/test_order.py

@@ -1,4 +1,3 @@
-import copy
 from datetime import UTC, datetime, timedelta, timezone
 
 import pytest
@@ -171,15 +170,7 @@ def test_get_orders_pagination(
 ) -> None:
     expected_returns = []
     if limit > 0:
-        for order in setup_orders_pagination:
-            self_link = copy.deepcopy(order["links"][0])
-            order["links"].append(self_link)
-            monitor_link = copy.deepcopy(order["links"][0])
-            monitor_link["rel"] = "monitor"
-            monitor_link["type"] = "application/json"
-            monitor_link["href"] = monitor_link["href"] + "/statuses"
-            order["links"].append(monitor_link)
-            expected_returns.append(order)
+        expected_returns = setup_orders_pagination
 
     pagination_tester(
         stapi_client=stapi_client,
@@ -228,7 +219,9 @@ def test_get_order_status_pagination(
     stapi_client: TestClient,
     order_statuses: dict[str, list[OrderStatus]],
 ) -> None:
-    stapi_client.app_state["_orders_db"]._statuses = order_statuses
+    for id, statuses in order_statuses.items():
+        for s in statuses:
+            stapi_client.app_state["_orders_db"].put_order_status(id, s)
 
     order_id = "test_order_id"
     expected_returns = []