add signals to trigger rule evaluation

Signed-off-by: tdruez <tdruez@aboutcode.org>

Author: tdruez

dje/admin.py

@@ -1245,14 +1245,16 @@ def get_fieldsets(self, request, obj=None):
             fields = [f"rule_{rule_type}_disabled", f"rule_{rule_type}_threshold"]
             for param_name in handler.parameters_schema:
                 fields.append(f"rule_{rule_type}_param_{param_name}")
-            rule_fieldsets.append((
-                handler.label,
-                {
-                    "fields": fields,
-                    "description": handler.description,
-                    "classes": ("grp-collapse grp-open",),
-                },
-            ))
+            rule_fieldsets.append(
+                (
+                    handler.label,
+                    {
+                        "fields": fields,
+                        "description": handler.description,
+                        "classes": ("grp-collapse grp-open",),
+                    },
+                )
+            )
         return rule_fieldsets
 
     def get_formset(self, request, obj=None, **kwargs):

policy/apps.py

@@ -13,3 +13,6 @@
 class PolicyConfig(AppConfig):
     name = "policy"
     verbose_name = _("Policy")
+
+    def ready(self):
+        import policy.signals  # noqa: F401

policy/engine.py

@@ -70,7 +70,9 @@ def evaluate_rules(product):
             # Explicitly resolve open violations so disabling a rule clears its history
             # rather than leaving stale unresolved records.
             ProductPolicyViolation.objects.filter(
-                rule_type=rule_type, product=product, resolved=False,
+                rule_type=rule_type,
+                product=product,
+                resolved=False,
             ).update(resolved=True, resolved_date=timezone.now())
             continue
 

policy/signals.py

@@ -0,0 +1,23 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# DejaCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: AGPL-3.0-only
+# See https://github.com/aboutcode-org/dejacode for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
+#
+
+import logging
+
+from django.db.models.signals import post_save
+from django.dispatch import receiver
+
+from policy.tasks import evaluate_product_rules_task
+
+logger = logging.getLogger(__name__)
+
+
+@receiver(post_save, sender="product_portfolio.Product")
+def evaluate_product_rules_on_save(sender, instance, **kwargs):
+    """Queue a policy rule evaluation whenever a product is saved."""
+    logger.debug(f"Queuing policy rule evaluation for product {instance.uuid}")
+    evaluate_product_rules_task.delay(product_uuid=instance.uuid)

policy/tasks.py

@@ -6,12 +6,16 @@
 # See https://aboutcode.org for more information about AboutCode FOSS projects.
 #
 
+import logging
+
 from django.apps import apps
 
 from django_rq import job
 
 from policy.engine import evaluate_rules
 
+logger = logging.getLogger(__name__)
+
 
 @job
 def evaluate_product_rules_task(product_uuid):
@@ -21,9 +25,12 @@ def evaluate_product_rules_task(product_uuid):
     try:
         product = Product.objects.select_related("dataspace").get(uuid=product_uuid)
     except Product.DoesNotExist:
+        logger.warning(f"evaluate_product_rules_task: product {product_uuid} not found, skipping.")
         return
 
-    evaluate_rules(product)
+    logger.info(f"Evaluating policy rules for product {product}")
+    violations = evaluate_rules(product)
+    logger.info(f"Policy rules evaluated for {product}: {len(violations)} active violation(s).")
 
 
 @job
@@ -35,5 +42,7 @@ def evaluate_all_products_rules_task(include_locked=False):
     if not include_locked:
         products = products.exclude_locked()
 
+    count = products.count()
+    logger.info(f"Queuing policy rule evaluation for {count} product(s).")
     for product in products:
         evaluate_product_rules_task.delay(product_uuid=product.uuid)

product_portfolio/views.py

@@ -2845,9 +2845,7 @@ def get_license_compliance_context(licenses, distribution_limit=10):
 
     @staticmethod
     def get_policy_compliance_context(product):
-        policy_violations = product.policy_violations.filter(resolved=False).select_related(
-            "policy_rule"
-        )
+        policy_violations = product.policy_violations.filter(resolved=False)
         return {
             "policy_violations": policy_violations,
             "policy_violation_count": policy_violations.count(),