feat(projectHistoryLogs): project history logs for bulk actions TASK-1229

kobo/apps/audit_log/audit_actions.py

@@ -25,6 +25,7 @@ class AuditAction(models.TextChoices):
     REMOVE = 'remove'
     REPLACE_FORM = 'replace-form'
     UNARCHIVE = 'unarchive'
+    UNDELETE = 'undelete'
     UPDATE = 'update'
     UPDATE_CONTENT = 'update-content'
     UPDATE_NAME = 'update-name'

kobo/apps/audit_log/base_views.py

@@ -39,6 +39,7 @@ class AuditLoggedViewSet(viewsets.GenericViewSet):
     def initialize_request(self, request, *args, **kwargs):
         request = super().initialize_request(request, *args, **kwargs)
         request._request.log_type = self.log_type
+        request._request._data = request.data.copy()
         return request
 
     def get_object(self):

kobo/apps/audit_log/middleware.py

@@ -1,3 +1,5 @@
+from rest_framework import status
+
 from kobo.apps.audit_log.models import AuditType, ProjectHistoryLog
 
 
@@ -7,7 +9,10 @@ def create_audit_logs(request):
         if request.method in ['GET', 'HEAD']:
             return response
         log_type = getattr(request, 'log_type', None)
-        if log_type == AuditType.PROJECT_HISTORY:
+        if (
+            status.is_success(response.status_code) and
+            log_type == AuditType.PROJECT_HISTORY
+        ):
             ProjectHistoryLog.create_from_request(request)
         return response
 

kobo/apps/audit_log/models.py

@@ -335,13 +335,55 @@ def create_from_request(cls, request):
             'asset-file-list': cls.create_from_file_request,
             'asset-export-list': cls.create_from_export_request,
             'exporttask-list': cls.create_from_v1_export,
+            'asset-bulk': cls.create_from_bulk_request,
         }
         url_name = request.resolver_match.url_name
         method = url_name_to_action.get(url_name, None)
         if not method:
             return
         method(request)
 
+    @staticmethod
+    def create_from_bulk_request(request):
+        try:
+            payload = request._data['payload']
+            action = payload['action']
+            asset_uids = payload['asset_uids']
+        except KeyError:
+            return  # Incorrect payload
+
+        if type(asset_uids) is not list or len(asset_uids) == 0:  # Nothing to do
+            return
+
+        bulk_action_to_audit_action = {
+            'archive': AuditAction.ARCHIVE,
+            'unarchive': AuditAction.UNARCHIVE,
+            'delete': AuditAction.DELETE,
+            'undelete': AuditAction.UNDELETE,
+        }
+        audit_action = bulk_action_to_audit_action[action]
+        if audit_action is None:
+            return  # Unsupported action
+
+        source = get_human_readable_client_user_agent(request)
+        client_ip = get_client_ip(request)
+
+        for asset_uid in asset_uids:
+            asset = Asset.all_objects.get(uid=asset_uid)
+            object_id = asset.pk
+            metadata = {
+                'asset_uid': asset_uid,
+                'log_subtype': PROJECT_HISTORY_LOG_PROJECT_SUBTYPE,
+                'ip_address': client_ip,
+                'source': source,
+            }
+            ProjectHistoryLog.objects.create(
+                user=request.user,
+                object_id=object_id,
+                action=audit_action,
+                metadata=metadata,
+            )
+
     @staticmethod
     def create_from_deployment_request(request):
         audit_log_info = getattr(request, 'additional_audit_log_info', None)

kobo/apps/audit_log/tests/test_project_history_logs.py

@@ -8,6 +8,7 @@
 from ddt import data, ddt, unpack
 from django.test import override_settings
 from django.urls import reverse
+from rest_framework.response import Response
 from rest_framework.reverse import reverse as drf_reverse
 
 from kobo.apps.audit_log.audit_actions import AuditAction
@@ -90,6 +91,23 @@ def _base_project_history_log_test(
         self._check_common_metadata(log.metadata, expected_subtype)
         return log.metadata
 
+    def _make_bulk_request(self, asset_uids, action) -> Response:
+        """
+        Make a bulk action request for a list of asset uid's and an action name
+
+        asset_uids: [list_of_uids]
+        action: [archive, unarchive, delete, undelete]
+        """
+        payload = {
+            'payload': {
+                'asset_uids': asset_uids,
+                'action': action,
+            }
+        }
+        url = reverse(self._get_endpoint('asset-bulk'))
+        response = self.client.post(url, data=payload, format='json')
+        return response
+
     def test_first_time_deployment_creates_log(self):
         post_data = {
             'active': True,
@@ -862,3 +880,39 @@ def test_export_v1_creates_log(self):
         log = log_query.first()
         self._check_common_metadata(log.metadata, PROJECT_HISTORY_LOG_PROJECT_SUBTYPE)
         self.assertEqual(log.object_id, self.asset.id)
+
+    @data(
+        ('archive', AuditAction.ARCHIVE),
+        ('unarchive', AuditAction.UNARCHIVE),
+        ('undelete', AuditAction.UNDELETE),
+        ('delete', AuditAction.DELETE),
+    )
+    @unpack
+    def test_bulk_actions(self, bulk_action, audit_action):
+        assets = [Asset.objects.create(
+            content={
+                'survey': [
+                    {
+                        'type': 'text',
+                        'label': 'Question 1',
+                        'name': 'q1',
+                        '$kuid': 'abc',
+                    },
+                ]
+            },
+            owner=self.user,
+            asset_type='survey',
+        ) for i in range(0, 2)]
+        for asset in assets:
+            asset.deploy(backend='mock', active=True)
+
+        uids = [asset.uid for asset in assets]
+
+        if bulk_action == 'undelete':
+            self._make_bulk_request(uids, 'delete')
+
+        self._make_bulk_request(uids, bulk_action)
+        project_hist_logs = ProjectHistoryLog.objects.filter(
+            object_id__in=[asset.id for asset in assets], action=audit_action
+        )
+        self.assertEqual(project_hist_logs.count(), 2)

kobo/apps/hook/tasks.py

@@ -1,7 +1,6 @@
 # coding: utf-8
 import time
 
-import constance
 from celery import shared_task
 from django.conf import settings
 from django.core.mail import EmailMultiAlternatives, get_connection

kpi/serializers/v2/asset.py

@@ -130,8 +130,8 @@ def to_representation(self, instance):
         if delete_request:
             if put_back_:
                 message = nt(
-                    f'%(count)d project has been undeleted',
-                    f'%(count)d projects have been undeleted',
+                    '%(count)d project has been undeleted',
+                    '%(count)d projects have been undeleted',
                     instance['project_counts'],
                 ) % {'count': instance['project_counts']}
             else: