capture mutable fields changes

Author: Alaanali

django_lifecycle/mixins.py

@@ -1,3 +1,4 @@
+from copy import deepcopy
 from functools import partial, reduce, lru_cache
 from inspect import isfunction
 from typing import Any, List
@@ -81,7 +82,7 @@ def __init__(self, *args, **kwargs):
         self._initial_state = self._snapshot_state()
 
     def _snapshot_state(self):
-        state = self.__dict__.copy()
+        state = deepcopy(self.__dict__)
 
         for watched_related_field in self._watched_fk_model_fields():
             state[watched_related_field] = self._current_value(watched_related_field)

tests/testapp/migrations/0006_useraccount_configurations.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0b1 on 2024-02-20 11:04
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("testapp", "0005_modelwithgenericforeignkey"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="useraccount",
+            name="configurations",
+            field=models.JSONField(default=dict),
+        ),
+    ]

tests/testapp/models.py

@@ -37,6 +37,7 @@ class UserAccount(LifecycleModel):
     has_trial = models.BooleanField(default=False)
     organization = models.ForeignKey(Organization, null=True, on_delete=models.SET_NULL)
     name_changes = models.IntegerField(default=0)
+    configurations = models.JSONField(default=dict)
 
     status = models.CharField(
         default="active",

tests/testapp/tests/test_mixin.py

@@ -55,6 +55,7 @@ def test_snapshot_state(self):
                 "status": "active",
                 "organization.name": "Dunder Mifflin",
                 "name_changes": 0,
+                "configurations": {},
             },
         )
 
@@ -77,6 +78,15 @@ def test_initial_value_if_field_has_changed(self):
         self.assertFalse(user_account.has_changed("username"))
         user_account.username = "Josephine"
         self.assertEqual(user_account.initial_value("username"), "Joe")
+    
+    def test_initial_value_if_mutable_field_has_changed(self):
+        data = self.stub_data
+        UserAccount.objects.create(**data)
+        user_account = UserAccount.objects.get()
+        self.assertFalse(user_account.has_changed("configurations"))
+        user_account.configurations['notifications'] = True
+        self.assertTrue(user_account.has_changed("configurations"))
+        self.assertEqual(user_account.initial_value("configurations"), {})
 
     def test_initial_value_if_field_has_not_changed(self):
         data = self.stub_data