Merge pull request #4498 from fecgov/feature/4491-sitewide-search-hotfix

[Adding to hotfix branch] Fix filter when results have `{` or `}`

fec/home/templatetags/filters.py

@@ -68,15 +68,22 @@ def web_app_url(path):
 
 @register.filter()
 def highlight_matches(text):
-    """Replaces the highlight markers with span tags for digitalgov search results"""
-    highlighted_text = text.replace('\ue000', '<span class="t-highlight">').replace('\ue001', '</span>')
+    """
+    Replaces the highlight markers with span tags for digitalgov search results.
+    Because format_html uses str.format, remove { and } because they are special characters.
+    """
+    cleaned_text = text.replace("{", "").replace("}", "")
+    highlighted_text = cleaned_text.replace(
+        "\ue000", '<span class="t-highlight">'
+    ).replace("\ue001", "</span>")
+
     return format_html(highlighted_text)
 
 
 @register.filter(name='splitlines')
 def splitlines(value):
     """
-        Returns the value turned into a list.
+    Returns the value turned into a list.
     """
     return value.splitlines()
 

fec/home/tests/test_filters.py

@@ -0,0 +1,23 @@
+from django.test import TestCase
+
+from home.templatetags.filters import highlight_matches
+
+
+class TestFilters(TestCase):
+
+    def test_highlight_matches(self):
+        text = '\ue000Highlighted\ue001 results'
+        highlighted_text = highlight_matches(text)
+        self.assertEqual(
+            highlighted_text,
+            '<span class="t-highlight">Highlighted</span> results'
+        )
+
+    def test_highlight_matches_with_brackets(self):
+        """highlight_matches should remove { and } from results"""
+        text = '\ue000Highlighted\ue001 {results}'
+        highlighted_text = highlight_matches(text)
+        self.assertEqual(
+            highlighted_text,
+            '<span class="t-highlight">Highlighted</span> results'
+        )