[Bugfix] Réparation du problème du clean_name vide sur les champs de formulaire (#492)

* Fix issue where forms had an empty clean_name

* Update release number

Author: Ash-Crow

forms/migrations/0005_fix_empty_formfield_clean_names.py

@@ -0,0 +1,21 @@
+from django.db import migrations
+
+from wagtail.contrib.forms.utils import get_field_clean_name
+
+
+def fix_empty_clean_names(apps, schema_editor):
+    FormField = apps.get_model("forms", "FormField")
+    for field in FormField.objects.filter(clean_name=""):
+        field.clean_name = get_field_clean_name(field.label)
+        field.save(update_fields=["clean_name"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("forms", "0004_formfield_locale_formfield_translation_key_and_more"),
+    ]
+
+    operations = [
+        migrations.RunPython(fix_empty_clean_names, reverse_code=migrations.RunPython.noop),
+    ]

forms/models.py

@@ -9,6 +9,7 @@
 from wagtail.contrib.forms.forms import BaseForm, FormBuilder
 from wagtail.contrib.forms.models import AbstractEmailForm, AbstractFormField
 from wagtail.contrib.forms.panels import FormSubmissionsPanel
+from wagtail.contrib.forms.utils import get_field_clean_name
 from wagtail.fields import RichTextField
 from wagtail.models import TranslatableMixin
 from wagtail_honeypot.models import HoneypotFormMixin, HoneypotFormSubmissionMixin
@@ -43,6 +44,13 @@ class FormField(TranslatableMixin, AbstractFormField):
         SynchronizedField("clean_name", overridable=False),
     ]
 
+    def save(self, *args, **kwargs):
+        # Guarantee clean_name is always set, even if pk is already assigned (e.g. when
+        # reconstructed from a revision via from_serializable_data before the first DB insert).
+        if not self.clean_name:
+            self.clean_name = get_field_clean_name(self.label)
+        super().save(*args, **kwargs)
+
     class Meta(TranslatableMixin.Meta, AbstractFormField.Meta):
         verbose_name = _("Form field")
         verbose_name_plural = _("Form fields")

forms/tests/test_forms.py

@@ -3,7 +3,7 @@
 from wagtail.test.utils import WagtailPageTestCase
 from wagtail_localize.models import TranslationSource
 
-from forms.models import FormPage
+from forms.models import FormField, FormPage
 
 
 class FormsTestCase(WagtailPageTestCase):
@@ -56,6 +56,57 @@ def test_incorrect_form_is_rejected(self):
         )
         # Updates sometimes mess with the order of the translations and so the displayed translation. Both are fine.
 
+    def test_form_field_clean_name_set_on_save(self):
+        """
+        Regression test: FormField.clean_name must never be empty after save.
+
+        Certain code paths (e.g. reconstruction from a page revision via
+        from_serializable_data) can produce FormField instances whose pk is
+        already set before save() is called, causingAbstractFormField.save()
+        to skip the clean_name computation (it only runs when pk is None).
+        This leaves clean_name as "" in the database, making all BO responses
+        appear as None.
+        """
+        form_page = FormPage.objects.first()
+
+        # Simulate the problematic path: a FormField whose pk is pre-assigned
+        # (non-None) but whose clean_name is still empty, as happens when
+        # from_serializable_data reconstructs a child object from a revision.
+        field = FormField.objects.filter(page=form_page).first()
+        original_clean_name = field.clean_name
+
+        field.clean_name = ""
+        field.save()
+
+        field.refresh_from_db()
+        self.assertNotEqual(field.clean_name, "", "clean_name should not be empty after save")
+        self.assertEqual(field.clean_name, original_clean_name)
+
+    def test_get_data_fields_has_no_empty_clean_names(self):
+        """
+        Regression test: every FormField returned by get_data_fields() must
+        have a non-empty clean_name.
+
+        If clean_name is "" in the DB, get_data_fields() returns ("", label)
+        tuples. The BO then calls form_data.get("") which is always None, and
+        the xlsx export collapses all "" keys so every column header becomes
+        the last field's label.
+        """
+        form_page = FormPage.objects.first()
+
+        # Force empty clean_names on all fields to simulate the buggy state.
+        FormField.objects.filter(page=form_page).update(clean_name="")
+
+        # Re-save each field; the overridden save() must restore clean_name.
+        for field in FormField.objects.filter(page=form_page):
+            field.save()
+
+        data_fields = form_page.get_data_fields()
+        for name, label in data_fields:
+            if name == "submit_time":
+                continue
+            self.assertNotEqual(name, "", f"Field '{label}' has an empty clean_name after save()")
+
     def test_form_field_labels_are_translatable(self):
         form_page = FormPage.objects.first()
         source, _ = TranslationSource.update_or_create_from_instance(form_page)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sites-conformes"
-version = "3.1.0"
+version = "3.1.1"
 description = "Gestionnaire de contenu permettant de créer et gérer un site internet basé sur le Système de design de l’État, accessible et responsive"
 authors = [
     { name = "Sites Conformes dev team", email = "contact@sites.beta.gouv.fr" }