table_sync 6.9.2 → 6.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09c6fd6d3ac06db07e1ac54edd3b5dbbcfb96b15191450f1fc71750087ecb660'
-  data.tar.gz: 4270f9f7a0037128664b9ee48b57ddf349304e46654a39a1cec08f59036d10da
+  metadata.gz: c9053c457facb21583722141c254d7795ce512a50be9b433c1fc6e4678b153c2
+  data.tar.gz: a3e030b3ef171c83ae81192712ce9db71789986f4f7d4c2121d335d516a34a1c
 SHA512:
-  metadata.gz: 95b363fd2d16fae609205940176ff31069864ee044ce691fbf6fbde5e5e5153c53e8bc1fa5089e42a32b310014f4970ab8efa35bb972b68f4734e75d5978a009
-  data.tar.gz: d1ef68707a2ec0cee63edd72a55511c8107fe5b056458cd808444a46d1fbfd8d1f03dbcb394901d269389029b0f9438034f7a36c4058eb95c3756c7a9ba1d17d
+  metadata.gz: ae4407fb443aec3794f52f8b4b81681ea6bae82fe3838b4e59403fde12a4bdc445bb831cffd53afb5759fe99f311fe1dfdbf6b73b2b2fd995bc4fff88cc4befb
+  data.tar.gz: 0714f4fecc46b8134cb1f06112d1e72912a28c563118ca901a72f7adb10d42d3a3d4bc65a55d2879e6788255b7c809fc84cd0bc54d7eac39cfa45df61ce28772

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [6.10.0] - 2025-11-21
+### Fixed
+- Add on_first_sync callback
+
+## [6.9.3] - 2025-10-09
+### Fixed
+- Add validate_types to model interface
+
 ## [6.9.2] - 2025-10-03
 ### Fixed
 - Fix of all types taking type cast into account

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    table_sync (6.9.2)
+    table_sync (6.10.0)
       memery
       rabbit_messaging (>= 1.7.0)
       rails
@@ -90,12 +90,12 @@ GEM
     bunny (2.24.0)
       amq-protocol (~> 2.3)
       sorted_set (~> 1, >= 1.0.2)
-    cgi (0.4.2)
+    cgi (0.5.0)
     coderay (1.1.3)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.3)
     crass (1.0.6)
-    date (3.4.1)
+    date (3.5.0)
     diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.3)
@@ -106,8 +106,8 @@ GEM
       activesupport (>= 6.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    io-console (0.8.0)
-    irb (1.15.2)
+    io-console (0.8.1)
+    irb (1.15.3)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
@@ -124,18 +124,19 @@ GEM
     loofah (2.24.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    mail (2.8.1)
+    mail (2.9.0)
+      logger
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.4)
+    marcel (1.1.0)
     memery (1.7.0)
     method_source (1.1.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.9)
     minitest (5.25.5)
-    net-imap (0.5.8)
+    net-imap (0.5.12)
       date
       net-protocol
     net-pop (0.1.2)
@@ -170,7 +171,7 @@ GEM
       ast (~> 2.4.1)
       racc
     pg (1.5.9)
-    pp (0.6.2)
+    pp (0.6.3)
       prettyprint
     prettyprint (0.2.0)
     prism (1.4.0)
@@ -224,11 +225,12 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     rbtree (0.4.6)
-    rdoc (6.14.0)
+    rdoc (6.15.1)
       erb
       psych (>= 4.0.0)
+      tsort
     regexp_parser (2.10.0)
-    reline (0.6.1)
+    reline (0.6.3)
       io-console (~> 0.5)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
@@ -308,10 +310,11 @@ GEM
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
-    stringio (3.1.7)
-    thor (1.3.2)
+    stringio (3.1.8)
+    thor (1.4.0)
     timecop (0.9.10)
     timeout (0.4.3)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)

data/lib/table_sync/receiving/config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "hooks/once"
+
 module TableSync::Receiving
   class Config
     attr_reader :model, :events
@@ -23,13 +25,10 @@ module TableSync::Receiving
     class << self
       attr_reader :default_values_for_options
 
-      # In a configs this options are requested as they are
+      # In a configs these options are requested as they are
       # config.option - get value
       # config.option(args) - set static value
       # config.option { ... } - set proc as value
-      #
-      # In `Receiving::Handler` or `Receiving::EventActions` this options are requested
-      # through `Receiving::ConfigDecorator#method_missing` which always executes `config.option`
 
       def add_option(name, value_setter_wrapper:, value_as_proc_setter_wrapper:, default:)
         ivar = :"@#{name}"
@@ -55,11 +54,30 @@ module TableSync::Receiving
           instance_variable_set(ivar, result_value)
         end
       end
+
+      def add_hook_option(name, hook_class:)
+        ivar = :"@#{name}"
+
+        @default_values_for_options ||= {}
+        @default_values_for_options[ivar] = proc { [] }
+
+        define_method(name) do |conditions, &handler|
+          hooks = instance_variable_get(ivar)
+          hooks ||= []
+
+          hooks << hook_class.new(conditions:, handler:)
+          instance_variable_set(ivar, hooks)
+        end
+      end
     end
 
     def allow_event?(name)
       events.include?(name)
     end
+
+    def option(name)
+      instance_variable_get(:"@#{name}")
+    end
   end
 end
 
@@ -201,6 +219,11 @@ TableSync::Receiving::Config.add_option :wrap_receiving,
   value_as_proc_setter_wrapper: any_value,
   default: proc { proc { |&block| block.call } }
 
+TableSync::Receiving::Config.add_hook_option(
+  :on_first_sync,
+  hook_class: TableSync::Receiving::Hooks::Once,
+)
+
 %i[
   before_update
   after_commit_on_update

data/lib/table_sync/receiving/config_decorator.rb

@@ -2,9 +2,6 @@
 
 module TableSync::Receiving
   class ConfigDecorator
-    extend Forwardable
-
-    def_delegators :@config, :allow_event?
     # rubocop:disable Metrics/ParameterLists
     def initialize(config:, event:, model:, version:, project_id:, raw_data:)
       @config = config
@@ -19,9 +16,17 @@ module TableSync::Receiving
     end
     # rubocop:enable Metrics/ParameterLists
 
-    def method_missing(name, **additional_params, &)
-      value = @config.send(name)
+    def option(name, **additional_params, &)
+      value = @config.option(name)
       value.is_a?(Proc) ? value.call(@default_params.merge(additional_params), &) : value
     end
+
+    def model
+      @config.model
+    end
+
+    def allow_event?(name)
+      @config.allow_event?(name)
+    end
   end
 end

data/lib/table_sync/receiving/handler.rb

@@ -22,22 +22,20 @@ class TableSync::Receiving::Handler < Rabbit::EventHandler
 
       next if data.empty?
 
-      version_key = config.version_key(data:)
-      data.each { |row| row[version_key] = version }
-
-      target_keys = config.target_keys(data:)
+      target_keys = config.option(:target_keys, data:)
 
       validate_data(data, target_keys:)
 
       data.sort_by! { |row| row.values_at(*target_keys).map { |value| sort_key(value) } }
 
+      version_key = config.option(:version_key, data:)
       params = { data:, target_keys:, version_key: }
 
       if event == :update
-        params[:default_values] = config.default_values(data:)
+        params[:default_values] = config.option(:default_values, data:)
       end
 
-      config.wrap_receiving(event:, **params) do
+      config.option(:wrap_receiving, **params) do
         perform(config, params)
       end
     end
@@ -83,25 +81,28 @@ class TableSync::Receiving::Handler < Rabbit::EventHandler
   end
 
   def processed_data(config)
+    version_key = config.option(:version_key, data:)
     data.filter_map do |row|
-      next if config.skip(row:)
+      next if config.option(:skip, row:)
 
       row = row.dup
 
-      config.mapping_overrides(row:).each do |before, after|
+      config.option(:mapping_overrides, row:).each do |before, after|
         row[after] = row.delete(before)
       end
 
-      config.except(row:).each { |x| row.delete(x) }
+      config.option(:except, row:).each { |x| row.delete(x) }
 
-      row.merge!(config.additional_data(row:))
+      row.merge!(config.option(:additional_data, row:))
 
-      only = config.only(row:)
+      only = config.option(:only, row:)
       row, rest = row.partition { |key, _| key.in?(only) }.map(&:to_h)
 
-      rest_key = config.rest_key(row:, rest:)
+      rest_key = config.option(:rest_key, row:, rest:)
       (row[rest_key] ||= {}).merge!(rest) if rest_key
 
+      row[version_key] = version
+
       row
     end
   end
@@ -138,16 +139,16 @@ class TableSync::Receiving::Handler < Rabbit::EventHandler
     raise TableSync::DataError.new(data, errors.keys, errors.to_json)
   end
 
-  def perform(config, params)
+  def perform(config, params) # rubocop:disable Metrics/MethodLength
     model = config.model
 
     model.transaction do
       results = if event == :update
-                  config.before_update(**params)
+                  config.option(:before_update, **params)
                   validate_data_types(model, params[:data])
                   model.upsert(**params)
                 else
-                  config.before_destroy(**params)
+                  config.option(:before_destroy, **params)
                   model.destroy(**params)
                 end
 
@@ -157,9 +158,15 @@ class TableSync::Receiving::Handler < Rabbit::EventHandler
       end
 
       if event == :update
-        model.after_commit { config.after_commit_on_update(**params, results:) }
+        model.after_commit do
+          config.option(:after_commit_on_update, **params, results:)
+
+          Array(config.option(:on_first_sync)).each do |hook|
+            hook.perform(config:, targets: results) if hook.enabled?
+          end
+        end
       else
-        model.after_commit { config.after_commit_on_destroy(**params, results:) }
+        model.after_commit { config.option(:after_commit_on_destroy, **params, results:) }
       end
     end
   end

data/lib/table_sync/receiving/hooks/once.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module TableSync::Receiving::Hooks
+  class Once
+    LOCK_KEY = "hook-once-lock-key"
+
+    attr_reader :conditions, :handler, :lookup_code
+
+    def initialize(conditions:, handler:)
+      @conditions = conditions
+      @handler = handler
+      init_lookup_code
+    end
+
+    def enabled?
+      conditions[:columns].any?
+    end
+
+    def perform(config:, targets:)
+      target_keys = config.option(:target_keys)
+      model = config.model
+
+      targets.each do |target|
+        next unless conditions?(target)
+
+        keys = target.slice(*target_keys)
+        model.try_advisory_lock(prepare_lock_key(keys)) do
+          model.find_and_save(keys:) do |entry|
+            next unless allow?(entry)
+
+            entry.hooks ||= []
+            entry.hooks << lookup_code
+            model.after_commit { handler.call(entry:) }
+          end
+        end
+      end
+    end
+
+    private
+
+    def allow?(entry)
+      Array(entry.hooks).exclude?(lookup_code)
+    end
+
+    def init_lookup_code
+      @lookup_code = conditions[:columns].map do |column|
+        "#{column}-#{conditions[column]}"
+      end.join(":")
+    end
+
+    def conditions?(row)
+      conditions[:columns].all? do |column|
+        row[column] == (conditions[column] || row[column])
+      end
+    end
+
+    def prepare_lock_key(row_keys)
+      lock_keys = [LOCK_KEY] + row_keys.values
+      Zlib.crc32(lock_keys.join(":")) % (2**31)
+    end
+  end
+end

data/lib/table_sync/receiving/model/active_record.rb

@@ -2,6 +2,13 @@
 
 module TableSync::Receiving::Model
   class ActiveRecord
+    ISOLATION_LEVELS = {
+      uncommitted: :read_uncommitted,
+      committed: :read_committed,
+      repeatable: :repeatable_read,
+      serializable: :serializable,
+    }.freeze
+
     class AfterCommitWrap
       def initialize(&block)
         @callback = block
@@ -33,6 +40,10 @@ module TableSync::Receiving::Model
       @schema = model_naming.schema.to_sym
     end
 
+    def isolation_level(lookup_code)
+      ISOLATION_LEVELS.fetch(lookup_code)
+    end
+
     def columns
       raw_model.column_names.map(&:to_sym)
     end
@@ -110,14 +121,30 @@ module TableSync::Receiving::Model
       types_validator.validate(data)
     end
 
-    def transaction(&)
-      ::ActiveRecord::Base.transaction(&)
+    def transaction(**params, &)
+      ::ActiveRecord::Base.transaction(**params, &)
     end
 
     def after_commit(&)
       db.add_transaction_record(AfterCommitWrap.new(&))
     end
 
+    def try_advisory_lock(lock_key)
+      transaction do
+        if db.query_value("SELECT pg_try_advisory_xact_lock(#{lock_key.to_i})")
+          yield
+        end
+      end
+    end
+
+    def find_and_save(keys:)
+      entry = raw_model.find_by(keys)
+      return unless entry
+
+      yield entry
+      entry.save!
+    end
+
     private
 
     attr_reader :raw_model, :types_validator

data/lib/table_sync/receiving/model/sequel.rb

@@ -4,6 +4,13 @@ module TableSync::Receiving::Model
   class Sequel
     attr_reader :table, :schema
 
+    ISOLATION_LEVELS = {
+      uncommitted: :uncommitted,
+      committed: :committed,
+      repeatable: :repeatable,
+      serializable: :serializable,
+    }.freeze
+
     def initialize(table_name)
       @raw_model = Class.new(::Sequel::Model(table_name)).tap(&:unrestrict_primary_key)
       @types_validator = TableSync::Utils::Schema::Builder::Sequel.build(@raw_model)
@@ -17,6 +24,10 @@ module TableSync::Receiving::Model
       @schema = model_naming.schema.to_sym
     end
 
+    def isolation_level(lookup_code)
+      ISOLATION_LEVELS.fetch(lookup_code)
+    end
+
     def columns
       dataset.columns
     end
@@ -57,14 +68,30 @@ module TableSync::Receiving::Model
       types_validator.validate(data)
     end
 
-    def transaction(&)
-      db.transaction(&)
+    def transaction(**params, &)
+      db.transaction(**params, &)
     end
 
     def after_commit(&)
       db.after_commit(&)
     end
 
+    def try_advisory_lock(lock_key)
+      transaction do
+        if db.get(::Sequel.function(:pg_try_advisory_xact_lock, lock_key.to_i))
+          yield
+        end
+      end
+    end
+
+    def find_and_save(keys:)
+      entry = dataset.first(keys)
+      return unless entry
+
+      yield entry
+      entry.save_changes
+    end
+
     private
 
     attr_reader :raw_model, :types_validator

data/lib/table_sync/receiving.rb

@@ -6,6 +6,7 @@ module TableSync
     require_relative "receiving/config_decorator"
     require_relative "receiving/dsl"
     require_relative "receiving/handler"
+    require_relative "receiving/hooks/once"
     require_relative "receiving/model/active_record"
     require_relative "receiving/model/sequel"
   end

data/lib/table_sync/utils/interface_checker.rb

@@ -101,3 +101,8 @@ __END__
   :schema:
     :parameters: []
     :description: "returns an instance of Symbol"
+  :validate_types:
+    :parameters:
+      - - :req
+        - :data
+    :description: "validate types of receiving data to make more readable errors"

data/lib/table_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TableSync
-  VERSION = "6.9.2"
+  VERSION = "6.10.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: table_sync
 version: !ruby/object:Gem::Version
-  version: 6.9.2
+  version: 6.10.0
 platform: ruby
 authors:
 - Umbrellio
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memery
@@ -118,6 +117,7 @@ files:
 - lib/table_sync/receiving/config_decorator.rb
 - lib/table_sync/receiving/dsl.rb
 - lib/table_sync/receiving/handler.rb
+- lib/table_sync/receiving/hooks/once.rb
 - lib/table_sync/receiving/model/active_record.rb
 - lib/table_sync/receiving/model/sequel.rb
 - lib/table_sync/setup/active_record.rb
@@ -141,7 +141,6 @@ homepage: https://github.com/umbrellio/table_sync
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: DB Table synchronization between microservices based on Model's event system
   and RabbitMQ messaging