Log content and qa changes (#5203)

Author: rgraber

kobo/apps/audit_log/audit_actions.py

@@ -2,19 +2,21 @@
 
 
 class AuditAction(models.TextChoices):
+    ARCHIVE = 'archive'
+    AUTH = 'auth'
     CREATE = 'create'
     DELETE = 'delete'
+    DEPLOY = 'deploy'
+    DISABLE_SHARING = 'disable-sharing'
+    ENABLE_SHARING = 'enable-sharing'
     IN_TRASH = 'in-trash'
+    MODIFY_SHARING = 'modify_sharing'
     PUT_BACK = 'put-back'
+    REDEPLOY = 'redeploy'
     REMOVE = 'remove'
-    UPDATE = 'update'
-    AUTH = 'auth'
-    DEPLOY = 'deploy'
-    ARCHIVE = 'archive'
     UNARCHIVE = 'unarchive'
-    REDEPLOY = 'redeploy'
+    UPDATE = 'update'
+    UPDATE_CONTENT = 'update-content'
     UPDATE_NAME = 'update-name'
     UPDATE_SETTINGS = 'update-settings'
-    ENABLE_SHARING = 'enable-sharing'
-    DISABLE_SHARING = 'disable-sharing'
-    MODIFY_SHARING = 'modify_sharing'
+    UPDATE_QA = 'update-qa'

kobo/apps/audit_log/models.py

@@ -379,17 +379,15 @@ def create_from_detail_request(cls, request):
             'log_subtype': PROJECT_HISTORY_LOG_PROJECT_SUBTYPE,
             'ip_address': get_client_ip(request),
             'source': get_human_readable_client_user_agent(request),
+            'latest_version_uid': updated_data['latest_version.uid']
         }
 
-        # always store the latest version uid
-        common_metadata.update(
-            {'latest_version_uid': updated_data['latest_version.uid']}
-        )
-
         changed_field_to_action_map = {
             'name': cls.name_change,
             'settings': cls.settings_change,
             'data_sharing': cls.sharing_change,
+            'content': cls.content_change,
+            'advanced_features.qual.qual_survey': cls.qa_change,
         }
 
         for field, method in changed_field_to_action_map.items():
@@ -462,3 +460,15 @@ def sharing_change(old_fields, new_fields):
             shared_fields_dict[ADDED] = added_fields
             shared_fields_dict[REMOVED] = removed_fields
         return action, {'shared_fields': shared_fields_dict}
+
+    @staticmethod
+    def content_change(*_):
+        # content is too long/complicated for meaningful comparison,
+        # so don't store values
+        return AuditAction.UPDATE_CONTENT, {}
+
+    @staticmethod
+    def qa_change(_, new_field):
+        # qa dictionary is complicated to parse and determine
+        # what actually changed, so just return the new dict
+        return AuditAction.UPDATE_QA, {'qa': {NEW: new_field}}

kobo/apps/audit_log/tests/test_project_history_logs.py

@@ -1,5 +1,6 @@
 import copy
 
+import jsonschema.exceptions
 from django.test import override_settings
 from django.urls import reverse
 
@@ -375,3 +376,55 @@ def test_modify_sharing_creates_log(self):
         )
         self.assertEqual(log_metadata['shared_fields'][ADDED], ['q2'])
         self.assertEqual(log_metadata['shared_fields'][REMOVED], ['q1'])
+
+    def test_update_content_creates_log(self):
+        self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data={'content': {'some': 'thing'}},
+            expected_action=AuditAction.UPDATE_CONTENT,
+        )
+
+    def test_update_qa_creates_log(self):
+        request_data = {
+            'advanced_features': {
+                'qual': {
+                    'qual_survey': [
+                        {
+                            'type': 'qual_note',
+                            'uuid': '12345',
+                            'scope': 'by_question#survey',
+                            'xpath': 'q1',
+                            'labels': {'_default': 'QA Question'},
+                            # requests to remove a question just add this
+                            # option rather than actually deleting anything
+                            'options': {'deleted': True},
+                        }
+                    ]
+                }
+            }
+        }
+
+        log_metadata = self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data=request_data,
+            expected_action=AuditAction.UPDATE_QA,
+        )
+
+        self.assertEqual(
+                log_metadata['qa'][NEW],
+                request_data['advanced_features']['qual']['qual_survey'],
+        )
+
+    def test_failed_qa_update_does_not_create_log(self):
+        # badly formatted QA dict should result in an error before update
+        request_data = {'advanced_features': {'qual': {'qual_survey': ['bad']}}}
+        with self.assertRaises(jsonschema.exceptions.ValidationError):
+            self.client.patch(
+                reverse('api_v2:asset-detail', kwargs={'uid': self.asset.uid}),
+                data=request_data,
+                format='json',
+            )
+
+        self.assertEqual(ProjectHistoryLog.objects.count(), 0)

kpi/views/v2/asset.py

@@ -387,6 +387,8 @@ class AssetViewSet(
         'settings',
         'latest_version.uid',
         'data_sharing',
+        'content',
+        'advanced_features.qual.qual_survey',
     ]
     log_type = AuditType.PROJECT_HISTORY