DAGE-122: added escape function to SolrSearchEngine and applied when retrieving doc using the template

rre-tools/src/rre_tools/shared/search_engines/search_engine_base.py

@@ -9,11 +9,25 @@
 NUMBER_OF_DOCS_EACH_FETCH = 100
 
 class BaseSearchEngine(ABC):
+
+    SPECIAL_CHARS: set[str] = {'\\', '+', '-', '!', '(', ')', ':', '^', '[', ']', '"',
+                               '{', '}', '~', '*', '?', '|', '&', '/'}
+
     def __init__(self, endpoint: HttpUrl):
         self.endpoint = HttpUrl(endpoint)
         self.QUERY_PLACEHOLDER = "$query"
         self.UNIQUE_KEY = 'id'
 
+    @staticmethod
+    def escape(string: str) -> str:
+        """Escape special characters used in query syntax."""
+        sb = []
+        for c in string:
+            if c in BaseSearchEngine.SPECIAL_CHARS:
+                sb.append('\\')
+            sb.append(c)
+        return ''.join(sb)
+
     def fetch_all(self, doc_fields: List[str]) -> Iterator[Document]:
         """Extract all documents from search engine in batches.
 

rre-tools/src/rre_tools/shared/search_engines/solr_search_engine.py

@@ -110,7 +110,7 @@ def fetch_for_evaluation(self, query_template: Path | str, doc_fields: List[str]
 
         query_template = Path(query_template)
         payload: Dict[str, Any] = self._parse_query_template(query_template)
-        payload = self._replace_placeholder(payload, self.QUERY_PLACEHOLDER, keyword)
+        payload = self._replace_placeholder(payload, self.QUERY_PLACEHOLDER, self.escape(keyword))
         payload['fl'] = self._unify_fields(doc_fields)
 
         return self._search(payload)

rre-tools/tests/shared/search_engines/test_base_search_engine.py

@@ -0,0 +1,25 @@
+from rre_tools.shared.search_engines import BaseSearchEngine
+
+
+def test_escape_no_special_chars():
+    assert BaseSearchEngine.escape("hello world") == "hello world"
+
+def test_escape_basic_specials():
+    assert BaseSearchEngine.escape("a+b") == "a\\+b"
+    assert BaseSearchEngine.escape("field:value") == "field\\:value"
+    assert BaseSearchEngine.escape("(test)") == "\\(test\\)"
+
+def test_escape_multiple_specials():
+    assert BaseSearchEngine.escape("a+b-(c*d)?") == "a\\+b\\-\\(c\\*d\\)\\?"
+    assert BaseSearchEngine.escape("[range]~{json}") == "\\[range\\]\\~\\{json\\}"
+
+def test_escape_with_backslash():
+    assert BaseSearchEngine.escape("path\\to/file") == "path\\\\to\\/file"
+
+def test_escape_quotes():
+    assert BaseSearchEngine.escape('"phrase" AND title:book') == '\\"phrase\\" AND title\\:book'
+
+def test_escape_all_special_chars():
+    all_specials = r'\+-!():^[]"{}~*?|&/'
+    expected = ''.join(['\\' + c for c in all_specials])
+    assert BaseSearchEngine.escape(all_specials) == expected