Merge pull request #126 from kitconcept/kid/suggest-include-images

Suggest: include images by default

Author: reekitconcept

backend/news/+suggest-include-images.feature

@@ -0,0 +1 @@
+Suggestions include images by default: the results page finds images, so the type-ahead does too (team decision from the intranet ticket 570 review). The built-in exclusion list keeps only fragment/redirect types (Glossary, FAQ, Link). @reebalazs

backend/src/kitconcept/solr/services/suggest.py

@@ -54,9 +54,9 @@ def query_suggest(self, query):
         )
         extra_fq = extra_conditions.query_list()
         # An explicit type filter wins over the built-in exclusions:
-        # the exclusion list keeps noise (e.g. images) out of the
-        # default suggestions, but a user who filters for exactly such
-        # a type must see it.
+        # the exclusion list keeps fragment/redirect types (FAQ items,
+        # glossary entries, links) out of the default suggestions, but
+        # a user who filters for exactly such a type must see it.
         has_type_filter = any(
             row and row[0] in ("portal_type", "Type")
             for row in extra_conditions.config
@@ -66,8 +66,11 @@ def query_suggest(self, query):
             []
             if has_type_filter
             else [
+                # Images are deliberately NOT excluded: the results
+                # page finds them, so the type-ahead must too (team
+                # decision, intranet ticket 570 review).
                 (
-                    "-portal_type:Image -portal_type:Glossary -portal_type:FAQ "
+                    "-portal_type:Glossary -portal_type:FAQ "
                     "-portal_type:(FAQ Item) -portal_type:(FAQ Category) "
                     "-portal_type:Link"
                 )

backend/tests/services/suggest/test_suggest.py

@@ -50,6 +50,14 @@ def func(data, index: int) -> dict:
 class TestSuggestDefaultBaseSearch(TestSuggestDefault):
     url = "/@solr-suggest?query=chomsky"
     expected_result: ClassVar[list] = [
+        {
+            # images are suggested by default, like on the results page
+            "@id": "http://localhost:59793/plone/noamchomsky",
+            "@type": "Image",
+            "description": "",
+            "title": "Prof. Dr. Noam Chomsky",
+            "type_title": "Image",
+        },
         {
             "@id": "http://localhost:59793/plone/mydocument",
             "@type": "Document",
@@ -124,9 +132,10 @@ def test_only_filtered_type(self, get_suggest_result_path):
 
 
 class TestSuggestExtraConditionsTypeOverridesExclusion(TestSuggestDefault):
-    """An explicit type filter wins over the built-in type exclusion
-    list: Image is normally excluded from suggestions, but a user who
-    filters for images must see them."""
+    """An explicit type filter restricts the suggestions to the
+    selected type - for images that means only the image is left (and
+    for the types still on the built-in exclusion list, the filter
+    would override the exclusion)."""
 
     url = "/@solr-suggest?query=chomsky&extra_conditions=" + encode_conditions([
         ["portal_type", "string", {"in": ["Image"]}]
@@ -159,7 +168,11 @@ class TestSuggestExtraConditionsDateRange(TestSuggestDefault):
 
     def test_recent_content_kept(self, get_suggest_result_path):
         paths = [get_suggest_result_path(item) for item in self.data["suggestions"]]
-        assert paths == ["/plone/mydocument", "/plone/mynews"]
+        assert paths == [
+            "/plone/noamchomsky",
+            "/plone/mydocument",
+            "/plone/mynews",
+        ]
 
 
 class TestSuggestExtraConditionsDateRangePast(TestSuggestDefault):