(Bug/fix) support for DJANGO_EASY_AUDIT_CRUD_EVENT_NO_CHANGED_FIELDS_…

…SKIP (#129)

also removes non-supported python version (django 2.0 does not support them); tightens up travis CI

.travis.yml

@@ -3,20 +3,19 @@ language: python
 dist: xenial
 
 python:
-    - '2.7'
     - '3.4'
     - '3.5'
     - '3.6'
     - '3.7'
-    - 'pypy2.7-6.0'
-    - 'pypy3.5-6.0'
+    - '3.8'
+    - 'pypy3'
 
 env:
-    - DJANGO="django>=1.11,<2.0"
-    - DJANGO="django>=1.11.17,<2.0"
     - DJANGO="django>=2.0,<2.1"
     - DJANGO="django>=2.1,<2.2"
-    - DJANGO="django>=2.2,<3.0"
+    - DJANGO="django>=2.2,<2.2.8"
+    - DJANGO="django>=2.2.8,<3.0"
+    - DJANGO="django>=3.0,<3.1"
 
 install:
     - pip install ${DJANGO}
@@ -30,31 +29,19 @@ script:
 
 matrix:
   exclude:
-    - python: "2.7"
-      env: DJANGO="django>=2.0,<2.1"
-    - python: "2.7"
-      env: DJANGO="django>=2.1,<2.2"
-    - python: "2.7"
-      env: DJANGO="django>=2.2,<3.0"
-    - python: "pypy2.7-6.0"
-      env: DJANGO="django>=1.11.17,<2.0"
-    - python: "pypy2.7-6.0"
-      env: DJANGO="django>=2.0,<2.1"
-    - python: "pypy2.7-6.0"
+    - python: "3.4"
       env: DJANGO="django>=2.1,<2.2"
-    - python: "pypy2.7-6.0"
-      env: DJANGO="django>=2.2,<3.0"
     - python: "3.4"
-      env: DJANGO="django>=1.11.17,<2.0"
+      env: DJANGO="django>=2.2,<2.2.8"
     - python: "3.4"
-      env: DJANGO="django>=2.1,<2.2"
+      env: DJANGO="django>=2.2.8,<3.0"
     - python: "3.4"
-      env: DJANGO="django>=2.2,<3.0"
+      env: DJANGO="django>=3.0,<3.1"
     - python: "3.5"
-      env: DJANGO="django>=1.11.17,<2.0"
-    - python: "3.6"
-      env: DJANGO="django>=1.11.17,<2.0"
-    - python: "pypy3.5-6.0"
-      env: DJANGO="django>=1.11.17,<2.0"
-    - python: "3.7"
-      env: DJANGO="django>=1.11,<2.0"
+      env: DJANGO="django>=3.0,<3.1"
+    - python: "3.8"
+      env: DJANGO="django>=2.0,<2.1"
+    - python: "3.8"
+      env: DJANGO="django>=2.1,<2.2"
+    - python: "3.8"
+      env: DJANGO="django>=2.2,<2.2.8"

README.md

@@ -96,6 +96,14 @@ Below are some of the settings you may want to use. These should be defined in y
   this is necessary in order to keep database atomicity concerns in check during signal handlers.
 
   To clarify, this is only _truly_ necessary for the model signals.
+
+* `DJANGO_EASY_AUDIT_CRUD_EVENT_NO_CHANGED_FIELDS_SKIP`
+
+  By default this is `False`, but this allows the calling project not to save `CRUDEvent` if the changed fields as
+  determined by the `pre_save` handler sees that there are no changed fields. We are keeping it off by default so that
+  projects that wish to use this (potentially less `CRUDEvent`) can choose to turn it on! And those that do not want it (yet or ever),
+  or those that do not closely follow the release notes of this project will have one less worry when upgrading.
+
 
 * `DJANGO_EASY_AUDIT_LOGGING_BACKEND`
 

easyaudit/settings.py

@@ -94,6 +94,12 @@ def get_model_list(class_list):
         CRUD_DIFFERENCE_CALLBACKS[idx] = getattr(import_module('.'.join(callback.split('.')[:-1])),
                                                  callback.split('.')[-1], None)
 
+# although this setting "exists" here we do not intend to use it anywhere due to test run issues
+# maybe we can properly solve this at a latter time. instead, anything inside of this library
+# should do the same getattr check here, bsaed on normal `settings` from `django.conf`.
+CRUD_EVENT_NO_CHANGED_FIELDS_SKIP = getattr(settings, "DJANGO_EASY_AUDIT_CRUD_EVENT_NO_CHANGED_FIELDS_SKIP", False)
+
+
 # Purge table optimization:
 # If TRUNCATE_TABLE_SQL_STATEMENT is not empty, we use it as custom sql statement
 # to speed up table truncation bypassing ORM, i.e.:

easyaudit/signals/model_signals.py

@@ -71,7 +71,7 @@ def pre_save(sender, instance, raw, using, update_fields, **kwargs):
             if not created:
                 old_model = sender.objects.get(pk=instance.pk)
                 delta = model_delta(old_model, instance)
-                if not delta:
+                if not delta and getattr(settings, "DJANGO_EASY_AUDIT_CRUD_EVENT_NO_CHANGED_FIELDS_SKIP", False):
                     return False
                 changed_fields = json.dumps(delta)
                 event_type = CRUDEvent.UPDATE

easyaudit/tests/test_app/tests.py

@@ -1,12 +1,11 @@
 # -*- coding: utf-8 -*-
 import json
 import re
+
 from django.test import TestCase, override_settings
 
-try: # Django 2.0
-    from django.urls import reverse
-except: # Django < 2.0
-    from django.core.urlresolvers import reverse
+from django.urls import reverse
+
 from django.contrib.auth.models import User
 from django.contrib.contenttypes.models import ContentType
 import bs4
@@ -50,6 +49,17 @@ def test_m2m_model(self):
         data = json.loads(crud_event.object_json_repr)[0]
         self.assertEqual(data['fields']['test_m2m'], [obj.id])
 
+    @override_settings(DJANGO_EASY_AUDIT_CRUD_EVENT_NO_CHANGED_FIELDS_SKIP=True)
+    def test_update_skip_no_changed_fields(self):
+        obj = TestModel.objects.create()
+        crud_event_qs = CRUDEvent.objects.filter(object_id=obj.id, content_type=ContentType.objects.get_for_model(obj))
+        self.assertEqual(1, crud_event_qs.count())
+        obj.name = 'changed name'
+        obj.save()
+        self.assertEqual(2, crud_event_qs.count())
+        last_change = crud_event_qs.first()
+        self.assertIn('name', last_change.changed_fields)
+
     def test_update(self):
         obj = TestModel.objects.create()
         crud_event_qs = CRUDEvent.objects.filter(object_id=obj.id, content_type=ContentType.objects.get_for_model(obj))
@@ -60,12 +70,19 @@ def test_update(self):
         last_change = crud_event_qs.first()
         self.assertIn('name', last_change.changed_fields)
 
-    def test_fake_update(self):
+    @override_settings(DJANGO_EASY_AUDIT_CRUD_EVENT_NO_CHANGED_FIELDS_SKIP=True)
+    def test_fake_update_skip_no_changed_fields(self):
         obj = TestModel.objects.create()
         crud_event_qs = CRUDEvent.objects.filter(object_id=obj.id, content_type=ContentType.objects.get_for_model(obj))
         obj.save()
         self.assertEqual(1, crud_event_qs.count())
 
+    def test_fake_update(self):
+        obj = TestModel.objects.create()
+        crud_event_qs = CRUDEvent.objects.filter(object_id=obj.id, content_type=ContentType.objects.get_for_model(obj))
+        obj.save()
+        self.assertEqual(2, crud_event_qs.count())
+
 
 @override_settings(TEST=True)
 class TestMiddleware(TestCase):

setup.py

@@ -33,11 +33,12 @@
         'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.2',
-        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3 :: Only',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Topic :: Software Development :: Libraries :: Python Modules',
     ],
 )