[fix]: Prevent FallbackMixin from generating spurious migrations

The deconstruct() method was serializing the fallback kwarg into Django migration files. This caused new migrations to be generated whenever the fallback default value changed in settings, even though no actual database schema change had occurred.

The fix removes fallback from deconstruct() so Django no longer tracks it as part of the field migration state. fallback is also made optional in __init__ (defaulting to None) so existing migrations that omit the kwarg remain valid.

Fixes: #1231

Author: shivsubh

openwisp_utils/fields.py

@@ -47,15 +47,18 @@ class FallbackMixin(object):
     field will save `None` in the database.
     """
 
+    non_db_attrs = ("fallback",)
+
     def __init__(self, *args, **kwargs):
-        self.fallback = kwargs.pop("fallback")
+        self.fallback = kwargs.pop("fallback", None)
         opts = dict(blank=True, null=True, default=None)
         opts.update(kwargs)
         super().__init__(*args, **opts)
 
     def deconstruct(self):
         name, path, args, kwargs = super().deconstruct()
-        kwargs["fallback"] = self.fallback
+        if self.fallback is not None:
+            kwargs["fallback"] = self.fallback
         return (name, path, args, kwargs)
 
     def from_db_value(self, value, expression, connection):

tests/test_project/tests/test_model.py

@@ -180,3 +180,25 @@ def test_fallback_decimal_field(self):
             book.save(update_fields=["price"])
             book.refresh_from_db(fields=["price"])
             self.assertEqual(book.price, 56)
+
+    def test_fallback_field_deconstruct(self):
+        with self.subTest("FallbackBooleanChoiceField"):
+            field = OrganizationRadiusSettings._meta.get_field("is_active")
+            name, path, args, kwargs = field.deconstruct()
+            self.assertIn("fallback", kwargs)
+        with self.subTest("FallbackCharField"):
+            field = OrganizationRadiusSettings._meta.get_field("greeting_text")
+            name, path, args, kwargs = field.deconstruct()
+            self.assertIn("fallback", kwargs)
+        with self.subTest("FallbackDecimalField"):
+            field = Book._meta.get_field("price")
+            name, path, args, kwargs = field.deconstruct()
+            self.assertIn("fallback", kwargs)
+        with self.subTest("FallbackPositiveIntegerField"):
+            field = Shelf._meta.get_field("books_count")
+            name, path, args, kwargs = field.deconstruct()
+            self.assertIn("fallback", kwargs)
+        with self.subTest("Plain field without fallback"):
+            field = Shelf._meta.get_field("name")
+            name, path, args, kwargs = field.deconstruct()
+            self.assertNotIn("fallback", kwargs)