Fix IntegrityError when cloning objects with pk=None (#664)

[kubajecminek]

Hi, thank you for auditlog.

This pull request fixes bug number #664. It is naive implementation but it seems that it works as expected. Please let me know what you think so I can adjust the patch accordingly.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.54%. Comparing base (5289482) to head (04386bc).
Report is 41 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #707      +/-   ##
==========================================
+ Coverage   95.21%   95.54%   +0.32%     
==========================================
  Files          31       33       +2     
  Lines        1025     1101      +76     
==========================================
+ Hits          976     1052      +76     
  Misses         49       49              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[hramezani]

why does this test here do?

[kubajecminek]

It disables test_create_duplicate_with_pk_none test for models which have another model as primary key (ModelPrimaryKeyModel).

[hramezani]

The fix that you did prevent log entry creation in case of pk is None, why did the log entry count increased by one?

[kubajecminek]

New entry has been created because we duplicated obj which is expected behavior. auditlog currently thinks that we're updating the object which is why it crashes on IntegrityError.

[hramezani]

Thanks @kubajecminek for the fix. I do not entirely understand the problem. could you please provide more information like error trace back?

Also, please add an entry to changelog file.

[kubajecminek]

Thanks for the review.

Thanks @kubajecminek for the fix. I do not entirely understand the problem. could you please provide more information like error trace back?

Sure. You can copy/duplicate object in Django with this trick:

entry = LogEntry.objects.first()
entry.pk = None
entry.save() # New object will be created

However auditlog thinks that we're updating the object.

Here's sample backtrace from running the tests without the fix:

======================================================================
ERROR: test_create_duplicate_with_pk_none (auditlog_tests.tests.UUIDPrimaryKeyModelModelWithActorTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/backends/utils.py", line 89, in _execute
    return self.cursor.execute(sql, params)
psycopg2.errors.NotNullViolation: null value in column "object_pk" of relation "auditlog_logentry" violates not-null constraint
DETAIL:  Failing row contains (512, null, null, UUIDPrimaryKeyModel object (None), 1, {"text": ["None", "I am strange."], "boolean": ["None", "False"]..., 2025-03-18 16:45:42.081858+00, null, 11, null, null, null, null, , null, null).


The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/Users/kuba.jecminek/Code/django-auditlog/auditlog_tests/tests.py", line 242, in test_create_duplicate_with_pk_none
    obj.save()
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/base.py", line 814, in save
    self.save_base(
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/base.py", line 861, in save_base
    pre_save.send(
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/dispatch/dispatcher.py", line 176, in send
    return [
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/dispatch/dispatcher.py", line 177, in <listcomp>
    (receiver, receiver(signal=self, sender=sender, **named))
  File "/Users/kuba.jecminek/Code/django-auditlog/auditlog/receivers.py", line 27, in wrapper
    signal_handler(*args, **kwargs)
  File "/Users/kuba.jecminek/Code/django-auditlog/auditlog/receivers.py", line 59, in log_update
    _create_log_entry(
  File "/Users/kuba.jecminek/Code/django-auditlog/auditlog/receivers.py", line 146, in _create_log_entry
    raise error
  File "/Users/kuba.jecminek/Code/django-auditlog/auditlog/receivers.py", line 124, in _create_log_entry
    log_entry = LogEntry.objects.log_create(
  File "/Users/kuba.jecminek/Code/django-auditlog/auditlog/models.py", line 77, in log_create
    return self.create(**kwargs)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/manager.py", line 87, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/query.py", line 658, in create
    obj.save(force_insert=True, using=self.db)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/base.py", line 814, in save
    self.save_base(
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/base.py", line 877, in save_base
    updated = self._save_table(
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/base.py", line 1020, in _save_table
    results = self._do_insert(
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/base.py", line 1061, in _do_insert
    return manager._insert(
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/manager.py", line 87, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/query.py", line 1805, in _insert
    return query.get_compiler(using=using).execute_sql(returning_fields)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/models/sql/compiler.py", line 1822, in execute_sql
    cursor.execute(sql, params)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/backends/utils.py", line 67, in execute
    return self._execute_with_wrappers(
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/backends/utils.py", line 80, in _execute_with_wrappers
    return executor(sql, params, many, context)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/backends/utils.py", line 89, in _execute
    return self.cursor.execute(sql, params)
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/utils.py", line 91, in __exit__
    raise dj_exc_value.with_traceback(traceback) from exc_value
  File "/Users/kuba.jecminek/Code/django-auditlog/.tox/py39-django42/lib/python3.9/site-packages/django/db/backends/utils.py", line 89, in _execute
    return self.cursor.execute(sql, params)
django.db.utils.IntegrityError: null value in column "object_pk" of relation "auditlog_logentry" violates not-null constraint
DETAIL:  Failing row contains (512, null, null, UUIDPrimaryKeyModel object (None), 1, {"text": ["None", "I am strange."], "boolean": ["None", "False"]..., 2025-03-18 16:45:42.081858+00, null, 11, null, null, null, null, , null, null).

Also, please add an entry to changelog file.

Will do!

[hramezani]

Thanks @kubajecminek