Fix m2m saved when simple history disabled (#1329)

* if statement to check settings * Updated changes * added reference to issue * added name as required * trigger test * Added test for #1329 and improved changelog --------- Co-authored-by: Anders <[email protected]>
jazzband · May 14, 2024 · bf58d58 · bf58d58
1 parent 23ef769
commit bf58d58
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -141,6 +141,7 @@ Authors
 - `ddusi <https://github.com/ddusi>`_
 - `DanialErfanian <https://github.com/DanialErfanian>`_
 - `Sridhar Marella <https://github.com/sridhar562345>`_
+- `Mattia Fantoni <https://github.com/MattFanto>`_
 
 Background
 ==========

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -25,6 +25,8 @@ Unreleased
 - Added a "Changes" column to ``SimpleHistoryAdmin``'s object history table, listing
   the changes between each historical record of the object; see the docs under
   "Customizing the History Admin Templates" for overriding its template context (gh-1128)
+- Fixed the setting ``SIMPLE_HISTORY_ENABLED = False`` not preventing M2M historical
+  records from being created (gh-1328)
 
 3.5.0 (2024-02-19)
 ------------------

diff --git a/simple_history/models.py b/simple_history/models.py
@@ -673,6 +673,8 @@ def get_change_reason_for_object(self, instance, history_type, using):
         return utils.get_change_reason_from_object(instance)
 
     def m2m_changed(self, instance, action, attr, pk_set, reverse, **_):
+        if not getattr(settings, "SIMPLE_HISTORY_ENABLED", True):
+            return
         if hasattr(instance, "skip_history_when_saving"):
             return
 

diff --git a/simple_history/tests/tests/test_models.py b/simple_history/tests/tests/test_models.py
@@ -2411,6 +2411,22 @@ def test_skip_history(self):
         self.assertEqual(skip_poll.history.all().count(), 2)
         self.assertEqual(skip_poll.history.all()[0].places.count(), 2)
 
+    @override_settings(SIMPLE_HISTORY_ENABLED=False)
+    def test_saving_with_disabled_history_doesnt_create_records(self):
+        # 1 from `setUp()`
+        self.assertEqual(PollWithManyToMany.history.count(), 1)
+
+        poll = PollWithManyToMany.objects.create(
+            question="skip history?", pub_date=today
+        )
+        poll.question = "huh?"
+        poll.save()
+        poll.places.add(self.place)
+
+        self.assertEqual(poll.history.count(), 0)
+        # The count should not have changed
+        self.assertEqual(PollWithManyToMany.history.count(), 1)
+
     def test_diff_against(self):
         self.poll.places.add(self.place)
         add_record, create_record = self.poll.history.all()