♻️ [#502] Make filtering more robust to future changes

Author: SilviaAmAm

backend/src/openarchiefbeheer/destruction/destruction_report.py

@@ -2,13 +2,17 @@
 from typing import IO
 
 from django.utils import timezone
-from django.utils.translation import gettext
+from django.utils.translation import gettext as _
 
 import xlsxwriter
 from glom import glom
 from timeline_logger.models import TimelineLog
 from xlsxwriter.worksheet import Worksheet
 
+from openarchiefbeheer.logging.logevent import (
+    destruction_list_reviewed,
+    get_event_template,
+)
 from openarchiefbeheer.zaken.api.constants import ZAAK_METADATA_FIELDS_MAPPINGS
 
 from .constants import InternalStatus
@@ -23,15 +27,16 @@ def add_review_process_table(
         self, worksheet: Worksheet, start_row: int = 0
     ) -> None:
         column_names = [
-            gettext("Group"),
-            gettext("Name"),
-            gettext("Date/Time"),
-            gettext("Changes"),
+            _("Group"),
+            _("Name"),
+            _("Date/Time"),
+            _("Changes"),
         ]
         worksheet.write_row(start_row, 0, column_names)
 
         logs = TimelineLog.objects.for_object(self).filter(
-            template="logging/destruction_list_reviewed.txt", extra_data__approved=True
+            template=get_event_template(destruction_list_reviewed),
+            extra_data__approved=True,
         )
         for row_count, log in enumerate(logs):
             user_data = log.extra_data["user"]
@@ -45,7 +50,7 @@ def add_review_process_table(
                 ),
                 # This column is not useful, since we are filtering on approved reviews.
                 # But it was specifically requested.
-                gettext("Has approved"),
+                _("Has approved"),
             ]
             worksheet.write_row(start_row + row_count + 1, 0, data)
 
@@ -68,10 +73,8 @@ def add_zaken_table(self, worksheet: Worksheet, start_row: int = 0) -> None:
     def generate_destruction_report(self, file: IO) -> None:
         workbook = xlsxwriter.Workbook(file.name, options={"in_memory": False})
 
-        worksheet_zaken = workbook.add_worksheet(name=gettext("Deleted zaken"))
-        worksheet_review_process = workbook.add_worksheet(
-            name=gettext("Review process")
-        )
+        worksheet_zaken = workbook.add_worksheet(name=_("Deleted zaken"))
+        worksheet_review_process = workbook.add_worksheet(name=_("Review process"))
 
         self.add_zaken_table(worksheet_zaken)
         self.add_review_process_table(worksheet_review_process)

backend/src/openarchiefbeheer/logging/logevent.py

@@ -1,4 +1,5 @@
 import traceback
+from typing import Callable
 
 from django.db.models import Max, Min, Model
 
@@ -19,6 +20,8 @@
     format_zaaktype_choices,
 )
 
+TEMPLATE_FORMAT = "logging/%(event)s.txt"
+
 
 def _create_log(
     model: Model, event: str, extra_data: dict | None = None, user: User | None = None
@@ -34,7 +37,7 @@ def _create_log(
 
     return TimelineLog.objects.create(
         content_object=model,
-        template=f"logging/{event}.txt",
+        template=TEMPLATE_FORMAT % {"event": event},
         extra_data=extra_data,
         user=user,
     )
@@ -257,3 +260,7 @@ def resync_failed(exc: Exception) -> None:
     return TimelineLog.objects.create(
         template="logging/resync_failed.txt", extra_data={"error": error}
     )
+
+
+def get_event_template(logging_func: Callable) -> str:
+    return TEMPLATE_FORMAT % {"event": logging_func.__name__}