Rewrite for clarity, add test, edit news

Author: davisagli

news/1954.bugfix

@@ -1 +1 @@
-Fix search handler remove/ignore sort_order if present. @mamico
+In the `@search` service, fix a case where the `sort_order` parameter was ignored. @mamico, @davisagli

src/plone/restapi/search/handler.py

@@ -131,21 +131,19 @@ def filter_query(self, query):
                 bits = query["path"]["query"].split("/")[len(vhm_physical_path) :]
                 query["path"]["query"] = "/".join(bits) or "/"
 
-        default_sort_on = search_settings.sort_on
-
+        # Get default sort_on from registry if not specified in query
         if "sort_on" not in query:
-            if default_sort_on != "relevance":
-                query["sort_on"] = self.default_sort_on
-        elif query["sort_on"] == "relevance":
-            del query["sort_on"]
-
-        if not query.get("sort_order") and (
-            query.get("sort_on", "") == "Date"
-            or query.get("sort_on", "") == "effective"  # compatibility with Volto
-        ):
-            query["sort_order"] = "reverse"
-
-        if "sort_order" in query and not query["sort_order"]:
+            query["sort_on"] = search_settings.sort_on
+            # To rank by relevance, sort_on must be omitted
+            if query["sort_on"] == "relevance":
+                del query["sort_on"]
+
+        sort_on = query.get("sort_on")
+        # Remove sort_order if sort_on is not set
+        if not sort_on and "sort_order" in query:
             del query["sort_order"]
+        # Default to reverse sort_order if sort_on is a date
+        elif sort_on in ("Date", "effective") and not query.get("sort_order"):
+            query["sort_order"] = "reverse"
 
         return query

src/plone/restapi/tests/test_search.py

@@ -765,6 +765,19 @@ def test_search_use_site_search_settings_for_default_sort_order(self):
             "Other Document",
         )
 
+        response = self.api_session.get(
+            "/@search",
+            params={
+                "use_site_search_settings": 1,
+                "sort_on": "effective",
+                "sort_order": "reverse",
+            },
+        ).json()
+        self.assertEqual(
+            [item["title"] for item in response["items"]][0],
+            "Other Document",
+        )
+
     def test_search_use_site_search_settings_with_navigation_root(self):
 
         alsoProvides(self.folder, INavigationRoot)