feat(dref): add translation completion check

Author: sudip-khanal

dref/serializers.py

@@ -205,6 +205,7 @@ class MiniDrefSerializer(serializers.ModelSerializer):
     unpublished_final_report_count = serializers.SerializerMethodField()
     operational_update_details = serializers.SerializerMethodField()
     final_report_details = serializers.SerializerMethodField()
+    original_language = serializers.CharField(read_only=True)
 
     class Meta:
         model = Dref
@@ -235,6 +236,7 @@ class Meta:
             "status",
             "status_display",
             "date_of_approval",
+            "original_language",
         ]
 
     @extend_schema_field(MiniOperationalUpdateActiveSerializer(many=True))
@@ -1543,6 +1545,7 @@ class CompletedDrefOperationsSerializer(serializers.ModelSerializer):
     status_display = serializers.CharField(source="get_status_display", read_only=True)
     application_type = serializers.SerializerMethodField()
     application_type_display = serializers.SerializerMethodField()
+    original_language = serializers.CharField(read_only=True)
 
     class Meta:
         model = DrefFinalReport
@@ -1560,6 +1563,7 @@ class Meta:
             "dref",
             "status",
             "status_display",
+            "original_language",
         )
 
     def get_application_type(self, obj) -> str:

dref/test_views.py

@@ -1,6 +1,7 @@
 import os
 from datetime import datetime, timedelta
 from unittest import mock
+from unittest.mock import patch
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -1028,10 +1029,16 @@ def test_update_and_finalize_dref(self):
 
         # Finalize DREF
         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.FINALIZED)
-        self.assertEqual(response.data["translation_module_original_language"], "en")
+        # Finalize without translation
+        with patch("dref.views.is_translation_complete", return_value=False):
+            response = self.client.post(finalize_url)
+            self.assert_400(response)
+        # Finalize with translation complete
+        with patch("dref.views.is_translation_complete", return_value=True):
+            response = self.client.post(finalize_url)
+            self.assert_200(response)
+            self.assertEqual(response.data["status"], Dref.Status.FINALIZED)
+            self.assertEqual(response.data["translation_module_original_language"], "en")
 
         # Update in English
         finalized_dref_id = response.data["id"]
@@ -1169,10 +1176,16 @@ def test_dref_operational_update_finalize(self):
 
         # Finalize Operational Update
         finalize_url = f"/api/v2/dref-op-update/{op_update.id}/finalize/"
-        response = self.client.post(finalize_url)
-        self.assert_200(response)
-        self.assertEqual(response.data["status"], Dref.Status.FINALIZED)
-        self.assertEqual(response.data["translation_module_original_language"], "en")
+        # Finalize without translation
+        with patch("dref.views.is_translation_complete", return_value=False):
+            response = self.client.post(finalize_url)
+            self.assert_400(response)
+        # Finalize with translation complete
+        with patch("dref.views.is_translation_complete", return_value=True):
+            response = self.client.post(finalize_url)
+            self.assert_200(response)
+            self.assertEqual(response.data["status"], Dref.Status.FINALIZED)
+            self.assertEqual(response.data["translation_module_original_language"], "en")
         # Update in English
         finalized_op_update_id = response.data["id"]
         url = f"/api/v2/dref-op-update/{finalized_op_update_id}/"
@@ -2200,10 +2213,16 @@ def test_dref_final_report_finalize(self):
 
         # Finalize final-report
         finalize_url = f"/api/v2/dref-final-report/{final_report.id}/finalize/"
-        response = self.client.post(finalize_url)
-        self.assert_200(response)
-        self.assertEqual(response.data["status"], Dref.Status.FINALIZED)
-        self.assertEqual(response.data["translation_module_original_language"], "en")
+        # Finalize without translation
+        with patch("dref.views.is_translation_complete", return_value=False):
+            response = self.client.post(finalize_url)
+            self.assert_400(response)
+        # Finalize with translation complete
+        with patch("dref.views.is_translation_complete", return_value=True):
+            response = self.client.post(finalize_url)
+            self.assert_200(response)
+            self.assertEqual(response.data["status"], Dref.Status.FINALIZED)
+            self.assertEqual(response.data["translation_module_original_language"], "en")
         # Update in English
         finalized_final_report_id = response.data["id"]
         data_en = {"title": "Updated title in English", "modified_at": datetime.now()}

dref/utils.py

@@ -1,6 +1,8 @@
 from django.conf import settings
 from django.contrib.postgres.aggregates import ArrayAgg
 from django.db import models
+from django.utils import translation
+from modeltranslation.translator import translator
 
 from dref.models import Dref, DrefFinalReport, DrefOperationalUpdate
 
@@ -53,3 +55,29 @@ def get_dref_users():
             )
         )
     return dref_users_list
+
+
+def is_translation_complete(instance, target_lang="en"):
+    """
+    Check all translatable fields of a instance have been
+    translated to the target language.
+    """
+    original_lang = getattr(instance, "translation_module_original_language", None)
+    if not original_lang:
+        return False
+    try:
+        opts = translator.get_options_for_model(type(instance))
+    except Exception:
+        return True
+    for field in getattr(opts, "fields", []):
+        with translation.override(original_lang):
+            original_value = getattr(instance, field, None)
+
+        with translation.override(target_lang):
+            translated_value = getattr(instance, field, None)
+        if not original_value:
+            continue
+        if not translated_value:
+            return False
+
+    return True

dref/views.py

@@ -41,6 +41,7 @@
     DrefShareUserSerializer,
     MiniDrefSerializer,
 )
+from dref.utils import is_translation_complete
 from main.permissions import DenyGuestUserPermission, UseBySuperAdminOnly
 
 
@@ -108,6 +109,10 @@ def finalize(self, request, pk=None, version=None):
         dref = self.get_object()
         if dref.status in [Dref.Status.FINALIZED, Dref.Status.APPROVED]:
             raise serializers.ValidationError(gettext("Cannot be finalized because it is already %s") % dref.get_status_display())
+
+        if not is_translation_complete(dref):
+            raise serializers.ValidationError("Cannot be finalized because translation is not completed")
+
         if dref.translation_module_original_language != "en":
             dref.translation_module_original_language = "en"
             dref.status = Dref.Status.FINALIZED
@@ -198,6 +203,8 @@ def finalize(self, request, pk=None, version=None):
             raise serializers.ValidationError(
                 gettext("Cannot be finalized because it is already %s") % operational_update.get_status_display()
             )
+        if not is_translation_complete(operational_update):
+            raise serializers.ValidationError("Cannot be finalized because translation is not completed")
         if operational_update.translation_module_original_language != "en":
             operational_update.translation_module_original_language = "en"
             operational_update.status = Dref.Status.FINALIZED
@@ -258,6 +265,9 @@ def finalize(self, request, pk=None, version=None):
             raise serializers.ValidationError(
                 gettext("Cannot be finalized because it is already %s") % field_report.get_status_display()
             )
+        if not is_translation_complete(field_report):
+            raise serializers.ValidationError("Cannot be finalized because translation is not completed")
+
         if field_report.translation_module_original_language != "en":
             field_report.translation_module_original_language = "en"
             field_report.status = Dref.Status.FINALIZED