feat: adding pagination for POST search_opportunities

Author: theodorehreuter

src/stapi_fastapi/backends/product_backend.py

@@ -16,7 +16,9 @@ async def search_opportunities(
         product_router: ProductRouter,
         search: OpportunityRequest,
         request: Request,
-    ) -> ResultE[list[Opportunity]]:
+        next: str | None,
+        limit: int,
+    ) -> ResultE[tuple[list[Opportunity], str]]:
         """
         Search for ordering opportunities for the  given search parameters.
 

src/stapi_fastapi/routers/product_router.py

@@ -165,27 +165,45 @@ def get_product(self, request: Request) -> Product:
         )
 
     async def search_opportunities(
-        self, search: OpportunityRequest, request: Request
+        self,
+        search: OpportunityRequest,
+        request: Request,
+        next: str | None = None,
+        limit: int = 10,
     ) -> OpportunityCollection:
         """
         Explore the opportunities available for a particular set of constraints
         """
-        match await self.product.backend.search_opportunities(self, search, request):
-            case Success(features):
-                return OpportunityCollection(
-                    features=features,
-                    links=[
-                        Link(  # current bug is missing method set and setting body for
+        match await self.product.backend.search_opportunities(
+            self, search, request, next, limit
+        ):
+            case Success((features, pagination_token)):
+                links = [
+                    Link(  # current bug is missing method set and setting body for
+                        href=str(
+                            request.url_for(
+                                f"{self.root_router.name}:{self.product.id}:create-order",
+                            ),
+                        ),
+                        rel="create-order",
+                        type=TYPE_JSON,
+                        method="POST",
+                    ),
+                ]
+                if pagination_token:
+                    links.append(
+                        Link(
                             href=str(
-                                request.url_for(
-                                    f"{self.root_router.name}:{self.product.id}:create-order",
-                                ),
+                                request.url.include_query_params(next=pagination_token)
                             ),
-                            rel="create-order",
+                            rel="next",
                             type=TYPE_JSON,
-                        ),
-                    ],
-                )
+                            method="POST",
+                            body=search,
+                        )
+                    )
+                    return OpportunityCollection(features=features, links=links)
+                return OpportunityCollection(features=features, links=links)
             case Failure(e) if isinstance(e, ConstraintsException):
                 raise e
             case Failure(e):

tests/application.py

@@ -113,19 +113,15 @@ async def search_opportunities(
             if limit > 100:
                 limit = 100
             if next:
-                start = self._opportunities.index(next)
+                start = int(next)
             end = min(start + limit, len(self._opportunities))
-            print(end)
-            # opportunities = self._opportunities.k
-            return Success(
-                (
-                    [
-                        o.model_copy(update=search.model_dump())
-                        for o in self._opportunities
-                    ],
-                    "",
-                )
-            )
+            opportunities = [
+                o.model_copy(update=search.model_dump())
+                for o in self._opportunities[start:end]
+            ]
+            if end < len(self._opportunities):
+                return Success((opportunities, str(end)))
+            return Success((opportunities, ""))
         except Exception as e:
             return Failure(e)
 

tests/conftest.py

@@ -186,3 +186,10 @@ def mock_test_spotlight_opportunities() -> list[Opportunity]:
             ),
         ),
     ]
+
+
+@pytest.fixture
+def mock_test_pagination_opportunities(
+    mock_test_spotlight_opportunities,
+) -> list[Opportunity]:
+    return [opp for opp in mock_test_spotlight_opportunities for __ in range(0, 3)]

tests/test_opportunity.py

@@ -2,6 +2,7 @@
 from typing import List
 
 import pytest
+from fastapi import status
 from fastapi.testclient import TestClient
 
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityCollection
@@ -27,7 +28,6 @@ def test_search_opportunities_response(
     start_string = rfc3339_strftime(start, format)
     end_string = rfc3339_strftime(end, format)
 
-    # Prepare the request payload
     request_payload = {
         "geometry": {
             "type": "Point",
@@ -43,13 +43,10 @@ def test_search_opportunities_response(
         },
     }
 
-    # Construct the endpoint URL using the `product_name` parameter
     url = f"/products/{product_id}/opportunities"
 
-    # Use POST method to send the payload
     response = stapi_client.post(url, json=request_payload)
 
-    # Validate response status and structure
     assert response.status_code == 200, f"Failed for product: {product_id}"
     body = response.json()
 
@@ -59,3 +56,45 @@ def test_search_opportunities_response(
         pytest.fail("response is not an opportunity collection")
 
     assert_link(f"POST {url}", body, "create-order", f"/products/{product_id}/orders")
+
+
+@pytest.mark.parametrize("product_id", ["test-spotlight"])
+def test_search_opportunities_pagination(
+    product_id: str,
+    stapi_client: TestClient,
+    product_backend: MockProductBackend,
+    mock_test_pagination_opportunities: List[Opportunity],
+) -> None:
+    product_backend._opportunities = mock_test_pagination_opportunities
+
+    now = datetime.now(UTC)
+    start = now
+    end = start + timedelta(days=5)
+    format = "%Y-%m-%dT%H:%M:%S.%f%z"
+    start_string = rfc3339_strftime(start, format)
+    end_string = rfc3339_strftime(end, format)
+
+    request_payload = {
+        "geometry": {
+            "type": "Point",
+            "coordinates": [0, 0],
+        },
+        "datetime": f"{start_string}/{end_string}",
+        "filter": {
+            "op": "and",
+            "args": [
+                {"op": ">", "args": [{"property": "off_nadir"}, 0]},
+                {"op": "<", "args": [{"property": "off_nadir"}, 45]},
+            ],
+        },
+    }
+
+    res = stapi_client.post(
+        f"/products/{product_id}/opportunities",
+        json=request_payload,
+        params={"next": None, "limit": 2},
+    )
+    body = res.json()  # noqa: F841
+
+    assert res.status_code == status.HTTP_200_OK
+    assert 1 == 2