Merge pull request #70 from cloudblue/fix/LITE-23027

LITE-23027 `cqrs.bulk_update` now supports `previous_data`

Author: d3rky

dj_cqrs/managers.py

@@ -1,7 +1,9 @@
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 
 import logging
 
+from dj_cqrs.constants import FIELDS_TRACKER_FIELD_NAME, TRACKED_FIELDS_ATTR_NAME
+
 from django.core.exceptions import ValidationError
 from django.db import Error, IntegrityError, transaction
 from django.db.models import F, Manager
@@ -25,8 +27,7 @@ def bulk_create(self, objs, **kwargs):
         objs = super().bulk_create(objs, **kwargs)
 
         if objs:
-            model = type(objs[0])
-            model.call_post_bulk_create(objs, using=self.db)
+            self.model.call_post_bulk_create(objs, using=self.db)
 
         return objs
 
@@ -36,12 +37,33 @@ def bulk_update(self, queryset, **kwargs):
         :param django.db.models.QuerySet queryset: Django Queryset (f.e. filter)
         :param kwargs: Update kwargs
         """
-        with transaction.atomic():
+        prev_data_mapper = {}
+        collect_prev_data = hasattr(self.model, FIELDS_TRACKER_FIELD_NAME)
+
+        def list_all():
+            return list(queryset.all())
+
+        with transaction.atomic(savepoint=False):
+            if collect_prev_data:
+                objs = list_all()
+                if not objs:
+                    return
+
+                for obj in objs:
+                    prev_data_mapper[obj.pk] = getattr(obj, FIELDS_TRACKER_FIELD_NAME).current()
+
             current_dt = timezone.now()
             result = queryset.update(
                 cqrs_revision=F('cqrs_revision') + 1, cqrs_updated=current_dt, **kwargs,
             )
-        queryset.model.call_post_update(list(queryset.all()), using=queryset.db)
+
+            objs = list_all()
+            if collect_prev_data:
+                for obj in objs:
+                    setattr(obj, TRACKED_FIELDS_ATTR_NAME, prev_data_mapper.get(obj.pk))
+
+        queryset.model.call_post_update(objs, using=queryset.db)
+
         return result
 
 

dj_cqrs/tracker.py

@@ -1,4 +1,6 @@
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
+
+from datetime import date, datetime
 
 from dj_cqrs.constants import ALL_BASIC_FIELDS, FIELDS_TRACKER_FIELD_NAME
 
@@ -25,6 +27,14 @@ def changed(self):
     def changed_initial(self):
         return {field: None for field in self.fields if self.get_field_value(field) is not None}
 
+    def get_field_value(self, field):
+        value = super().get_field_value(field)
+
+        if isinstance(value, (date, datetime)):
+            value = str(value)
+
+        return value
+
 
 class CQRSTracker(FieldTracker):
 

tests/test_master/test_mixin.py

@@ -1,5 +1,6 @@
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 
+from datetime import timedelta
 from time import sleep
 from uuid import uuid4
 
@@ -636,6 +637,29 @@ def test_cqrs_tracked_fields_tracking(mocker):
     assert tracked_data == {'cqrs_revision': 0, 'char_field': 'Value'}
 
 
+@pytest.mark.django_db(transaction=True)
+def test_cqrs_tracked_fields_date_and_datetime_tracking(mocker):
+    old_dt = now()
+    old_d = (old_dt + timedelta(days=1)).date()
+
+    models.BasicFieldsModel.objects.create(
+        int_field=1,
+        datetime_field=old_dt,
+        date_field=old_d,
+    )
+
+    publisher_mock = mocker.patch('dj_cqrs.controller.producer.produce')
+    instance = models.BasicFieldsModel.objects.first()
+    instance.datetime_field = now()
+    instance.date_field = now().date()
+    instance.save()
+
+    tracked_data = instance.get_tracked_fields_data()
+    assert publisher_mock.call_args[0][0].previous_data == tracked_data == {
+        'cqrs_revision': 0, 'datetime_field': str(old_dt), 'date_field': str(old_d),
+    }
+
+
 def test_mptt_cqrs_tracked_fields_model_has_tracker():
     instance = models.MPTTWithTrackingModel()
     tracker = getattr(instance, FIELDS_TRACKER_FIELD_NAME)

tests/test_master/test_signals.py

@@ -1,4 +1,4 @@
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 
 from datetime import datetime, timezone
 
@@ -10,7 +10,7 @@
 import pytest
 
 from tests.dj_master import models
-from tests.utils import assert_publisher_once_called_with_args
+from tests.utils import assert_is_sub_dict, assert_publisher_once_called_with_args
 
 
 @pytest.mark.parametrize('model', (models.AllFieldsModel, models.BasicFieldsModel))
@@ -136,7 +136,7 @@ def test_automatic_post_bulk_create(mocker):
 
 
 @pytest.mark.django_db(transaction=True)
-def test_post_bulk_update(mocker):
+def test_post_bulk_update_wout_prev_data(mocker):
     for i in range(3):
         models.SimplestModel.objects.create(id=i)
     cqrs_updated = models.SimplestModel.objects.get(id=1).cqrs_updated
@@ -155,3 +155,55 @@ def test_post_bulk_update(mocker):
     m = models.SimplestModel.objects.get(id=1)
     assert m.cqrs_updated > cqrs_updated
     assert m.cqrs_revision == 1
+
+
+@pytest.mark.django_db(transaction=True)
+def test_post_bulk_update_with_prev_data(mocker):
+    for i in range(3):
+        models.SimplestTrackedModel.objects.create(id=i, description='old')
+
+    m = models.SimplestTrackedModel.objects.get(id=1)
+    m.status = 'x'
+    m.save()
+
+    publisher_mock = mocker.patch('dj_cqrs.controller.producer.produce')
+    models.SimplestTrackedModel.cqrs.bulk_update(
+        queryset=models.SimplestTrackedModel.objects.filter(id__in={0, 1}).order_by('id'),
+        description='new',
+        status=None,
+    )
+
+    m = models.SimplestTrackedModel.objects.get(id=2)
+    assert m.cqrs_revision == 0
+
+    assert publisher_mock.call_count == 2
+    for pk, prev_data in (
+        (0, {'description': 'old', 'status': None}),
+        (1, {'description': 'old', 'status': 'x'}),
+    ):
+        t0_payload = publisher_mock.call_args_list[pk][0][0]
+        assert t0_payload.signal_type == SignalType.SAVE
+        assert t0_payload.cqrs_id == models.SimplestTrackedModel.CQRS_ID
+        assert t0_payload.pk == pk
+
+        assert_is_sub_dict(
+            {'id': pk, 'description': 'new', 'status': None},
+            t0_payload.instance_data,
+        )
+        assert t0_payload.previous_data == prev_data
+
+        m = models.SimplestTrackedModel.objects.get(id=pk)
+        assert m.cqrs_revision == pk + 1
+        assert m.description == 'new'
+        assert m.status is None
+
+
+@pytest.mark.django_db
+def test_post_bulk_update_nothing_to_update(mocker):
+    publisher_mock = mocker.patch('dj_cqrs.controller.producer.produce')
+    models.SimplestTrackedModel.cqrs.bulk_update(
+        queryset=models.SimplestTrackedModel.objects.all(),
+        description='something',
+    )
+
+    publisher_mock.assert_not_called()