Ensure dirty-bit is updated when calling save on a syncable model with update_fields

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 List of the most important changes for each release.
 
+## 0.8.12
+- Fixes issue where dirty-bit isn't updated when calling save on a syncable model with `update_fields`
+
 ## 0.8.11
 - Adds additional `deserialization_exception` field to `Store` model to track the fully qualified exception path
 

morango/__init__.py

@@ -1 +1 @@
-__version__ = "0.8.11"
+__version__ = "0.8.12"

morango/models/core.py

@@ -849,6 +849,13 @@ def save(self, update_dirty_bit_to=True, *args, **kwargs):
             self._morango_dirty_bit = True
         elif not update_dirty_bit_to:
             self._morango_dirty_bit = False
+
+        # ensure the dirty bit field is in the fields to update if present, to keep it in sync
+        if update_dirty_bit_to is not None and kwargs.get("update_fields") is not None:
+            kwargs["update_fields"] = set(kwargs["update_fields"]) | {
+                "_morango_dirty_bit"
+            }
+
         super(SyncableModel, self).save(*args, **kwargs)
 
     def delete(

tests/testapp/tests/integration/test_syncing_models.py

@@ -67,6 +67,24 @@ def test_syncable_save(self):
         user.save(update_dirty_bit_to=None)
         self.assertTrue(MyUser.objects.first()._morango_dirty_bit)
 
+    def test_syncable_save_with_update_fields_persists_dirty_bit(self):
+        user = MyUser.objects.first()
+        user.save(update_dirty_bit_to=False)
+        self.assertFalse(MyUser.objects.first()._morango_dirty_bit)
+
+        user.username = "updated-name"
+        user.save(update_fields=["username"])
+        self.assertTrue(MyUser.objects.first()._morango_dirty_bit)
+
+    def test_syncable_save_with_update_fields_when_to_ignore_dirty_bit(self):
+        user = MyUser.objects.first()
+        user.save(update_dirty_bit_to=False)
+        self.assertFalse(MyUser.objects.first()._morango_dirty_bit)
+
+        user.username = "updated-name"
+        user.save(update_dirty_bit_to=None, update_fields=["username"])
+        self.assertFalse(MyUser.objects.first()._morango_dirty_bit)
+
     def test_syncing_objects_manager_with_custom_default_manager(self):
         """Test that syncing_objects manager includes all objects even when default manager filters them out"""
         # Create some test objects