Merge pull request #4033 from kobotoolbox/3734-use-latest-deployed-asset-version-submission-edit

Use latest deployed version of the form for submission edits

Author: jnm

kpi/tests/api/v2/test_api_submissions.py

@@ -863,7 +863,8 @@ def test_get_legacy_edit_link_submission_as_owner(self):
         assert response.status_code == status.HTTP_200_OK
 
         expected_response = {
-            'url': f"{settings.ENKETO_URL}/edit/{self.submission['_uuid']}"
+            'url': f"{settings.ENKETO_URL}/edit/{self.submission['_uuid']}",
+            'version_uid': self.asset.latest_deployed_version.uid,
         }
         assert response.data == expected_response
 
@@ -886,7 +887,8 @@ def test_get_edit_link_submission_as_owner(self):
         response = self.client.get(self.submission_url, {'format': 'json'})
         assert response.status_code == status.HTTP_200_OK
         expected_response = {
-            'url': f"{settings.ENKETO_URL}/edit/{self.submission['_uuid']}"
+            'url': f"{settings.ENKETO_URL}/edit/{self.submission['_uuid']}",
+            'version_uid': self.asset.latest_deployed_version.uid,
         }
         self.assertEqual(response.data, expected_response)
 
@@ -1002,8 +1004,10 @@ def test_get_edit_link_with_partial_perms_as_anotheruser(self):
 
         response = self.client.get(url, {'format': 'json'})
         self.assertEqual(response.status_code, status.HTTP_200_OK)
-        url = f"{settings.ENKETO_URL}/edit/{submission['_uuid']}"
-        expected_response = {'url': url}
+        expected_response = {
+            'url': f"{settings.ENKETO_URL}/edit/{submission['_uuid']}",
+            'version_uid': self.asset.latest_deployed_version.uid,
+        }
         self.assertEqual(response.data, expected_response)
 
     @responses.activate
@@ -1118,6 +1122,70 @@ def test_get_multiple_edit_links_and_attempt_submit_edits(self):
             with pytest.raises(KeyError) as e:
                 res = self.client.post(url)
 
+    @responses.activate
+    def test_get_edit_link_submission_with_latest_asset_deployment(self):
+        """
+        Check that the submission edit is using the asset version associated
+        with the latest **deployed** version.
+        """
+        original_versions_count = self.asset.asset_versions.count()
+        original_deployed_versions_count = self.asset.deployed_versions.count()
+        original_deployed_version_uid = self.asset.latest_deployed_version.uid
+
+        ee_url = (
+            f'{settings.ENKETO_URL}/{settings.ENKETO_EDIT_INSTANCE_ENDPOINT}'
+        )
+        # Mock Enketo response
+        responses.add_callback(
+            responses.POST,
+            ee_url,
+            callback=enketo_edit_instance_response,
+            content_type='application/json',
+        )
+
+        # make a change to the asset content but don't redeploy yet
+        self.asset.content['survey'].append(
+            {
+                'type': 'note',
+                'name': 'n',
+                'label': 'A new note',
+            }
+        )
+        self.asset.save()
+        assert self.asset.asset_versions.count() == original_versions_count + 1
+        assert (
+            self.asset.deployed_versions.count()
+            == original_deployed_versions_count
+        )
+
+        # ensure that the latest deployed version is used for the edit, even if
+        # there's a new asset version
+        response = self.client.get(self.submission_url, {'format': 'json'})
+        assert response.status_code == status.HTTP_200_OK
+        expected_response = {
+            'url': f"{settings.ENKETO_URL}/edit/{self.submission['_uuid']}",
+            'version_uid': original_deployed_version_uid,
+        }
+        assert response.data == expected_response
+
+        # redeploy the asset to create a new deployment version
+        self.asset.deploy(active=True)
+        self.asset.save()
+        assert self.asset.asset_versions.count() == original_versions_count + 2
+        assert (
+            self.asset.deployed_versions.count()
+            == original_deployed_versions_count + 1
+        )
+
+        # ensure that the newly deployed version is used for editing
+        response = self.client.get(self.submission_url, {'format': 'json'})
+        assert response.status_code == status.HTTP_200_OK
+        expected_response = {
+            'url': f"{settings.ENKETO_URL}/edit/{self.submission['_uuid']}",
+            'version_uid': self.asset.latest_deployed_version.uid,
+        }
+        assert response.data == expected_response
+
 
 class SubmissionViewApiTests(BaseSubmissionTestCase):
 
@@ -1153,7 +1221,8 @@ def test_get_view_link_submission_as_owner(self):
         assert response.status_code == status.HTTP_200_OK
 
         expected_response = {
-            'url': f"{settings.ENKETO_URL}/view/{self.submission['_uuid']}"
+            'url': f"{settings.ENKETO_URL}/view/{self.submission['_uuid']}",
+            'version_uid': self.asset.latest_deployed_version.uid,
         }
         assert response.data == expected_response
 
@@ -1256,8 +1325,10 @@ def test_get_view_link_with_partial_perms_as_anotheruser(self):
 
         response = self.client.get(url, {'format': 'json'})
         self.assertEqual(response.status_code, status.HTTP_200_OK)
-        url = f"{settings.ENKETO_URL}/view/{submission['_uuid']}"
-        expected_response = {'url': url}
+        expected_response = {
+            'url': f"{settings.ENKETO_URL}/view/{submission['_uuid']}",
+            'version_uid': self.asset.latest_deployed_version.uid,
+        }
         self.assertEqual(response.data, expected_response)
 
 

kpi/views/v2/data.py

@@ -622,8 +622,8 @@ def _get_enketo_link(
         # )
         # version_uid = list(submissions_stream)[0][INFERRED_VERSION_ID_KEY]
 
-        # Let's use the latest version uid temporarily
-        version_uid = self.asset.latest_version.uid
+        # Let's use the latest **deployed** version uid temporarily
+        version_uid = self.asset.latest_deployed_version.uid
 
         # Retrieve the XML root node name from the submission. The instance's
         # root node name specified in the form XML (i.e. the first child of
@@ -687,4 +687,9 @@ def _get_enketo_link(
         json_response = response.json()
         enketo_url = json_response.get(f'{action_}_url')
 
-        return Response({'url': enketo_url})
+        return Response(
+            {
+                'url': enketo_url,
+                'version_uid': version_uid,
+            }
+        )