logidze 0.11.0 → 1.2.0

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

@@ -1,4 +1,4 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VERSION::MAJOR < 5 ? '' : '[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,246 +1,33 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VERSION::MAJOR < 5 ? '' : '[5.0]' %>
-  require 'logidze/migration'
-  include Logidze::Migration
-
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def up
-    unless current_setting_missing_supported?
-      execute <<-SQL
-        DO $$
-          BEGIN
-          EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET logidze.disabled=' || quote_literal('');
-          EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET logidze.meta=' || quote_literal('');
-          END;
-        $$
-        LANGUAGE plpgsql;
-      SQL
-    end
-
-    <% if update? %>
-    execute <<-SQL
+<%- if update? -%>
+    # Drop legacy functions (<1.0)
+    execute <<~SQL
       DROP FUNCTION IF EXISTS logidze_version(bigint, jsonb);
       DROP FUNCTION IF EXISTS logidze_snapshot(jsonb);
       DROP FUNCTION IF EXISTS logidze_version(bigint, jsonb, text[]);
       DROP FUNCTION IF EXISTS logidze_snapshot(jsonb, text[]);
+      DROP FUNCTION IF EXISTS logidze_version(bigint, jsonb, timestamp with time zone, text[]);
+      DROP FUNCTION IF EXISTS logidze_snapshot(jsonb, text, text[]);
+      DROP FUNCTION IF EXISTS logidze_exclude_keys(jsonb, VARIADIC text[]);
+      DROP FUNCTION IF EXISTS logidze_compact_history(jsonb);
     SQL
-    <% end %>
-
-    execute <<-SQL
-      CREATE OR REPLACE FUNCTION logidze_version(v bigint, data jsonb, ts timestamp with time zone, blacklist text[] DEFAULT '{}') RETURNS jsonb AS $body$
-        DECLARE
-          buf jsonb;
-        BEGIN
-          buf := jsonb_build_object(
-                   'ts',
-                   (extract(epoch from ts) * 1000)::bigint,
-                   'v',
-                    v,
-                    'c',
-                    logidze_exclude_keys(data, VARIADIC array_append(blacklist, 'log_data'))
-                   );
-          IF coalesce(#{current_setting('logidze.meta')}, '') <> '' THEN
-            buf := jsonb_set(buf, ARRAY['m'], current_setting('logidze.meta')::jsonb);
-          END IF;
-          RETURN buf;
-        END;
-      $body$
-      LANGUAGE plpgsql;
-
-      CREATE OR REPLACE FUNCTION logidze_snapshot(item jsonb, ts_column text, blacklist text[] DEFAULT '{}') RETURNS jsonb AS $body$
-        DECLARE
-          ts timestamp with time zone;
-        BEGIN
-          IF ts_column IS NULL THEN
-            ts := statement_timestamp();
-          ELSE
-            ts := coalesce((item->>ts_column)::timestamp with time zone, statement_timestamp());
-          END IF;
-          return json_build_object(
-            'v', 1,
-            'h', jsonb_build_array(
-                   logidze_version(1, item, ts, blacklist)
-                 )
-            );
-        END;
-      $body$
-      LANGUAGE plpgsql;
-
-      CREATE OR REPLACE FUNCTION logidze_exclude_keys(obj jsonb, VARIADIC keys text[]) RETURNS jsonb AS $body$
-        DECLARE
-          res jsonb;
-          key text;
-        BEGIN
-          res := obj;
-          FOREACH key IN ARRAY keys
-          LOOP
-            res := res - key;
-          END LOOP;
-          RETURN res;
-        END;
-      $body$
-      LANGUAGE plpgsql;
-
-      CREATE OR REPLACE FUNCTION logidze_compact_history(log_data jsonb) RETURNS jsonb AS $body$
-        DECLARE
-          merged jsonb;
-        BEGIN
-          merged := jsonb_build_object(
-            'ts',
-            log_data#>'{h,1,ts}',
-            'v',
-            log_data#>'{h,1,v}',
-            'c',
-            (log_data#>'{h,0,c}') || (log_data#>'{h,1,c}')
-          );
-
-          IF (log_data#>'{h,1}' ? 'm') THEN
-            merged := jsonb_set(merged, ARRAY['m'], log_data#>'{h,1,m}');
-          END IF;
-
-          return jsonb_set(
-            log_data,
-            '{h}',
-            jsonb_set(
-              log_data->'h',
-              '{1}',
-              merged
-            ) - 0
-          );
-        END;
-      $body$
-      LANGUAGE plpgsql;
-
-      CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
-        DECLARE
-          changes jsonb;
-          version jsonb;
-          snapshot jsonb;
-          new_v integer;
-          size integer;
-          history_limit integer;
-          debounce_time integer;
-          current_version integer;
-          merged jsonb;
-          iterator integer;
-          item record;
-          columns_blacklist text[];
-          ts timestamp with time zone;
-          ts_column text;
-        BEGIN
-          ts_column := NULLIF(TG_ARGV[1], 'null');
-          columns_blacklist := COALESCE(NULLIF(TG_ARGV[2], 'null'), '{}');
-
-          IF TG_OP = 'INSERT' THEN
-            snapshot = logidze_snapshot(to_jsonb(NEW.*), ts_column, columns_blacklist);
-
-            IF snapshot#>>'{h, -1, c}' != '{}' THEN
-              NEW.log_data := snapshot;
-            END IF;
-
-          ELSIF TG_OP = 'UPDATE' THEN
-
-            IF OLD.log_data is NULL OR OLD.log_data = '{}'::jsonb THEN
-              snapshot = logidze_snapshot(to_jsonb(NEW.*), ts_column, columns_blacklist);
-              IF snapshot#>>'{h, -1, c}' != '{}' THEN
-                NEW.log_data := snapshot;
-              END IF;
-              RETURN NEW;
-            END IF;
-
-            history_limit := NULLIF(TG_ARGV[0], 'null');
-            debounce_time := NULLIF(TG_ARGV[3], 'null');
-
-            current_version := (NEW.log_data->>'v')::int;
-
-            IF ts_column IS NULL THEN
-              ts := statement_timestamp();
-            ELSE
-              ts := (to_jsonb(NEW.*)->>ts_column)::timestamp with time zone;
-              IF ts IS NULL OR ts = (to_jsonb(OLD.*)->>ts_column)::timestamp with time zone THEN
-                ts := statement_timestamp();
-              END IF;
-            END IF;
-
-            IF NEW = OLD THEN
-              RETURN NEW;
-            END IF;
-
-            IF current_version < (NEW.log_data#>>'{h,-1,v}')::int THEN
-              iterator := 0;
-              FOR item in SELECT * FROM jsonb_array_elements(NEW.log_data->'h')
-              LOOP
-                IF (item.value->>'v')::int > current_version THEN
-                  NEW.log_data := jsonb_set(
-                    NEW.log_data,
-                    '{h}',
-                    (NEW.log_data->'h') - iterator
-                  );
-                END IF;
-                iterator := iterator + 1;
-              END LOOP;
-            END IF;
-
-            changes := hstore_to_jsonb_loose(
-              hstore(NEW.*) - hstore(OLD.*)
-            );
-
-            new_v := (NEW.log_data#>>'{h,-1,v}')::int + 1;
-
-            size := jsonb_array_length(NEW.log_data->'h');
-            version := logidze_version(new_v, changes, ts, columns_blacklist);
-
-            IF version->>'c' = '{}' THEN
-              RETURN NEW;
-            END IF;
-
-            IF (
-              debounce_time IS NOT NULL AND
-              (version->>'ts')::bigint - (NEW.log_data#>'{h,-1,ts}')::text::bigint <= debounce_time
-            ) THEN
-              -- merge new version with the previous one
-              new_v := (NEW.log_data#>>'{h,-1,v}')::int;
-              version := logidze_version(new_v, (NEW.log_data#>'{h,-1,c}')::jsonb || changes, ts, columns_blacklist);
-              -- remove the previous version from log
-              NEW.log_data := jsonb_set(
-                NEW.log_data,
-                '{h}',
-                (NEW.log_data->'h') - (size - 1)
-              );
-            END IF;
-
-            NEW.log_data := jsonb_set(
-              NEW.log_data,
-              ARRAY['h', size::text],
-              version,
-              true
-            );
-
-            NEW.log_data := jsonb_set(
-              NEW.log_data,
-              '{v}',
-              to_jsonb(new_v)
-            );
-
-            IF history_limit IS NOT NULL AND history_limit = size THEN
-              NEW.log_data := logidze_compact_history(NEW.log_data);
-            END IF;
-          END IF;
 
-          return NEW;
-        END;
-        $body$
-        LANGUAGE plpgsql;
+<%- end -%>
+    execute <<~SQL
+<%- function_definitions.each do |f| -%>
+<%= inject_sql("#{f.name}.sql", indent: 6) %>
+<%- end -%>
     SQL
   end
 
   def down
-    <% unless update? %>
-    execute <<-SQL
-      DROP FUNCTION logidze_version(bigint, jsonb, timestamp with time zone, text[]) CASCADE;
-      DROP FUNCTION logidze_exclude_keys(jsonb, text[]) CASCADE;
-      DROP FUNCTION logidze_compact_history(jsonb) CASCADE;
-      DROP FUNCTION logidze_snapshot(jsonb, text, text[]) CASCADE;
-      DROP FUNCTION logidze_logger() CASCADE;
+<%- unless update? -%>
+    execute <<~SQL
+  <%- function_definitions.each do |f| -%>
+      DROP FUNCTION IF EXISTS <%= f.name %>(<%= f.signature %>) CASCADE;
+  <%- end -%>
     SQL
-    <% end %>
+<%- end -%>
   end
 end

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

@@ -0,0 +1,41 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+  <%- if update? -%>
+    reversible do |dir|
+      dir.up do
+        # Drop legacy functions (<1.0)
+        execute <<~SQL
+          DROP FUNCTION IF EXISTS logidze_version(bigint, jsonb);
+          DROP FUNCTION IF EXISTS logidze_snapshot(jsonb);
+          DROP FUNCTION IF EXISTS logidze_version(bigint, jsonb, text[]);
+          DROP FUNCTION IF EXISTS logidze_snapshot(jsonb, text[]);
+          DROP FUNCTION IF EXISTS logidze_version(bigint, jsonb, timestamp with time zone, text[]);
+          DROP FUNCTION IF EXISTS logidze_snapshot(jsonb, text, text[]);
+          DROP FUNCTION IF EXISTS logidze_exclude_keys(jsonb, VARIADIC text[]);
+          DROP FUNCTION IF EXISTS logidze_compact_history(jsonb);
+        SQL
+      end
+    end
+
+  <%- end -%>
+  <%- function_definitions.each do |f| -%>
+    <%- previous_version = previous_version_for(f.name) -%>
+    <%- if previous_version -%>
+      <%- if previous_version != f.version -%>
+    update_function :<%= f.name %>, version: <%= f.version %>, revert_to_version: <%= previous_version %>
+      <%- end -%>
+    <%- else -%>
+    reversible do |dir|
+      dir.up do
+        create_function :<%= f.name %>, version: <%= f.version %>
+      end
+
+      dir.down do
+        execute "DROP FUNCTION IF EXISTS <%= f.name %>(<%= f.signature %>) CASCADE"
+      end
+    end
+
+    <%- end -%>
+  <%- end -%>
+  end
+end

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

@@ -2,11 +2,19 @@
 
 require "rails/generators"
 require "rails/generators/active_record/migration/migration_generator"
+require_relative "../inject_sql"
+require_relative "../fx_helper"
+
+using RubyNext
 
 module Logidze
   module Generators
     class ModelGenerator < ::ActiveRecord::Generators::Base # :nodoc:
+      include InjectSql
+      include FxHelper
+
       source_root File.expand_path("templates", __dir__)
+      source_paths << File.expand_path("triggers", __dir__)
 
       class_option :limit, type: :numeric, optional: true, desc: "Specify history size limit"
 
@@ -21,23 +29,31 @@ module Logidze
 
       class_option :path, type: :string, optional: true, desc: "Specify path to the model file"
 
-      class_option :blacklist, type: :array, optional: true
-      class_option :whitelist, type: :array, optional: true
+      class_option :except, type: :array, optional: true
+      class_option :only, type: :array, optional: true
 
       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"
 
       def generate_migration
-        if options[:blacklist] && options[:whitelist]
-          warn "Use only one: --whitelist or --blacklist"
+        if options[:except] && options[:only]
+          warn "Use only one: --only or --except"
           exit(1)
         end
         migration_template "migration.rb.erb", "db/migrate/#{migration_file_name}"
       end
 
+      def generate_fx_trigger
+        return unless fx?
+
+        template "logidze.sql", "db/triggers/logidze_on_#{table_name}_v#{next_version.to_s.rjust(2, "0")}.sql"
+      end
+
       def inject_logidze_to_model
         return if update?
 
@@ -48,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
@@ -75,14 +93,13 @@ module Logidze
           options[:update]
         end
 
-        def columns_blacklist
-          array = if !options[:whitelist]
-            options[:blacklist]
-          else
-            class_name.constantize.column_names - options[:whitelist]
-          end
+        def filtered_columns
+          format_pgsql_array(options[:only] || options[:except])
+        end
 
-          format_pgsql_array(array)
+        def include_columns
+          return unless options[:only] || options[:except]
+          options[:only].present?
         end
 
         def timestamp_column
@@ -96,12 +113,35 @@ module Logidze
           options[:debounce_time]
         end
 
+        def previous_version
+          @previous_version ||= all_triggers.filter_map { |path| Regexp.last_match[1].to_i if path =~ %r{logidze_on_#{table_name}_v(\d+).sql} }.max
+        end
+
+        def next_version
+          previous_version&.next || 1
+        end
+
+        def all_triggers
+          @all_triggers ||=
+            begin
+              res = nil
+              in_root do
+                res = if File.directory?("db/triggers")
+                  Dir.entries("db/triggers")
+                else
+                  []
+                end
+              end
+              res
+            end
+        end
+
         def logidze_logger_parameters
-          format_pgsql_args(limit, timestamp_column, columns_blacklist, debounce_time)
+          format_pgsql_args(limit, timestamp_column, filtered_columns, include_columns, debounce_time)
         end
 
         def logidze_snapshot_parameters
-          format_pgsql_args("to_jsonb(t)", timestamp_column, columns_blacklist)
+          format_pgsql_args("to_jsonb(t)", timestamp_column, filtered_columns, include_columns)
         end
 
         def format_pgsql_array(ruby_array)

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

@@ -1,43 +1,64 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VERSION::MAJOR < 5 ? '' : '[5.0]' %>
-  require 'logidze/migration'
-  include Logidze::Migration
-
-  def up
-    <% if update? %>
-    execute "DROP TRIGGER logidze_on_<%= table_name %> on <%= table_name %>;"
-    <% elsif !only_trigger? %>
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+<%- unless update? || only_trigger? -%>
     add_column :<%= table_name %>, :log_data, :jsonb
-    <% end %>
+<%- end -%>
 
-    execute <<-SQL
-      CREATE TRIGGER logidze_on_<%= table_name %>
-      BEFORE UPDATE OR INSERT ON <%= table_name %> FOR EACH ROW
-      WHEN (coalesce(#{current_setting('logidze.disabled')}, '') <> 'on')
-      EXECUTE PROCEDURE logidze_logger(<%= logidze_logger_parameters %>);
-    SQL
+<%- if fx? -%>
+  <%- if previous_version -%>
+    update_trigger :logidze_on_<%= table_name %>, on: :<%= table_name %>, version: <%= next_version %>, revert_to_version: <%= previous_version %>
+  <%- else -%>
+    reversible do |dir|
+      dir.up do
+    <%- if update? -%>
+        # Drop legacy trigger if any (<1.0)
+        execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
 
-    <% if backfill? %>
-    execute <<-SQL
-      UPDATE <%= table_name %> as t
-      SET log_data = logidze_snapshot(<%= logidze_snapshot_parameters %>);
-    SQL
-    <% end %>
-  end
+    <%- 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 %>;"
+      end
+    end
+  <%- end -%>
+<%- else -%>
+    reversible do |dir|
+      dir.up do
+  <%- if update? -%>
+        execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
+
+  <%- end -%>
+        execute <<~SQL
+<%= inject_sql("logidze.sql", indent: 10) %>
+        SQL
+      end
 
-  def down
-    <% if update? %>
-    # NOTE: We have no idea on how to revert the migration
-    # ('cause we don't know the previous trigger params),
-    # but you can do that on your own.
-    # 
-    # 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 %>;"
+      dir.down do
+  <%- if update? -%>
+        # NOTE: We have no idea on how to revert the migration
+        # ('cause we don't know the previous trigger params),
+        # but you can do that on your own.
+        #
+        # 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 %>;"
+  <%- end -%>
+      end
+    end
+<%- end -%>
+<%- if backfill? -%>
 
-    <% if !only_trigger? %>
-    remove_column :<%= table_name %>, :log_data
-    <% end %>
-    <% end %>
+    reversible do |dir|
+      dir.up do
+        execute <<~SQL
+          UPDATE <%= table_name %> as t
+          SET log_data = logidze_snapshot(<%= logidze_snapshot_parameters %>);
+        SQL
+      end
+    end
+<%- end -%>
   end
 end