flask-postgresql-audit 1.0.3__tar.gz → 1.0.4__tar.gz

{flask_postgresql_audit-1.0.3 → flask_postgresql_audit-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flask-postgresql_audit
-Version: 1.0.3
+Version: 1.0.4
 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.0.3 → flask_postgresql_audit-1.0.4}/flask_postgresql_audit/__init__.py

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

{flask_postgresql_audit-1.0.3 → flask_postgresql_audit-1.0.4}/flask_postgresql_audit/alembic/entities.py

@@ -46,6 +46,15 @@ def trigger_update_factory(**context):
     )
 
 
+def get_pk_values(**context):
+    sql = parse_template("get_pk_values.sql", **context)
+    return PGFunction(
+        schema=context["schema_name"],
+        signature="get_pk_values(relid oid, row_data jsonb)",
+        definition=sql["definition"],
+    )
+
+
 def get_setting_factory(**context):
     sql = parse_template("get_setting.sql", **context)
     return PGFunction(

{flask_postgresql_audit-1.0.3 → flask_postgresql_audit-1.0.4}/flask_postgresql_audit/alembic/setup.py

@@ -62,6 +62,7 @@ def setup_db(audit: "PostgreSQLAudit"):
 
 def register_core_entities(audit: "PostgreSQLAudit"):
     audit.pg_audit_entities.add(entities.btree_gist)
+    audit.pg_audit_entities.add(entities.get_pk_values(**audit.context))
     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.create_activity_factory(**audit.context))

{flask_postgresql_audit-1.0.3 → flask_postgresql_audit-1.0.4}/flask_postgresql_audit/base.py

@@ -22,6 +22,7 @@ class ActivityBase:
     native_transaction_id: OMap[int] = mapped_column(BigInteger, index=True)
     verb: OMap[str] = mapped_column(Text)
 
+    row_key: OMap[list[str]] = mapped_column(JSONB, default=[], server_default="[]")
     old_data: OMap[dict] = mapped_column(JSONB, default={}, server_default="{}")
     changed_data: OMap[dict] = mapped_column(JSONB, default={}, server_default="{}")
 

{flask_postgresql_audit-1.0.3 → flask_postgresql_audit-1.0.4}/flask_postgresql_audit/templates/create_activity.sql

@@ -20,7 +20,7 @@ BEGIN
     IF (TG_OP = 'UPDATE') THEN
         INSERT INTO ${schema_prefix}pga_activity(
             id, schema_name, table_name, relid, issued_at, native_transaction_id,
-            verb, old_data, changed_data, transaction_id)
+            verb, row_key, old_data, changed_data, transaction_id)
         SELECT
             nextval('${schema_prefix}pga_activity_id_seq') as id,
             TG_TABLE_SCHEMA::text AS schema_name,
@@ -29,6 +29,7 @@ BEGIN
             statement_timestamp() AT TIME ZONE 'UTC' AS issued_at,
             txid_current() AS native_transaction_id,
             LOWER(TG_OP) AS verb,
+            ${schema_prefix}get_pk_values(TG_RELID, new_data) AS row_key,
             old_data - excluded_cols AS old_data,
             ${schema_prefix}jsonb_subtract(new_data, old_data) - excluded_cols AS changed_data,
             _transaction_id AS transaction_id
@@ -48,7 +49,7 @@ BEGIN
     ELSIF (TG_OP = 'INSERT') THEN
         INSERT INTO ${schema_prefix}pga_activity(
             id, schema_name, table_name, relid, issued_at, native_transaction_id,
-            verb, old_data, changed_data, transaction_id)
+            verb, row_key, old_data, changed_data, transaction_id)
         SELECT
             nextval('${schema_prefix}pga_activity_id_seq') as id,
             TG_TABLE_SCHEMA::text AS schema_name,
@@ -57,6 +58,7 @@ BEGIN
             statement_timestamp() AT TIME ZONE 'UTC' AS issued_at,
             txid_current() AS native_transaction_id,
             LOWER(TG_OP) AS verb,
+            ${schema_prefix}get_pk_values(TG_RELID, to_jsonb(new_table)) AS row_key,
             '{}'::jsonb AS old_data,
             row_to_json(new_table.*)::jsonb - excluded_cols AS changed_data,
             _transaction_id AS transaction_id
@@ -64,7 +66,7 @@ BEGIN
     ELSEIF TG_OP = 'DELETE' THEN
         INSERT INTO ${schema_prefix}pga_activity(
             id, schema_name, table_name, relid, issued_at, native_transaction_id,
-            verb, old_data, changed_data, transaction_id)
+            verb, row_key, old_data, changed_data, transaction_id)
         SELECT
             nextval('${schema_prefix}pga_activity_id_seq') as id,
             TG_TABLE_SCHEMA::text AS schema_name,
@@ -73,6 +75,7 @@ BEGIN
             statement_timestamp() AT TIME ZONE 'UTC' AS issued_at,
             txid_current() AS native_transaction_id,
             LOWER(TG_OP) AS verb,
+            ${schema_prefix}get_pk_values(TG_RELID, to_jsonb(old_table)) AS row_key,
             row_to_json(old_table.*)::jsonb - excluded_cols AS old_data,
             '{}'::jsonb AS changed_data,
             _transaction_id AS transaction_id

flask_postgresql_audit-1.0.4/flask_postgresql_audit/templates/get_pk_values.sql

@@ -0,0 +1,22 @@
+CREATE OR REPLACE FUNCTION get_pk_values(relid oid, row_data jsonb) RETURNS jsonb AS $$
+    DECLARE
+        pk_columns text [];
+        pk_values jsonb;
+    BEGIN
+        SELECT array_agg(a.attname ORDER BY a.attnum) INTO pk_columns
+        FROM pg_index i
+            JOIN pg_attribute a ON a.attrelid = i.indrelid
+                AND a.attnum = ANY(i.indkey)
+        WHERE i.indrelid = relid
+            AND i.indisprimary;
+
+        IF pk_columns IS NULL THEN
+            RETURN '{}'::jsonb;
+        END IF;
+
+        SELECT jsonb_agg(row_data->>col) INTO pk_values
+        FROM unnest(pk_columns) AS col;
+
+        RETURN pk_values;
+    END;
+$$ LANGUAGE plpgsql;

{flask_postgresql_audit-1.0.3 → flask_postgresql_audit-1.0.4}/tests/test_defaults.py

@@ -9,6 +9,7 @@ class TestCustomSchemaactivityCreation:
     def test_insert(self, user):
         stmt = sa.select(audit.Activity).limit(1)
         if activity := db.session.scalar(stmt):
+            assert activity.row_key == ["1"]
             assert activity.old_data == {}
             assert activity.changed_data == {"id": user.id, "name": "John", "age": 15}
             assert activity.table_name == "user"