Convert bool filters to 0 or 1 when querying the search service

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Current (in progress)
 
-- Nothing yet
+- Convert bool filters to 0 or 1 when querying the search service [#3202](https://github.com/opendatateam/udata/pull/3202)
 
 ## 10.0.2 (2024-11-19)
 

udata/search/query.py

@@ -41,7 +41,12 @@ def execute_search(self):
             if self.sort:
                 url = url + f"&sort={self.sort}"
             for name, value in self._filters.items():
-                url = url + f"&{name}={value}"
+                param_value = value
+                # HACK: use the `.__class__.__name__` to avoid having to import `BoolFilter` here, as importing it at the top would make a import loop.
+                if self.adapter.filters[name].__class__.__name__ == "BoolFilter":
+                    # The search service uses 1 and 0 for booleans.
+                    param_value = 1 if value == "true" else 0
+                url = url + f"&{name}={param_value}"
             r = requests.get(url, timeout=current_app.config["SEARCH_SERVICE_REQUEST_TIMEOUT"])
             r.raise_for_status()
             result = r.json()

udata/tests/apiv2/test_datasets.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 
-from flask import url_for
+from flask import current_app, url_for
 
 import udata.core.organization.constants as org_constants
 from udata.core.dataset.apiv2 import DEFAULT_PAGE_SIZE
@@ -53,6 +53,8 @@ def test_search_dataset(self):
         _dataset_org = DatasetFactory(organization=org)
         dataset_org_public_service = DatasetFactory(organization=org_public_service)
 
+        # This is needed or the test will fail if you have a search service configured in your udata.cfg file.
+        current_app.config["SEARCH_SERVICE_API_URL"] = ""
         response = self.get(
             url_for("apiv2.dataset_search", organization_badge=org_constants.PUBLIC_SERVICE)
         )

udata/tests/dataset/test_dataset_tasks.py

@@ -1,4 +1,5 @@
 import pytest
+from flask import current_app
 
 from udata.core.dataset import tasks
 
@@ -22,6 +23,9 @@ def test_purge_datasets():
         Dataset.objects.create(title="keep me"),
     ]
 
+    # This is needed or the test will fail if you have a search service configured in your udata.cfg file.
+    current_app.config["SEARCH_SERVICE_API_URL"] = ""
+
     topic = Topic.objects.create(name="test topic", datasets=datasets)
 
     user = UserFactory()

udata/tests/search/test_query.py

@@ -1,3 +1,8 @@
+from unittest.mock import patch
+
+from flask import current_app
+
+from udata.core.dataset.search import DatasetSearch
 from udata.search.query import DEFAULT_PAGE_SIZE, SearchQuery
 from udata.tests.api import APITestCase
 
@@ -37,3 +42,29 @@ def test_search_query_to_url(self):
         search_query = SearchQuery(params=query)
         url = search_query.to_url()
         assert "organization=534fff81a3a7292c64a77e5c&q=insee&sort=-created&page=1" in url
+
+    @patch("requests.get")
+    # Mock udata.search.result.SearchResult, used in SearchQuery.execute_search.
+    @patch("udata.search.query.SearchResult")
+    def test_search_query_for_search_service(self, search_result_req, mock_req):
+        """When using the search service, boolean filters need to be converted to 0 or 1."""
+        current_app.config["SEARCH_SERVICE_API_URL"] = "http://example.com/"
+        query = {
+            "featured": "true",
+            "page": 1,
+            "page_size": 20,
+        }
+        search_query = SearchQuery(query)
+        search_query.adapter = DatasetSearch
+        search_query.execute_search()
+        mock_req.assert_called_with(
+            "http://example.com/datasets/?q=&page=1&page_size=20&featured=1", timeout=20
+        )
+
+        query["featured"] = "false"
+        search_query = SearchQuery(query)
+        search_query.adapter = DatasetSearch
+        search_query.execute_search()
+        mock_req.assert_called_with(
+            "http://example.com/datasets/?q=&page=1&page_size=20&featured=0", timeout=20
+        )