flask-postgresql-audit 1.1.2__tar.gz → 1.1.3__tar.gz

{flask_postgresql_audit-1.1.2 → flask_postgresql_audit-1.1.3}/CHANGES.md

@@ -3,6 +3,10 @@
 Here you can see the full list of changes between each Flask-PostgreSQL-Audit
 release.
 
+## 1.1.3 (2026-08-21)
+
+-   Add `jsonb_diff()` function to recursively compute differences across JSONB objects and arrays.
+
 ## 1.1.2 (2026-08-21)
 
 -   Add dedicated `jsonb_array_subtract()` function to support set difference operations on JSONB arrays.

{flask_postgresql_audit-1.1.2 → flask_postgresql_audit-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: flask-postgresql-audit
-Version: 1.1.2
+Version: 1.1.3
 Summary: Versioning and auditing extension for PostgreSQL and SQLAlchemy.
 Project-URL: Homepage, https://github.com/higamigu/flask-postgresql-audit
 Author-email: Higamigu <higamigu@gmail.com>, Konsta Vesterinen <konsta@fastmonkeys.com>

{flask_postgresql_audit-1.1.2 → flask_postgresql_audit-1.1.3}/flask_postgresql_audit/__init__.py

@@ -1,4 +1,4 @@
 # ruff: noqa: F401
 from .core import Audit, PostgreSQLAudit
 
-__version__ = "1.1.2"
+__version__ = "1.1.3"

{flask_postgresql_audit-1.1.2 → flask_postgresql_audit-1.1.3}/flask_postgresql_audit/alembic/entities.py

@@ -90,3 +90,13 @@ def jsonb_array_subtract_factory(**context):
         signature="jsonb_array_subtract(arg1 jsonb, arg2 jsonb)",
         definition=sql["definition"],
     )
+
+
+def jsonb_diff_factory(**context):
+    context.setdefault("jsonb_subtract_join_type", "LEFT")
+    sql = parse_template("jsonb_diff.sql", **context)
+    return PGFunction(
+        schema=context["schema_name"],
+        signature="jsonb_diff(arg1 jsonb, arg2 jsonb)",
+        definition=sql["definition"],
+    )

{flask_postgresql_audit-1.1.2 → flask_postgresql_audit-1.1.3}/flask_postgresql_audit/alembic/setup.py

@@ -129,6 +129,7 @@ def register_core_entities(audit: "PostgreSQLAudit"):
     audit.pg_audit_entities.add(entities.get_setting_factory(**audit.context))
     audit.pg_audit_entities.add(entities.jsonb_subtract_factory(**audit.context))
     audit.pg_audit_entities.add(entities.jsonb_array_subtract_factory(**audit.context))
+    audit.pg_audit_entities.add(entities.jsonb_diff_factory(**audit.context))
     audit.pg_audit_entities.add(entities.create_activity_factory(**audit.context))
 
 

flask_postgresql_audit-1.1.3/flask_postgresql_audit/templates/jsonb_diff.sql

@@ -0,0 +1,42 @@
+CREATE FUNCTION ${schema_prefix}jsonb_diff(arg1 jsonb, arg2 jsonb) RETURNS jsonb AS $$
+SELECT
+    CASE
+        WHEN jsonb_typeof(arg1) = 'array' AND jsonb_typeof(arg2) = 'array' THEN
+            ${schema_prefix}jsonb_array_subtract(arg1, arg2)
+        WHEN jsonb_typeof(arg1) = 'object' AND jsonb_typeof(arg2) = 'object' THEN
+            COALESCE(
+                (
+                    SELECT json_object_agg(
+                        KEY,
+                        CASE
+                            WHEN new_type = 'object' AND old_type = 'object'
+                                THEN ${schema_prefix}jsonb_diff(new_value, old_value)
+                            WHEN new_type = 'array' AND old_type = 'array'
+                                THEN ${schema_prefix}jsonb_diff(new_value, old_value)
+                            ELSE new_value
+                        END
+                    )
+                    FROM (
+                        SELECT KEY, VALUE AS new_value, jsonb_typeof(VALUE) AS new_type
+                        FROM jsonb_each(arg1)
+                    ) AS NEW
+                    ${jsonb_subtract_join_type} OUTER JOIN (
+                        SELECT KEY, VALUE AS old_value, jsonb_typeof(VALUE) AS old_type
+                        FROM jsonb_each(arg2)
+                    ) AS OLD
+                    USING (KEY)
+                    WHERE new_value IS DISTINCT FROM old_value
+                )::jsonb,
+                '{}'::jsonb
+            )
+        WHEN jsonb_typeof(arg1) = 'array' THEN
+            ${schema_prefix}jsonb_array_subtract(arg1, arg2)
+        WHEN jsonb_typeof(arg1) = 'object' AND (arg2 IS NULL OR jsonb_typeof(arg2) != 'object') THEN
+            arg1
+        WHEN arg1 IS DISTINCT FROM arg2 THEN
+            arg1
+        ELSE
+            NULL
+    END
+$$ LANGUAGE SQL;
+

{flask_postgresql_audit-1.1.2 → flask_postgresql_audit-1.1.3}/tests/test_operators.py

@@ -63,3 +63,51 @@ def test_jsonb_array_subtract(test_client, arg1, arg2, result):
         )
         == result
     )
+
+
+JSONB_DIFF = "SELECT {schema}jsonb_diff((:new)::jsonb, (:old)::jsonb)"
+
+
+@pytest.mark.parametrize(
+    ("old", "new", "result"),
+    (
+        ({}, {}, {}),
+        ({"age": 13}, {"age": 14}, {"age": 14}),
+        ({"name": "Someone"}, {"name": "Someone"}, {}),
+        (
+            {"a": {"b": 1, "c": 2}},
+            {"a": {"b": 1, "c": 3}},
+            {"a": {"c": 3}},
+        ),
+        ([2], [1, 2, 3], [1, 3]),
+        ([1, 2, 3], [1, 2, 3], []),
+        (
+            {"tags": [2], "name": "a"},
+            {"tags": [1, 2, 3], "name": "a"},
+            {"tags": [1, 3]},
+        ),
+        (
+            {"tags": [1, 2], "name": "a"},
+            {"tags": [1, 2], "name": "a"},
+            {},
+        ),
+        (
+            {"data": {"items": ["b"], "meta": {"v": 1}}},
+            {"data": {"items": ["a", "b", "c"], "meta": {"v": 2}}},
+            {"data": {"items": ["a", "c"], "meta": {"v": 2}}},
+        ),
+        (
+            [{"id": 1}],
+            [{"id": 1}, {"id": 2}],
+            [{"id": 2}],
+        ),
+    ),
+)
+def test_jsonb_diff(test_client, old, new, result):
+    assert (
+        db.session.scalar(
+            text(JSONB_DIFF.format(schema=audit.context["schema_prefix"])),
+            {"old": json.dumps(old), "new": json.dumps(new)},
+        )
+        == result
+    )