diff --git a/CHANGELOG.md b/CHANGELOG.md index ffafec8..8b77774 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Next Release +#### Fixes + +- `KeyError` when calling `changes_str` on a log entry that tracks many-to-many field changes ([#798](https://github.com/jazzband/django-auditlog/pull/798)) + ## 3.4.1 (2025-12-13) #### Fixes diff --git a/auditlog/models.py b/auditlog/models.py index edc5dd2..dd5158e 100644 --- a/auditlog/models.py +++ b/auditlog/models.py @@ -1,7 +1,7 @@ import ast import contextlib import json -from collections.abc import Callable +from collections.abc import Callable, Sequence from copy import deepcopy from datetime import timezone from typing import Any @@ -427,21 +427,31 @@ class AbstractLogEntry(models.Model): not satisfying, please use :py:func:`LogEntry.changes_dict` and format the string yourself. :param colon: The string to place between the field name and the values. - :param arrow: The string to place between each old and new value. + :param arrow: The string to place between each old and new value (non-m2m field changes only). :param separator: The string to place between each field. :return: A readable string of the changes in this log entry. """ substrings = [] - for field, values in self.changes_dict.items(): - substring = "{field_name:s}{colon:s}{old:s}{arrow:s}{new:s}".format( - field_name=field, - colon=colon, - old=values[0], - arrow=arrow, - new=values[1], - ) - substrings.append(substring) + if all(isinstance(value, Sequence) for value in self.changes_dict.values()): + substrings = [ + "{field_name:s}{colon:s}{old:s}{arrow:s}{new:s}".format( + field_name=field, + colon=colon, + old=values[0], + arrow=arrow, + new=values[1], + ) + for field, values in sorted(self.changes_dict.items()) + ] + elif all( + isinstance(value, dict) and value.get("type") == "m2m" + for value in self.changes_dict.values() + ): + substrings = [ + f"{field}{colon}{value_dict['operation']} {sorted(value_dict['objects'])}" + for field, value_dict in self.changes_dict.items() + ] return separator.join(substrings) diff --git a/auditlog_tests/tests.py b/auditlog_tests/tests.py index aba766e..6764195 100644 --- a/auditlog_tests/tests.py +++ b/auditlog_tests/tests.py @@ -131,6 +131,11 @@ class SimpleModelTest(TestCase): {"boolean": ["False", "True"]}, msg="The change is correctly logged", ) + self.assertEqual( + history.changes_str, + "boolean: False → True", + msg="Changes string is correct", + ) def test_update_specific_field_supplied_via_save_method(self): obj = self.obj @@ -149,6 +154,11 @@ class SimpleModelTest(TestCase): "when using the `update_fields`." ), ) + self.assertEqual( + obj.history.get(action=LogEntry.Action.UPDATE).changes_str, + "boolean: False → True", + msg="Changes string is correct", + ) def test_django_update_fields_edge_cases(self): """ @@ -179,6 +189,11 @@ class SimpleModelTest(TestCase): {"boolean": ["False", "True"], "integer": ["None", "1"]}, msg="The 2 fields changed are correctly logged", ) + self.assertEqual( + obj.history.get(action=LogEntry.Action.UPDATE).changes_str, + "boolean: False → True; integer: None → 1", + msg="Changes string is correct", + ) def test_delete(self): """Deletion is logged correctly.""" @@ -494,6 +509,13 @@ class ManyRelatedModelTest(TestCase): }, ) + def test_changes_str(self): + self.obj.related.add(self.related) + log_entry = self.obj.history.first() + self.assertEqual( + log_entry.changes_str, f"related: add {[smart_str(self.related)]}" + ) + def test_adding_existing_related_obj(self): self.obj.related.add(self.related) log_entry = self.obj.history.first() @@ -725,6 +747,11 @@ class SimpleIncludeModelTest(TestCase): {"label": ["Initial label", "New label"]}, msg="Only the label was logged, regardless of multiple entries in `update_fields`", ) + self.assertEqual( + obj.history.get(action=LogEntry.Action.UPDATE).changes_str, + "label: Initial label → New label", + msg="Changes string is correct", + ) def test_register_include_fields(self): sim = SimpleIncludeModel(label="Include model", text="Looong text") @@ -2061,6 +2088,11 @@ class JSONModelTest(TestCase): {"json": ["{}", '{"quantity": "1"}']}, msg="The change is correctly logged", ) + self.assertEqual( + history.changes_str, + 'json: {} → {"quantity": "1"}', + msg="Changes string is correct", + ) def test_update_with_no_changes(self): """No changes are logged.""" @@ -2697,6 +2729,7 @@ class TestAccessLog(TestCase): ) self.assertIsNone(log_entry.changes) self.assertEqual(log_entry.changes_dict, {}) + self.assertEqual(log_entry.changes_str, "") class SignalTests(TestCase): @@ -3120,6 +3153,9 @@ class BaseManagerSettingTest(TestCase): } }, ) + self.assertEqual( + log_entry.changes_str, f"m2m_related: add {[smart_str(obj_two)]}" + ) class TestMaskStr(TestCase):