feat: correctly adding pagination link object to top level collection feat: replacing token in url if new token is provided tests: continue to updae test to validate additional pieces of the limit/token expected functionality, still breaking on limit check feat: removing use or Orders type and going with tuple instead

Author: theodorehreuter

src/stapi_fastapi/backends/root_backend.py

@@ -6,18 +6,19 @@
 
 from stapi_fastapi.models.order import (
     Order,
-    Orders,
+    OrderCollection,
     OrderStatus,
     OrderStatusPayload,
 )
 
 
 class RootBackend[T: OrderStatusPayload, U: OrderStatus](Protocol):  # pragma: nocover
     async def get_orders(
-        self, request: Request, next_token: str, limit: int
-    ) -> ResultE[Orders]:
+        self, request: Request, next: str | None, limit: int | None
+    ) -> ResultE[tuple[OrderCollection, str]]:
         """
-        Return a list of existing orders.
+        Return a list of existing orders and pagination token if applicable
+        No pagination will return empty string for token
         """
         ...
 

src/stapi_fastapi/models/order.py

@@ -113,11 +113,6 @@ def __getitem__(self, index: int) -> Order:
         return self.features[index]
 
 
-class Orders(BaseModel):
-    collection: OrderCollection
-    token: str
-
-
 class OrderPayload(BaseModel, Generic[ORP]):
     datetime: DatetimeInterval
     geometry: Geometry

src/stapi_fastapi/routers/root_router.py

@@ -160,11 +160,11 @@ def get_products(self, request: Request) -> ProductsCollection:
         )
 
     async def get_orders(
-        self, request: Request, next_token: str, limit: int
+        self, request: Request, next_token: str | None = None, limit: int | None = None
     ) -> OrderCollection:
         match await self.backend.get_orders(request, next_token, limit):
-            case Success(orders):
-                for order in orders.collection:
+            case Success((collections, token)):
+                for order in collections:
                     order.links.append(
                         Link(
                             href=str(
@@ -176,7 +176,22 @@ async def get_orders(
                             type=TYPE_JSON,
                         )
                     )
-                return orders.collection
+                if next_token:
+                    query = request.url.components.query
+                    if query:  # check url for params
+                        params = {
+                            param.split("=")[0]: param.split("=")[1]
+                            for param in query.split("&")
+                        }
+                        params["next_token"] = token  # replace old token if exists
+                        updated_url = request.url.replace_query_params(**params)
+                    else:  # add if doesn't exist
+                        updated_url = request.url.include_query_params(token=token)
+
+                    collections.links.append(
+                        Link(href=str(updated_url), rel="next", type=TYPE_JSON)
+                    )
+                return collections
             case Failure(e):
                 logging.exception("An error occurred while retrieving orders", e)
                 raise HTTPException(

tests/test_order.py

@@ -196,9 +196,11 @@ def test_order_pagination(
     create_second_order_allowed_payloads: list[OrderPayload],
 ) -> None:
     product_backend._allowed_payloads = create_order_allowed_payloads
+    OLD_TOKEN = "a_token"
 
     # check empty
-    res = stapi_client.get("/orders", params={"next_token": "a", "limit": 1})
+    res = stapi_client.get("/orders")
+
     default_orders = {"type": "FeatureCollection", "features": [], "links": []}
 
     assert res.status_code == status.HTTP_200_OK
@@ -220,9 +222,17 @@ def test_order_pagination(
     )
 
     # call all orders
-    res = stapi_client.get("/orders", params={"next_token": "a", "limit": 1})
+    res = stapi_client.get("/orders", params={"next_token": OLD_TOKEN, "limit": 1})
     checker = res.json()
 
     assert res.status_code == status.HTTP_200_OK
-    assert len(checker["features"]) == 1
+
+    # temp check to make sure token link isn't added to inside collection
+    for link in checker["features"][1]["links"]:
+        assert link["rel"] != "next"
     assert checker["links"] != []
+
+    # check to make sure new token in link
+    assert OLD_TOKEN not in checker["links"][0]["href"]
+
+    assert len(checker["features"]) == 1