logidze 1.0.0.rc1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 747454e7c38a1969f39ed1f4b9d9142b2afc48d7ed7c34534b82abcac88dc4d7
-  data.tar.gz: 2522172435f01b7d4441479f5f0c3e1bf08cde1f36e6ac9c745c8c8a20bd1d6f
+  metadata.gz: be9e11a375ab711ba02349e3cd14fbd4503af6572d969ced6db24bd36407bf05
+  data.tar.gz: '03885f890051fc938cba4089798bcc8b1b753a5ae941c5d93907536e1685ff94'
 SHA512:
-  metadata.gz: cbbcbe791ca4f682f75c188c0b65db6f8244dea84a6cb5390a85c980921f1f84bf3676962dbb5792cf5ac2d7a24f0dbf1ac6b916f7bf03a1a13a1820ebc89507
-  data.tar.gz: 4514014a739bc452aa7ad8fb26495a96aa651bfa3c8c4784021c1e2d13874c003c57e24b28ac6397f5ca5239e4e65dd76f0565df7af69ad29bbc8dd63630cc8b
+  metadata.gz: 24bc6a181263eaeb98762e8c183ba74b717a3195d2809460ceeddfbeefdc63c4b72e3c5da2b8426bba2722c765a41c27bf3ff2d3e265b5760a561795e205ee5a
+  data.tar.gz: 96f0e22ccad449d642320a9bf105e05ed15623ecaa1a52e453bfda356df2dbf9cb13eda235c6e288e1cf62d0484234f92104673c7ef15c9fbfe135d8bb757b16

data/CHANGELOG.md

@@ -2,7 +2,40 @@
 
 ## master (unreleased)
 
-## 1.0.0.rc1 (2020-09-01)
+## 1.2.1 (2022-01-13)
+
+- [Fixes [#207](https://github.com/palkan/logidze/issues/207)] Add support for the use of `table_name_prefix` or `table_name_suffix`. ([@cavi21][])
+
+- [Fixes [#205](https://github.com/palkan/logidze/issues/205)] Allow `rails destroy logidze:model SomeModel` to delete the migration file. ([@danielmklein][])
+
+## 1.2.0 (2021-06-11)
+
+- Add user-defined exception handling ([@skryukov][])
+
+By default, Logidze raises an exception which causes the entire transaction to fail.
+To change this behavior, it's now possible to override `logidze_capture_exception(error_data jsonb)` function.
+
+- [Fixes [#69](https://github.com/palkan/logidze/issues/69)] Fallback on NUMERIC_VALUE_OUT_OF_RANGE exception ([@skryukov][])
+
+- [Fixes [#192](https://github.com/palkan/logidze/issues/192)] Skip `log_data` column during `apply_column_diff` ([@skryukov][])
+
+## 1.1.0 (2021-03-31)
+
+- Add pending upgrade checks [Experimental]. ([@skryukov][])
+
+Now Logidze can check for a pending upgrade. Use `Logidze.pending_upgrade = :warn` to be notified by warning, or `Logidze.pending_upgrade = :error` if you want Logidze to raise an error.
+
+- [Fixes [#171](https://github.com/palkan/logidze/issues/171)] Stringify jsonb column values within snapshots. ([@skryukov][])
+
+- [Fixes [#175](https://github.com/palkan/logidze/issues/175)] Set dynamic ActiveRecord version for migrations. ([@skryukov][])
+
+- [Fixes [#184](https://github.com/palkan/logidze/issues/184)] Remove Rails meta-gem dependency ([@bf4][])
+
+## 1.0.0 (2020-11-09)
+
+- Add `--name` option to model generator to specify the migration name. ([@palkan][])
+
+When you update Logidze installation for a model multiple times, you might hit the `DuplicateMigrationNameError` (see [#167](https://github.com/palkan/logidze/issues/167)).
 
 - Add `.with_full_snapshot` to add full snapshots to the log instead of diffs. ([@palkan][])
 
@@ -330,3 +363,7 @@ This is a quick fix for a more general problem (see [#59](https://github.com/pal
 [@zocoi]: https://github.com/zocoi
 [@duderman]: https://github.com/duderman
 [@oleg-kiviljov]: https://github.com/oleg-kiviljov
+[@skryukov]: https://github.com/skryukov
+[@bf4]: https://github.com/bf4
+[@cavi21]: https://github.com/cavi21
+[@danielmklein]: https://github.com/danielmklein

data/README.md

@@ -1,6 +1,6 @@
 [![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](http://cultofmartians.com)
 [![Gem Version](https://badge.fury.io/rb/logidze.svg)](https://rubygems.org/gems/logidze)
-![Build](https://github.com/palkan/logidze/workflows/Build/badge.svg)
+[![Build](https://github.com/palkan/logidze/workflows/Build/badge.svg)](https://github.com/palkan/logidze/actions)
 [![Open Source Helpers](https://www.codetriage.com/palkan/logidze/badges/users.svg)](https://www.codetriage.com/palkan/logidze)
 
 # Logidze
@@ -10,8 +10,6 @@ Logidze provides tools for logging DB records changes when using PostgreSQL (>=9
 Logidze allows you to create a DB-level log (using triggers) and gives you an API to browse this log.
 The log is stored with the record itself in JSONB column. No additional tables required.
 
-**❗️ IMPORTANT:** This page contains documentation for the upcoming v1.0. For the latest release documentation see the [0-stable branch](https://github.com/palkan/logidze/tree/0-stable). If you're just starting with Logidze, we recommend using the latest release candidate (`1.0.0.rc1`).
-
 🤔 [How is Logidze pronounced?](https://github.com/palkan/logidze/issues/73)
 
 Other requirements:
@@ -24,18 +22,19 @@ Other requirements:
 
 ## Links
 
+- [Logidze 1.0: Active Record, Postgres, Rails, and time travel](https://evilmartians.com/chronicles/logidze-1-0-active-record-postgresql-rails-and-time-travel?utm_source=logidze)
 - [Logidze: for all those tired of versioning data](https://evilmartians.com/chronicles/introducing-logidze?utm_source=logidze)
 
 ## Table of contents
 
-- [Main concepts](#main-concepts)
 - [Installation & Configuration](#installation)
   - [Using with schema.rb](#using-with-schemarb)
-  - [Configuration models](#configuration-models)
+  - [Configuring models](#configuring-models)
   - [Backfill data](#backfill-data)
-  - [Log size limit](#log-size-limit)
+  - [Log size limits](#log-size-limits)
   - [Tracking only selected columns](#tracking-only-selected-columns)
   - [Logs timestamps](#logs-timestamps)
+  - [Undoing a Generated Invocation](#undoing-a-generated-invocation)
 - [Usage](#usage)
   - [Basic API](#basic-api)
   - [Track meta information](#track-meta-information)
@@ -46,6 +45,7 @@ Other requirements:
   - [Associations versioning](#associations-versioning)
 - [Dealing with large logs](#dealing-with-large-logs)
 - [Handling records deletion](#handling-records-deletion)
+- [Handling PG exceptions](#handling-pg-exceptions)
 - [Upgrading](#upgrading)
 - [Log format](#log-format)
 - [Troubleshooting 🚨](#troubleshooting)
@@ -56,7 +56,7 @@ Other requirements:
 Add Logidze to your application's Gemfile:
 
 ```ruby
-gem "logidze", "1.0.0.rc1"
+gem "logidze", "~> 1.1"
 ```
 
 Install required DB extensions and create trigger function:
@@ -135,8 +135,8 @@ Model.create_logidze_snapshot
 Model.create_logidze_snapshot(timestamp: :created_at)
 
 # filter columns
-Model.create_logidze_snapshot(only: %(name))
-Model.create_logidze_snapshot(except: %(password))
+Model.create_logidze_snapshot(only: %w[name])
+Model.create_logidze_snapshot(except: %w[password])
 
 # or call a similar method (but with !) on a record
 
@@ -179,6 +179,16 @@ bundle exec rails generate logidze:model Post --timestamp_column time
 bundle exec rails generate logidze:model Post --timestamp_column nil # "null" and "false" will also work
 ```
 
+### Undoing a Generated Invocation
+
+If you would like to re-do your `rails generate` anew, as with other generators you can use `rails destroy` to revert it, which will delete the migration file and undo the injection of `has_logidze` into the model file:
+
+```sh
+bundle exec rails destroy logidze:model Post
+```
+
+**IMPORTANT**: If you use non-UTC time zone for Active Record (`config.active_record.default_timezone`), you MUST always infer log timestamps from a timestamp column (e.g., when back-filling data); otherwise, you may end up with inconsistent logs ([#199](https://github.com/palkan/logidze/issues/199)). In general, we recommend using UTC as the database time unless there is a very strong reason not to.
+
 ## Usage
 
 ### Basic API
@@ -275,11 +285,13 @@ Logidze.append_on_undo = true
 You can store any meta information you want inside your version (it could be IP address, user agent, etc.). To add it you should wrap your code with a block:
 
 ```ruby
-Logidze.with_meta(ip: request.ip) do
+Logidze.with_meta({ip: request.ip}) do
   post.save!
 end
 ```
 
+**NOTE:** You should pass metadata as a Hash; passing keyword arguments doesn't work in Ruby 3.0+.
+
 Meta expects a hash to be passed so you won't need to encode and decode JSON manually.
 
 By default `.with_meta` wraps the block into a DB transaction. That could lead to an unexpected behavior, especially, when using `.with_meta` within an around_action. To avoid wrapping the block into a DB transaction use `transactional: false` option.
@@ -436,12 +448,21 @@ If you want to keep changes history after records deletion as well, consider usi
 
 See also the discussion: [#61](https://github.com/palkan/logidze/issues/61).
 
+## Handling PG exceptions
+
+By default, Logidze raises an exception which causes the entire transaction to fail.
+To change this behavior, it's now possible to override `logidze_capture_exception(error_data jsonb)` function.
+
+For example, you may want to raise a warning instead of an exception and complete the transaction without updating log_data.
+
+Related issues: [#193](https://github.com/palkan/logidze/issues/193)
+
 ## Upgrading
 
 We try to make an upgrade process as simple as possible. For now, the only required action is to create and run a migration:
 
 ```sh
-rails generate logidze:install --update
+bundle exec rails generate logidze:install --update
 ```
 
 This updates core `logdize_logger` DB function. No need to update tables or triggers.
@@ -451,23 +472,37 @@ This updates core `logdize_logger` DB function. No need to update tables or trig
 If you want to update Logidze settings for the model, run migration with `--update` flag:
 
 ```sh
-rails generate logidze:model Post --update --only=title,body,rating
+bundle exec rails generate logidze:model Post --update --only=title,body,rating
 ```
 
+You can also use the `--name` option to specify the migration name to avoid duplicate migration names:
+
+```sh
+$ bundle exec rails generate logidze:model Post --update --only=title,body,rating --name add_only_filter_to_posts_log_data
+
+    create db/migrate/20202309142344_add_only_filter_to_posts_log_data.rb
+```
+
+### Pending upgrade check [Experimental]
+
+Logidze can check for a pending upgrade. Use `Logidze.on_pending_upgrade = :warn` to be notified by warning, or `Logidze.on_pending_upgrade = :error` if you want Logidze to raise an error.
+
 ### Upgrading from 0.x to 1.0 (edge)
 
 #### Schema and migrations
 
-Most SQL functions definitions has changed without backward compatibility.
+Most SQL function definitions have changed without backward compatibility.
 Perform the following steps to upgrade:
 
-1. Re-install Logidze: `rails generate logidze:install --update`.
+1. Re-install Logidze: `bundle exec rails generate logidze:install --update`.
+
+1. Re-install Logidze triggers **for all models**: `bundle exec rails generate logidze:model <model> --update`.
 
-1. Re-install Logidze triggers **for all models**: `rails generate logidze:model <model> --update`.
+   **NOTE:** If you had previously specified whitelist/blacklist attributes, you will need to include the `--only`/`--except` [option](#tracking-only-selected-columns) as appropriate. You can easily copy these column lists from the previous logidze migration for the model.
 
 1. Remove the `include Logidze::Migration` line from the old migration files (if any)—this module has been removed.
 
-Rewrite the migrations to not use the `#current_setting(name)` and `#current_setting_missing_supported?` methods or copy them from the latest [0.x release](https://github.com/palkan/logidze/blob/0-stable/lib/logidze/migration.rb).
+Rewrite legacy logidze migrations to not use the `#current_setting(name)` and `#current_setting_missing_supported?` methods, or copy them from the latest [0.x release](https://github.com/palkan/logidze/blob/0-stable/lib/logidze/migration.rb).
 
 #### API changes
 
@@ -532,11 +567,27 @@ First, when restoring data dumps you should consider using `--disable-triggers`
 
 When restoring data dumps for a particular PostgreSQL schema (e.g., when using Apartment), you may encounter the issue with non-existent Logidze functions. That happens because `pg_dump` adds `SELECT pg_catalog.set_config('search_path', '', false);`, and, thus, breaks our existing triggers/functions, because they live either in "public" or in a tenant's namespace (see [this thread](https://postgrespro.com/list/thread-id/2448092)).
 
+### `PG::NumericValueOutOfRange: ERROR: value overflows numeric format`
+
+Due to the usage of `hstore_to_jsonb_loose` under the hood, there could be a situation when you have a string representing a number in the scientific notation (e.g., "557236406134e62000323100"). Postgres would try to convert it to a number (a pretty big one, for sure) and fail with the exception.
+
+Related issues: [#69](https://github.com/palkan/logidze/issues/69).
+
 ## Development
 
-We use [Dip](https://github.com/bibendi/dip) for development. Provision the project by running `dip provision` and then use `dip bundle`, `dip rspec` or `dip bash` to interact with a Docker development environment.
+This project requires a PostgreSQL instance running with the following setup:
+
+```sh
+# For testing
+createdb -h postgres -U postgres logidze_test
+
+# For benchmarks
+createdb -h postgres -U postgres logidze_bench
+createdb -h postgres -U postgres logidze_perf_bench
+psql -d logidze_bench -c 'CREATE EXTENSION IF NOT EXISTS hstore;'
+```
 
-If you prefer developing on your local machine, make user you have Postgres installed and run `./bin/setup`.
+This project is compatible with [Reusable Docker environment](https://evilmartians.com/chronicles/reusable-development-containers-with-docker-compose-and-dip) setup.
 
 ## Contributing
 

data/lib/generators/logidze/install/functions/logidze_capture_exception.sql

@@ -0,0 +1,23 @@
+CREATE OR REPLACE FUNCTION logidze_capture_exception(error_data jsonb) RETURNS boolean AS $body$
+  -- version: 1
+BEGIN
+  -- Feel free to change this function to change Logidze behavior on exception.
+  --
+  -- Return `false` to raise exception or `true` to commit record changes.
+  --
+  -- `error_data` contains:
+  --   - returned_sqlstate
+  --   - message_text
+  --   - pg_exception_detail
+  --   - pg_exception_hint
+  --   - pg_exception_context
+  --   - schema_name
+  --   - table_name
+  -- Learn more about available keys:
+  -- https://www.postgresql.org/docs/9.6/plpgsql-control-structures.html#PLPGSQL-EXCEPTION-DIAGNOSTICS-VALUES
+  --
+
+  return false;
+END;
+$body$
+LANGUAGE plpgsql;

data/lib/generators/logidze/install/functions/logidze_compact_history.sql

@@ -1,5 +1,5 @@
--- version: 1
 CREATE OR REPLACE FUNCTION logidze_compact_history(log_data jsonb, cutoff integer DEFAULT 1) RETURNS jsonb AS $body$
+  -- version: 1
   DECLARE
     merged jsonb;
   BEGIN

data/lib/generators/logidze/install/functions/logidze_filter_keys.sql

@@ -1,5 +1,5 @@
--- version: 1
 CREATE OR REPLACE FUNCTION logidze_filter_keys(obj jsonb, keys text[], include_columns boolean DEFAULT false) RETURNS jsonb AS $body$
+  -- version: 1
   DECLARE
     res jsonb;
     key text;

data/lib/generators/logidze/install/functions/logidze_logger.sql

@@ -1,5 +1,5 @@
--- version: 1
 CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
+  -- version: 2
   DECLARE
     changes jsonb;
     version jsonb;
@@ -9,26 +9,32 @@ CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
     history_limit integer;
     debounce_time integer;
     current_version integer;
-    merged jsonb;
+    k text;
     iterator integer;
     item record;
     columns text[];
     include_columns boolean;
     ts timestamp with time zone;
     ts_column text;
+    err_sqlstate text;
+    err_message text;
+    err_detail text;
+    err_hint text;
+    err_context text;
+    err_table_name text;
+    err_schema_name text;
+    err_jsonb jsonb;
+    err_captured boolean;
   BEGIN
     ts_column := NULLIF(TG_ARGV[1], 'null');
     columns := NULLIF(TG_ARGV[2], 'null');
     include_columns := NULLIF(TG_ARGV[3], 'null');
 
     IF TG_OP = 'INSERT' THEN
-      -- always exclude log_data column
-      changes := to_jsonb(NEW.*) - 'log_data';
-
       IF columns IS NOT NULL THEN
-        snapshot = logidze_snapshot(changes, ts_column, columns, include_columns);
+        snapshot = logidze_snapshot(to_jsonb(NEW.*), ts_column, columns, include_columns);
       ELSE
-        snapshot = logidze_snapshot(changes, ts_column);
+        snapshot = logidze_snapshot(to_jsonb(NEW.*), ts_column);
       END IF;
 
       IF snapshot#>>'{h, -1, c}' != '{}' THEN
@@ -38,13 +44,10 @@ CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
     ELSIF TG_OP = 'UPDATE' THEN
 
       IF OLD.log_data is NULL OR OLD.log_data = '{}'::jsonb THEN
-        -- always exclude log_data column
-        changes := to_jsonb(NEW.*) - 'log_data';
-
         IF columns IS NOT NULL THEN
-          snapshot = logidze_snapshot(changes, ts_column, columns, include_columns);
+          snapshot = logidze_snapshot(to_jsonb(NEW.*), ts_column, columns, include_columns);
         ELSE
-          snapshot = logidze_snapshot(changes, ts_column);
+          snapshot = logidze_snapshot(to_jsonb(NEW.*), ts_column);
         END IF;
 
         IF snapshot#>>'{h, -1, c}' != '{}' THEN
@@ -89,11 +92,37 @@ CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
       changes := '{}';
 
       IF (coalesce(current_setting('logidze.full_snapshot', true), '') = 'on') THEN
-        changes = hstore_to_jsonb_loose(hstore(NEW.*));
+        BEGIN
+          changes = hstore_to_jsonb_loose(hstore(NEW.*));
+        EXCEPTION
+          WHEN NUMERIC_VALUE_OUT_OF_RANGE THEN
+            changes = row_to_json(NEW.*)::jsonb;
+            FOR k IN (SELECT key FROM jsonb_each(changes))
+            LOOP
+              IF jsonb_typeof(changes->k) = 'object' THEN
+                changes = jsonb_set(changes, ARRAY[k], to_jsonb(changes->>k));
+              END IF;
+            END LOOP;
+        END;
       ELSE
-        changes = hstore_to_jsonb_loose(
-          hstore(NEW.*) - hstore(OLD.*)
-        );
+        BEGIN
+          changes = hstore_to_jsonb_loose(
+                hstore(NEW.*) - hstore(OLD.*)
+            );
+        EXCEPTION
+          WHEN NUMERIC_VALUE_OUT_OF_RANGE THEN
+            changes = (SELECT
+              COALESCE(json_object_agg(key, value), '{}')::jsonb
+              FROM
+              jsonb_each(row_to_json(NEW.*)::jsonb)
+              WHERE NOT jsonb_build_object(key, value) <@ row_to_json(OLD.*)::jsonb);
+            FOR k IN (SELECT key FROM jsonb_each(changes))
+            LOOP
+              IF jsonb_typeof(changes->k) = 'object' THEN
+                changes = jsonb_set(changes, ARRAY[k], to_jsonb(changes->>k));
+              END IF;
+            END LOOP;
+        END;
       END IF;
 
       changes = changes - 'log_data';
@@ -145,6 +174,30 @@ CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
     END IF;
 
     return NEW;
+  EXCEPTION
+    WHEN OTHERS THEN
+      GET STACKED DIAGNOSTICS err_sqlstate = RETURNED_SQLSTATE,
+                              err_message = MESSAGE_TEXT,
+                              err_detail = PG_EXCEPTION_DETAIL,
+                              err_hint = PG_EXCEPTION_HINT,
+                              err_context = PG_EXCEPTION_CONTEXT,
+                              err_schema_name = SCHEMA_NAME,
+                              err_table_name = TABLE_NAME;
+      err_jsonb := jsonb_build_object(
+        'returned_sqlstate', err_sqlstate,
+        'message_text', err_message,
+        'pg_exception_detail', err_detail,
+        'pg_exception_hint', err_hint,
+        'pg_exception_context', err_context,
+        'schema_name', err_schema_name,
+        'table_name', err_table_name
+      );
+      err_captured = logidze_capture_exception(err_jsonb);
+      IF err_captured THEN
+        return NEW;
+      ELSE
+        RAISE;
+      END IF;
   END;
 $body$
 LANGUAGE plpgsql;

data/lib/generators/logidze/install/functions/logidze_snapshot.sql

@@ -1,8 +1,10 @@
--- version: 1
 CREATE OR REPLACE FUNCTION logidze_snapshot(item jsonb, ts_column text DEFAULT NULL, columns text[] DEFAULT NULL, include_columns boolean DEFAULT false) RETURNS jsonb AS $body$
+  -- version: 3
   DECLARE
     ts timestamp with time zone;
+    k text;
   BEGIN
+    item = item - 'log_data';
     IF ts_column IS NULL THEN
       ts := statement_timestamp();
     ELSE
@@ -13,6 +15,13 @@ CREATE OR REPLACE FUNCTION logidze_snapshot(item jsonb, ts_column text DEFAULT N
       item := logidze_filter_keys(item, columns, include_columns);
     END IF;
 
+    FOR k IN (SELECT key FROM jsonb_each(item))
+    LOOP
+      IF jsonb_typeof(item->k) = 'object' THEN
+         item := jsonb_set(item, ARRAY[k], to_jsonb(item->>k));
+      END IF;
+    END LOOP;
+
     return json_build_object(
       'v', 1,
       'h', jsonb_build_array(

data/lib/generators/logidze/install/functions/logidze_version.sql

@@ -1,8 +1,9 @@
--- version: 1
 CREATE OR REPLACE FUNCTION logidze_version(v bigint, data jsonb, ts timestamp with time zone) RETURNS jsonb AS $body$
+  -- version: 2
   DECLARE
     buf jsonb;
   BEGIN
+    data = data - 'log_data';
     buf := jsonb_build_object(
               'ts',
               (extract(epoch from ts) * 1000)::bigint,

data/lib/generators/logidze/install/install_generator.rb

@@ -2,6 +2,7 @@
 
 require "rails/generators"
 require "rails/generators/active_record"
+require "logidze/utils/function_definitions"
 require_relative "../inject_sql"
 require_relative "../fx_helper"
 
@@ -14,8 +15,6 @@ module Logidze
       include InjectSql
       include FxHelper
 
-      class FuncDef < Struct.new(:name, :version, :signature); end
-
       source_root File.expand_path("templates", __dir__)
       source_paths << File.expand_path("functions", __dir__)
 
@@ -80,21 +79,7 @@ module Logidze
         end
 
         def function_definitions
-          @function_definitions ||=
-            begin
-              Dir.glob(File.join(__dir__, "functions", "*.sql")).map do |path|
-                name = path.match(/([^\/]+)\.sql/)[1]
-
-                file = File.open(path)
-                header = file.readline
-
-                version = header.match(/version:\s+(\d+)/)[1].to_i
-                parameters = file.readline.match(/CREATE OR REPLACE FUNCTION\s+[\w_]+\((.*)\)/)[1]
-                signature = parameters.split(/\s*,\s*/).map { |param| param.split(/\s+/, 2).last.sub(/\s+DEFAULT .*$/, "") }.join(", ")
-
-                FuncDef.new(name, version, signature)
-              end
-            end
+          @function_definitions ||= Logidze::Utils::FunctionDefinitions.from_fs
         end
       end
 

data/lib/generators/logidze/install/templates/hstore.rb.erb

@@ -1,4 +1,4 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     enable_extension :hstore
   end

data/lib/generators/logidze/install/templates/migration.rb.erb

@@ -1,4 +1,4 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def up
 <%- if update? -%>
     # Drop legacy functions (<1.0)

data/lib/generators/logidze/install/templates/migration_fx.rb.erb

@@ -1,4 +1,4 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
   <%- if update? -%>
     reversible do |dir|

data/lib/generators/logidze/model/model_generator.rb

@@ -35,6 +35,8 @@ module Logidze
       class_option :timestamp_column, type: :string, optional: true,
                                       desc: "Specify timestamp column"
 
+      class_option :name, type: :string, optional: true, desc: "Migration name"
+
       class_option :update, type: :boolean, optional: true,
                             desc: "Define whether this is an update migration"
 
@@ -43,7 +45,7 @@ module Logidze
           warn "Use only one: --only or --except"
           exit(1)
         end
-        migration_template "migration.rb.erb", "db/migrate/#{migration_file_name}"
+        migration_template "migration.rb.erb", "db/migrate/#{migration_name}.rb"
       end
 
       def generate_fx_trigger
@@ -62,6 +64,8 @@ module Logidze
 
       no_tasks do
         def migration_name
+          return options[:name] if options[:name].present?
+
           if update?
             "update_logidze_for_#{plural_table_name}"
           else
@@ -69,8 +73,9 @@ module Logidze
           end
         end
 
-        def migration_file_name
-          "#{migration_name}.rb"
+        def full_table_name
+          config = ActiveRecord::Base
+          "#{config.table_name_prefix}#{table_name}#{config.table_name_suffix}"
         end
 
         def limit

data/lib/generators/logidze/model/templates/migration.rb.erb

@@ -1,4 +1,4 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
 <%- unless update? || only_trigger? -%>
     add_column :<%= table_name %>, :log_data, :jsonb
@@ -12,14 +12,18 @@ class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
       dir.up do
     <%- if update? -%>
         # Drop legacy trigger if any (<1.0)
-        execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
+        execute <<~SQL
+          DROP TRIGGER IF EXISTS "logidze_on_<%= full_table_name %>" on "<%= full_table_name %>";
+        SQL
 
     <%- end -%>
         create_trigger :logidze_on_<%= table_name %>, on: :<%= table_name %>
       end
 
       dir.down do
-        execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
+        execute <<~SQL
+          DROP TRIGGER IF EXISTS "logidze_on_<%= full_table_name %>" on "<%= full_table_name %>";
+        SQL
       end
     end
   <%- end -%>
@@ -27,7 +31,9 @@ class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
     reversible do |dir|
       dir.up do
   <%- if update? -%>
-        execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
+        execute <<~SQL
+          DROP TRIGGER IF EXISTS "logidze_on_<%= full_table_name %>" on "<%= full_table_name %>";
+        SQL
 
   <%- end -%>
         execute <<~SQL
@@ -44,7 +50,9 @@ class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
         # Uncomment this line if you want to raise an error.
         # raise ActiveRecord::IrreversibleMigration
   <%- else -%>
-        execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
+        execute <<~SQL
+          DROP TRIGGER IF EXISTS "logidze_on_<%= full_table_name %>" on "<%= full_table_name %>";
+        SQL
   <%- end -%>
       end
     end
@@ -54,7 +62,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration[5.0]
     reversible do |dir|
       dir.up do
         execute <<~SQL
-          UPDATE <%= table_name %> as t
+          UPDATE "<%= full_table_name %>" as t
           SET log_data = logidze_snapshot(<%= logidze_snapshot_parameters %>);
         SQL
       end

data/lib/generators/logidze/model/triggers/logidze.sql

@@ -1,5 +1,5 @@
-CREATE TRIGGER logidze_on_<%= table_name %>
-BEFORE UPDATE OR INSERT ON <%= table_name %> FOR EACH ROW
+CREATE TRIGGER <%= %Q("logidze_on_#{full_table_name}") %>
+BEFORE UPDATE OR INSERT ON <%= %Q("#{full_table_name}") %> FOR EACH ROW
 WHEN (coalesce(current_setting('logidze.disabled', true), '') <> 'on')
 -- Parameters: history_size_limit (integer), timestamp_column (text), filtered_columns (text[]),
 -- include_columns (boolean), debounce_time_ms (integer)

data/lib/logidze/engine.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "logidze"
+require "logidze/utils/check_pending"
 
 module Logidze
   class Engine < Rails::Engine # :nodoc:
@@ -11,5 +12,13 @@ module Logidze
         ActiveRecord::Base.send :include, Logidze::HasLogidze
       end
     end
+
+    initializer "check Logidze function versions" do |app|
+      if config.logidze.on_pending_upgrade != :ignore
+        ActiveSupport.on_load(:active_record) do
+          app.config.app_middleware.use Logidze::Utils::CheckPending
+        end
+      end
+    end
   end
 end

data/lib/logidze/history.rb

@@ -48,7 +48,7 @@ module Logidze
     end
 
     # Return diff from the initial state to specified time or version.
-    # Optional `data` paramater can be used as initial diff state.
+    # Optional `data` parameter can be used as initial diff state.
     def changes_to(time: nil, version: nil, data: {}, from: 0)
       raise ArgumentError, "Time or version must be specified" if time.nil? && version.nil?
 

data/lib/logidze/model.rb

@@ -213,7 +213,7 @@ module Logidze
 
     # Loads log_data field from the database, stores to the attributes hash and returns it
     def reload_log_data
-      self.log_data = self.class.where(self.class.primary_key => id).pluck("#{self.class.table_name}.log_data").first
+      self.log_data = self.class.where(self.class.primary_key => id).pluck("#{self.class.table_name}.log_data".to_sym).first
     end
 
     # Nullify log_data column for a single record
@@ -239,7 +239,7 @@ module Logidze
     end
 
     def apply_column_diff(column, value)
-      return if deleted_column?(column)
+      return if deleted_column?(column) || column == "log_data"
 
       write_attribute column, deserialize_value(column, value)
     end
@@ -253,14 +253,8 @@ module Logidze
       object_at
     end
 
-    if Rails::VERSION::MAJOR < 5
-      def deserialize_value(column, value)
-        @attributes[column].type.type_cast_from_database(value)
-      end
-    else
-      def deserialize_value(column, value)
-        @attributes[column].type.deserialize(value)
-      end
+    def deserialize_value(column, value)
+      @attributes[column].type.deserialize(value)
     end
 
     def deleted_column?(column)

data/lib/logidze/utils/check_pending.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "./function_definitions"
+require_relative "./pending_migration_error"
+
+module Logidze
+  module Utils
+    # This Rack middleware is used to verify that all functions are up to date
+    class CheckPending
+      def initialize(app)
+        @app = app
+        @needs_check = true
+        @mutex = Mutex.new
+      end
+
+      delegate :connection, to: ActiveRecord::Base
+
+      def call(env)
+        @mutex.synchronize do
+          if @needs_check
+            notify_or_raise! if needs_migration?
+          end
+          @needs_check = false
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def notify_or_raise!
+        case Logidze.on_pending_upgrade
+        when :warn
+          warn "\n**************************************************\n"\
+               "⛔️  WARNING: Logidze needs an upgrade and might not work correctly.\n"\
+               "Please, make sure to run `bundle exec rails generate logidze:install --update` "\
+               "and apply generated migration."\
+               "\n**************************************************\n\n"
+        when :raise
+          raise Logidze::Utils::PendingMigrationError, "Logidze needs upgrade. Run `bundle exec rails generate logidze:install --update` and apply generated migration."
+        end
+      end
+
+      def needs_migration?
+        (library_function_versions - pg_function_versions).any?
+      end
+
+      def pg_function_versions
+        Logidze::Utils::FunctionDefinitions.from_db.map { |func| [func.name, func.version] }
+      end
+
+      def library_function_versions
+        @library_function_versions ||= Logidze::Utils::FunctionDefinitions.from_fs.map { |func| [func.name, func.version] }
+      end
+    end
+  end
+end

data/lib/logidze/utils/function_definitions.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Logidze
+  module Utils
+    class FuncDef < Struct.new(:name, :version, :signature); end
+
+    module FunctionDefinitions
+      class << self
+        def from_fs
+          function_paths = Dir.glob(File.join(__dir__, "..", "..", "generators", "logidze", "install", "functions", "*.sql"))
+          function_paths.map do |path|
+            name = path.match(/([^\/]+)\.sql/)[1]
+
+            file = File.open(path)
+            header, version_comment = file.readline, file.readline
+
+            signature = parse_signature(header)
+            version = parse_version(version_comment)
+            FuncDef.new(name, version, signature)
+          end
+        end
+
+        def from_db
+          query = <<~SQL
+            SELECT pp.proname, pg_get_functiondef(pp.oid) AS definition
+            FROM pg_proc pp
+            WHERE pp.proname like 'logidze_%'
+            ORDER BY pp.oid;
+          SQL
+          ActiveRecord::Base.connection.execute(query).map do |row|
+            version = parse_version(row["definition"])
+            FuncDef.new(row["proname"], version, nil)
+          end
+        end
+
+        private
+
+        def parse_version(line)
+          line.match(/version:\s+(\d+)/)&.[](1).to_i
+        end
+
+        def parse_signature(line)
+          parameters = line.match(/CREATE OR REPLACE FUNCTION\s+[\w_]+\((.*)\)/)[1]
+          parameters.split(/\s*,\s*/).map { |param| param.split(/\s+/, 2).last.sub(/\s+DEFAULT .*$/, "") }.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/logidze/utils/pending_migration_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Logidze
+  module Utils
+    class PendingMigrationError < StandardError
+      if Rails::VERSION::MAJOR >= 6
+        require "active_record"
+        require "active_support/actionable_error"
+        include ActiveSupport::ActionableError
+
+        action "Upgrade Logidze" do
+          Rails::Generators.invoke("logidze:install", ["--update"])
+          ActiveRecord::Tasks::DatabaseTasks.migrate
+          if ActiveRecord::Base.dump_schema_after_migration
+            ActiveRecord::Tasks::DatabaseTasks.dump_schema(
+              ActiveRecord::Base.connection_db_config
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/logidze/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logidze
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.2.1"
 end

data/lib/logidze.rb

@@ -26,6 +26,8 @@ module Logidze
     attr_accessor :ignore_log_data_by_default
     # Whether #at should return self or nil when log_data is nil
     attr_accessor :return_self_if_log_data_is_empty
+    # Determines what Logidze should do when upgrade is needed (:raise | :warn | :ignore)
+    attr_reader :on_pending_upgrade
 
     # Temporary disable DB triggers.
     #
@@ -35,7 +37,7 @@ module Logidze
       with_logidze_setting("logidze.disabled", "on") { yield }
     end
 
-    # Instructure Logidze to create a full snapshot for the new versions, not a diff
+    # Instruct Logidze to create a full snapshot for the new versions, not a diff
     #
     # @example
     #   Logidze.with_full_snapshot { post.touch }
@@ -43,6 +45,13 @@ module Logidze
       with_logidze_setting("logidze.full_snapshot", "on") { yield }
     end
 
+    def on_pending_upgrade=(mode)
+      if %i[raise warn ignore].exclude? mode
+        raise ArgumentError, "Unknown on_pending_upgrade option `#{mode.inspect}`. Expecting :raise, :warn or :ignore"
+      end
+      @on_pending_upgrade = mode
+    end
+
     private
 
     def with_logidze_setting(name, value)
@@ -59,4 +68,5 @@ module Logidze
   self.associations_versioning = false
   self.ignore_log_data_by_default = false
   self.return_self_if_log_data_is_empty = true
+  self.on_pending_upgrade = :ignore
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.2.1
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -149,6 +163,7 @@ files:
 - lib/generators/logidze/fx_helper.rb
 - lib/generators/logidze/inject_sql.rb
 - lib/generators/logidze/install/USAGE
+- lib/generators/logidze/install/functions/logidze_capture_exception.sql
 - lib/generators/logidze/install/functions/logidze_compact_history.sql
 - lib/generators/logidze/install/functions/logidze_filter_keys.sql
 - lib/generators/logidze/install/functions/logidze_logger.sql
@@ -172,6 +187,9 @@ files:
 - lib/logidze/ignore_log_data/cast_attribute_patch.rb
 - lib/logidze/meta.rb
 - lib/logidze/model.rb
+- lib/logidze/utils/check_pending.rb
+- lib/logidze/utils/function_definitions.rb
+- lib/logidze/utils/pending_migration_error.rb
 - lib/logidze/version.rb
 - lib/logidze/versioned_association.rb
 homepage: http://github.com/palkan/logidze
@@ -183,7 +201,7 @@ metadata:
   documentation_uri: http://github.com/palkan/logidze
   homepage_uri: http://github.com/palkan/logidze
   source_code_uri: http://github.com/palkan/logidze
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,12 +212,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: PostgreSQL JSONB-based model changes tracking
 test_files: []