From 2295a29d81df9d9e0ca0f65e6e4f14a1f5cc357c Mon Sep 17 00:00:00 2001
From: Sergei Maertens <sergei@maykinmedia.nl>
Date: Tue, 18 Jun 2024 12:02:40 +0200
Subject: [PATCH] :recycle: Rename existing logic rule check

DMN action checks are also logic rule checks, so the collector function
and context variables are renamed to better cover what they actually
detect.
---
 src/openforms/emails/digest.py                |  6 ++--
 src/openforms/emails/tasks.py                 |  6 ++--
 .../emails/templates/emails/admin_digest.html | 10 +++----
 .../emails/tests/test_digest_functions.py     | 28 ++++++++++---------
 4 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/src/openforms/emails/digest.py b/src/openforms/emails/digest.py
index 1400a9944d..0b653c804c 100644
--- a/src/openforms/emails/digest.py
+++ b/src/openforms/emails/digest.py
@@ -124,7 +124,7 @@ def admin_link(self) -> str:
 
 
 @dataclass
-class InvalidLogicRule:
+class InvalidLogicVariable:
     variable: str
     form_name: str
     form_id: int
@@ -366,7 +366,7 @@ def collect_invalid_registration_backends() -> list[InvalidRegistrationBackend]:
     return invalid_registration_backends
 
 
-def collect_invalid_logic_rules() -> list[InvalidLogicRule]:
+def collect_invalid_logic_variables() -> list[InvalidLogicVariable]:
     forms = Form.objects.live().iterator()
     static_variables = {
         var.key: {"source": var.source, "type": var.data_type}
@@ -409,7 +409,7 @@ def collect_invalid_logic_rules() -> list[InvalidLogicRule]:
 
             def _report():
                 invalid_logic_rules.append(
-                    InvalidLogicRule(
+                    InvalidLogicVariable(
                         variable=var.key,
                         form_name=form.admin_name,
                         form_id=form.id,
diff --git a/src/openforms/emails/tasks.py b/src/openforms/emails/tasks.py
index d5a7bb15a5..0443b4987a 100644
--- a/src/openforms/emails/tasks.py
+++ b/src/openforms/emails/tasks.py
@@ -15,7 +15,7 @@
     collect_failed_prefill_plugins,
     collect_failed_registrations,
     collect_invalid_certificates,
-    collect_invalid_logic_rules,
+    collect_invalid_logic_variables,
     collect_invalid_registration_backends,
 )
 from .utils import send_mail_html
@@ -32,7 +32,7 @@ def get_context_data(self) -> dict[str, Any]:
         broken_configurations = collect_broken_configurations()
         invalid_certificates = collect_invalid_certificates()
         invalid_registration_backends = collect_invalid_registration_backends()
-        invalid_logic_rules = collect_invalid_logic_rules()
+        invalid_logic_variables = collect_invalid_logic_variables()
 
         return {
             "failed_emails": failed_emails,
@@ -41,7 +41,7 @@ def get_context_data(self) -> dict[str, Any]:
             "broken_configurations": broken_configurations,
             "invalid_certificates": invalid_certificates,
             "invalid_registration_backends": invalid_registration_backends,
-            "invalid_logic_rules": invalid_logic_rules,
+            "invalid_logic_variables": invalid_logic_variables,
         }
 
     def render(self) -> str:
diff --git a/src/openforms/emails/templates/emails/admin_digest.html b/src/openforms/emails/templates/emails/admin_digest.html
index fcbf162e63..4cb0e69ea4 100644
--- a/src/openforms/emails/templates/emails/admin_digest.html
+++ b/src/openforms/emails/templates/emails/admin_digest.html
@@ -110,7 +110,6 @@ <h5>{% trans "Found invalid certificates" %}</h5>
 {% if invalid_registration_backends %}
     <h5>{% trans "Registration backends problems" %}</h5>
     <ul>
-        <ul>
         {% for failed_backend in invalid_registration_backends %}
             <li>
                 <p>
@@ -130,18 +129,17 @@ <h5>{% trans "Registration backends problems" %}</h5>
     </ul>
 {% endif %}
 
-{% if invalid_logic_rules %}
+{% if invalid_logic_variables %}
     <h5>{% trans "Logic rules problems" %}</h5>
     <ul>
-        <ul>
-        {% for logic_rule in invalid_logic_rules %}
+        {% for problem in invalid_logic_variables %}
             <li>
                 <p>
-                    {% blocktranslate with var=logic_rule.variable form_name=logic_rule.form_name trimmed %}
+                    {% blocktranslate with var=problem.variable form_name=problem.form_name trimmed %}
                         Logic rule for variable '{{ var }}' is invalid in form '{{ form_name }}'.<br>
                     {% endblocktranslate %}
                 </p>
-                <p><a href="{{ logic_rule.admin_link }}">{% trans "View form" %}</a></p>
+                <p><a href="{{ problem.admin_link }}">{% trans "View form" %}</a></p>
             </li>
         {% endfor %}
     </ul>
diff --git a/src/openforms/emails/tests/test_digest_functions.py b/src/openforms/emails/tests/test_digest_functions.py
index 7d167859ed..2db49c57aa 100644
--- a/src/openforms/emails/tests/test_digest_functions.py
+++ b/src/openforms/emails/tests/test_digest_functions.py
@@ -36,13 +36,13 @@
 from stuf.stuf_bg.client import NoServiceConfigured
 
 from ..digest import (
-    InvalidLogicRule,
+    InvalidLogicVariable,
     collect_broken_configurations,
     collect_failed_emails,
     collect_failed_prefill_plugins,
     collect_failed_registrations,
     collect_invalid_certificates,
-    collect_invalid_logic_rules,
+    collect_invalid_logic_variables,
     collect_invalid_registration_backends,
 )
 from ..tasks import Digest
@@ -678,7 +678,7 @@ def test_valid_logic_rules_are_not_collected_and_not_logged(self):
             json_logic_trigger={"==": [{"var": "foo"}, "apple"]},
         )
 
-        invalid_logic_rules = collect_invalid_logic_rules()
+        invalid_logic_rules = collect_invalid_logic_variables()
 
         logs_exist = TimelineLogProxy.objects.exists()
 
@@ -714,7 +714,7 @@ def test_invalid_logic_rules_with_nested_key_are_only_logged(self):
         )
 
         with self.assertLogs() as logs:
-            collect_invalid_logic_rules()
+            collect_invalid_logic_variables()
 
         logs_messages = [log.getMessage() for log in logs.records]
 
@@ -773,51 +773,53 @@ def test_invalid_logic_rules_are_collected_and_not_logged(self):
         )
 
         with self.assertNoLogs():
-            invalid_logic_rules = collect_invalid_logic_rules()
+            invalid_logic_rules = collect_invalid_logic_variables()
 
         self.assertEqual(len(invalid_logic_rules), 8)
         self.assertIn(
-            InvalidLogicRule(
+            InvalidLogicVariable(
                 variable="temp", form_name=form.admin_name, form_id=form.id
             ),
             invalid_logic_rules,
         )
         self.assertIn(
-            InvalidLogicRule(
+            InvalidLogicVariable(
                 variable="fooStr.nested", form_name=form.admin_name, form_id=form.id
             ),
             invalid_logic_rules,
         )
         self.assertIn(
-            InvalidLogicRule(
+            InvalidLogicVariable(
                 variable="fooArray.bar", form_name=form.admin_name, form_id=form.id
             ),
             invalid_logic_rules,
         )
         self.assertIn(
-            InvalidLogicRule(
+            InvalidLogicVariable(
                 variable="foo.wrong", form_name=form.admin_name, form_id=form.id
             ),
             invalid_logic_rules,
         )
         self.assertIn(
-            InvalidLogicRule(
+            InvalidLogicVariable(
                 variable="temp.0.other", form_name=form.admin_name, form_id=form.id
             ),
             invalid_logic_rules,
         )
         self.assertIn(
-            InvalidLogicRule(
+            InvalidLogicVariable(
                 variable="another", form_name=form.admin_name, form_id=form.id
             ),
             invalid_logic_rules,
         )
         self.assertIn(
-            InvalidLogicRule(variable="", form_name=form.admin_name, form_id=form.id),
+            InvalidLogicVariable(
+                variable="", form_name=form.admin_name, form_id=form.id
+            ),
             invalid_logic_rules,
         )
         self.assertIn(
-            InvalidLogicRule(
+            InvalidLogicVariable(
                 variable="pie.filling", form_name=form.admin_name, form_id=form.id
             ),
             invalid_logic_rules,