trx_ext 1.0.0

data/lib/trx_ext/callback_pool.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module TrxExt
+  class CallbackPool
+    class << self
+      # @param :previous [nil, TrxExt::CallbackPool]
+      # @return [TrxExt::CallbackPool]
+      def add(previous: nil)
+        # It may happen when transaction is defined inside `on_complete` callback and, thus, when adding the
+        # `on_complete` callback for it, `previous` will point on the `TrxExt::CallbackPool` of the transaction's
+        # callback that is being executing right now. We should not continue such chain and allow the transaction to
+        # build its own chain.
+        # Example:
+        #   trx do |c1|
+        #     c1.on_complete do
+        #       # When executing .add to define c2 TrxExt::CallbackPool - previous argument will contain
+        #       # c1 TrxExt::CallbackPool that is already being executing. Assign nil to previous in this case.
+        #       trx do |c2|
+        #         c2.on_complete { }
+        #       end
+        #     end
+        #   end
+        previous = nil if previous&.locked_for_execution?
+        inst = new
+        inst.previous = previous
+        inst
+      end
+    end
+
+    # Points on the previous instance in the single linked chain
+    attr_accessor :previous
+    attr_writer :locked_for_execution
+
+    def initialize
+      @callbacks = []
+      @locked_for_execution = false
+    end
+
+    # @return [Boolean] whether current instance is locked for the next {#exec_callbacks} action
+    def locked_for_execution?
+      @locked_for_execution
+    end
+
+    # @param blk [Proc]
+    # @return [void]
+    def on_complete(&blk)
+      @callbacks.push(blk)
+    end
+
+    # The chain of callbacks pool comes as follows:
+    # <#TrxExt::CallbackPool:0x03 @callbacks=[] previous=
+    #   <#TrxExt::CallbackPool:0x02 @callbacks=[] previous=
+    #     <#TrxExt::CallbackPool:0x01 @callbacks=[] previous=nil>
+    #   >
+    # >
+    # The most inner instance - is the instance that was created first in stack call. The most top instance - is the
+    # instance that was created last in the stack call.
+    # Related example of how they are created during `trx` calls:
+    #   trx do |c0x01|
+    #     trx do |c0x02|
+    #       trx do |c0x03|
+    #       end
+    #     end
+    #   end
+    #
+    # At the end of execution of each `trx` - {#exec_callbacks_chain} will be called for each {TrxExt::CallbackPool}.
+    # But only <#TrxExt::CallbackPool:0x01> will really execute the callbacks of all pools in the chain - only it has
+    # rights to do this, because only it stands on the top of the call stack. This is ensured with
+    # `return unless previous.nil?` condition. At the moment of execution of {#exec_callbacks_chain} of top-stack
+    # instance - {ActiveRecord::Base.connection.current_callbacks_chain_link} points on the most inner, by call stack,
+    # {TrxExt::CallbackPool}. In the example above, it is <#TrxExt::CallbackPool:0x03>
+    #
+    # @param :connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter]
+    # @return [Boolean] whether callbacks was executed
+    def exec_callbacks_chain(connection:)
+      return false unless previous.nil?
+
+      current = connection.current_callbacks_chain_link
+      loop do
+        # It is important to keep it here to prevent potential
+        # `NoMethodError: undefined method `exec_callbacks' for nil:NilClass` exception when trying to execute callbacks
+        # for the transaction that raised an exception. In case of exception - current_callbacks_chain_link is set to
+        # nil. See {TrxExt::Retry.retry_until_serialized}. See {TrxExt::Transaction#transaction}.
+        # Example:
+        #   trx { raise "trol" } # Should raise RuntimeError instead of NoMethodError
+        break if current.nil?
+
+        current.locked_for_execution = true
+        current.exec_callbacks
+        current = current.previous
+      end
+      # Can't use `ensure` here, because it will be triggered even if condition in first line is falsey. And we need
+      # to set connection#current_callbacks_chain_link to nil only in case of exception or in case of successful run of
+      # callbacks
+      connection.current_callbacks_chain_link = nil
+      true
+    rescue
+      connection.current_callbacks_chain_link = nil
+      raise
+    end
+
+    # @return [void]
+    def exec_callbacks
+      @callbacks.each(&:call)
+      nil
+    end
+  end
+end

data/lib/trx_ext/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TrxExt
+  class Config
+    attr_accessor :unique_retries
+
+    def initialize
+      # Number of retries of unique constraint error before failing
+      @unique_retries = 5
+    end
+  end
+end

data/lib/trx_ext/object_ext.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module TrxExt
+  module ObjectExt
+    # Wraps specified method in an +ActiveRecord+ transaction.
+    #
+    # @example
+    #   class Tilapia < Symbology::Base
+    #     wrap_in_trx def gnosis(number)
+    #       introspect(number, string.numerology(:kabbalah).sum)
+    #     end
+    #   end
+    #
+    #   order = Tilapia.new
+    #   order.gnosis(93)
+    #   #   (0.6ms)  BEGIN
+    #   #  Introspection Load (0.4ms)  SELECT "introspections".* FROM "introspections" WHERE "introspections"."id" = $1 LIMIT 1  [["id", 93]]
+    #   #   (0.2ms)  COMMIT
+    #   # => 418
+    #
+    # @param method [Symbol] a name of the method
+    # @return [Symbol]
+    def wrap_in_trx(method)
+      module_to_prepend = Module.new do
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(...)
+          trx do
+            super
+          end
+        end
+        RUBY
+      end
+      prepend module_to_prepend
+      method
+    end
+
+    # A shorthand version of <tt>ActiveRecord::Base.transaction</tt>
+    def trx(...)
+      ActiveRecord::Base.transaction(...)
+    end
+  end
+end

data/lib/trx_ext/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrxExt
+  class Railtie < Rails::Railtie
+    initializer 'trx_ext.setup_ar' do
+      TrxExt.integrate!
+    end
+  end
+end

data/lib/trx_ext/retry.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module TrxExt
+  module Retry
+    class << self
+      # Wraps specified method in a +TrxExt::Retry.retry_until_serialized+ loop.
+      #
+      # @param klass [Class] class a method belongs to
+      # @param method [Symbol] instance method that needs to be wrapped into +TrxExt::Retry.retry_until_serialized+
+      def with_retry_until_serialized(klass, method)
+        module_to_prepend = Module.new do
+          klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{method}(...)
+              ::TrxExt::Retry.retry_until_serialized do
+                super
+              end
+            end
+          RUBY
+        end
+        prepend module_to_prepend
+        method
+      end
+
+      # Retries block execution until serialization errors are no longer raised
+      def retry_until_serialized
+        retries_count = 0
+        begin
+          yield
+        rescue => error
+          error_classification = error_classification(error)
+          if error_classification == :record_not_unique
+            retries_count += 1
+          end
+          if retry_query?(error, retries_count)
+            TrxExt.log("Detected transaction rollback condition. Reason - #{error_classification}. Retrying...")
+            retry
+          else
+            raise error
+          end
+        end
+      end
+
+      private
+
+      def error_classification(error)
+        case
+        when error.message.index('deadlock detected')
+          :deadlock
+        when error.message.index('could not serialize')
+          :serialization_error
+        when error.class == ActiveRecord::RecordNotUnique
+          :record_not_unique
+        end
+      end
+
+      def retry_query?(error, retryies_count)
+        classification = error_classification(error)
+        ActiveRecord::Base.connection.open_transactions == 0 &&
+          (%i(deadlock serialization_error).include?(classification) ||
+            classification == :record_not_unique && retryies_count < TrxExt.config.unique_retries)
+      end
+    end
+  end
+end

data/lib/trx_ext/transaction.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module TrxExt
+  # Implements the feature that allows you to define callbacks that will be fired after SQL transaction is complete.
+  module Transaction
+    # See https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/DatabaseStatements.html#method-i-transaction
+    # for available params
+    def transaction(**kwargs, &blk)
+      pool = nil
+      TrxExt::Retry.retry_until_serialized do
+        super(**kwargs) do
+          pool = TrxExt::CallbackPool.add(previous: current_callbacks_chain_link)
+          self.current_callbacks_chain_link = pool
+          blk.call(pool)
+        end
+      rescue
+        self.current_callbacks_chain_link = nil
+        raise
+      end
+    ensure
+      pool.exec_callbacks_chain(connection: self)
+    end
+
+    # Returns the {TrxExt::CallbackPool} instance for the transaction that is being executed at the moment.
+    def current_callbacks_chain_link
+      @trx_callbacks_chain
+    end
+
+    # Set the {TrxExt::CallbackPool} instance for the transaction that is being executed at the moment.
+    def current_callbacks_chain_link=(val)
+      @trx_callbacks_chain = val
+    end
+  end
+end

data/lib/trx_ext/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module TrxExt
+  VERSION = "1.0.0"
+  SUPPORTED_AR_VERSIONS = %w(6.0.4.1 6.1.4.1).freeze
+end

data/lib/trx_ext.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require_relative "trx_ext/callback_pool"
+require_relative "trx_ext/object_ext"
+require_relative "trx_ext/retry"
+require_relative "trx_ext/transaction"
+require_relative "trx_ext/config"
+require_relative "trx_ext/version"
+
+module TrxExt
+  class << self
+    attr_accessor :logger
+
+    # @return [void]
+    def integrate!
+      ActiveSupport.on_load(:active_record) do
+        require 'active_record/connection_adapters/postgresql_adapter'
+
+        # Allow to use #wrap_in_trx and #trx methods everywhere
+        Object.prepend(TrxExt::ObjectExt)
+
+        # Patch #transaction
+        ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(TrxExt::Transaction)
+
+        # Single SELECT/UPDATE/DELETE queries should also be retried even if they are not a part of explicit transaction
+        TrxExt::Retry.with_retry_until_serialized(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_query)
+        TrxExt::Retry.with_retry_until_serialized(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_update)
+        TrxExt::Retry.with_retry_until_serialized(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_delete)
+      end
+    end
+
+    # @return [void]
+    def log(msg)
+      return unless logger
+
+      logger.info(msg)
+    end
+
+    # @return [TrxExt::Config]
+    def config
+      @config ||= TrxExt::Config.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end
+
+if defined?(Rails::Railtie)
+  require_relative "trx_ext/railtie"
+else
+  TrxExt.integrate!
+end

data/trx_ext.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/trx_ext/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "trx_ext"
+  spec.version       = TrxExt::VERSION
+  spec.authors       = ["Ivan Dzyzenko"]
+  spec.email         = ["ivan.dzyzenko@gmail.com"]
+
+  spec.summary       = "ActiveRecord's transaction extension"
+  spec.description   = "Allow you to retry deadlocks, serialization errors, non-unique errors."
+  spec.homepage      = "https://github.com/intale/trx_ext"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/intale/trx_ext/tree/v#{spec.version}"
+  spec.metadata["changelog_uri"] = "https://github.com/intale/trx_ext/blob/v#{spec.version}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '~> 6'
+  spec.add_dependency 'pg', '~> 1.2'
+  spec.add_development_dependency 'rspec', "~> 3.10"
+  spec.add_development_dependency 'timecop', "~> 0.9.4"
+  spec.add_development_dependency 'factory_bot', "~> 6.2"
+  spec.add_development_dependency 'fivemat', '~> 1.3'
+  spec.add_development_dependency 'rspec-its', '~> 1.3'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: trx_ext
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ivan Dzyzenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Allow you to retry deadlocks, serialization errors, non-unique errors.
+email:
+- ivan.dzyzenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test_all_ar_versions
+- lib/trx_ext.rb
+- lib/trx_ext/callback_pool.rb
+- lib/trx_ext/config.rb
+- lib/trx_ext/object_ext.rb
+- lib/trx_ext/railtie.rb
+- lib/trx_ext/retry.rb
+- lib/trx_ext/transaction.rb
+- lib/trx_ext/version.rb
+- log/.gitkeep
+- trx_ext.gemspec
+homepage: https://github.com/intale/trx_ext
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/intale/trx_ext
+  source_code_uri: https://github.com/intale/trx_ext/tree/v1.0.0
+  changelog_uri: https://github.com/intale/trx_ext/blob/v1.0.0/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: ActiveRecord's transaction extension
+test_files: []