Add vocabulary support for facet conditions (#63)

- Add useVocab/useVocabs hooks with VocabContext for caching and batched
  fetching
- Extend fieldList config to support vocabulary references (name,
  isMultilingual)
- Return vocabulary metadata from backend search endpoint
- Wire vocabulary labels into SearchConditions and SearchConditionsField
- Hide search prefix box for vocabulary-backed facet fields
- Fix useSelector rerenders in SolrSearchAutosuggest and routes
- Fix livesearch widget exception during text changes
- Fix test_services_navigation.py which used the wrong layer and
  corrupted ZODB state
- Add INSTRUCTIONS.md with documentation for vocabulary support and
  calculated fields
- Add tests for VocabContext, useVocab, useVocabs, and backend
  vocabulary parsing

Author: reekitconcept

CLAUDE.md

@@ -0,0 +1,3 @@
+# Instructions for using kitconcept.solr
+
+The file `./markdown-docs/INSTRUCTIONS.md` contains instructions for using kitconcept.solr in selected use cases. Refer to this file for more details.

backend/news/63.bugfix

@@ -0,0 +1 @@
+Fix test_services_navigation.py which used the wrong layer and corrupted ZODB state @reebalazs

backend/news/63.feature

@@ -0,0 +1 @@
+Add vocabulary support for facet conditions. @reebalazs

backend/src/kitconcept/solr/interfaces.py

@@ -17,7 +17,26 @@ class IKitconceptSolrLayer(IDefaultBrowserLayer):
     "properties": {
         "fieldList": {
             "type": "array",
-            "items": {"type": "string"},
+            "items": {
+                "oneOf": [
+                    {"type": "string"},
+                    {
+                        "type": "object",
+                        "properties": {
+                            "name": {"type": "string"},
+                            "vocabulary": {
+                                "type": "object",
+                                "properties": {
+                                    "name": {"type": "string"},
+                                    "isMultilingual": {"type": "boolean"},
+                                },
+                                "required": ["name"],
+                            },
+                        },
+                        "required": ["name"],
+                    },
+                ],
+            },
         },
         "searchTabs": {
             "type": "array",

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

@@ -253,6 +253,7 @@ def enhance_result(
             result.get("response", {}).get("docs", []),
             result.get("highlighting", {}),
         )
+        result["vocabularies"] = solr_config.vocabularies
         # Solr response is pruned of the unnecessary parts, unless explicitly requested.
         if not keep_full_solr_response:
             result.pop("facet_counts", None)

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

@@ -90,16 +90,33 @@ def select_condition(self, group_select: int) -> str:
         condition = filters[group_select]
         return f"{base_query}{condition}"
 
+    @staticmethod
+    def _field_name(item) -> str:
+        """Extract the field name from a fieldList item (string or dict)."""
+        if isinstance(item, dict):
+            return item["name"]
+        return item
+
     @property
     def field_list(self) -> str:
         raw_value = self.config.get("fieldList", [])
-        invalid_fields = [item for item in raw_value if "," in item]
+        names = [self._field_name(item) for item in raw_value]
+        invalid_fields = [name for name in names if "," in name]
         if invalid_fields:
             raise SolrConfigError(
                 "Error parsing solr config, fieldList item contains comma (,) "
                 "which is prohibited"
             )
-        return ",".join(raw_value)
+        return ",".join(names)
+
+    @property
+    def vocabularies(self) -> list:
+        raw_value = self.config.get("fieldList", [])
+        return [
+            {"field": item["name"], **item["vocabulary"]}
+            for item in raw_value
+            if isinstance(item, dict) and "vocabulary" in item
+        ]
 
     def select_layouts(self, group_select: int) -> list:
         return self.listOflayouts[group_select]

backend/tests/services/navigation/test_services_navigation.py

@@ -5,52 +5,70 @@
 from plone.dexterity.utils import createContentInContainer
 from plone.registry.interfaces import IRegistry
 from plone.restapi.bbb import INavigationSchema
-from plone.restapi.testing import PLONE_RESTAPI_DX_FUNCTIONAL_TESTING
+from kitconcept.solr.testing import FUNCTIONAL_TESTING
 from plone.restapi.testing import RelativeSession
 from zope.component import getUtility
 
 import transaction
 import unittest
 
 
+LANG = "en"
+
+
+def create(container, portal_type, **kw):
+    content = createContentInContainer(container, portal_type, **kw)
+    content.language = LANG
+    return content
+
+
 class TestServicesNavigation(unittest.TestCase):
-    layer = PLONE_RESTAPI_DX_FUNCTIONAL_TESTING
+    layer = FUNCTIONAL_TESTING
 
     def setUp(self):
         self.app = self.layer["app"]
         self.portal = self.layer["portal"]
         self.portal_url = self.portal.absolute_url()
         setRoles(self.portal, TEST_USER_ID, ["Manager"])
 
+        # Re-enable Folder type (disabled by plone.volto profile)
+        fti = self.portal.portal_types["Folder"]
+        fti.global_allow = True
+
+        # Ensure Folder is in displayed_types for navigation
+        registry = getUtility(IRegistry)
+        settings = registry.forInterface(INavigationSchema, prefix="plone")
+        displayed_types = settings.displayed_types
+        if "Folder" not in displayed_types:
+            settings.displayed_types = tuple(list(displayed_types) + ["Folder"])
+
         self.api_session = RelativeSession(self.portal_url, test=self)
         self.api_session.headers.update({"Accept": "application/json"})
         self.api_session.auth = (SITE_OWNER_NAME, SITE_OWNER_PASSWORD)
 
-        self.folder = createContentInContainer(
-            self.portal, "Folder", id="folder", title="Some Folder"
-        )
-        self.folder2 = createContentInContainer(
+        self.folder = create(self.portal, "Folder", id="folder", title="Some Folder")
+        self.folder2 = create(
             self.portal, "Folder", id="folder2", title="Some Folder 2"
         )
-        self.subfolder1 = createContentInContainer(
+        self.subfolder1 = create(
             self.folder, "Folder", id="subfolder1", title="SubFolder 1"
         )
-        self.subfolder2 = createContentInContainer(
+        self.subfolder2 = create(
             self.folder, "Folder", id="subfolder2", title="SubFolder 2"
         )
-        self.thirdlevelfolder = createContentInContainer(
+        self.thirdlevelfolder = create(
             self.subfolder1,
             "Folder",
             id="thirdlevelfolder",
             title="Third Level Folder",
         )
-        self.fourthlevelfolder = createContentInContainer(
+        self.fourthlevelfolder = create(
             self.thirdlevelfolder,
             "Folder",
             id="fourthlevelfolder",
             title="Fourth Level Folder",
         )
-        createContentInContainer(self.folder, "Document", id="doc1", title="A document")
+        create(self.folder, "Document", id="doc1", title="A document")
         transaction.commit()
 
     def tearDown(self):
@@ -93,13 +111,13 @@ def test_dont_broke_with_contents_without_review_state(self):
         settings = registry.forInterface(INavigationSchema, prefix="plone")
         displayed_types = settings.displayed_types
         settings.displayed_types = tuple(list(displayed_types) + ["File"])
-        createContentInContainer(
+        create(
             self.portal,
             "File",
             id="example-file",
             title="Example file",
         )
-        createContentInContainer(
+        create(
             self.folder,
             "File",
             id="example-file-1",
@@ -123,7 +141,7 @@ def test_show_excluded_items(self):
         # False for Plone 6.0 and True for Plone 5.2
         # explicitly set the value to False to avoid test failures
         settings.show_excluded_items = False
-        createContentInContainer(
+        create(
             self.folder,
             "Folder",
             id="excluded-subfolder",
@@ -161,13 +179,13 @@ def test_navigation_sorting(self):
             "Collection",
             "File",
         )
-        createContentInContainer(
+        create(
             self.portal,
             "File",
             id="example-file",
             title="Example file",
         )
-        createContentInContainer(
+        create(
             self.folder,
             "File",
             id="example-file-1",
@@ -208,7 +226,7 @@ def test_use_nav_title_when_available_and_set(self):
         title = "Example Document"
         nav_title = "Fancy title"
 
-        createContentInContainer(
+        create(
             self.folder,
             "DXTestDocument",
             id="example-dx-document",

backend/tests/services/vocabularies/test_vocabularies.py

@@ -0,0 +1,113 @@
+import pytest
+
+
+solr_config_with_vocabs = {
+    "fieldList": [
+        "UID",
+        {
+            "name": "Title",
+            "vocabulary": {
+                "name": "kitconcept.solr.vocabularies.test",
+                "isMultilingual": False,
+            },
+        },
+        "Description",
+        {
+            "name": "Type",
+            "vocabulary": {
+                "name": "kitconcept.solr.vocabularies.types",
+            },
+        },
+        "effective",
+        "start",
+        "created",
+        "end",
+        "path_string",
+        "phone",
+        "email",
+        "location",
+    ],
+    "searchTabs": [
+        {
+            "label": "All",
+            "filter": "Type(*)",
+        },
+        {
+            "label": "Pages",
+            "filter": "Type:(Page)",
+        },
+    ],
+}
+
+solr_config_no_vocabs = {
+    "fieldList": [
+        "UID",
+        "Title",
+        "Description",
+        "Type",
+        "effective",
+        "start",
+        "created",
+        "end",
+        "path_string",
+        "phone",
+        "email",
+        "location",
+    ],
+    "searchTabs": [
+        {
+            "label": "All",
+            "filter": "Type(*)",
+        },
+        {
+            "label": "Pages",
+            "filter": "Type:(Page)",
+        },
+    ],
+}
+
+
+class TestVocabulariesEndpoint:
+    @pytest.fixture(autouse=True)
+    def _init(self, portal_with_content, manager_request):
+        self.portal = portal_with_content
+        response = manager_request.get(self.url)
+        self.data = response.json()
+
+
+class TestVocabulariesInResponse(TestVocabulariesEndpoint):
+    url = "/@solr?q=chomsky"
+
+    @pytest.fixture()
+    def registry_config(self) -> dict:
+        return {
+            "collective.solr.active": 1,
+            "kitconcept.solr.config": solr_config_with_vocabs,
+        }
+
+    def test_vocabularies(self):
+        assert self.data.get("vocabularies") == [
+            {
+                "field": "Title",
+                "name": "kitconcept.solr.vocabularies.test",
+                "isMultilingual": False,
+            },
+            {
+                "field": "Type",
+                "name": "kitconcept.solr.vocabularies.types",
+            },
+        ]
+
+
+class TestVocabulariesEmptyInResponse(TestVocabulariesEndpoint):
+    url = "/@solr?q=chomsky"
+
+    @pytest.fixture()
+    def registry_config(self) -> dict:
+        return {
+            "collective.solr.active": 1,
+            "kitconcept.solr.config": solr_config_no_vocabs,
+        }
+
+    def test_vocabularies_empty(self):
+        assert self.data.get("vocabularies") == []

backend/tests/utils/test_utils.py

@@ -90,6 +90,34 @@ def test_field_list(self):
         )
 
 
+solr_config_with_dict_fields = {
+    **solr_config,
+    "fieldList": [
+        "UID",
+        {
+            "name": "Title",
+            "vocabulary": {
+                "name": "kitconcept.solr.vocabularies.test",
+                "isMultilingual": False,
+            },
+        },
+        "Description",
+        "Type",
+    ],
+}
+
+
+class TestUtilsFieldListWithDictFields(TestUtils):
+    @pytest.fixture()
+    def registry_config(self) -> dict:
+        return {
+            "kitconcept.solr.config": solr_config_with_dict_fields,
+        }
+
+    def test_field_list(self):
+        assert self.solr_config.field_list == "UID,Title,Description,Type"
+
+
 class TestUtilsSelectLayouts(TestUtils):
     def test_select_layouts(self):
         assert self.solr_config.select_layouts(0) is None