feat: add filter extension for items_collection (#77)

add the FilterExtension already available for the search endpoint to the
items endpoint

Author: jlahovnik

stac_fastapi/eodag/app.py

@@ -124,6 +124,7 @@
 itm_col_extensions_map = {
     "token": TokenPaginationExtension(),
     "sort": SortExtension(conformance_classes=[SortConformanceClasses.ITEMS]),
+    "filter": FilterExtension(client=FiltersClient(stac_metadata_model=stac_metadata_model)),
 }
 
 all_extensions = {

stac_fastapi/eodag/core.py

@@ -373,6 +373,8 @@ async def item_collection(
         limit: Optional[int] = None,
         page: Optional[str] = None,
         sortby: Optional[list[str]] = None,
+        filter_expr: Optional[str] = None,
+        filter_lang: Optional[str] = "cql2-text",
         **kwargs: Any,
     ) -> ItemCollection:
         """
@@ -386,6 +388,9 @@ async def item_collection(
         :param datetime: Date and time range to filter the items.
         :param limit: Maximum number of items to return.
         :param page: Page token for pagination.
+        :param sortby: List of fields to sort the results by.
+        :param filter_expr: CQL filter to apply to the search.
+        :param filter_lang: Language of the filter (default is "cql2-text").
         :param kwargs: Additional arguments.
         :returns: An ItemCollection.
         :raises NotFoundError: If the collection does not exist.
@@ -405,6 +410,9 @@ async def item_collection(
             sortby_converted = get_sortby_to_post(sortby)
             base_args["sortby"] = cast(Any, sortby_converted)
 
+        if filter_expr:
+            add_filter_to_args(base_args, filter_lang, filter_expr)
+
         clean = {}
         for k, v in base_args.items():
             if v is not None and v != []:
@@ -481,12 +489,7 @@ def get_search(
             base_args["datetime"] = format_datetime_range(datetime)
 
         if filter_expr:
-            if filter_lang == "cql2-text":
-                filter_expr = to_cql2(parse_cql2_text(filter_expr))
-                filter_lang = "cql2-json"
-
-            base_args["filter"] = str2json("filter_expr", filter_expr)
-            base_args["filter_lang"] = "cql2-json"
+            add_filter_to_args(base_args, filter_lang, filter_expr)
 
         # Remove None values from dict
         clean = {}
@@ -766,3 +769,18 @@ def eodag_search_next_page(dag, eodag_args):
         logger.info("StopIteration encountered during next page search.")
         search_result = SearchResult([])
     return search_result
+
+
+def add_filter_to_args(base_args: dict[str, Any], filter_lang: Optional[str], filter_expr: Optional[str]):
+    """Parse the filter from the query and add to arguments
+
+    :param base_args:
+    :param filter_expr: CQL filter to apply to the search.
+    :param filter_lang: Language of the filter (default is "cql2-text").
+    """
+    if filter_lang == "cql2-text":
+        filter_expr = to_cql2(parse_cql2_text(filter_expr))
+        filter_lang = "cql2-json"
+
+    base_args["filter"] = str2json("filter_expr", filter_expr)
+    base_args["filter_lang"] = "cql2-json"

tests/test_search.py

@@ -290,6 +290,61 @@ async def test_date_search_from_items(request_valid, defaults, use_dates):
     )
 
 
+async def test_filter_extension_items(request_valid, defaults, mock_search):
+    """Search through eodag server /items endpoint using the filter extension should return a valid response"""
+
+    # one parameter
+    expected_kwargs = {"sat:absolute_orbit": 1234}
+    await request_valid(
+        f"collections/{defaults.collection}/items?bbox={defaults.bbox_csv}&filter=sat:absolute_orbit=1234",
+        expected_search_kwargs=dict(
+            collection=defaults.collection,
+            token=None,
+            items_per_page=DEFAULT_ITEMS_PER_PAGE,
+            geom=defaults.bbox_wkt,
+            raise_errors=False,
+            count=False,
+            validate=True,
+            **expected_kwargs,
+        ),
+    )
+    mock_search.reset_mock()
+
+    # two parameters connected with 'and'
+    expected_kwargs = {"sat:absolute_orbit": 1234, "processing:level": "S2MSIL1C"}
+    filter_expr = "filter=sat:absolute_orbit=1234 AND processing:level='S2MSIL1C'"
+    await request_valid(
+        f"collections/{defaults.collection}/items?bbox={defaults.bbox_csv}&{filter_expr}",
+        expected_search_kwargs=dict(
+            collection=defaults.collection,
+            token=None,
+            items_per_page=DEFAULT_ITEMS_PER_PAGE,
+            geom=defaults.bbox_wkt,
+            raise_errors=False,
+            count=False,
+            validate=True,
+            **expected_kwargs,
+        ),
+    )
+    mock_search.reset_mock()
+
+    # with IN
+    expected_kwargs = {"instruments": ["MSI"]}
+    await request_valid(
+        f"collections/{defaults.collection}/items?bbox={defaults.bbox_csv}&filter=instruments IN ('MSI')",
+        expected_search_kwargs=dict(
+            collection=defaults.collection,
+            token=None,
+            items_per_page=DEFAULT_ITEMS_PER_PAGE,
+            geom=defaults.bbox_wkt,
+            raise_errors=False,
+            count=False,
+            validate=True,
+            **expected_kwargs,
+        ),
+    )
+
+
 @pytest.mark.parametrize(
     "sortby,expected_sort_by",
     [