add monitor link to Order

Author: Phil Varner

src/stapi_fastapi/routers/product_router.py

@@ -7,7 +7,7 @@
 from geojson_pydantic.geometries import Geometry
 from returns.result import Failure, Success
 
-from stapi_fastapi.constants import TYPE_GEOJSON, TYPE_JSON
+from stapi_fastapi.constants import TYPE_JSON
 from stapi_fastapi.exceptions import ConstraintsException
 from stapi_fastapi.models.opportunity import (
     OpportunityCollection,
@@ -214,8 +214,8 @@ async def create_order(
             request,
         ):
             case Success(order):
+                self.root_router.add_order_links(order, request)
                 location = str(self.root_router.generate_order_href(request, order.id))
-                order.links.append(Link(href=location, rel="self", type=TYPE_GEOJSON))
                 response.headers["Location"] = location
                 return order
             case Failure(e) if isinstance(e, ConstraintsException):

src/stapi_fastapi/routers/root_router.py

@@ -190,21 +190,7 @@ async def get_order(self: Self, order_id: str, request: Request) -> Order:
         """
         match await self.backend.get_order(order_id, request):
             case Success(Some(order)):
-                order.links.extend(
-                    [
-                        Link(href=str(request.url), rel="self", type=TYPE_GEOJSON),
-                        Link(
-                            href=str(
-                                request.url_for(
-                                    f"{self.name}:list-order-statuses",
-                                    order_id=order_id,
-                                )
-                            ),
-                            rel="monitor",
-                            type=TYPE_JSON,
-                        ),
-                    ]
-                )
+                self.add_order_links(order, request)
                 return order
             case Success(Maybe.empty):
                 raise NotFoundException("Order not found")
@@ -262,14 +248,35 @@ async def set_order_status(
                     status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
                     detail="Error setting Order Status",
                 )
-            case _:
-                raise AssertionError("Expected code to be unreachable")
+            case x:
+                raise AssertionError(f"Expected code to be unreachable {x}")
 
     def add_product(self: Self, product: Product) -> None:
         # Give the include a prefix from the product router
         product_router = ProductRouter(product, self)
         self.include_router(product_router, prefix=f"/products/{product.id}")
         self.product_routers[product.id] = product_router
 
-    def generate_order_href(self: Self, request: Request, order_id: int | str) -> URL:
+    def generate_order_href(self: Self, request: Request, order_id: str) -> URL:
         return request.url_for(f"{self.name}:get-order", order_id=order_id)
+
+    def generate_order_statuses_href(
+        self: Self, request: Request, order_id: str
+    ) -> URL:
+        return request.url_for(f"{self.name}:list-order-statuses", order_id=order_id)
+
+    def add_order_links(self, order: Order, request: Request):
+        order.links.append(
+            Link(
+                href=str(self.generate_order_href(request, order.id)),
+                rel="self",
+                type=TYPE_GEOJSON,
+            )
+        )
+        order.links.append(
+            Link(
+                href=str(self.generate_order_statuses_href(request, order.id)),
+                rel="monitor",
+                type=TYPE_JSON,
+            ),
+        )

tests/test_order.py

@@ -64,6 +64,25 @@ def test_new_order_location_header_matches_self_link(
     assert new_order_response.headers["Location"] == str(link["href"])
 
 
+@pytest.mark.parametrize("product_id", ["test-spotlight"])
+def test_new_order_links(new_order_response: Response, assert_link) -> None:
+    order = new_order_response.json()
+    assert_link(
+        f"GET /orders/{order['id']}",
+        order,
+        "monitor",
+        f"/orders/{order['id']}/statuses",
+    )
+
+    assert_link(
+        f"GET /orders/{order['id']}",
+        order,
+        "self",
+        f"/orders/{order['id']}",
+        media_type="application/geo+json",
+    )
+
+
 @pytest.fixture
 def get_order_response(
     stapi_client: TestClient, new_order_response: Response
@@ -100,13 +119,12 @@ def test_get_order_properties(
 
 @pytest.mark.parametrize("product_id", ["test-spotlight"])
 def test_order_status_after_create(
-    get_order_response: Response, assert_link, stapi_client: TestClient
+    get_order_response: Response, stapi_client: TestClient, assert_link
 ) -> None:
     body = get_order_response.json()
     assert_link(
         f"GET /orders/{body['id']}", body, "monitor", f"/orders/{body['id']}/statuses"
     )
-
     link = find_link(body["links"], "monitor")
 
     res = stapi_client.get(link["href"])