Merge pull request #7 from maykinmedia/feature/add-logging

Add logging

Author: SilviaAmAm

backend/requirements/base.in

@@ -12,6 +12,7 @@ django-hijack
 django-redis
 django-rosetta
 maykin-2fa
+django-timeline-logger
 
 # API libraries
 djangorestframework

backend/requirements/base.txt

@@ -36,6 +36,7 @@ django==4.2.11
     # via
     #   -r requirements/base.in
     #   django-admin-index
+    #   django-appconf
     #   django-axes
     #   django-cors-headers
     #   django-formtools
@@ -49,13 +50,16 @@ django==4.2.11
     #   django-sendfile2
     #   django-simple-certmanager
     #   django-solo
+    #   django-timeline-logger
     #   django-two-factor-auth
     #   djangorestframework
     #   drf-spectacular
     #   maykin-2fa
     #   zgw-consumers
 django-admin-index==3.1.1
     # via -r requirements/base.in
+django-appconf==1.0.6
+    # via django-timeline-logger
 django-axes==6.4.0
     # via -r requirements/base.in
 django-cors-headers==4.3.1
@@ -84,6 +88,8 @@ django-simple-certmanager==2.0.0
     # via zgw-consumers
 django-solo==2.2.0
     # via zgw-consumers
+django-timeline-logger==4.0.0
+    # via -r requirements/base.in
 django-two-factor-auth[phonenumberslite,webauthn]==1.16.0
     # via maykin-2fa
 djangorestframework==3.15.1

backend/requirements/ci.txt

@@ -78,6 +78,7 @@ django==4.2.11
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   django-admin-index
+    #   django-appconf
     #   django-axes
     #   django-cors-headers
     #   django-formtools
@@ -92,6 +93,7 @@ django==4.2.11
     #   django-sendfile2
     #   django-simple-certmanager
     #   django-solo
+    #   django-timeline-logger
     #   django-two-factor-auth
     #   djangorestframework
     #   drf-spectacular
@@ -101,6 +103,11 @@ django-admin-index==3.1.1
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
+django-appconf==1.0.6
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   django-timeline-logger
 django-axes==6.4.0
     # via
     #   -c requirements/base.txt
@@ -168,6 +175,10 @@ django-solo==2.2.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   zgw-consumers
+django-timeline-logger==4.0.0
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
 django-two-factor-auth[phonenumberslite,webauthn]==1.16.0
     # via
     #   -c requirements/base.txt

backend/requirements/dev.txt

@@ -111,6 +111,7 @@ django==4.2.11
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-admin-index
+    #   django-appconf
     #   django-axes
     #   django-cors-headers
     #   django-debug-toolbar
@@ -127,6 +128,7 @@ django==4.2.11
     #   django-sendfile2
     #   django-simple-certmanager
     #   django-solo
+    #   django-timeline-logger
     #   django-two-factor-auth
     #   djangorestframework
     #   drf-spectacular
@@ -136,6 +138,11 @@ django-admin-index==3.1.1
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+django-appconf==1.0.6
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   django-timeline-logger
 django-axes==6.4.0
     # via
     #   -c requirements/ci.txt
@@ -209,6 +216,10 @@ django-solo==2.2.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   zgw-consumers
+django-timeline-logger==4.0.0
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
 django-two-factor-auth[phonenumberslite,webauthn]==1.16.0
     # via
     #   -c requirements/ci.txt

backend/src/openarchiefbeheer/conf/base.py

@@ -119,10 +119,12 @@
     "drf_spectacular",
     "zgw_consumers",
     "simple_certmanager",
+    "timeline_logger",
     # Project applications.
     "openarchiefbeheer.accounts",
     "openarchiefbeheer.destruction",
     "openarchiefbeheer.utils",
+    "openarchiefbeheer.logging",
 ]
 
 MIDDLEWARE = [

backend/src/openarchiefbeheer/destruction/api/serializers.py

@@ -5,6 +5,7 @@
 from rest_framework.exceptions import ValidationError
 
 from openarchiefbeheer.accounts.api.serializers import UserSerializer
+from openarchiefbeheer.logging import logevent
 
 from ..constants import ListItemStatus
 from ..models import DestructionList, DestructionListAssignee, DestructionListItem
@@ -58,7 +59,8 @@ def create(self, validated_data: dict) -> DestructionList:
         assignees_data = validated_data.pop("assignees")
         items_data = validated_data.pop("items")
 
-        validated_data["author"] = self.context["request"].user
+        author = self.context["request"].user
+        validated_data["author"] = author
         destruction_list = DestructionList.objects.create(**validated_data)
 
         DestructionListItem.objects.bulk_create(
@@ -77,4 +79,7 @@ def create(self, validated_data: dict) -> DestructionList:
         )
 
         destruction_list.assign(assignees[0])
+
+        logevent.destruction_list_created(destruction_list, author)
+
         return destruction_list

backend/src/openarchiefbeheer/destruction/api/viewsets.py

@@ -21,5 +21,4 @@ def get_permissions(self):
 
     @transaction.atomic
     def create(self, request, *args, **kwargs):
-        # TODO log creation
         return super().create(request, *args, **kwargs)

backend/src/openarchiefbeheer/destruction/tests/test_serializers.py

@@ -7,6 +7,7 @@
 
 from freezegun import freeze_time
 from rest_framework.test import APIRequestFactory
+from timeline_logger.models import TimelineLog
 
 from openarchiefbeheer.accounts.tests.factories import UserFactory
 from openarchiefbeheer.destruction.api.serializers import DestructionListSerializer
@@ -88,6 +89,17 @@ def test_create_destruction_list(self):
         self.assertEqual(sent_mail[0].subject, _("Destruction list review request"))
         self.assertEqual(sent_mail[0].recipients(), ["[email protected]"])
 
+        logs = TimelineLog.objects.filter(user=record_manager)
+
+        self.assertEqual(logs.count(), 1)
+
+        message = logs[0].get_message()
+
+        self.assertEqual(
+            message,
+            '[2024-05-02T16:00:00+02:00]: Destruction list "A test list" created by user record_manager.',
+        )
+
     def test_zaak_already_included_in_other_list(self):
         user1 = UserFactory.create(
             username="reviewer1", role__can_review_destruction=True

backend/src/openarchiefbeheer/logging/__init__.py

@@ -0,0 +1,21 @@
+from django.db.models import Model
+
+from timeline_logger.models import TimelineLog
+
+from openarchiefbeheer.accounts.models import User
+from openarchiefbeheer.destruction.models import DestructionList
+
+
+def _create_log(
+    model: Model, event: str, extra_data: dict | None = None, user: User | None = None
+) -> TimelineLog:
+    return TimelineLog.objects.create(
+        content_object=model,
+        template=f"logging/{event}.txt",
+        extra_data=extra_data,
+        user=user,
+    )
+
+
+def destruction_list_created(destruction_list: DestructionList, user: User) -> None:
+    _create_log(model=destruction_list, event="destruction_list_created", user=user)

backend/src/openarchiefbeheer/logging/logevent.py

@@ -0,0 +1,3 @@
+{% load i18n %}{% blocktranslate trimmed with timestamp=log.timestamp|date:"c" list_name=log.content_object.name user=log.user %}
+   [{{ timestamp }}]: Destruction list "{{ list_name }}" created by user {{ user }}.
+{% endblocktranslate %}