Fix i18n text/json field serialization in Django admin #10597

Follow-up to 9334ae1.

Author: jacobtylerwalls

arches/app/utils/betterJSONSerializer.py

@@ -53,7 +53,11 @@ def __init__(self, **options):
         self.utf_encode = False
 
     def encode(self, obj):
-        return self.serializeToPython(obj, **self._options)
+        if isinstance(obj, (I18n_JSON, I18n_String)):
+            # Ensure raw JSON strings are re-encoded ("'" -> "\"")
+            # and non-active language values are preserved.
+            return DjangoJSONEncoder().encode(obj.raw_value)
+        return self.serialize(obj, **self._options)
 
     def serializeToPython(self, obj, **options):
         # allow users to override any kwargs passed into the __init__ method
@@ -71,7 +75,7 @@ def serializeToPython(self, obj, **options):
 
     def serialize(self, obj, **options):
         obj = self.serializeToPython(obj, **options)
-        # prevent raw strings from begin re-encoded
+        # prevent raw strings from being re-encoded
         # this is especially important when doing bulk operations in elasticsearch
         if isinstance(obj, str):
             return obj

releases/7.6.0.md

@@ -43,6 +43,7 @@ Arches 7.6.0 Release Notes
 - 10911 Styling fix in resource model manage menu
 - 10726 Upgrade openpyxl package to 3.1.2 and fixes ETL modules
 - 9191 Adds unlocalized string datatype
+- 10597 Fix internationalized string/json field entry problems in the Django admin
 - 10787 Search Export: data exportable as "system values" (e.g. concept valueids) instead of "display values" (e.g. string preflabel)
 - 10121 Prevent language code duplication during concept import; avoid creating Language objects other than English in new projects
 - 10575 Add pre-commit hooks for formatting

tests/utils/test_betterJSONSerializer.py

@@ -0,0 +1,27 @@
+from django.test import SimpleTestCase
+from django.utils.translation import activate
+
+from arches.app.models.fields.i18n import I18n_JSON, I18n_String
+from arches.app.utils.betterJSONSerializer import JSONSerializer
+
+# these tests can be run from the command line via
+# python manage.py test tests.utils.test_betterJSONSerializer --settings="tests.test_settings"
+
+
+class TestBetterJSONSerializer(SimpleTestCase):
+    def test_encode_i18n_json(self):
+        serializer = JSONSerializer()
+        json = I18n_JSON("{'trueLabel': {'en': 'Yes'}")
+        encoded = serializer.encode(json)
+        self.assertEqual(
+            encoded, "\"{'trueLabel': {'en': 'Yes'}\"", "JSON must be double-quoted"
+        )
+
+    def test_encode_i18n_string(self):
+        string = I18n_String()
+        string["de"] = "German label"
+        string["en"] = "English label"
+
+        serializer = JSONSerializer()
+        encoded = serializer.encode(string)
+        self.assertEqual(encoded, '{"en": "English label", "de": "German label"}')