logidze 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c273494bd5a85f1f9d967a8fb474bc8ef4df75d42bf756a96f4a83e6cc9ed1a2
-  data.tar.gz: da791cced5e41ff2025ba349d16b394f6398a06b22782a5e78b7be1f18edbb48
+  metadata.gz: e6c441d5e6e60ef695eb354e4bfb5be9fa182bd8b70755d829aee6eb2781e401
+  data.tar.gz: d64374a0d6327f2f713fd7341c31de93472f32d045cb5c825c35874c756307d4
 SHA512:
-  metadata.gz: 30e03d1adf876881e88e630774963d3a347b3c3114a2e345177d9c6b6480bab9bfd76d572fe681dd5a9b006cd2c212ed07e1a340fbc0a9275df48c6da0d11553
-  data.tar.gz: 52663d375ac840f39d783eb2441b104b9ab910d3ee93d8ca309be9d9be626396caa6d9daac72d348e0d225945f37948bb197f18928bc865a9d2114735520cecb
+  metadata.gz: f3f453e410de263ed8b0704aece35e6274dfc19c9074a8f75450e84033318b149ae81c9e1f48cc9d515e523b95c98c14cbd3453a7c41db1690febfe8060f640d
+  data.tar.gz: dbf4a22b357889bc0d2aaeda52bffc8bc245cdc12d2cb34d0f7c9ccec7c0f60807ecc3cbd5272fee567420024309f8be05f6e1e8c9f45334ab3d2ad155a97a12

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change log
 
+## master (unreleased)
+
+## 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][])
@@ -332,3 +346,4 @@ 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

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
@@ -22,16 +22,16 @@ 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)
   - [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)
 - [Usage](#usage)
@@ -439,7 +439,7 @@ See also the discussion: [#61](https://github.com/palkan/logidze/issues/61).
 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.
@@ -449,31 +449,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
-$ rails generate logidze:model Post --update --only=title,body,rating --name add_only_filter_to_posts_log_data
+$ 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.pending_upgrade = :warn` to be notified by warning, or `Logidze.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
 

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: 1
   DECLARE
     changes jsonb;
     version jsonb;

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

@@ -1,7 +1,8 @@
--- 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: 2
   DECLARE
     ts timestamp with time zone;
+    k text;
   BEGIN
     IF ts_column IS NULL THEN
       ts := statement_timestamp();
@@ -13,6 +14,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,5 +1,5 @@
--- version: 1
 CREATE OR REPLACE FUNCTION logidze_version(v bigint, data jsonb, ts timestamp with time zone) RETURNS jsonb AS $body$
+  -- version: 1
   DECLARE
     buf jsonb;
   BEGIN

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/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

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

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/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"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-03-31 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:
     - - ">="
@@ -172,6 +186,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