wbcompliance 1.59.0__py2.py3-none-any.whl → 1.59.2__py2.py3-none-any.whl

wbcompliance/migrations/0022_riskincident_precheck.py

@@ -0,0 +1,39 @@
+# Generated by Django 5.0.12 on 2025-11-28 09:18
+
+from django.db import migrations, models
+import django.db.models.deletion
+from django.db.models import Exists, OuterRef
+
+
+def handle_data(apps, schema_editor):
+    CheckedObjectIncidentRelationship = apps.get_model('wbcompliance', 'CheckedObjectIncidentRelationship')
+    RiskIncident = apps.get_model('wbcompliance', 'RiskIncident')
+    CheckedObjectIncidentRelationship.objects.filter(incident__isnull=True).delete()
+    RiskIncident.objects.filter(checked_object_relationships__isnull=True).delete()
+    RiskIncident.objects.annotate(
+        is_precheck=Exists(CheckedObjectIncidentRelationship.objects.filter(incident=OuterRef("id"), rule_check__activator_id__isnull=False))
+    ).filter(is_precheck=True).update(precheck=True)
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('wbcompliance', '0021_riskcheck_passive_check'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='riskincident',
+            name='precheck',
+            field=models.BooleanField(default=False, help_text='If true, this incident was created during a precheck evaluation', verbose_name='Precheck Incident'),
+        ),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL IMMEDIATE;"),
+        migrations.RunPython(handle_data),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL DEFERRED;"),
+        migrations.AlterField(
+            model_name='checkedobjectincidentrelationship',
+            name='incident',
+            field=models.ForeignKey(default=None, on_delete=django.db.models.deletion.CASCADE,
+                                    related_name='checked_object_relationships', to='wbcompliance.riskincident'),
+            preserve_default=False,
+        ),
+    ]

wbcompliance/models/risk_management/checks.py

@@ -1,6 +1,7 @@
 from contextlib import suppress
+from datetime import date, timedelta
 from types import DynamicClassAttribute
-from typing import Self
+from typing import Any, Self
 
 from celery import shared_task
 from django.contrib.contenttypes.fields import GenericForeignKey
@@ -8,12 +9,14 @@ from django.contrib.contenttypes.models import ContentType
 from django.db import models
 from django.template import Context, Template
 from django.utils.translation import gettext_lazy as _
+from pandas._libs.tslibs.offsets import BDay
+from psycopg.types.range import DateRange
 from wbcore.contrib.color.enums import WBColor
 from wbcore.contrib.icons import WBIcon
 from wbcore.models import WBModel
 from wbcore.utils.models import ComplexToStringMixin
 
-from .incidents import CheckedObjectIncidentRelationship
+from .incidents import CheckedObjectIncidentRelationship, RiskIncident, RiskIncidentType
 
 
 class RiskCheckManager(models.Manager):
@@ -103,9 +106,13 @@ class RiskCheck(ComplexToStringMixin, WBModel):
             self.rule.checked_object_relationships.filter(
                 checked_object_content_type=self.checked_object_content_type, checked_object_id=self.checked_object_id
             ).exists()
-            or self.activator_id is not None
+            or self.precheck
         )
 
+    @property
+    def precheck(self) -> bool:
+        return self.activator_id is not None
+
     @property
     def previous_check(self) -> Self | None:
         """
@@ -130,6 +137,20 @@ class RiskCheck(ComplexToStringMixin, WBModel):
         self.checked_object_repr = str(self.checked_object)
         super().save(*args, **kwargs)
 
+    def delete(self, *args, **kwargs):
+        incidents = RiskIncident.all_objects.filter(
+            id__in=list(
+                CheckedObjectIncidentRelationship.objects.filter(rule_check_id=self.id).values_list(
+                    "incident", flat=True
+                )
+            )
+        )
+        super().delete(*args, **kwargs)
+        # ensure that incident without subincidents are deleted automatically
+        for incident in incidents:
+            if not incident.checked_object_relationships.exists():
+                incident.delete()
+
     def compute_str(self) -> str:
         return _("{} - {}").format(
             self.checked_object,
@@ -167,7 +188,7 @@ class RiskCheck(ComplexToStringMixin, WBModel):
                 # If the check is passive, we aggregated incident per breached object and return it for further processing
             if self.needs_incident:
                 report = report_template.render(Context({"report_details": incident_result.report_details}))
-                incident, created = self.rule.get_or_create_incident(
+                incident, created = self.get_or_create_incident(
                     self.evaluation_date,
                     incident_result.severity,
                     incident_result.breached_object,
@@ -195,6 +216,68 @@ class RiskCheck(ComplexToStringMixin, WBModel):
         self.save()
         return incidents
 
+    def get_or_create_incident(
+        self,
+        evaluation_date: date,
+        incident_severity: "RiskIncidentType",
+        breached_object: Any,
+        breached_object_repr: str,
+    ) -> tuple[RiskIncident, bool]:
+        """
+        Utility function to get or create incident base on the given breached object
+
+        Args:
+            evaluation_date: The incident date
+            incident_severity: The incident severity
+            breached_object: The breached object (i.e. the object that triggers the incident)
+            breached_object_repr: Its string representation
+
+        Returns:
+            A tuple (incident, is_created)
+        """
+
+        # Consider that if an incident happens one business day in the future or past, it is continue
+        date_range = DateRange(  # type: ignore
+            (evaluation_date - BDay(1)).date(), (evaluation_date + BDay(1)).date(), "[]"
+        )
+        incidents = RiskIncident.objects.filter(rule=self.rule, date_range__overlap=date_range, precheck=self.precheck)
+        if breached_object:
+            # If a breached_object is provided, we lookup over it
+            incidents = incidents.filter(
+                breached_content_type=ContentType.objects.get_for_model(breached_object),
+                breached_object_id=breached_object.id,
+            )
+        else:
+            # Otherwise, we lookup over its string representation. Might need to change as this is not very robust
+            incidents = incidents.filter(
+                breached_object_repr=breached_object_repr,
+            )
+        created = False
+        if incident := incidents.first():
+            incident.date_range = DateRange(  # type: ignore
+                lower=incident.date_range.lower, upper=(evaluation_date + timedelta(days=1))
+            )
+            incident.severity = incident_severity
+        else:
+            incident = RiskIncident(
+                rule=self.rule,
+                date_range=DateRange(lower=evaluation_date, upper=(evaluation_date + timedelta(days=1))),  # type: ignore
+                breached_content_type=ContentType.objects.get_for_model(breached_object) if breached_object else None,
+                breached_object_id=breached_object.id if breached_object else None,
+                breached_object_repr=breached_object_repr,
+                severity=incident_severity,
+                status=RiskIncident.Status.OPEN,
+            )
+            created = True
+
+        if self.rule.automatically_close_incident:
+            incident.status = RiskIncident.Status.CLOSED
+        elif self.precheck:
+            incident.status = RiskIncident.Status.IGNORED
+        incident.precheck = self.precheck
+        incident.save()
+        return incident, created
+
     class Meta:
         verbose_name = "Risk Check"
         verbose_name_plural = "Risk Checks"

wbcompliance/models/risk_management/incidents.py

@@ -112,9 +112,7 @@ class CheckedObjectIncidentRelationship(ComplexToStringMixin, RiskIncidentMixin)
     incident = models.ForeignKey(
         to="wbcompliance.RiskIncident",
         related_name="checked_object_relationships",
-        null=True,
-        blank=True,
-        on_delete=models.SET_NULL,
+        on_delete=models.CASCADE,
     )
 
     rule_check = models.ForeignKey(
@@ -248,8 +246,12 @@ class CheckedObjectIncidentRelationship(ComplexToStringMixin, RiskIncidentMixin)
 
 
 class RiskIncidentDefaultManager(models.Manager):
+    def __init__(self, only_passive_checks: bool = True):
+        self.only_passive_checks = only_passive_checks
+        super().__init__()
+
     def get_queryset(self):
-        return (
+        qs = (
             super()
             .get_queryset()
             .annotate(
@@ -259,6 +261,9 @@ class RiskIncidentDefaultManager(models.Manager):
                 ignore_until=TruncDate("ignore_until_time"),
             )
         )
+        if self.only_passive_checks:
+            qs = qs.filter(precheck=False)
+        return qs
 
 
 class RiskIncident(ComplexToStringMixin, RiskIncidentMixin):
@@ -297,6 +302,11 @@ class RiskIncident(ComplexToStringMixin, RiskIncidentMixin):
     ignore_duration = models.DurationField(
         blank=True, null=True, help_text=_("If set, will ignore the forthcoming incidents for the specified duration")
     )
+    precheck = models.BooleanField(
+        default=False,
+        verbose_name=_("Precheck Incident"),
+        help_text="If true, this incident was created during a precheck evaluation",
+    )
 
     def get_ignore_until_date(self) -> date | None:
         if self.last_ignored_date and self.ignore_duration:
@@ -367,6 +377,7 @@ class RiskIncident(ComplexToStringMixin, RiskIncidentMixin):
         return dict()
 
     objects = RiskIncidentDefaultManager()
+    all_objects = RiskIncidentDefaultManager(only_passive_checks=False)
 
     class Meta:
         verbose_name = "Risk Incident"

wbcompliance/models/risk_management/rules.py

@@ -22,7 +22,6 @@ from django.template.loader import get_template
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
 from pandas.tseries.offsets import BDay
-from psycopg.types.range import DateRange
 from rest_framework.reverse import reverse
 from wbcore.contrib.directory.models import Person
 from wbcore.contrib.guardian.models.mixins import PermissionObjectModelMixin
@@ -33,7 +32,7 @@ from wbcore.utils.rrules import convert_rrulestr_to_dict
 
 from .backend import AbstractRuleBackend
 from .checks import RiskCheck
-from .incidents import CheckedObjectIncidentRelationship, RiskIncident, RiskIncidentType
+from .incidents import CheckedObjectIncidentRelationship, RiskIncident
 
 User: BaseUser = get_user_model()
 
@@ -511,69 +510,6 @@ class RiskRule(PermissionObjectModelMixin, WBModel):
 
         return permissions
 
-    def get_or_create_incident(
-        self,
-        evaluation_date: date,
-        incident_severity: "RiskIncidentType",
-        breached_object: Any,
-        breached_object_repr: str,
-    ) -> tuple[RiskIncident, bool]:
-        """
-        Utility function to get or create incident base on the given breached object
-
-        Args:
-            rule:  The rule this incident happens
-            evaluation_date: The incident date
-            incident_severity: The incident severity
-            breached_object: The breached object (i.e. the object that triggers the incident)
-            breached_object_repr: Its string representation
-
-        Returns:
-            A tuple (incident, is_created)
-        """
-
-        # Consider that if an incident happens one business day in the future or past, it is continue
-        date_range = DateRange(  # type: ignore
-            (evaluation_date - BDay(1)).date(), (evaluation_date + BDay(1)).date(), "[]"
-        )
-        incidents = RiskIncident.objects.filter(rule=self, date_range__overlap=date_range)
-        if breached_object:
-            # If a breached_object is provided, we lookup over it
-            incidents = incidents.filter(
-                breached_content_type=ContentType.objects.get_for_model(breached_object),
-                breached_object_id=breached_object.id,
-            )
-        else:
-            # Otherwise, we lookup over its string representation. Might need to change as this is not very robust
-            incidents = incidents.filter(
-                breached_object_repr=breached_object_repr,
-            )
-        if incident := incidents.first():
-            incident.date_range = DateRange(
-                lower=incident.date_range.lower, upper=(evaluation_date + timedelta(days=1))
-            )  # type: ignore
-            if self.automatically_close_incident:
-                incident.status = RiskIncident.Status.CLOSED
-            incident.save()
-            return incident, False
-        else:
-            return (
-                RiskIncident.objects.create(
-                    rule=self,
-                    date_range=DateRange(lower=evaluation_date, upper=(evaluation_date + timedelta(days=1))),  # type: ignore
-                    breached_content_type=ContentType.objects.get_for_model(breached_object)
-                    if breached_object
-                    else None,
-                    breached_object_id=breached_object.id if breached_object else None,
-                    breached_object_repr=breached_object_repr,
-                    severity=incident_severity,
-                    status=RiskIncident.Status.CLOSED
-                    if self.automatically_close_incident
-                    else RiskIncident.Status.OPEN,
-                ),
-                True,
-            )
-
     def notify(self, evaluation_date: date):
         """
         Create the notification for this rule relationship and all implied persons
@@ -662,7 +598,7 @@ class RiskRule(PermissionObjectModelMixin, WBModel):
 def pre_save_risk_threshold(sender, instance, **kwargs):
     with suppress(RuleThreshold.DoesNotExist):
         pre_save_instance = RuleThreshold.objects.get(id=instance.id)
-        RiskIncident.objects.filter(rule=instance.rule, severity=pre_save_instance.severity).update(
+        RiskIncident.all_objects.filter(rule=instance.rule, severity=pre_save_instance.severity).update(
             severity=instance.severity
         )
         CheckedObjectIncidentRelationship.objects.filter(
@@ -672,7 +608,7 @@ def pre_save_risk_threshold(sender, instance, **kwargs):
 
 @receiver(pre_delete, sender="wbcompliance.RuleThreshold")
 def pre_delete_risk_threshold(sender, instance, **kwargs):
-    RiskIncident.objects.filter(rule=instance.rule, severity=instance.severity).delete()
+    RiskIncident.all_objects.filter(rule=instance.rule, severity=instance.severity).delete()
     CheckedObjectIncidentRelationship.objects.filter(incident__rule=instance.rule, severity=instance.severity).delete()
 
 

wbcompliance/tests/risk_management/models/test_incidents.py

@@ -85,7 +85,7 @@ class TestRiskIncidentFactory:
             (fake.date_object(), False),
         ],
     )
-    def test_get_or_create_incident(self, risk_rule, risk_incident_type, evaluation_date, is_breached_object):
+    def test_get_or_create_incident(self, risk_check, risk_incident_type, evaluation_date, is_breached_object):
         if is_breached_object:
             breached_object = get_anonymous_user()
             breached_object_repr = str(get_anonymous_user())
@@ -94,11 +94,11 @@ class TestRiskIncidentFactory:
             breached_object_repr = fake.text(max_nb_chars=125)
 
         assert not RiskIncident.objects.exists()
-        risk_rule.get_or_create_incident(evaluation_date, risk_incident_type, breached_object, breached_object_repr)
+        risk_check.get_or_create_incident(evaluation_date, risk_incident_type, breached_object, breached_object_repr)
         if breached_object:
             assert (
                 RiskIncident.objects.filter(
-                    rule=risk_rule,
+                    rule=risk_check.rule,
                     date_range__contains=evaluation_date,
                     breached_content_type=ContentType.objects.get_for_model(breached_object),
                     breached_object_id=breached_object.id,
@@ -108,19 +108,21 @@ class TestRiskIncidentFactory:
         else:
             assert (
                 RiskIncident.objects.filter(
-                    rule=risk_rule, date_range__contains=evaluation_date, breached_object_repr=breached_object_repr
+                    rule=risk_check.rule,
+                    date_range__contains=evaluation_date,
+                    breached_object_repr=breached_object_repr,
                 ).count()
                 == 1
             )
         assert RiskIncident.objects.count() == 1
         # Check if we reevaluate this incident one business day later, the incident is consider the same
-        risk_rule.get_or_create_incident(
+        risk_check.get_or_create_incident(
             (evaluation_date + BDay(1)).date(), risk_incident_type, breached_object, breached_object_repr
         )
         assert RiskIncident.objects.count() == 1
 
         # Check if we reevaluate this incident three business day later, the incident is consider the discontinue, and then a new incident is created
-        risk_rule.get_or_create_incident(
+        risk_check.get_or_create_incident(
             (evaluation_date + BDay(3)).date(), risk_incident_type, breached_object, breached_object_repr
         )
 
@@ -135,7 +137,7 @@ class TestRiskIncidentFactory:
         risk_incident.save()
         assert risk_incident.status == RiskIncident.Status.RESOLVED
         new_evaluation_date = subincident.rule_check.evaluation_date + timedelta(days=1)
-        incident, created = risk_incident.rule.get_or_create_incident(
+        incident, created = subincident.rule_check.get_or_create_incident(
             new_evaluation_date,
             subincident.severity,
             risk_incident.breached_content_object,

{wbcompliance-1.59.0.dist-info → wbcompliance-1.59.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wbcompliance
-Version: 1.59.0
+Version: 1.59.2
 Summary: A workbench module for managing compliance.
 Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
 Requires-Dist: wbcore

{wbcompliance-1.59.0.dist-info → wbcompliance-1.59.2.dist-info}/RECORD

@@ -47,6 +47,7 @@ wbcompliance/migrations/0018_alter_rulecheckedobjectrelationship_unique_together
 wbcompliance/migrations/0019_rulegroup_riskrule_activation_date_and_more.py,sha256=OZsIfILAl1u2dTLd_kffTov5US3HWOtkeoXyHodjQQ0,2011
 wbcompliance/migrations/0020_rename_trigger_content_type_riskcheck_checked_object_content_type_and_more.py,sha256=XZVSSrk-71tSp9_VO6M0S9jaFJy5azyJEMYvO7e_Ut8,3135
 wbcompliance/migrations/0021_riskcheck_passive_check.py,sha256=8P0ELPz-_UmnBOY_AyjkAtRJyXD9AOqYUhUB_9FW27Y,836
+wbcompliance/migrations/0022_riskincident_precheck.py,sha256=H2l9REAsogn7EsUMWcE_A7ldZ6QUZ9UnfhhJpioyyhk,1756
 wbcompliance/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbcompliance/models/__init__.py,sha256=gk3D0yZ3ZpJh1Nl-Kyc1PWm67t0Gj7t47Jl2xm9Lisk,534
 wbcompliance/models/compliance_form.py,sha256=6xWJ5cEt0mfNsZjLYXI8GcP1Jb4MsFsvPhtVITmE0yI,24879
@@ -55,11 +56,11 @@ wbcompliance/models/compliance_type.py,sha256=Euevn9BRt7_R7lv49kTDlkMoL1uTQuUKWn
 wbcompliance/models/enums.py,sha256=id1m8trG7b6Sw3Sa9VrLgD104GC2nG9A8ngJzaRqIIQ,424
 wbcompliance/models/risk_management/__init__.py,sha256=DJXoHheA5REDpPYP0uyRmFWyNKP-ir_z5YB61CN6N-E,247
 wbcompliance/models/risk_management/backend.py,sha256=pbszChXMxA36JjK0nIkrz0k7w9ImKUTGMVlokgA1R-w,4736
-wbcompliance/models/risk_management/checks.py,sha256=S9MkG3kmMzixx9bi2P2SEREj9b25dstiPeThGx6jeHI,8601
+wbcompliance/models/risk_management/checks.py,sha256=cVDSiHd41y0HBp6ujNvRqvWcruYmi_gByZdj3CEYMIA,12143
 wbcompliance/models/risk_management/dispatch.py,sha256=cLi63vSGbk9xhCoVgr4UmVk2kfYmGiyohKINSvCodb0,1423
-wbcompliance/models/risk_management/incidents.py,sha256=RNYjsFK87JLUByF4hcWk5W8eYL6sdlojfPuLdXCgYcE,23803
+wbcompliance/models/risk_management/incidents.py,sha256=4xKTDvhfruWJEZ7axgnKW2_sbUbtchjnLerjZVq4Uzg,24267
 wbcompliance/models/risk_management/mixins.py,sha256=KsdjpM1Cl235z8h57USVcYSBKtO2VRH1S0FCuJOEMH0,3762
-wbcompliance/models/risk_management/rules.py,sha256=u6Mo2jxojY1EEJ2-3TaAKB4OXz9s4AF8sQCE0wc0x8Q,28507
+wbcompliance/models/risk_management/rules.py,sha256=ra7XkBuDCPknTCamEIdRhxSs6Fo1P9tJnvhjTT7xZ8g,25660
 wbcompliance/serializers/__init__.py,sha256=OhRIuUrexqQePCISpu-BKry9dfioYGfpO8RwlcwhHtI,1122
 wbcompliance/serializers/compliance_form.py,sha256=OxPILlup_CP4Qwvu864oMqz7QUZsk2QOkOGFifWP3gM,11615
 wbcompliance/serializers/compliance_task.py,sha256=euTQya2LdexoRblew9zMkv40kU7wkW9nU2uLTI-lwow,17035
@@ -86,7 +87,7 @@ wbcompliance/tests/risk_management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQe
 wbcompliance/tests/risk_management/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbcompliance/tests/risk_management/models/test_backends.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbcompliance/tests/risk_management/models/test_checks.py,sha256=F4Pbn7q4PBmWx5fjvkwEclioG1mEt2M53maegSI9hYU,2467
-wbcompliance/tests/risk_management/models/test_incidents.py,sha256=wy7dkm1c2klnU_FUzDuz2i3oVWMbqoJ2zHiMTxQIbIY,15046
+wbcompliance/tests/risk_management/models/test_incidents.py,sha256=BYhBbD6M83poo5VrLzULG9xXpbtOlw9ObhzLwm31KAE,15107
 wbcompliance/tests/risk_management/models/test_rules.py,sha256=j3g2gK6SV0F9a7U2eh2bEzPLI2wtZZoueQpzH6NTxpw,11177
 wbcompliance/viewsets/__init__.py,sha256=JVv3mT5i-9dSYIC_lrvJqcFCPI92KQp9AZ21lR-eqEg,1498
 wbcompliance/viewsets/compliance_form.py,sha256=2DKB72gzHQ9W3P3n7Al50awVLhMKBfkEEUZeMHASfGw,17295
@@ -137,6 +138,6 @@ wbcompliance/viewsets/titles/risk_managment/checks.py,sha256=47DEQpj8HBSa-_TImW-
 wbcompliance/viewsets/titles/risk_managment/incidents.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbcompliance/viewsets/titles/risk_managment/rules.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbcompliance/viewsets/titles/risk_managment/tables.py,sha256=x_9mr6JWZ9GVNAEvfdNCeFZtGGYSG0-sXrR9pwTyocU,256
-wbcompliance-1.59.0.dist-info/METADATA,sha256=8RXxxWBjoI56DxAGyX25eIMnOEs3K2PE9mTgUdIUzWI,196
-wbcompliance-1.59.0.dist-info/WHEEL,sha256=aha0VrrYvgDJ3Xxl3db_g_MDIW-ZexDdrc_m-Hk8YY4,105
-wbcompliance-1.59.0.dist-info/RECORD,,
+wbcompliance-1.59.2.dist-info/METADATA,sha256=sJhCLSF5pLurkOr1QX4OWQ_FpidTrpJdF4gs1d8Tb-8,196
+wbcompliance-1.59.2.dist-info/WHEEL,sha256=aha0VrrYvgDJ3Xxl3db_g_MDIW-ZexDdrc_m-Hk8YY4,105
+wbcompliance-1.59.2.dist-info/RECORD,,