[tracer][api] Improve list functions filtering

* search report types by name
* order reports by name and time
* filter reports by type
* filter plots groups by methodology

Author: ao-picterra

src/picterra/tracer_client.py

@@ -167,6 +167,7 @@ def list_plots_groups(
         search: Optional[str] = None,
         page_number: Optional[int] = None,
         include_archived: bool = False,
+        methodology: Optional[str] = None
     ) -> ResultsPage:
         """
         List all the plots group the user can access, see `ResultsPage`
@@ -179,6 +180,7 @@ def list_plots_groups(
             search: The term used to filter by name
             page_number: Optional page (from 1) of the list we want to retrieve
             include_archived: If true, includes archived plot groups in the results
+            methodology: If not None, filters the groups by the methodology (eg "Coffee - EUDR")
 
         Returns:
             See https://app.picterra.ch/public/apidocs/plots_analysis/v1/#tag/plots-groups/operation/getPlotsGroupsList
@@ -190,6 +192,8 @@ def list_plots_groups(
             data["page_number"] = int(page_number)
         if include_archived:
             data["include_archived"] = include_archived
+        if methodology is not None:
+            data["methodology"] = methodology
         return self._return_results_page("plots_groups", data)
 
     def analyze_plots_precheck(
@@ -304,6 +308,8 @@ def list_plots_analysis_reports(
         plots_group_id: Optional[str] = None,
         page_number: Optional[int] = None,
         include_archived: bool = False,
+        search: Optional[str] = None,
+        report_type: Optional[str] = None,
     ) -> ResultsPage:
         """
         List all the reports belonging to a given plots analysis, see `ResultsPage`
@@ -314,6 +320,9 @@ def list_plots_analysis_reports(
             page_number: Optional page (from 1) of the list we want to retrieve
             include_archived: Defaults to false. If true, includes archived analysis reports in the
                               results
+            search: Optional term to search report types by name
+            report_type: Optional type of report to restrict the list by, use list_plots_analysis_report_types
+                to know which the available report types are
 
         Deprecated arguments:
             plots_group_id: ignored, do not provide it
@@ -329,6 +338,10 @@ def list_plots_analysis_reports(
             params["page_number"] = int(page_number)
         if include_archived:
             params["include_archived"] = include_archived
+        if search is not None:
+            params["search"] = search.strip()
+        if report_type is not None:
+            params["report_type"] = report_type
         return self._return_results_page(
             f"plots_analyses/{plots_analysis_id}/reports/", params
         )
@@ -337,12 +350,14 @@ def list_plots_analysis_report_types(
         self,
         plots_analysis_id: str,
         plots_group_id: Optional[str] = None,
+        search: Optional[str] = None,
     ) -> List[Dict[str, Any]]:
         """
         List all the plots analyses report types the user can use (see create_plots_analysis_report)
 
         Args:
             plots_analysis_id: id of the plots analysis
+            search: optional term to search report types by name, if any
 
         Deprecated arguments:
             plots_group_id: ignored, do not provide it
@@ -353,8 +368,12 @@ def list_plots_analysis_report_types(
         if plots_group_id is not None:
             warnings.warn("Passing plots_group_id is not needed anymore, remove it", DeprecationWarning)
 
+        params: Dict[str, Any] = {}
+        if search is not None:
+            params["search"] = search.strip()
         resp = self.sess.get(
-            self._full_url(f"plots_analyses/{plots_analysis_id}/reports/types/")
+            self._full_url(f"plots_analyses/{plots_analysis_id}/reports/types/"),
+            params=params
         )
         _check_resp_is_ok(resp, "Couldn't list report types")
         return resp.json()

tests/test_tracer_client.py

@@ -244,6 +244,10 @@ def test_list_plots_groups(monkeypatch):
     add_mock_paginated_list_response(url, 2, "m_2", "spam")
     plots_groups = client.list_plots_groups(search="m_2", page_number=2)
     assert plots_groups[0]["name"] == "spam_1"
+    # Filter list
+    add_mock_paginated_list_response(url, qs={"methodology": "cocoa"})
+    plots_groups = client.list_plots_groups(methodology="cocoa")
+    assert plots_groups[0]["name"] == "a_1"
 
 
 @responses.activate
@@ -301,13 +305,17 @@ def test_list_plots_analysis_reports(monkeypatch):
     reports = client.list_plots_analysis_reports("my-analysis-id")
     assert len(reports) == 3
     assert reports[0]["name"] == "a_1" and reports[-1]["name"] == "a_3"
+    # test search and filter
+    add_mock_paginated_list_response(url, qs={"report_type": "type_1", "search": "spam"})
+    reports = client.list_plots_analysis_reports("my-analysis-id", search="spam", report_type="type_1")
+    assert len(reports) == 2
 
 
 @responses.activate
 def test_list_plots_analysis_report_types(monkeypatch):
     client: TracerClient = _client(monkeypatch, platform="plots_analysis")
     url = plots_analysis_api_url("plots_analyses/my-analysis-id/reports/types/")
-    responses.get(
+    _add_api_response(
         url,
         json=[
             {"report_type": "type_1", "name": "a_1"},
@@ -319,6 +327,16 @@ def test_list_plots_analysis_report_types(monkeypatch):
     reports = client.list_plots_analysis_report_types("my-analysis-id")
     assert len(reports) == 4
     assert reports[0]["report_type"] == "type_1" and reports[-1]["name"] == "a_4"
+    _add_api_response(
+        url,
+        json=[
+            {"report_type": "type_1", "name": "a_1"},
+            {"report_type": "type_2", "name": "a_2"},
+        ],
+        match=responses.matchers.query_param_matcher({"search": "spam"})
+    )
+    reports = client.list_plots_analysis_report_types("my-analysis-id", search="spam")
+    assert len(reports) == 2
 
 
 @responses.activate

tests/utils.py

@@ -53,7 +53,15 @@ def plots_analysis_api_url(path):
     return urljoin(TEST_API_URL, urljoin("public/api/plots_analysis/v1/", path))
 
 
-def add_mock_paginated_list_response(endpoint: str, page: int = 1, search_string: str = None, name_prefix: str = "a", num_results: int = 2, include_archived: Optional[bool] = None):
+def add_mock_paginated_list_response(
+    endpoint: str,
+    page: int = 1,
+    search_string: str = None,
+    name_prefix: str = "a",
+    num_results: int = 2,
+    include_archived: Optional[bool] = None,
+    qs: Optional[dict] = None
+):
     curr, next = str(page), str(page + 1)
     data1 = {
         "count": num_results * num_results,
@@ -67,11 +75,12 @@ def add_mock_paginated_list_response(endpoint: str, page: int = 1, search_string
     qs_params = {"page_number": curr}
     if search_string:
         qs_params["search"] = search_string
+    if qs is not None:
+        qs_params.update(qs)
     if include_archived is not None:
         qs_params["include_archived"] = str(include_archived).lower()
     _add_api_response(
-        endpoint + "?page_number=" + curr + (("&search=" + search_string) if search_string else "") + (
-            "&include_archived=" + str(include_archived).lower() if include_archived is not None else ""),
+        endpoint,
         match=responses.matchers.query_param_matcher(qs_params),
         json=data1,
     )