🗑️ [#3283] Make FormDefinitionSerializer.name read only

the name is set via translations

Author: stevenbal

CHANGELOG.rst

@@ -2,6 +2,16 @@
 Changelog
 =========
 
+3.0.0 (TBD)
+===========
+
+Major release.
+
+Deprecations:
+
+* ``FormDefinition.name`` has been made read only, because this name is set via translations.
+  This should not impact any Form imports that already have translations in them
+
 2.8.1 (2024-10-29)
 ==================
 

src/openapi.yaml

@@ -7893,7 +7893,7 @@ components:
           format: uuid
         name:
           type: string
-          maxLength: 50
+          readOnly: true
         internalName:
           type: string
           description: internal name for management purposes
@@ -7944,7 +7944,7 @@ components:
           format: uuid
         name:
           type: string
-          maxLength: 50
+          readOnly: true
         internalName:
           type: string
           description: internal name for management purposes
@@ -9506,7 +9506,7 @@ components:
           format: uuid
         name:
           type: string
-          maxLength: 50
+          readOnly: true
         internalName:
           type: string
           description: internal name for management purposes

src/openforms/forms/api/serializers/form_definition.py

@@ -114,8 +114,7 @@ class Meta:
                 "view_name": "api:formdefinition-detail",
                 "lookup_field": "uuid",
             },
-            # TODO: enable this in v3, deprecate writing this field
-            # "name": {"read_only": True},  # writing is done via the `translations` field
+            "name": {"read_only": True},  # writing is done via the `translations` field
             "slug": {
                 "required": False,
             },

src/openforms/forms/tests/admin/test_form.py

@@ -281,6 +281,10 @@ def test_form_admin_import_feedback_messages(self):
                                         }
                                     ]
                                 },
+                                "translations": {
+                                    "en": {"name": "testform"},
+                                    "nl": {"name": "testformulier"},
+                                },
                             }
                         ]
                     ).encode("utf-8")

src/openforms/forms/tests/exports/formDefinitions.json

@@ -12,6 +12,10 @@
         "internal_name": "Test Definition Internal 1",
         "slug": "test-definition-1",
         "url": "http://testserver/api/v2/form-definitions/f0dad93b-333b-49af-868b-a6bcb94fa1b8",
-        "uuid": "f0dad93b-333b-49af-868b-a6bcb94fa1b8"
+        "uuid": "f0dad93b-333b-49af-868b-a6bcb94fa1b8",
+        "translations": {
+            "en": {"name": "Test Definition 1"},
+            "nl": {"name": "Test Definitie 1"}
+        }
     }
 ]

src/openforms/forms/tests/test_api_form_versions.py

@@ -1,6 +1,7 @@
 import datetime
 
 from django.urls import reverse
+from django.utils import translation
 
 from freezegun import freeze_time
 from rest_framework import status
@@ -191,7 +192,9 @@ def test_restore_version(self):
         form_step = form_steps.get()
         restored_form_definition = form_step.form_definition
 
-        self.assertEqual("Test Definition 1", restored_form_definition.name)
+        with translation.override("en"):
+            self.assertEqual("Test Definition 1", restored_form_definition.name)
+            self.assertEqual("Test Definitie 1", restored_form_definition.name_nl)
         self.assertEqual(
             "Test Definition Internal 1", restored_form_definition.internal_name
         )

src/openforms/forms/tests/test_api_formdefinition.py

@@ -156,14 +156,19 @@ def test_update(self):
                     ],
                 },
                 "login_required": True,
+                "translations": {
+                    "en": {"name": "Updated name"},
+                    "nl": {"name": "Bijgewerkte naam"},
+                },
             },
         )
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
         definition.refresh_from_db()
 
-        self.assertEqual("Updated name", definition.name)
+        self.assertEqual("Bijgewerkte naam", definition.name)
+        self.assertEqual("Updated name", definition.name_en)
         self.assertEqual("updated-slug", definition.slug)
         self.assertEqual(True, definition.login_required)
         self.assertIn(
@@ -217,14 +222,19 @@ def test_create(self):
                         }
                     ],
                 },
+                "translations": {
+                    "en": {"name": "Name"},
+                    "nl": {"name": "Naam"},
+                },
             },
         )
 
         self.assertEqual(status.HTTP_201_CREATED, response.status_code)
 
         definition = FormDefinition.objects.get()
 
-        self.assertEqual("Name", definition.name)
+        self.assertEqual("Naam", definition.name)
+        self.assertEqual("Name", definition.name_en)
         self.assertEqual("a-slug", definition.slug)
         self.assertEqual(
             [

src/openforms/forms/tests/test_restore_version.py

@@ -3,6 +3,7 @@
 import json
 
 from django.test import TestCase
+from django.utils import translation
 from django.utils.translation import gettext as _
 
 from freezegun import freeze_time
@@ -63,7 +64,9 @@ def test_restoring_version(self):
 
         restored_form_definition = form_steps.get().form_definition
 
-        self.assertEqual("Test Definition 1", restored_form_definition.name)
+        with translation.override("en"):
+            self.assertEqual("Test Definition 1", restored_form_definition.name)
+            self.assertEqual("Test Definitie 1", restored_form_definition.name_nl)
         self.assertEqual(
             "Test Definition Internal 1", restored_form_definition.internal_name
         )