feat(dref): add dref finalize api

Author: sudip-khanal

dref/admin.py

@@ -98,6 +98,7 @@ class DrefAdmin(CompareVersionAdmin, TranslationAdmin, admin.ModelAdmin):
         "risk_security",
         "proposed_action",
     )
+    readonly_fields = ("original_language",)
 
     def get_queryset(self, request):
         return (
@@ -143,6 +144,7 @@ class DrefOperationalUpdateAdmin(CompareVersionAdmin, TranslationAdmin, admin.Mo
         "district",
         "risk_security",
     )
+    readonly_fields = ("original_language",)
     list_filter = ["dref"]
 
     def get_queryset(self, request):
@@ -199,6 +201,7 @@ class DrefFinalReportAdmin(CompareVersionAdmin, TranslationAdmin, admin.ModelAdm
         "national_society_actions",
         "source_information",
     )
+    readonly_fields = ("original_language",)
     list_filter = ["dref"]
     search_fields = ["title", "national_society__name", "appeal_code"]
 

dref/serializers.py

@@ -6,7 +6,7 @@
 from django.contrib.auth.models import User
 from django.db import models, transaction
 from django.utils import timezone
-from django.utils.translation import gettext
+from django.utils.translation import get_language, gettext
 from django.utils.translation import gettext_lazy as _
 from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
@@ -35,6 +35,7 @@
 )
 from dref.utils import get_dref_users
 from lang.serializers import ModelSerializer
+from main.translation import TRANSLATOR_ORIGINAL_LANGUAGE_FIELD_NAME
 from main.writable_nested_serializers import NestedCreateMixin, NestedUpdateMixin
 from utils.file_check import validate_file_type
 
@@ -348,16 +349,22 @@ def get_image_url(self, identifiedneed) -> str:
 
 
 class MiniOperationalUpdateSerializer(ModelSerializer):
+    status_display = serializers.CharField(source="get_status_display", read_only=True)
+
     class Meta:
         model = DrefOperationalUpdate
         fields = [
             "id",
             "title",
             "operational_update_number",
+            "status",
+            "status_display",
         ]
 
 
 class MiniDrefFinalReportSerializer(ModelSerializer):
+    status_display = serializers.CharField(source="get_status_display", read_only=True)
+
     class Meta:
         model = DrefFinalReport
         fields = [
@@ -368,7 +375,7 @@ class Meta:
         ]
 
 
-class DrefSerializer(NestedUpdateMixin, NestedCreateMixin, ModelSerializer):
+class DrefSerializer(NestedUpdateMixin, NestedCreateMixin, serializers.ModelSerializer):
     SUB_TOTAL_COST = 75000
     SURGE_DEPLOYMENT_COST = 10000
     SURGE_INDIRECT_COST = 5800
@@ -427,6 +434,7 @@ class Meta:
             "created_by",
             "budget_file_preview",
             "is_dref_imminent_v2",
+            "original_language",
         )
         exclude = (
             "cover_image",
@@ -603,6 +611,12 @@ def validate_budget_file_preview(self, budget_file_preview):
         validate_file_type(budget_file_preview)
         return budget_file_preview
 
+    def _set_original_language(self, validated_data):
+        current_lang = get_language()
+        validated_data["original_language"] = current_lang
+        validated_data[TRANSLATOR_ORIGINAL_LANGUAGE_FIELD_NAME] = current_lang
+        return validated_data
+
     def create(self, validated_data):
         validated_data["created_by"] = self.context["request"].user
         validated_data["is_active"] = True
@@ -620,7 +634,7 @@ def create(self, validated_data):
             # Event Description
             validated_data["event_scope"] = None
             validated_data["identified_gaps"] = None
-            # Targeted Population
+            # Targeted Populationtranslate_model_fields_to_english
             validated_data["women"] = None
             validated_data["men"] = None
             validated_data["girls"] = None
@@ -631,6 +645,8 @@ def create(self, validated_data):
             validated_data["communication"] = None
             dref_assessment_report = super().create(validated_data)
             dref_assessment_report.needs_identified.clear()
+            # set original language
+            validated_data = self._set_original_language(validated_data)
             return dref_assessment_report
         # NOTE: Setting flag for only newly created DREF of type IMMINENT
         if type_of_dref == Dref.DrefType.IMMINENT:
@@ -640,6 +656,8 @@ def create(self, validated_data):
             to = {u.email for u in validated_data["users"]}
         else:
             to = None
+        # set original language
+        validated_data = self._set_original_language(validated_data)
         dref = super().create(validated_data)
         if to:
             transaction.on_commit(lambda: send_dref_email.delay(dref.id, list(to), "New"))
@@ -649,6 +667,14 @@ def update(self, instance, validated_data):
         validated_data["modified_by"] = self.context["request"].user
         modified_at = validated_data.pop("modified_at", None)
         type_of_dref = validated_data.get("type_of_dref")
+        current_lang = get_language()
+        original_lang = instance.translation_module_original_language
+        if instance.status == Dref.Status.FINALIZED:
+            if current_lang != "en":
+                raise serializers.ValidationError(gettext("Finalized records can only be updated in English."))
+        elif current_lang != original_lang:
+            raise serializers.ValidationError(gettext("Only original language is supported: %s" % original_lang))
+
         if modified_at is None:
             raise serializers.ValidationError({"modified_at": "Modified At is required!"})
         if type_of_dref and type_of_dref == Dref.DrefType.ASSESSMENT:
@@ -724,6 +750,7 @@ class Meta:
             "operational_update_number",
             "modified_by",
             "created_by",
+            "original_language",
         )
         exclude = (
             "images",
@@ -1113,6 +1140,7 @@ class Meta:
             "created_by",
             "financial_report_preview",
             "is_dref_imminent_v2",
+            "original_language",
         )
         exclude = (
             "images",

dref/tasks.py

@@ -1,11 +1,17 @@
+import logging
+
 from celery import shared_task
+from django.apps import apps as django_apps
 from django.template.loader import render_to_string
 
+from lang.tasks import ModelTranslator
 from notifications.notification import send_notification
 
 from .models import Dref
 from .utils import get_email_context
 
+logger = logging.getLogger(__name__)
+
 
 @shared_task
 def send_dref_email(dref_id, users_emails, new_or_updated=""):
@@ -20,3 +26,19 @@ def send_dref_email(dref_id, users_emails, new_or_updated=""):
 
     send_notification(email_subject, users_emails, email_body, email_type)
     return email_context
+
+
+@shared_task()
+def translate_fields_to_english(model_name: str, pk: int) -> None:
+    model = django_apps.get_model(model_name)
+    obj = model.objects.get(pk=pk)
+    try:
+        ModelTranslator().translate_model_fields_to_english(obj)
+        obj.status = Dref.Status.FINALIZED
+        obj.translation_module_original_language = "en"
+        obj.save(update_fields=["status", "translation_module_original_language"])
+    except Exception as exc:
+        obj.status = Dref.Status.DRAFT
+        obj.save(update_fields=["status"])
+        logger.warning(f"Translation failed for '{model_name} {pk}': {exc}", exc_info=True)
+        raise exc

dref/test_views.py

@@ -7,6 +7,7 @@
 from django.contrib.auth.models import Permission
 from django.contrib.contenttypes.models import ContentType
 from django.core import management
+from django.test import TestCase
 from rest_framework import status
 
 from api.models import Country, DisasterType, District, Region, RegionName
@@ -27,7 +28,7 @@
     DrefOperationalUpdate,
     ProposedAction,
 )
-from dref.tasks import send_dref_email
+from dref.tasks import send_dref_email, translate_fields_to_english
 from main.test_case import APITestCase
 
 
@@ -883,6 +884,158 @@ def test_dref_latest_update(self):
         # Title should be latest since modified_at is greater than modified_at in database
         self.assertEqual(response.data["title"], "New title")
 
+    def test_dref_create_and_update_in_local_language(
+        self,
+    ):
+        national_society = Country.objects.create(name="Test country xzz")
+        disaster_type = DisasterType.objects.create(name="Test country abc")
+
+        data = {
+            "title": "Prueba de título Dref",
+            "type_of_onset": Dref.OnsetType.SLOW.value,
+            "disaster_category": Dref.DisasterCategory.YELLOW.value,
+            "status": Dref.Status.DRAFT.value,
+            "num_assisted": 5666,
+            "num_affected": 23,
+            "amount_requested": 127771111,
+            "emergency_appeal_planned": False,
+            "event_date": "2021-08-01",
+            "ns_respond_date": "2021-08-01",
+            "event_text": "Texto de prueba para la respuesta",
+            "did_ns_request_fund": False,
+            "lessons_learned": "Texto de prueba para lecciones aprendidas",
+            "complete_child_safeguarding_risk": True,
+            "child_safeguarding_risk_level": "Muy alto",
+            "event_description": "Texto de prueba para descripción del evento",
+            "anticipatory_actions": "Texto de prueba para acciones anticipatorias",
+            "event_scope": "Texto de prueba para alcance del evento",
+            "government_requested_assistance": False,
+            "government_requested_assistance_date": "2021-08-01",
+            "national_authorities": "Texto de prueba para autoridades nacionales",
+            "icrc": "Texto de prueba para lecciones aprendidas",
+            "un_or_other_actor": "Texto de prueba para lecciones aprendidas",
+            "major_coordination_mechanism": "Texto de prueba para lecciones aprendidas",
+            "identified_gaps": "Texto de prueba para lecciones aprendidas",
+            "people_assisted": "Texto de prueba para lecciones aprendidas",
+            "selection_criteria": "Texto de prueba para lecciones aprendidas",
+            "entity_affected": "Texto de prueba para lecciones aprendidas",
+            "community_involved": "Texto de prueba para lecciones aprendidas",
+            "women": 344444,
+            "men": 5666,
+            "girls": 22,
+            "boys": 344,
+            "disability_people_per": "12.45",
+            "people_per": "10.35",
+            "displaced_people": 234243,
+            "operation_objective": "Texto de prueba para objetivo de operación",
+            "response_strategy": "Texto de prueba para estrategia de respuesta",
+            "secretariat_service": "Texto de prueba para servicio de secretaría",
+            "national_society_strengthening": "",
+            "ns_request_date": "2021-07-01",
+            "submission_to_geneva": "2021-07-01",
+            "date_of_approval": "2021-07-01",
+            "end_date": "2021-07-05",
+            "publishing_date": "2021-08-01",
+            "operation_timeframe": 4,
+            "appeal_code": "J7876",
+            "glide_code": "ER878",
+            "appeal_manager_name": "Nombre de prueba",
+            "appeal_manager_email": "[email protected]",
+            "project_manager_name": "Nombre de prueba",
+            "project_manager_email": "[email protected]",
+            "national_society_contact_name": "Nombre de prueba",
+            "national_society_contact_email": "[email protected]",
+            "media_contact_name": "Nombre de prueba",
+            "media_contact_email": "[email protected]",
+            "ifrc_emergency_name": "Nombre de prueba",
+            "ifrc_emergency_email": "[email protected]",
+            "originator_name": "Nombre de prueba",
+            "originator_email": "[email protected]",
+            "national_society": national_society.id,
+            "disaster_type": disaster_type.id,
+            "needs_identified": [{"title": "shelter_housing_and_settlements", "description": "hola"}],
+            "planned_interventions": [
+                {
+                    "title": "shelter_housing_and_settlements",
+                    "description": "matriz",
+                    "budget": 23444,
+                    "male": 12222,
+                    "female": 2255,
+                    "indicators": [
+                        {
+                            "title": "título de prueba",
+                            "actual": 21232,
+                            "target": 44444,
+                        }
+                    ],
+                }
+            ],
+        }
+
+        url = "/api/v2/dref/"
+
+        self.client.force_authenticate(self.user)
+        response = self.client.post(url, data, format="json", HTTP_ACCEPT_LANGUAGE="es")
+        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.data["original_language"], "es")
+        self.assertEqual(response.data["translation_module_original_language"], "es")
+        self.assertEqual(response.data["title"], "Prueba de título Dref")
+        # Test update
+        dref_id = response.data["id"]
+        url = f"/api/v2/dref/{dref_id}/"
+        #  update in French
+        data_fr = {"title": "Titre en français", "modified_at": datetime.now()}
+        response = self.client.patch(url, data=data_fr, format="json", HTTP_ACCEPT_LANGUAGE="fr")
+        self.assert_400(response)
+
+        #  update in Arabic
+        data_ar = {"title": "العنوان بالعربية", "modified_at": datetime.now()}
+        response = self.client.patch(url, data=data_ar, format="json", HTTP_ACCEPT_LANGUAGE="ar")
+        self.assert_400(response)
+
+        #  update in English
+        data_en = {"title": "Updated title in English", "modified_at": datetime.now()}
+        response = self.client.patch(url, data=data_en, format="json", HTTP_ACCEPT_LANGUAGE="en")
+        self.assert_400(response)
+
+    @mock.patch("dref.tasks.translate_fields_to_english.delay")
+    def test_update_and_finalize_dref(self, mock_translate):
+        dref = DrefFactory.create(
+            title="Título original en español",
+            type_of_dref=Dref.DrefType.IMMINENT,
+            created_by=self.user,
+            status=Dref.Status.DRAFT,
+            translation_module_original_language="es",
+        )
+
+        url = f"/api/v2/dref/{dref.id}/"
+        self.client.force_authenticate(self.user)
+        # update in Spanish
+        data_es = {"title": "en español", "modified_at": datetime.now()}
+        response = self.client.patch(url, data=data_es, HTTP_ACCEPT_LANGUAGE="es")
+        self.assert_200(response)
+        self.assertEqual(response.data["title"], "en español")
+        # update in French
+        data_fr = {"title": "Titre en français", "modified_at": datetime.now()}
+        response = self.client.patch(url, data=data_fr, format="json", HTTP_ACCEPT_LANGUAGE="fr")
+        self.assert_400(response)
+        # update in Arabic
+        data_ar = {"title": "العنوان بالعربية", "modified_at": datetime.now()}
+        response = self.client.patch(url, data=data_ar, format="json", HTTP_ACCEPT_LANGUAGE="ar")
+        self.assert_400(response)
+        # update in English
+        data_en = {"title": "Updated title in English", "modified_at": datetime.now()}
+        response = self.client.patch(url, data=data_en, HTTP_ACCEPT_LANGUAGE="en")
+        self.assert_400(response)
+
+        # Finalize DREF
+        with self.capture_on_commit_callbacks(execute=True):
+            finalize_url = f"/api/v2/dref/{dref.id}/finalize/"
+            response = self.client.post(finalize_url)
+        self.assert_200(response)
+        self.assertEqual(response.data["status"], Dref.Status.FINALIZING)
+        mock_translate.assert_called_once_with("dref.Dref", dref.id)
+
     def test_dref_op_update_locking(self):
         user1, _ = UserFactory.create_batch(2)
         dref = DrefFactory.create(
@@ -1852,6 +2005,28 @@ def test_dref_imminent_v2_final_report(self):
         )
 
 
+class TranslateFieldsToEnglishTaskTest(TestCase):
+
+    def test_translate_fields_to_english_task(self):
+        dref = DrefFactory.create(
+            title="Titre en français",
+            type_of_dref=Dref.DrefType.IMMINENT,
+            status=Dref.Status.DRAFT,
+            translation_module_original_language="fr",
+        )
+
+        with mock.patch("dref.tasks.ModelTranslator.translate_model_fields_to_english") as mock_translate:
+            mock_translate.return_value = None
+
+            # Call the task
+            translate_fields_to_english("dref.Dref", dref.pk)
+            # Reload object from DB
+            dref.refresh_from_db()
+            mock_translate.assert_called_once()
+            self.assertEqual(dref.status, Dref.Status.FINALIZED)
+            self.assertEqual(dref.translation_module_original_language, "en")
+
+
 User = get_user_model()