From 6dae59b7da1fb7677d943c27708280713920887a Mon Sep 17 00:00:00 2001
From: big1hc <binh.nguyenthanh2@vn.bosch.com>
Date: Wed, 9 Aug 2023 19:02:20 +0700
Subject: [PATCH] bugfix in filter_needs

---
 docs/changelog.rst            |  2 ++
 sphinx_needs/filter_common.py | 15 ++++++++++++---
 2 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/docs/changelog.rst b/docs/changelog.rst
index b48e608c1..faa3fb33a 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -16,6 +16,8 @@ Released: under development
   for debugging purposes.
   (`#917 <https://github.com/useblocks/sphinx-needs/pull/917>`_)
 
+* Bugfix: Check filter strings for correctness.
+  (`#964 <https://github.com/useblocks/sphinx-needs/pull/964>`_)
 * Bugfix: Replace hardcoded `index` with config value `root_doc`.
   (`#877 <https://github.com/useblocks/sphinx-needs/pull/877>`_)
 * Bugfix: Fix unbounded memory usage in pickle environment.
diff --git a/sphinx_needs/filter_common.py b/sphinx_needs/filter_common.py
index 250bc40aa..5f7154314 100644
--- a/sphinx_needs/filter_common.py
+++ b/sphinx_needs/filter_common.py
@@ -274,6 +274,10 @@ def filter_needs(app: Sphinx, needs, filter_string: str = "", current_need=None)
     return found_needs
 
 
+def need_search(*args, **kwargs):
+    return bool(re.search(*args, **kwargs))
+
+
 @measure_time("filtering")
 def filter_single_need(
     app: Sphinx, need, filter_string: str = "", needs=None, current_need=None, filter_compiled=None
@@ -300,15 +304,20 @@ def filter_single_need(
     # Get needs external filter data and merge to filter_context
     filter_context.update(app.config.needs_filter_data)
 
-    filter_context["search"] = re.search
+    filter_context["search"] = need_search
     result = False
     try:
         # Set filter_context as globals and not only locals in eval()!
         # Otherwise, the vars not be accessed in list comprehensions.
         if filter_compiled:
-            result = bool(eval(filter_compiled, filter_context))
+            result = eval(filter_compiled, filter_context)
         else:
-            result = bool(eval(filter_string, filter_context))
+            result = eval(filter_string, filter_context)
+        if not isinstance(result, bool):
+            # Raises NeedsInvalidFilter if the result is a string type
+            raise NeedsInvalidFilter(
+                f"Error when evaluating filter: expected output to have True/False but got a string <{result}>"
+            )
     except Exception as e:
         raise NeedsInvalidFilter(f"Filter {filter_string} not valid. Error: {e}.")
     return result