test sort collections

Author: jonhealy1

stac_fastapi/core/stac_fastapi/core/base_database_logic.py

@@ -1,7 +1,7 @@
 """Base database logic."""
 
 import abc
-from typing import Any, Dict, Iterable, List, Optional
+from typing import Any, Dict, Iterable, List, Optional, Tuple
 
 
 class BaseDatabaseLogic(abc.ABC):
@@ -14,9 +14,23 @@ class BaseDatabaseLogic(abc.ABC):
 
     @abc.abstractmethod
     async def get_all_collections(
-        self, token: Optional[str], limit: int
-    ) -> Iterable[Dict[str, Any]]:
-        """Retrieve a list of all collections from the database."""
+        self,
+        token: Optional[str],
+        limit: int,
+        request: Any = None,
+        sort: Optional[List[Dict[str, Any]]] = None,
+    ) -> Tuple[List[Dict[str, Any]], Optional[str]]:
+        """Retrieve a list of collections from the database, supporting pagination.
+
+        Args:
+            token (Optional[str]): The pagination token.
+            limit (int): The number of results to return.
+            request (Any, optional): The FastAPI request object. Defaults to None.
+            sort (Optional[List[Dict[str, Any]]], optional): Optional sort parameter. Defaults to None.
+
+        Returns:
+            A tuple of (collections, next pagination token if any).
+        """
         pass
 
     @abc.abstractmethod

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic.py

@@ -187,9 +187,7 @@ async def get_all_collections(
         Returns:
             A tuple of (collections, next pagination token if any).
         """
-        search_after = None
-        if token:
-            search_after = [token]
+        search_after = token
 
         formatted_sort = None
         if sort:
@@ -202,13 +200,22 @@ async def get_all_collections(
             # Always include id as a secondary sort to ensure consistent pagination
             formatted_sort.setdefault("id", {"order": "asc"})
 
+        # Use a collections-specific default sort that doesn't rely on properties.datetime
+        collections_default_sort = {"id": {"order": "asc"}}
+
+        # Build the search body step by step to avoid type errors
+        body = {
+            "sort": formatted_sort or collections_default_sort,
+            "size": limit,
+        }
+
+        # Only add search_after if we have a token
+        if search_after is not None:
+            body["search_after"] = search_after  # type: ignore
+
         response = await self.client.search(
             index=COLLECTIONS_INDEX,
-            body={
-                "sort": formatted_sort or DEFAULT_SORT,
-                "size": limit,
-                **({"search_after": search_after} if search_after is not None else {}),
-            },
+            body=body,
         )
 
         hits = response["hits"]["hits"]

stac_fastapi/opensearch/stac_fastapi/opensearch/database_logic.py

@@ -171,6 +171,7 @@ async def get_all_collections(
         Returns:
             A tuple of (collections, next pagination token if any).
         """
+        collections_default_sort = [{"id": {"order": "asc"}}]
         formatted_sort = []
         if sort:
             for item in sort:
@@ -182,7 +183,7 @@ async def get_all_collections(
             if not any("id" in item for item in formatted_sort):
                 formatted_sort.append({"id": {"order": "asc"}})
         else:
-            formatted_sort = [{"id": {"order": "asc"}}]
+            formatted_sort = collections_default_sort
 
         search_body = {
             "sort": formatted_sort,

stac_fastapi/tests/api/test_api_search_collections.py

@@ -0,0 +1,79 @@
+import uuid
+
+import pytest
+
+from ..conftest import create_collection
+
+
+@pytest.mark.asyncio
+async def test_collections_sort_id_asc(app_client, txn_client, load_test_data):
+    """Verify GET /collections honors ascending sort on id."""
+    # Create multiple collections with different ids
+    base_collection = load_test_data("test_collection.json")
+
+    # Create collections with ids in a specific order to test sorting
+    # Use unique prefixes to avoid conflicts between tests
+    test_prefix = f"asc-{uuid.uuid4().hex[:8]}"
+    collection_ids = [f"{test_prefix}-c", f"{test_prefix}-a", f"{test_prefix}-b"]
+
+    for i, coll_id in enumerate(collection_ids):
+        test_collection = base_collection.copy()
+        test_collection["id"] = coll_id
+        test_collection["title"] = f"Test Collection {i}"
+        await create_collection(txn_client, test_collection)
+
+    # Test ascending sort by id
+    resp = await app_client.get(
+        "/collections",
+        params=[("sortby", "+id")],
+    )
+    assert resp.status_code == 200
+    resp_json = resp.json()
+
+    # Filter collections to only include the ones we created for this test
+    test_collections = [
+        c for c in resp_json["collections"] if c["id"].startswith(test_prefix)
+    ]
+
+    # Collections should be sorted alphabetically by id
+    sorted_ids = sorted(collection_ids)
+    assert len(test_collections) == len(collection_ids)
+    for i, expected_id in enumerate(sorted_ids):
+        assert test_collections[i]["id"] == expected_id
+
+
+@pytest.mark.asyncio
+async def test_collections_sort_id_desc(app_client, txn_client, load_test_data):
+    """Verify GET /collections honors descending sort on id."""
+    # Create multiple collections with different ids
+    base_collection = load_test_data("test_collection.json")
+
+    # Create collections with ids in a specific order to test sorting
+    # Use unique prefixes to avoid conflicts between tests
+    test_prefix = f"desc-{uuid.uuid4().hex[:8]}"
+    collection_ids = [f"{test_prefix}-c", f"{test_prefix}-a", f"{test_prefix}-b"]
+
+    for i, coll_id in enumerate(collection_ids):
+        test_collection = base_collection.copy()
+        test_collection["id"] = coll_id
+        test_collection["title"] = f"Test Collection {i}"
+        await create_collection(txn_client, test_collection)
+
+    # Test descending sort by id
+    resp = await app_client.get(
+        "/collections",
+        params=[("sortby", "-id")],
+    )
+    assert resp.status_code == 200
+    resp_json = resp.json()
+
+    # Filter collections to only include the ones we created for this test
+    test_collections = [
+        c for c in resp_json["collections"] if c["id"].startswith(test_prefix)
+    ]
+
+    # Collections should be sorted in reverse alphabetical order by id
+    sorted_ids = sorted(collection_ids, reverse=True)
+    assert len(test_collections) == len(collection_ids)
+    for i, expected_id in enumerate(sorted_ids):
+        assert test_collections[i]["id"] == expected_id