feat(eap): update revise workflow with locked feature

- Update admin panel
- Add test for edge cases

Author: susilnem

eap/admin.py

@@ -85,12 +85,13 @@ class SimplifiedEAPAdmin(admin.ModelAdmin):
         "eap_registration__country__name",
         "eap_registration__disaster_type__name",
     )
-    list_display = ("simplifed_eap_application", "version", "is_locked")
+    list_display = ("simplifed_eap_application", "eap_registration", "version", "is_locked")
     autocomplete_fields = (
         "eap_registration",
         "created_by",
         "modified_by",
         "admin2",
+        "partners",
     )
     readonly_fields = (
         "cover_image",
@@ -159,6 +160,7 @@ def get_queryset(self, request):
             )
             .prefetch_related(
                 "admin2",
+                "partners",
                 "partner_contacts",
             )
         )
@@ -176,12 +178,13 @@ class FullEAPAdmin(admin.ModelAdmin):
         "eap_registration__country__name",
         "eap_registration__disaster_type__name",
     )
-    list_display = ("eap_registration",)
+    list_display = ("full_eap_application", "eap_registration", "version", "is_locked")
     autocomplete_fields = (
         "eap_registration",
         "created_by",
         "modified_by",
         "admin2",
+        "partners",
     )
     readonly_fields = (
         "partner_contacts",
@@ -244,6 +247,9 @@ def regenerate_diff_pdf_file(self, request, queryset):
 
     regenerate_diff_pdf_file.short_description = "Regenerate EAP diff PDF files for selected Full EAPs"
 
+    def full_eap_application(self, obj):
+        return f"{obj.eap_registration.national_society.society_name} - {obj.eap_registration.disaster_type.name}"
+
     def get_queryset(self, request):
         return (
             super()
@@ -258,6 +264,7 @@ def get_queryset(self, request):
             )
             .prefetch_related(
                 "admin2",
+                "partners",
                 "partner_contacts",
                 "key_actors",
                 "risk_analysis_source_of_information",

eap/models.py

@@ -1275,7 +1275,7 @@ class Meta:
         ]
 
     def __str__(self):
-        return f"Simplified EAP for {self.eap_registration}- version:{self.version}"
+        return f"{self.eap_registration} (VERSION {self.version})"
 
     def generate_snapshot(self):
         """
@@ -1291,6 +1291,7 @@ def generate_snapshot(self):
                 overrides={
                     "parent_id": self.id,
                     "version": self.version + 1,
+                    "is_locked": False,
                     "created_by_id": self.created_by_id,
                     "modified_by_id": self.modified_by_id,
                     "review_checklist_file": None,
@@ -1823,7 +1824,7 @@ class Meta:
         ]
 
     def __str__(self):
-        return f"Full EAP for {self.eap_registration}- version:{self.version}"
+        return f"{self.eap_registration} (VERSION {self.version})"
 
     def generate_snapshot(self):
         """
@@ -1838,6 +1839,7 @@ def generate_snapshot(self):
                 overrides={
                     "parent_id": self.id,
                     "version": self.version + 1,
+                    "is_locked": False,
                     "created_by_id": self.created_by_id,
                     "modified_by_id": self.modified_by_id,
                     "review_checklist_file": None,

eap/serializers.py

@@ -918,14 +918,19 @@ def _validate_status(self, validated_data: dict[str, typing.Any]) -> dict[str, t
             EAPRegistration.Status.UNDER_REVIEW,
         ):
             if self.instance.get_eap_type_enum == EAPType.SIMPLIFIED_EAP:
-                # NOTE: Generating PDF asynchronously
+                self.instance.latest_simplified_eap.is_locked = True
+                self.instance.latest_simplified_eap.save(update_fields=["is_locked"])
+                # NOTE: Generating export PDF asynchronously
                 transaction.on_commit(
                     lambda: generate_export_eap_pdf.delay(
                         eap_registration_id=self.instance.id,
                         version=self.instance.latest_simplified_eap.version,
                     )
                 )
             else:
+                self.instance.latest_full_eap.is_locked = True
+                self.instance.latest_full_eap.save(update_fields=["is_locked"])
+                # NOTE: Generate export PDF asynchronously
                 transaction.on_commit(
                     lambda: generate_export_eap_pdf.delay(
                         eap_registration_id=self.instance.id,
@@ -1000,6 +1005,13 @@ def _validate_status(self, validated_data: dict[str, typing.Any]) -> dict[str, t
 
             # Check latest EAP has NS Addressing Comments file uploaded
             if self.instance.get_eap_type_enum == EAPType.SIMPLIFIED_EAP:
+                # NOTE: If EAP is locked, NS has to revise the EAP to address the comments before resubmitting.
+                if self.instance.latest_simplified_eap.is_locked:
+                    raise serializers.ValidationError(
+                        gettext("Cannot change status to %s, Please revise the EAP to address the comments.")
+                        % EAPRegistration.Status(new_status).label
+                    )
+
                 if not (self.instance.latest_simplified_eap and self.instance.latest_simplified_eap.updated_checklist_file):
                     raise serializers.ValidationError(
                         {
@@ -1010,6 +1022,10 @@ def _validate_status(self, validated_data: dict[str, typing.Any]) -> dict[str, t
                         },
                     )
 
+                # Lock the latest eap
+                self.instance.latest_simplified_eap.is_locked = True
+                self.instance.latest_simplified_eap.save(update_fields=["is_locked"])
+
                 # Generating PDFs asynchronously
                 transaction.on_commit(
                     lambda: group(
@@ -1025,6 +1041,12 @@ def _validate_status(self, validated_data: dict[str, typing.Any]) -> dict[str, t
                 )
 
             else:
+                if self.instance.latest_full_eap.is_locked:
+                    raise serializers.ValidationError(
+                        gettext("Cannot change status to %s, Please revise the EAP to address the comments.")
+                        % EAPRegistration.Status(new_status).label
+                    )
+
                 if not (self.instance.latest_full_eap and self.instance.latest_full_eap.updated_checklist_file):
                     raise serializers.ValidationError(
                         {
@@ -1035,6 +1057,10 @@ def _validate_status(self, validated_data: dict[str, typing.Any]) -> dict[str, t
                         },
                     )
 
+                # Lock the latest full eap
+                self.instance.latest_full_eap.is_locked = True
+                self.instance.latest_full_eap.save(update_fields=["is_locked"])
+
                 # Generating PDFs asynchronously
                 transaction.on_commit(
                     lambda: group(

eap/test_views.py

@@ -1274,6 +1274,8 @@ def test_status_transition(self):
         response = self.client.post(self.url, data, format="json")
         self.assertEqual(response.status_code, 200, response.data)
         self.assertEqual(response.data["status"], EAPStatus.UNDER_REVIEW)
+        simplified_eap.refresh_from_db()
+        self.assertTrue(simplified_eap.is_locked)
 
         # NOTE: Check if the NS can update after changing to UNDER_REVIEW
         # FAILS: As simplified EAP is in UNDER_REVIEW, cannot update
@@ -1283,6 +1285,7 @@ def test_status_transition(self):
             "readiness_budget": 5000,
             "pre_positioning_budget": 5000,
             "early_action_budget": 5000,
+            "modified_at": datetime.now(),
         }
         url = f"/api/v2/simplified-eap/{simplified_eap.id}/"
         response = self.client.patch(url, update_data, format="json")
@@ -1321,12 +1324,25 @@ def test_status_transition(self):
                 self.eap_registration.latest_simplified_eap.review_checklist_file,
             )
 
+        # Fails, As NS has to revise the EAP before transitioning to UNDER_REVIEW.
+        status_data = {
+            "status": EAPStatus.UNDER_REVIEW,
+        }
+        response = self.client.post(self.url, status_data)
+        self.assertEqual(response.status_code, 400, response.data)
+
+        # Fails, As User only can revise after NS_ADDRESSING_COMMENTS, cannot update directly as it's locked
+        update_data["modified_at"] = datetime.now()
+        response = self.client.patch(url, update_data, format="json")
+        self.assertEqual(response.status_code, 400, response.data)
+
         # NOTE: NS revise which creates a snapshot of simplified eap
         # updates the latest simplified eap with updated checklist file. So, there should be two snapshots of SimplifiedEAP now.
         revise_url = f"/api/v2/simplified-eap/{simplified_eap.id}/revise/"
         self.authenticate(self.country_admin)
         response = self.client.post(revise_url)
-        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.status_code, 200, response.data)
+        self.assertFalse(response.data["is_locked"], response.data)
 
         # NOTE: Check if snapshot is created or not
         # First SimplifedEAP should be locked
@@ -1371,13 +1387,21 @@ def test_status_transition(self):
             self.eap_registration.latest_simplified_eap.id,
             second_snapshot.id,
         )
+        # Second snapshot should not be locked.
+        self.assertFalse(second_snapshot.is_locked, "Latest snapshot shouldn't be locked."),
 
-        # NOTE: Cannot create another snapshot from locked snapshot
+        # NOTE: Cannot create revise as this eap has already been revised once.
         revise_url = f"/api/v2/simplified-eap/{simplified_eap.id}/revise/"
         self.authenticate(self.country_admin)
         response = self.client.post(revise_url)
         self.assertEqual(response.status_code, 400, response.data)
 
+        # NOTE: Cannot update in previous snapshot
+        url = f"/api/v2/simplified-eap/{simplified_eap.id}/"
+        update_data["modified_at"] = datetime.now()
+        response = self.client.patch(url, update_data, format="json")
+        self.assertEqual(response.status_code, 400, response.data)
+
         # NOTE: Transition to UNDER_REVIEW
         # NS_ADDRESSING_COMMENTS -> UNDER_REVIEW
         data = {
@@ -1411,6 +1435,8 @@ def test_status_transition(self):
         response = self.client.post(self.url, data, format="json")
         self.assertEqual(response.status_code, 200, response.data)
         self.assertEqual(response.data["status"], EAPStatus.UNDER_REVIEW)
+        second_snapshot.refresh_from_db()
+        self.assertTrue(second_snapshot.is_locked, "Should be locked after transition to UNDER_REVIEW.")
 
         # AGAIN NOTE: Transition to NS_ADDRESSING_COMMENTS
         # UNDER_REVIEW -> NS_ADDRESSING_COMMENTS
@@ -1433,10 +1459,23 @@ def test_status_transition(self):
             self.assertEqual(response.status_code, 200, response.data)
             self.assertEqual(response.data["status"], EAPStatus.NS_ADDRESSING_COMMENTS)
 
+        # Fails, As NS has to revise the EAP before transitioning to UNDER_REVIEW.
+        status_data = {
+            "status": EAPStatus.UNDER_REVIEW,
+        }
+        response = self.client.post(self.url, status_data)
+        self.assertEqual(response.status_code, 400, response.data)
+
+        # Cannot update as it is in NS_ADDRESSING_COMMENTS, only revise is allowed
+        update_data["modified_at"] = datetime.now()
+        response = self.client.patch(url, update_data, format="json")
+        self.assertEqual(response.status_code, 400, response.data)
+
         revise_url = f"/api/v2/simplified-eap/{second_snapshot.id}/revise/"
         self.authenticate(self.country_admin)
         response = self.client.post(revise_url)
-        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.status_code, 200, response.data)
+        self.assertFalse(response.data["is_locked"])
 
         # Check if three snapshots are created now
         self.eap_registration.refresh_from_db()
@@ -1482,12 +1521,18 @@ def test_status_transition(self):
             third_snapshot.id,
         )
 
-        # NOTE: Cannot create another snapshot from locked snapshot
+        # NOTE: Cannot create another snapshot as this eap has already been revised
         revise_url = f"/api/v2/simplified-eap/{second_snapshot.id}/revise/"
         self.authenticate(self.country_admin)
         response = self.client.post(revise_url)
         self.assertEqual(response.status_code, 400, response.data)
 
+        # NOTE: Cannot update the previous snapshot
+        url = f"/api/v2/simplified-eap/{second_snapshot.id}/"
+        update_data["modified_at"] = datetime.now()
+        response = self.client.patch(url, update_data, format="json")
+        self.assertEqual(response.status_code, 400, response.data)
+
         # NOTE: Again Transition to UNDER_REVIEW
         # NS_ADDRESSING_COMMENTS -> UNDER_REVIEW
         data = {
@@ -1556,6 +1601,13 @@ def test_status_transition(self):
             self.assertEqual(response.status_code, 200, response.data)
             self.assertEqual(response.data["status"], EAPStatus.NS_ADDRESSING_COMMENTS)
 
+        # Fails, As NS has to revise the EAP before transitioning to UNDER_REVIEW.
+        status_data = {
+            "status": EAPStatus.UNDER_REVIEW,
+        }
+        response = self.client.post(self.url, status_data)
+        self.assertEqual(response.status_code, 400, response.data)
+
         revise_url = f"/api/v2/simplified-eap/{third_snapshot.id}/revise/"
         self.authenticate(self.country_admin)
         response = self.client.post(revise_url)
@@ -1706,7 +1758,7 @@ def test_status_transition(self):
         # FAILS As simplified EAP is in PENDING_PFA, cannot updated
         url = f"/api/v2/simplified-eap/{simplified_eap.id}/"
         response = self.client.patch(url, update_data, format="json")
-        self.assertEqual(response.status_code, 400)
+        self.assertEqual(response.status_code, 400, response.data)
 
         # NOTE: Transition to APPROVED
         # PENDING_PFA -> APPROVED
@@ -1736,7 +1788,7 @@ def test_status_transition(self):
         self.authenticate(self.country_admin)
         url = f"/api/v2/simplified-eap/{simplified_eap.id}/"
         response = self.client.patch(url, update_data, format="json")
-        self.assertEqual(response.status_code, 400)
+        self.assertEqual(response.status_code, 400, response.data)
 
     @mock.patch("eap.serializers.generate_export_eap_pdf")
     @mock.patch("eap.serializers.group")

eap/views.py

@@ -296,14 +296,23 @@ def revise(
         id: int,
     ):
         simplified_eap_instance = self.get_object()
-        if simplified_eap_instance.is_locked:
+        if simplified_eap_instance.eap_registration.status != EAPStatus.NS_ADDRESSING_COMMENTS:
             return response.Response(
-                {"detail": "This version is locked and cannot be revised again."},
+                {"detail": f"Only EAPs with status {EAPStatus.NS_ADDRESSING_COMMENTS} can be revised."},
                 status=status.HTTP_400_BAD_REQUEST,
             )
-        if simplified_eap_instance.eap_registration.status != EAPStatus.NS_ADDRESSING_COMMENTS:
+
+        if simplified_eap_instance.is_locked is False:
             return response.Response(
-                {"detail": f"Only EAPs with status {EAPStatus.NS_ADDRESSING_COMMENTS} can be revised."},
+                {"detail": "EAP can only be revised when it is locked."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Check if new version of EAP can be created (i.e. if the current version is locked)
+        eap_registration_instance = EAPRegistration.objects.filter(id=simplified_eap_instance.eap_registration_id).first()
+        if eap_registration_instance and eap_registration_instance.latest_simplified_eap_id != simplified_eap_instance.id:
+            return response.Response(
+                {"detail": "A new version of the EAP has already been created. Please revise the latest version of the EAP."},
                 status=status.HTTP_400_BAD_REQUEST,
             )
 
@@ -409,15 +418,23 @@ def revise(
         id: int,
     ):
         full_eap_instance = self.get_object()
-        if full_eap_instance.is_locked:
+        if full_eap_instance.eap_registration.status != EAPStatus.NS_ADDRESSING_COMMENTS:
             return response.Response(
-                {"detail": "This version is locked and cannot be revised again."},
+                {"detail": f"Only EAPs with status {EAPStatus.NS_ADDRESSING_COMMENTS} can be revised."},
                 status=status.HTTP_400_BAD_REQUEST,
             )
 
-        if full_eap_instance.eap_registration.status != EAPStatus.NS_ADDRESSING_COMMENTS:
+        if full_eap_instance.is_locked is False:
             return response.Response(
-                {"detail": f"Only EAPs with status {EAPStatus.NS_ADDRESSING_COMMENTS} can be revised."},
+                {"detail": "EAP can only be revised when it is locked."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Check if new version of EAP can be created (i.e. if the current version is locked)
+        eap_registration_instance = EAPRegistration.objects.filter(id=full_eap_instance.eap_registration_id).first()
+        if eap_registration_instance and eap_registration_instance.latest_full_eap_id != full_eap_instance.id:
+            return response.Response(
+                {"detail": "A new version of the EAP has already been created. Please revise the latest version of the EAP."},
                 status=status.HTTP_400_BAD_REQUEST,
             )