Просмотр исходного кода

Fixes #23603: Keep cleared fields on form refresh (#23709)

An edit form refresh now sends an empty value for each cleared multiple
select, so the re-rendered form no longer falls back to the saved
selection. Dynamic choice fields also ignore an invalid value when
resolving initial_params, which the cable form receives once a
termination side is empty.

Fixes #23603
Martin Hauser 34 минут назад
Родитель
Сommit
2c6751f18d

Разница между файлами не показана из-за своего большого размера
+ 0 - 0
netbox/project-static/dist/netbox.js


Разница между файлами не показана из-за своего большого размера
+ 0 - 0
netbox/project-static/dist/netbox.js.map


+ 33 - 2
netbox/project-static/src/htmx.ts

@@ -8,6 +8,12 @@ import { initMessages } from './messages';
 import { initQuickAdd } from './quickAdd';
 import { focusFirstFormError } from './forms/errors';
 
+type HtmxConfigRequestDetail = {
+  elt: Element;
+  verb: string;
+  formData: FormData;
+};
+
 type HtmxSettleDetail = {
   elt?: Element;
   target?: Element;
@@ -28,6 +34,30 @@ function initDepedencies(): void {
   initMessages();
 }
 
+/**
+ * On an object edit form refresh (see HTMXSelect), send each cleared multiple select as an empty
+ * value, so the server does not render its saved selection again.
+ */
+function includeClearedMultipleSelects(event: Event): void {
+  const { elt, verb, formData } = (event as CustomEvent<HtmxConfigRequestDetail>).detail;
+  const include = elt.getAttribute('hx-include');
+  if (verb !== 'get' || !include?.startsWith('#') || !elt.closest('form.object-edit')) return;
+
+  // htmx applies hx-params before this event, so leave filtered requests as they are
+  const params = elt.closest('[hx-params], [data-hx-params]');
+  const filter = params?.getAttribute('hx-params') ?? params?.getAttribute('data-hx-params');
+  if (params && filter !== '*') return;
+
+  const container = document.getElementById(include.slice(1));
+  const selects = container?.querySelectorAll<HTMLSelectElement>('select[multiple]');
+  for (const select of selects ?? []) {
+    const empty = !select.selectedOptions.length;
+    if (select.name && empty && !select.matches(':disabled') && !formData.has(select.name)) {
+      formData.append(select.name, '');
+    }
+  }
+}
+
 /**
  * Reveal validation errors only for a swapped-in form submission, scoped to the swapped content.
  * Dependent-field refreshes post on `change` and re-render a bound form, so gating on the verb
@@ -48,10 +78,11 @@ function revealSubmissionErrors(event: Event): void {
 }
 
 /**
- * Hook into HTMX's event system to reinitialize specific native event listeners when HTMX swaps
- * elements.
+ * Hook into HTMX's event system to complete object edit form refreshes, and to reinitialize specific
+ * native event listeners when HTMX swaps elements.
  */
 export function initHtmx(): void {
+  document.addEventListener('htmx:configRequest', includeClearedMultipleSelects);
   document.addEventListener('htmx:afterSettle', event => {
     initDepedencies();
     revealSubmissionErrors(event);

+ 5 - 1
netbox/utilities/forms/fields/dynamic.py

@@ -145,7 +145,11 @@ class DynamicModelChoiceMixin:
                 if value:
                     filter_kwargs[kwarg] = value
             if filter_kwargs:
-                queryset = self.queryset.filter(**filter_kwargs)
+                try:
+                    queryset = self.queryset.filter(**filter_kwargs)
+                except (TypeError, ValueError):
+                    # Catch any error caused by invalid initial data passed from the user
+                    queryset = self.queryset.none()
                 if isinstance(self, forms.ModelMultipleChoiceField):
                     # A lookup across a reverse relation yields one row per matching child
                     self.initial = list(queryset.distinct())

+ 10 - 2
netbox/utilities/tests/test_forms.py

@@ -766,7 +766,7 @@ class DynamicModelChoiceFieldTestCase(TestCase):
         )
         Rack.objects.bulk_create(cls.racks)
 
-    def _make_form(self, site_field_class, data=None, rack_context=None):
+    def _make_form(self, site_field_class, data=None, rack_context=None, rack_initial=None):
         class TestForm(forms.Form):
             rack = DynamicModelMultipleChoiceField(queryset=Rack.objects.all(), required=False, context=rack_context)
             site = site_field_class(
@@ -774,7 +774,9 @@ class DynamicModelChoiceFieldTestCase(TestCase):
                 required=False,
                 initial_params={'racks__in': '$rack'},
             )
-        return TestForm(data=data, initial={'rack': [rack.pk for rack in self.racks]})
+        if rack_initial is None:
+            rack_initial = [rack.pk for rack in self.racks]
+        return TestForm(data=data, initial={'rack': rack_initial})
 
     def test_multiple_choice_field_selects_every_matching_object(self):
         """A multiple-choice parent field selects every distinct object matched by initial_params."""
@@ -801,6 +803,12 @@ class DynamicModelChoiceFieldTestCase(TestCase):
         self.assertIn(field.initial, self.sites)
         self.assertEqual(field.queryset.count(), 1)
 
+    def test_invalid_child_value_leaves_initial_unset(self):
+        """An invalid child value leaves a parent field without an initial value."""
+        field = self._make_form(DynamicModelMultipleChoiceField, rack_initial=[''])['site'].field
+
+        self.assertFalse(field.initial)
+
     def test_options_name_their_parent(self):
         """Each rendered option names its parent object."""
         html = str(self._make_form(DynamicModelMultipleChoiceField, rack_context={'parent': 'site'})['rack'])

Некоторые файлы не были показаны из-за большого количества измененных файлов