Changes logged for JSON-field aren't valid JSON

[lukaszett]

Hello everyone,

suppose I have the following model:

from django.db import models

from auditlog.registry import auditlog

class Foo(models.Model):
    bar = models.JSONField()


auditlog.register(Foo)

Now I create a new instance and check for the last LogEntry:

Foo.objects.create(bar={"baz":1})
entry = LogEntry.objects.latest()
bar_changes = entry.changes_dict.get("bar")
new_bar = bar_changes[1]
print(new_bar)

This outputs:

{'baz': 1}

I would expect the log entries for JsonFields to be a valid string to feed into json.loads however, the double quotes around the keys get converted into single quotes which is not allowed for json. I did some digging into where this conversion happens but I didn't really come to a conclusion.

Is this the desired behaviour or is it a bug?

[hramezani]

Hello @lukaszett,

Thanks for reporting this issue.

I think it's because we don't dumps the JSONField value to when we make the diff.

django-auditlog/auditlog/diff.py

Line 75 in 971a4f4

value = field.to_python(getattr(obj, field.name, None))

Probably it can be fixed by changing it like

value = json.dumps(field.to_python(getattr(obj, field.name, None)))

Would you like to work on it @lukaszett ?

[CleitonDeLima]

Can i do a PR of this @hramezani?

[hramezani]

@CleitonDeLima sure!
But first of all try to reproduce the problem on master. I guess the problem might be fixed by the breaking chane PR that got merged yesterday.