Beccagraber/dev 1229 use advanced actions

kobo/apps/audit_log/models.py

@@ -19,6 +19,7 @@
     get_client_ip,
     get_human_readable_client_user_agent,
 )
+from kobo.apps.subsequences.constants import Action
 from kpi.constants import (
     ACCESS_LOG_LOGINAS_AUTH_TYPE,
     ACCESS_LOG_SUBMISSION_AUTH_TYPE,
@@ -404,6 +405,8 @@ def create_from_request(cls, request: WSGIRequest):
             'submissions-list': cls._create_from_submission_request,
             'submission-detail': cls._create_from_submission_request,
             'submission-supplement': cls._create_from_submission_extra_request,
+            'advanced-features-list': cls._create_from_question_advanced_feature_request, # noqa
+            'advanced-features-detail': cls._create_from_question_advanced_feature_request,  # noqa
         }
         url_name = request.resolver_match.url_name
         method = url_name_to_action.get(url_name, None)
@@ -787,6 +790,32 @@ def _create_from_permissions_request(cls, request):
             )
         ProjectHistoryLog.objects.bulk_create(logs)
 
+    @classmethod
+    def _create_from_question_advanced_feature_request(cls, request):
+        initial_data = getattr(request, 'initial_data', None)
+        updated_data = getattr(request, 'updated_data', None)
+        source_data = updated_data if updated_data else initial_data
+        asset_uid = request.resolver_match.kwargs['parent_lookup_asset']
+        if not source_data:
+            return
+        if source_data.get('action') != Action.QUAL:
+            return
+        owner = source_data.pop('asset.owner.username')
+        object_id = source_data.pop('object_id')
+        metadata = {
+            'asset_uid': asset_uid,
+            'log_subtype': PROJECT_HISTORY_LOG_PROJECT_SUBTYPE,
+            'ip_address': get_client_ip(request),
+            'source': get_human_readable_client_user_agent(request),
+            'project_owner': owner,
+        }
+        action = AuditAction.UPDATE_QA
+        metadata['qa'] = {PROJECT_HISTORY_LOG_METADATA_FIELD_NEW: source_data['params']}
+        user = get_database_user(request.user)
+        ProjectHistoryLog.objects.create(
+            user=user, object_id=object_id, action=action, metadata=metadata
+        )
+
     @classmethod
     def _create_from_v1_export(cls, request):
         updated_data = getattr(request, 'updated_data', None)

kobo/apps/audit_log/tests/test_project_history_logs.py

@@ -27,6 +27,8 @@
     remove_uuid_prefix,
 )
 from kobo.apps.openrosa.libs.utils.logger_tools import dict2xform
+from kobo.apps.subsequences.constants import Action
+from kobo.apps.subsequences.models import QuestionAdvancedFeature
 from kpi.constants import (
     ASSET_TYPE_TEMPLATE,
     CLONE_ARG_NAME,
@@ -589,6 +591,108 @@ def test_update_qa_creates_log(self):
             request_data['advanced_features']['_actionConfigs'],
         )
 
+    def test_add_qa_creates_log(self):
+        request_data = {
+            'action': 'qual',
+            'question_xpath': 'Audio',
+            'params': [
+                {
+                    'labels': {'_default': 'wherefore?'},
+                    'uuid': '12345',
+                    'type': 'qualText',
+                }
+            ],
+        }
+        metadata = self._base_project_history_log_test(
+            self.client.post,
+            reverse(
+                self._get_endpoint('advanced-features-list'), args=[self.asset.uid]
+            ),
+            request_data=request_data,
+            expected_action=AuditAction.UPDATE_QA,
+            expected_subtype=PROJECT_HISTORY_LOG_PROJECT_SUBTYPE,
+        )
+        self.assertEqual(metadata['qa']['new'], request_data['params'])
+
+    def test_failed_add_qa_does_not_create_log(self):
+        request_data = {
+            'action': 'qual',
+            'question_xpath': 'Audio',
+            'params': [{'bad': 'params'}],
+        }
+        self.client.post(
+            reverse(
+                self._get_endpoint('advanced-features-list'), args=[self.asset.uid]
+            ),
+            data=request_data,
+        )
+        self.assertEqual(ProjectHistoryLog.objects.count(), 0)
+
+    def test_add_other_advanced_feature_does_not_create_log(self):
+        request_data = {
+            'action': 'manual_transcription',
+            'question_xpath': 'Audio',
+            'params': [{'language': 'en'}],
+        }
+        self.client.post(
+            reverse(
+                self._get_endpoint('advanced-features-list'), args=[self.asset.uid]
+            ),
+            data=request_data,
+        )
+        self.assertEqual(ProjectHistoryLog.objects.count(), 0)
+
+    def test_modify_qa_creates_log(self):
+        question_qual_action = QuestionAdvancedFeature.objects.create(
+            asset=self.asset,
+            action=Action.QUAL,
+            question_xpath='q1',
+            params=[
+                {'labels': {'_default': 'why?'}, 'uuid': '12345', 'type': 'qualText'}
+            ],
+        )
+        request_data = {
+            'params': [
+                {
+                    'labels': {'_default': 'wherefore?'},
+                    'uuid': '12345',
+                    'type': 'qualText',
+                }
+            ]
+        }
+        metadata = self._base_project_history_log_test(
+            self.client.patch,
+            reverse(
+                self._get_endpoint('advanced-features-detail'),
+                args=[self.asset.uid, question_qual_action.uid],
+            ),
+            request_data=request_data,
+            expected_action=AuditAction.UPDATE_QA,
+            expected_subtype=PROJECT_HISTORY_LOG_PROJECT_SUBTYPE,
+        )
+        self.assertEqual(metadata['qa']['new'], request_data['params'])
+
+    def test_failed_modify_qa_does_not_create_log(self):
+        question_qual_action = QuestionAdvancedFeature.objects.create(
+            asset=self.asset,
+            action=Action.QUAL,
+            question_xpath='q1',
+            params=[
+                {'labels': {'_default': 'why?'}, 'uuid': '12345', 'type': 'qualText'}
+            ],
+        )
+        request_data = {'params': [{'bad': 'params'}]}
+        self.client.patch(
+            reverse(
+                self._get_endpoint('advanced-features-detail'),
+                args=[self.asset.uid, question_qual_action.uid],
+            ),
+            request_data=request_data,
+            expected_action=AuditAction.UPDATE_QA,
+            expected_subtype=PROJECT_HISTORY_LOG_PROJECT_SUBTYPE,
+        )
+        self.assertEqual(ProjectHistoryLog.objects.count(), 0)
+
     @data(True, False)
     def test_register_service_creates_log(self, use_v2):
         request_data = {

kobo/apps/subsequences/actions/base.py

@@ -458,6 +458,17 @@ def run_external_process(
         """
         raise NotImplementedError
 
+    def update_params(self, incoming_params):
+        """
+        Returns the result of updating current params with incoming ones from
+        a request. May be overridden, eg, to prevent deletion of existing lanugages
+        for transcriptions/translations
+        Defaults to replacing the existing params with the new ones.
+        Should raise an error if the incoming params are not well-formatted
+        """
+        self.validate_params(incoming_params)
+        self.params = incoming_params
+
     def _inject_data_schema(self, destination_schema: dict, skipped_keys: list):
         raise Exception('This method is going away')
         """
@@ -594,6 +605,13 @@ def languages(self) -> list[str]:
             languages.append(individual_params['language'])
         return languages
 
+    def update_params(self, incoming_params):
+        self.validate_params(incoming_params)
+        current_languages = self.languages
+        for language_obj in incoming_params:
+            if language_obj['language'] not in current_languages:
+                self.params.append(language_obj)
+
 
 class BaseAutomaticNLPAction(BaseManualNLPAction):
     """

kobo/apps/subsequences/constants.py

@@ -1,3 +1,5 @@
+from django.db import models
+
 SUBMISSION_UUID_FIELD = 'meta/rootUuid'  # FIXME: import from elsewhere
 SUPPLEMENT_KEY = '_supplementalDetails'  # leave unchanged for backwards compatibility
 
@@ -20,3 +22,11 @@
     '20250820',
     None
 ]
+
+
+class Action(models.TextChoices):
+    MANUAL_TRANSCRIPTION = 'manual_transcription'
+    MANUAL_TRANSLATION = 'manual_translation'
+    AUTOMATIC_GOOGLE_TRANSLATION = 'automatic_google_translation'
+    AUTOMATIC_GOOGLE_TRANSCRIPTION = 'automatic_google_transcription'
+    QUAL = 'qual'

kobo/apps/subsequences/docs/api/v2/subsequences/create.md

@@ -0,0 +1,74 @@
+## Add an advanced action to an asset
+
+Enables a new type of advanced action on a question in the asset.
+* `action`, `params`, and `question_xpath` are required
+* `params` must match the expected param_schema of the `action`
+
+Accepted `action`s include:
+* `manual_transcription`
+* `automatic_google_transcription`
+* `manual_translation`
+* `automatic_google_translation`
+* `qual`
+
+For all actions except `qual`, `params` must look like
+> '[{"language": "es"}, {"language": "en"}, ...]'
+
+For `qual`, `params` must look like
+```
+   [
+        {
+            'type': 'qualInteger',
+            'uuid': '1a2c8eb0-e2ec-4b3c-942a-c1a5410c081a',
+            'labels': {'_default': 'How many characters appear in the story?'},
+        },
+        {
+            'type': 'qualSelectMultiple',
+            'uuid': '2e30bec7-4843-43c7-98bc-13114af230c5',
+            'labels': {'_default': "What themes were present in the story?"},
+            'choices': [
+                {
+                    'uuid': '2e24e6b4-bc3b-4e8e-b0cd-d8d3b9ca15b6',
+                    'labels': {'_default': 'Empathy'},
+                },
+                {
+                    'uuid': 'cb82919d-2948-4ccf-a488-359c5d5ee53a',
+                    'labels': {'_default': 'Competition'},
+                },
+                {
+                    'uuid': '8effe3b1-619e-4ada-be45-ebcea5af0aaf',
+                    'labels': {'_default': 'Apathy'},
+                },
+            ],
+        },
+        {
+            'type': 'qualSelectOne',
+            'uuid': '1a8b748b-f470-4c40-bc09-ce2b1197f503',
+            'labels': {'_default': 'Was this a first-hand account?'},
+            'choices': [
+                {
+                    'uuid': '3c7aacdc-8971-482a-9528-68e64730fc99',
+                    'labels': {'_default': 'Yes'},
+                },
+                {
+                    'uuid': '7e31c6a5-5eac-464c-970c-62c383546a94',
+                    'labels': {'_default': 'No'},
+                },
+            ],
+        },
+        {
+            'type': 'qualTags',
+            'uuid': 'e9b4e6d1-fdbb-4dc9-8b10-a9c3c388322f',
+            'labels': {'_default': 'Tag any landmarks mentioned in the story'},
+        },
+        {
+            'type': 'qualText',
+            'uuid': '83acf2a7-8edc-4fd8-8b9f-f832ca3f18ad',
+            'labels': {'_default': 'Add any further remarks'},
+        },
+        {
+            'type': 'qualNote',
+            'uuid': '5ef11d48-d7a3-432e-af83-8c2e9b1feb72',
+            'labels': {'_default': 'Thanks for your diligence'},
+        },
+    ]```

kobo/apps/subsequences/docs/api/v2/subsequences/list.md

@@ -0,0 +1,3 @@
+## List all advanced features on an asset
+
+Lists all advanced features on all questions in an asset

kobo/apps/subsequences/docs/api/v2/subsequences/retrieve.md

@@ -0,0 +1,3 @@
+## Retrieve advanced feature configuration for a question on an asset
+
+Gets the params for one advanced action for one question in an asset

kobo/apps/subsequences/docs/api/v2/subsequences/update.md

@@ -0,0 +1,67 @@
+## Update an advanced action on an asset
+
+Update the params of an advanced action on a question in the asset.
+* `params` is required
+* `params` must match the expected param_schema of the action being updated
+
+For all actions except `qual`, `params` must look like
+> '[{"language": "es"}, {"language": "en"}, ...]'
+
+For `qual`, `params` must look like
+```
+   [
+        {
+            'type': 'qualInteger',
+            'uuid': '1a2c8eb0-e2ec-4b3c-942a-c1a5410c081a',
+            'labels': {'_default': 'How many characters appear in the story?'},
+        },
+        {
+            'type': 'qualSelectMultiple',
+            'uuid': '2e30bec7-4843-43c7-98bc-13114af230c5',
+            'labels': {'_default': "What themes were present in the story?"},
+            'choices': [
+                {
+                    'uuid': '2e24e6b4-bc3b-4e8e-b0cd-d8d3b9ca15b6',
+                    'labels': {'_default': 'Empathy'},
+                },
+                {
+                    'uuid': 'cb82919d-2948-4ccf-a488-359c5d5ee53a',
+                    'labels': {'_default': 'Competition'},
+                },
+                {
+                    'uuid': '8effe3b1-619e-4ada-be45-ebcea5af0aaf',
+                    'labels': {'_default': 'Apathy'},
+                },
+            ],
+        },
+        {
+            'type': 'qualSelectOne',
+            'uuid': '1a8b748b-f470-4c40-bc09-ce2b1197f503',
+            'labels': {'_default': 'Was this a first-hand account?'},
+            'choices': [
+                {
+                    'uuid': '3c7aacdc-8971-482a-9528-68e64730fc99',
+                    'labels': {'_default': 'Yes'},
+                },
+                {
+                    'uuid': '7e31c6a5-5eac-464c-970c-62c383546a94',
+                    'labels': {'_default': 'No'},
+                },
+            ],
+        },
+        {
+            'type': 'qualTags',
+            'uuid': 'e9b4e6d1-fdbb-4dc9-8b10-a9c3c388322f',
+            'labels': {'_default': 'Tag any landmarks mentioned in the story'},
+        },
+        {
+            'type': 'qualText',
+            'uuid': '83acf2a7-8edc-4fd8-8b9f-f832ca3f18ad',
+            'labels': {'_default': 'Add any further remarks'},
+        },
+        {
+            'type': 'qualNote',
+            'uuid': '5ef11d48-d7a3-432e-af83-8c2e9b1feb72',
+            'labels': {'_default': 'Thanks for your diligence'},
+        },
+    ]```