add filter to item collection

Author: jonhealy1

CHANGELOG.md

@@ -10,7 +10,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- Sortby functionality to the item collection route. [#437](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/437)
+- Sort extension and sortby functionality to the item collection route. [#437](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/437)
+- Query extension and query functionality to the item collection route. [#437](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/437)
+- Filter extension and filter functionality to the item collection route. [#437](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/437)
 
 ### Changed
 

stac_fastapi/core/stac_fastapi/core/core.py

@@ -284,10 +284,13 @@ async def get_collection(
     async def item_collection(
         self,
         collection_id: str,
+        request: Request,
         bbox: Optional[BBox] = None,
         datetime: Optional[str] = None,
         limit: Optional[int] = None,
         sortby: Optional[str] = None,
+        filter_expr: Optional[str] = None,
+        filter_lang: Optional[str] = None,
         token: Optional[str] = None,
         query: Optional[str] = None,
         **kwargs,
@@ -300,6 +303,7 @@ async def item_collection(
 
         Args:
             collection_id (str): ID of the collection to list items from.
+            request (Request): FastAPI Request object.
             bbox (Optional[BBox]): Optional bounding box filter.
             datetime (Optional[str]): Optional datetime or interval filter.
             limit (Optional[int]): Optional page size. Defaults to env ``STAC_ITEM_LIMIT`` when unset.
@@ -308,16 +312,15 @@ async def item_collection(
                 imply ascending order.
             token (Optional[str]): Optional pagination token.
             query (Optional[str]): Optional query string.
-            **kwargs: Must include ``request`` (FastAPI Request).
+            filter_expr (Optional[str]): Optional filter expression.
+            filter_lang (Optional[str]): Optional filter language.
 
         Returns:
             ItemCollection: Feature collection with items, paging links, and counts.
 
         Raises:
             HTTPException: 404 if the collection does not exist.
         """
-        request: Request = kwargs["request"]
-
         try:
             await self.get_collection(collection_id=collection_id, request=request)
         except Exception:
@@ -333,6 +336,8 @@ async def item_collection(
             token=token,
             sortby=sortby,
             query=query,
+            filter_expr=filter_expr,
+            filter_lang=filter_lang,
         )
 
     async def get_item(
@@ -521,9 +526,14 @@ async def post_search(
                         search=search, op=operator, field=field, value=value
                     )
 
-        # only cql2_json is supported here
+        # Apply CQL2 filter (support both 'filter_expr' and canonical 'filter')
+        cql2_filter = None
         if hasattr(search_request, "filter_expr"):
             cql2_filter = getattr(search_request, "filter_expr", None)
+        if cql2_filter is None and hasattr(search_request, "filter"):
+            cql2_filter = getattr(search_request, "filter", None)
+
+        if cql2_filter is not None:
             try:
                 search = await self.database.apply_cql2_filter(search, cql2_filter)
             except Exception as e:

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py

@@ -132,6 +132,7 @@
         QueryExtension(
             conformance_classes=[QueryConformanceClasses.ITEMS],
         ),
+        filter_extension,
     ],
     request_type="GET",
 )

stac_fastapi/tests/api/test_api.py

@@ -1,3 +1,4 @@
+import json
 import os
 import random
 import uuid
@@ -1634,3 +1635,57 @@ async def test_item_collection_query(app_client, txn_client, ctx):
     resp_json = resp.json()
     ids = [f["id"] for f in resp_json["features"]]
     assert test_item["id"] in ids
+
+
+@pytest.mark.asyncio
+async def test_filter_by_id(app_client, ctx):
+    """Test filtering items by ID using the filter parameter."""
+    # Get the test item and collection from the context
+    item = ctx.item
+    collection_id = item["collection"]
+    item_id = item["id"]
+
+    # Create a filter to match the item by ID
+    filter_body = {"op": "=", "args": [{"property": "id"}, item_id]}
+
+    # Make the request with the filter
+    params = [("filter", json.dumps(filter_body)), ("filter-lang", "cql2-json")]
+
+    resp = await app_client.get(
+        f"/collections/{collection_id}/items",
+        params=params,
+    )
+
+    # Verify the response
+    assert resp.status_code == 200
+    resp_json = resp.json()
+
+    # Should find exactly one matching item
+    assert len(resp_json["features"]) == 1
+    assert resp_json["features"][0]["id"] == item_id
+    assert resp_json["features"][0]["collection"] == collection_id
+
+
+@pytest.mark.asyncio
+async def test_filter_by_nonexistent_id(app_client, ctx):
+    """Test filtering with a non-existent ID returns no results."""
+    collection_id = ctx.item["collection"]
+
+    # Create a filter with a non-existent ID
+    filter_body = {
+        "op": "=",
+        "args": [{"property": "id"}, "this-id-does-not-exist-12345"],
+    }
+
+    # Make the request with the filter
+    params = [("filter", json.dumps(filter_body)), ("filter-lang", "cql2-json")]
+
+    resp = await app_client.get(
+        f"/collections/{collection_id}/items",
+        params=params,
+    )
+
+    # Verify the response
+    assert resp.status_code == 200
+    resp_json = resp.json()
+    assert len(resp_json["features"]) == 0

stac_fastapi/tests/api/test_filters.py

@@ -0,0 +1,59 @@
+"""Tests for STAC API filter extension."""
+
+import json
+
+import pytest
+
+
+@pytest.mark.asyncio
+async def test_filter_by_id(app_client, ctx):
+    """Test filtering items by ID using the filter parameter."""
+    # Get the test item and collection from the context
+    item = ctx.item
+    collection_id = item["collection"]
+    item_id = item["id"]
+
+    # Create a filter to match the item by ID
+    filter_body = {"op": "=", "args": [{"property": "id"}, item_id]}
+
+    # Make the request with the filter
+    params = [("filter", json.dumps(filter_body)), ("filter-lang", "cql2-json")]
+
+    resp = await app_client.get(
+        f"/collections/{collection_id}/items",
+        params=params,
+    )
+
+    # Verify the response
+    assert resp.status_code == 200
+    resp_json = resp.json()
+
+    # Should find exactly one matching item
+    assert len(resp_json["features"]) == 1
+    assert resp_json["features"][0]["id"] == item_id
+    assert resp_json["features"][0]["collection"] == collection_id
+
+
+@pytest.mark.asyncio
+async def test_filter_by_nonexistent_id(app_client, ctx):
+    """Test filtering with a non-existent ID returns no results."""
+    collection_id = ctx.item["collection"]
+
+    # Create a filter with a non-existent ID
+    filter_body = {
+        "op": "=",
+        "args": [{"property": "id"}, "this-id-does-not-exist-12345"],
+    }
+
+    # Make the request with the filter
+    params = [("filter", json.dumps(filter_body)), ("filter-lang", "cql2-json")]
+
+    resp = await app_client.get(
+        f"/collections/{collection_id}/items",
+        params=params,
+    )
+
+    # Verify the response
+    assert resp.status_code == 200
+    resp_json = resp.json()
+    assert len(resp_json["features"]) == 0