feat: add filtering (#23)

* feat: add filtering

* feat: better filtering

Author: gadomski

pyproject.toml

@@ -11,7 +11,7 @@ dependencies = [
     "obstore>=0.6.0",
     "pydantic>=2.10.4",
     "pystac>=1.13.0",
-    "rustac==0.7.0b4",
+    "rustac==0.7.0b5",
     "stac-fastapi-api>=5.0.2",
     "stac-fastapi-extensions>=5.0.2",
     "stac-fastapi-types>=5.0.2",

src/stac_fastapi/geoparquet/api.py

@@ -11,6 +11,7 @@
 
 import stac_fastapi.api.models
 from stac_fastapi.api.app import StacApi
+from stac_fastapi.extensions.core.filter import SearchFilterExtension
 from stac_fastapi.extensions.core.pagination import OffsetPaginationExtension
 from stac_fastapi.types.search import BaseSearchPostRequest
 
@@ -23,12 +24,14 @@
 GetSearchRequestModel = stac_fastapi.api.models.create_request_model(
     model_name="SearchGetRequest",
     base_model=FixedSearchGetRequest,
+    extensions=[SearchFilterExtension()],
     mixins=[OffsetPaginationExtension().GET],
     request_type="GET",
 )
 PostSearchRequestModel = stac_fastapi.api.models.create_request_model(
     model_name="SearchPostRequest",
     base_model=BaseSearchPostRequest,
+    extensions=[SearchFilterExtension()],
     mixins=[OffsetPaginationExtension().POST],
     request_type="POST",
 )

src/stac_fastapi/geoparquet/client.py

@@ -164,7 +164,12 @@ def search(
         else:
             collections = list(hrefs.keys())
 
-        search_dict = search.model_dump(exclude_none=True)
+        search_dict = search.model_dump(exclude_none=True, by_alias=True)
+        kwargs.pop("filter_crs", None)
+        if filter_expr := kwargs.pop("filter_expr", None):
+            kwargs["filter"] = filter_expr
+        if "filter" not in kwargs:
+            kwargs.pop("filter_lang", None)
         search_dict.update(**kwargs)
 
         limit = search_dict.get("limit", DEFAULT_LIMIT)

tests/test_search.py

@@ -82,3 +82,49 @@ def test_multiple_collections(client: TestClient) -> None:
             (link for link in data["links"] if link["rel"] == "next"), None
         )
     assert len(items) == 20
+
+
+def test_filter(client: TestClient) -> None:
+    params = {"limit": 1, "filter": "naip:year='notayear'"}
+    response = client.get("/search", params=params)
+    response.raise_for_status()
+    assert not response.json()["features"]
+
+
+def test_filter_post(client: TestClient) -> None:
+    params = {
+        "limit": 1,
+        "filter": {"op": "=", "args": [{"property": "naip:year"}, "2022"]},
+    }
+    response = client.post("/search", json=params)
+    response.raise_for_status()
+    assert len(response.json()["features"]) == 1
+
+    params = {
+        "limit": 1,
+        "filter": {"op": "=", "args": [{"property": "naip:year"}, "notayear"]},
+    }
+    response = client.post("/search", json=params)
+    response.raise_for_status()
+    assert len(response.json()["features"]) == 0
+
+
+def test_paging_filter(client: TestClient) -> None:
+    params = {"limit": 1, "filter": "naip:year='2022'"}
+    response = client.get("/search", params=params)
+    assert response.status_code == 200
+    assert response.json()["features"][0]["id"] == "ne_m_4110264_sw_13_060_20220827"
+    next_link = next(
+        (link for link in response.json()["links"] if link["rel"] == "next")
+    )
+    url = urllib.parse.urlparse(next_link["href"])
+    assert urllib.parse.parse_qs(url.query) == {
+        "limit": ["1"],
+        "offset": ["1"],
+        "collections": ["naip,naip-10,openaerialmap-10,openaerialmap"],
+        "filter": ["naip:year='2022'"],
+        "filter_lang": ["cql2-text"],
+    }
+    response = client.get("/search", params=url.query)
+    assert response.status_code == 200
+    assert response.json()["features"][0]["id"] == "ne_m_4110263_sw_13_060_20220820"