Exclude ManyToManyFields when using bulk_create_with_history (#699)

* Add failing test for bulk_create_with_history

* Exclude ManyToManyFields in bulk_create_with_history

* Fix unrelated test failure

* Format

* Add myself to AUTHORS.rst

* Add entry to CHANGES.rst

Author: sbuss

AUTHORS.rst

@@ -95,6 +95,7 @@ Authors
 - Shane Engelman
 - Steeve Chailloux
 - Stefan Borer (`sbor23 <https://github.com/sbor23>`_)
+- Steven Buss (`sbuss <https://github.com/sbuss>`_)
 - Steven Klass
 - Tommy Beadle (`tbeadle <https://github.com/tbeadle>`_)
 - Trey Hunner (`treyhunner <https://github.com/treyhunner>`_)

CHANGES.rst

@@ -4,6 +4,7 @@ Changes
 Unreleased
 ----------
 - Add default date to ``bulk_create_with_history`` and ``bulk_update_with_history`` (gh-687)
+- Exclude ManyToManyFields when using ``bulk_create_with_history`` (gh-699)
 
 2.11.0 (2020-06-20)
 -------------------

simple_history/tests/models.py

@@ -693,3 +693,13 @@ class ForeignKeyToSelfModel(models.Model):
 class Street(models.Model):
     name = models.CharField(max_length=150)
     log = HistoricalRecords(related_name="history")
+
+
+class BulkCreateManyToManyModelOther(models.Model):
+    name = models.CharField(max_length=15, unique=True)
+
+
+class BulkCreateManyToManyModel(models.Model):
+    name = models.CharField(max_length=15, unique=True)
+    other = models.ManyToManyField(BulkCreateManyToManyModelOther)
+    history = HistoricalRecords()

simple_history/tests/tests/test_utils.py

@@ -10,6 +10,7 @@
 
 from simple_history.exceptions import NotHistoricalModelError
 from simple_history.tests.models import (
+    BulkCreateManyToManyModel,
     Document,
     Place,
     Poll,
@@ -179,7 +180,8 @@ def test_bulk_create_no_ids_return(self, hist_manager_mock):
             objects=Mock(
                 bulk_create=Mock(return_value=[Place(name="Place 1")]),
                 filter=Mock(return_value=objects),
-            )
+            ),
+            _meta=Mock(get_fields=Mock(return_value=[])),
         )
         result = bulk_create_with_history(objects, model)
         self.assertEqual(result, objects)
@@ -192,6 +194,22 @@ def test_bulk_create_no_ids_return(self, hist_manager_mock):
         )
 
 
+class BulkCreateWithManyToManyField(TestCase):
+    def setUp(self):
+        self.data = [
+            BulkCreateManyToManyModel(name="Object 1"),
+            BulkCreateManyToManyModel(name="Object 2"),
+            BulkCreateManyToManyModel(name="Object 3"),
+            BulkCreateManyToManyModel(name="Object 4"),
+            BulkCreateManyToManyModel(name="Object 5"),
+        ]
+
+    def test_bulk_create_with_history(self):
+        bulk_create_with_history(self.data, BulkCreateManyToManyModel)
+
+        self.assertEqual(BulkCreateManyToManyModel.objects.count(), 5)
+
+
 @skipIf(django.VERSION < (2, 2,), reason="bulk_update does not exist before 2.2")
 class BulkUpdateWithHistoryTestCase(TestCase):
     def setUp(self):

simple_history/utils.py

@@ -2,6 +2,7 @@
 
 import django
 from django.db import transaction
+from django.db.models import ManyToManyField
 from django.forms.models import model_to_dict
 
 from simple_history.exceptions import NotHistoricalModelError
@@ -69,7 +70,13 @@ def bulk_create_with_history(
         record
     :return: List of objs with IDs
     """
-
+    # Exclude ManyToManyFields because they end up as invalid kwargs to
+    # model.objects.filter(...) below.
+    exclude_fields = [
+        field.name
+        for field in model._meta.get_fields()
+        if isinstance(field, ManyToManyField)
+    ]
     history_manager = get_history_manager_for_model(model)
     second_transaction_required = True
     with transaction.atomic(savepoint=False):
@@ -88,7 +95,10 @@ def bulk_create_with_history(
         with transaction.atomic(savepoint=False):
             for obj in objs_with_id:
                 attributes = dict(
-                    filter(lambda x: x[1] is not None, model_to_dict(obj).items())
+                    filter(
+                        lambda x: x[1] is not None,
+                        model_to_dict(obj, exclude=exclude_fields).items(),
+                    )
                 )
                 obj_list += model.objects.filter(**attributes)
             history_manager.bulk_history_create(