isolator 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f7e62d7f280c06f8ad704770d5ba5f14198006bccec0ce69e0e1aa99a8b32c7
-  data.tar.gz: 4c4aabcfad57d3ba2da54b5e75b7ee057bf25a10d382094d05a04fec2f371c85
+  metadata.gz: dc5300f95e1333baa45e8e10e1e13b1ebc03175b648791bfec5a87e160643e9e
+  data.tar.gz: e184eb7fc257b0ab5ae95878ea955769d9925b8b428dc6c469bcde5af89c69f5
 SHA512:
-  metadata.gz: 565c283a6ddebe9e7d39472094f44f346a1ea1b49afc5ad9fe7aee1ecb98e5910fd5cdc4c0804c581132363338e39465faadab3f51eccbddaea8f731225fd364
-  data.tar.gz: ab01a1494c0fac2c1920bced02ae86c6b6b26a6e420f3ef6e43fdd1bd300e14e259c3353b9af08b14787b5ebe499d816222998e837d0af4e16006d9c77a9f5d1
+  metadata.gz: 2668126bfa3de56db202b28dc4eeb5267a2acccf2843d2843d7928cc7fbd96d3a7f42b90b1e652b97857b9f2e3f75e009bacacc4ab9532d4c7ebfbbeea35fb56
+  data.tar.gz: 252e668eb55d8f4b8ddda8567833be514b595817d2064d35190bdd74719409568a7779e0bcf8564da4d32e45bc3d3fe6a5ae5afe3ec1d6018dfb0db107c1418d

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## master
 
+## 1.0.0 (2023-11-30)
+
+- Add ability to track concurrent transactions to with a thread (e.g., to multiple databases). ([@palkan][])
+
+  This feature is disabled by default, opt-in via: `Isolator.config.disallow_per_thread_concurrent_transactions = true`.
+
+- Add `Isolator.on_transaction_begin` and `Isolator.on_transaction_end` callbacks. ([@palkan][])
+
+- Drop Ruby 2.6 and Rails 5 support. ([@palkan][])
+
+## 0.11.0 (2023-09-27)
+
+- Use Rails new `transaction.active_record` event if available to better handle edge cases. ([@palkan][])
+
+- Fix logging non-UTF8 strings. ([@palkan][])
+
+  Fixes [#66](https://github.com/palkan/isolator/issues/66)
+
 ## 0.10.0 (2023-08-15)
 
 - Support multiple databases with DatabaseCleaner. ([@palkan][])

data/README.md

@@ -101,6 +101,9 @@ Isolator.configure do |config|
   # Define a custom ignorer class (must implement .prepare)
   # uses a row number based list from the .isolator_todo.yml file
   config.ignorer = Isolator::Ignorer
+
+  # Turn on/off raising exceptions for simultaneous transactions to different databases
+  config.disallow_cross_database_transactions = false
 end
 ```
 
@@ -108,6 +111,34 @@ Isolator relies on [uniform_notifier][] to send custom notifications.
 
 **NOTE:** `uniform_notifier` should be installed separately (i.e., added to Gemfile).
 
+### Callbacks
+
+Isolator different callbacks so you can inject your own logic or build custom extensions.
+
+```ruby
+# This callback is called when Isolator enters the "danger zone"—a within-transaction context
+Isolator.before_isolate do
+  puts "Entering a database transaction. Be careful!"
+end
+
+# This callback is called when Isolator leaves the "danger zone"
+Isolator.after_isolate do
+  puts "Leaving a database transaction. Everything is fine. Feel free to call slow HTTP APIs"
+end
+
+# This callback is called every time a new transaction is open (root or nested)
+Isolator.on_transaction_open do |event|
+  puts "New transaction from #{event[:connection_id]}. " \
+       "Current depth: #{event[:depth]}"
+end
+
+# This callback is called every time a transaction is completed
+Isolator.on_transaction_close do |event|
+  puts "Transaction completed from #{event[:connection_id]}. " \
+       "Current depth: #{event[:depth]}"
+end
+```
+
 ### Transactional tests support
 
  - Rails' baked-in [use_transactional_tests](https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html#class-ActiveRecord::FixtureSet-label-Transactional+Tests)
@@ -115,7 +146,7 @@ Isolator relies on [uniform_notifier][] to send custom notifications.
 
 ### Supported ORMs
 
-- `ActiveRecord` >= 5.1 (4.2 likely till works, but we do not test against it anymore)
+- `ActiveRecord` >= 6.0 (see older versions of Isolator for previous versions)
 - `ROM::SQL` (only if Active Support instrumentation extension is loaded)
 
 ### Adapters
@@ -159,7 +190,6 @@ Isolator.adapters.sidekiq.ignore_if { Thread.current[:sidekiq_postpone] }
 
 You can add as many _ignores_ as you want, the offense is registered iff all of them return false.
 
-
 ### Using with sidekiq/testing
 
 If you require sidekiq/testing in your tests after isolator is required then it will blow away isolator's hooks, so you need to require isolator after requiring sidekiq/testing.

data/lib/isolator/adapter_builder.rb

@@ -31,12 +31,18 @@ module Isolator
       def build_mod(method_name, adapter)
         return nil unless method_name
 
+        adapter_name = "__isolator_adapter_#{adapter.object_id}"
+
         Module.new do
-          define_method method_name do |*args, **kwargs, &block|
-            # check if we are even notifying before calling `caller`, which is well known to be slow
-            adapter.notify(caller, self, *args, **kwargs) if adapter.notify?(*args, **kwargs)
-            super(*args, **kwargs, &block)
-          end
+          define_method(adapter_name) { adapter }
+
+          module_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{method_name}(...)
+              # check if we are even notifying before calling `caller`, which is well known to be slow
+              #{adapter_name}.notify(caller, self, ...) if #{adapter_name}.notify?(...)
+              super
+            end
+          RUBY
         end
       end
     end

data/lib/isolator/adapters/base.rb

@@ -27,8 +27,8 @@ module Isolator
         Isolator.notify(exception: build_exception(obj, args, kwargs), backtrace: backtrace)
       end
 
-      def notify?(*args, **kwargs)
-        enabled? && Isolator.enabled? && Isolator.within_transaction? && !ignored?(*args, **kwargs)
+      def notify?(...)
+        enabled? && Isolator.enabled? && Isolator.within_transaction? && !ignored?(...)
       end
 
       def ignore_if(&block)

data/lib/isolator/adapters/http/sniffer.rb

@@ -6,12 +6,12 @@ require "sniffer"
 Sniffer::Config.defaults["logger"] = nil
 
 Isolator.isolate :http, target: Sniffer.singleton_class,
-                        method_name: :store,
-                        exception_class: Isolator::HTTPError,
-                        details_message: ->(_obj, args) {
-                          req = args.first.request
-                          "#{req.method} #{req.host}:#{req.port}#{req.query}"
-                        }
+  method_name: :store,
+  exception_class: Isolator::HTTPError,
+  details_message: ->(_obj, args) {
+    req = args.first.request
+    "#{req.method} #{req.host}:#{req.port}#{req.query}"
+  }
 
 Isolator.before_isolate do
   next if Isolator.adapters.http.disabled?

data/lib/isolator/adapters/mailers/mail.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 Isolator.isolate :mailer, target: Mail::Message,
-                          method_name: :deliver,
-                          exception_class: Isolator::MailerError,
-                          details_message: ->(obj) {
-                            "From: #{obj.from}\n" \
-                            "To: #{obj.to}\n" \
-                            "Subject: #{obj.subject}"
-                          }
+  method_name: :deliver,
+  exception_class: Isolator::MailerError,
+  details_message: ->(obj) {
+    "From: #{obj.from}\n" \
+    "To: #{obj.to}\n" \
+    "Subject: #{obj.subject}"
+  }

data/lib/isolator/callbacks.rb

@@ -11,6 +11,14 @@ module Isolator
       after_isolate_callbacks << block
     end
 
+    def on_transaction_begin(&block)
+      transaction_begin_callbacks << block
+    end
+
+    def on_transaction_end(&block)
+      transaction_end_callbacks << block
+    end
+
     def start!
       return if Isolator.disabled?
       before_isolate_callbacks.each(&:call)
@@ -21,6 +29,14 @@ module Isolator
       after_isolate_callbacks.each(&:call)
     end
 
+    def notify!(event, payload)
+      if event == :begin
+        transaction_begin_callbacks.each { |cb| cb.call(payload) }
+      elsif event == :end
+        transaction_end_callbacks.each { |cb| cb.call(payload) }
+      end
+    end
+
     def before_isolate_callbacks
       @before_isolate_callbacks ||= []
     end
@@ -28,5 +44,13 @@ module Isolator
     def after_isolate_callbacks
       @after_isolate_callbacks ||= []
     end
+
+    def transaction_begin_callbacks
+      @transaction_begin_callbacks ||= []
+    end
+
+    def transaction_end_callbacks
+      @transaction_end_callbacks ||= []
+    end
   end
 end

data/lib/isolator/notifier.rb

@@ -29,14 +29,22 @@ module Isolator
     def log_exception
       return unless Isolator.config.logger
 
-      msg = "[ISOLATOR EXCEPTION]\n" \
-            "#{exception.message}"
+      separator = " ↳ "
 
-      filtered_backtrace.each do |offense_line|
-        msg += "\n  ↳ #{offense_line}"
-      end
+      begin
+        msg = "[ISOLATOR EXCEPTION]\n" \
+              "#{exception.message}"
 
-      Isolator.config.logger.warn(msg)
+        filtered_backtrace.each do |offense_line|
+          msg += "\n #{separator}#{offense_line}"
+        end
+
+        Isolator.config.logger.warn(msg)
+      rescue Encoding::CompatibilityError
+        should_retry = separator != " - "
+        separator = " - "
+        retry if should_retry
+      end
     end
 
     def send_notifications

data/lib/isolator/orm_adapters/active_record.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "./active_support_subscriber"
+require_relative "active_support_subscriber"
 
-Isolator::ActiveSupportSubscriber.subscribe!("sql.active_record")
+# We rely on this feature introduced in 7.1.0.beta1: https://github.com/rails/rails/pull/49192
+if ActiveRecord::VERSION::MAJOR >= 7 && ActiveRecord::VERSION::MINOR >= 1
+  require_relative "active_support_transaction_subscriber"
+  Isolator::ActiveSupportTransactionSubscriber.subscribe!
+else
+  Isolator::ActiveSupportSubscriber.subscribe!("sql.active_record")
+end

data/lib/isolator/orm_adapters/active_support_subscriber.rb

@@ -7,14 +7,46 @@ module Isolator
     START_PATTERN = %r{(\ABEGIN|\ASAVEPOINT)}xi
     FINISH_PATTERN = %r{(\ACOMMIT|\AROLLBACK|\ARELEASE|\AEND TRANSACTION)}xi
 
-    def self.subscribe!(event)
-      ::ActiveSupport::Notifications.subscribe(event) do |_name, _start, _finish, _id, query|
-        connection_id = query[:connection_id] || query[:connection]&.object_id || 0
-        # Prevents "ArgumentError: invalid byte sequence in UTF-8" by replacing invalid byte sequence with "?"
-        sanitized_query = query[:sql].encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "?")
-        Isolator.incr_transactions!(connection_id) if START_PATTERN.match?(sanitized_query)
-        Isolator.decr_transactions!(connection_id) if FINISH_PATTERN.match?(sanitized_query)
+    class Subscriber
+      def start(event, id, payload)
+        return unless start_event?(payload[:sql])
+
+        connection_id = extract_connection_id(payload)
+
+        Isolator.incr_transactions!(connection_id)
+      end
+
+      def finish(event, id, payload)
+        return unless finish_event?(payload[:sql])
+
+        connection_id = extract_connection_id(payload)
+
+        Isolator.decr_transactions!(connection_id)
+      end
+
+      private
+
+      def start_event?(sql)
+        START_PATTERN.match?(sanitize_query(sql))
       end
+
+      def finish_event?(sql)
+        FINISH_PATTERN.match?(sanitize_query(sql))
+      end
+
+      # Prevents "ArgumentError: invalid byte sequence in UTF-8" by replacing invalid byte sequence with "?"
+      def sanitize_query(sql)
+        sql.encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "?")
+      end
+
+      def extract_connection_id(payload)
+        payload[:connection_id] || payload[:connection]&.object_id || 0
+      end
+    end
+
+    def self.subscribe!(event)
+      subscriber = Subscriber.new
+      ::ActiveSupport::Notifications.subscribe(event, subscriber)
     end
   end
 end

data/lib/isolator/orm_adapters/active_support_transaction_subscriber.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Isolator
+  # ActiveSupport notifications subscriber for "transaction.active_record" event (new in Rails 7.1)
+  module ActiveSupportTransactionSubscriber
+    class Subscriber < ActiveSupportSubscriber::Subscriber
+      attr_reader :stacks
+
+      def initialize
+        @stacks = Hash.new { |h, k| h[k] = [] }
+      end
+
+      def start(event, id, payload)
+        if event.start_with?("transaction.")
+          connection_id = extract_transaction_connection_id(payload)
+
+          # transaction.active_record can be issued without a query (when we restart the transaction),
+          # so we should add a new one on the stack.
+          # Example: https://github.com/rails/rails/blob/ce49fa9b31cd4a21d43db39d0cea364bce28b51d/activerecord/lib/active_record/connection_adapters/abstract/transaction.rb#L337
+          if stacks[connection_id].last == :raw
+            # Update the type of the last transaction event
+            stacks[connection_id].pop
+            stacks[connection_id] << :transaction
+          else
+            stacks[connection_id] << :transaction
+            Isolator.incr_transactions!(connection_id)
+          end
+        end
+      end
+
+      def finish(event, id, payload)
+        if event.start_with?("sql.")
+          if start_event?(payload[:sql])
+            connection_id = extract_connection_id(payload)
+
+            stacks[connection_id] << :raw
+
+            Isolator.incr_transactions!(connection_id)
+          end
+
+          if finish_event?(payload[:sql])
+            connection_id = extract_connection_id(payload)
+
+            # Decrement only if the transaction was started in the raw mode,
+            # otherwise we should wait for the "transaction" event
+            if stacks[connection_id].last == :raw
+              stacks[connection_id].pop
+              Isolator.decr_transactions!(connection_id)
+            end
+          end
+        end
+
+        if event.start_with?("transaction.")
+          connection_id = extract_transaction_connection_id(payload)
+          stacks[connection_id].pop
+
+          Isolator.decr_transactions!(connection_id)
+        end
+      end
+
+      private
+
+      def extract_transaction_connection_id(payload)
+        payload[:connection]&.object_id || 0
+      end
+    end
+
+    def self.subscribe!(event = "transaction.active_record", sql_event = "sql.active_record")
+      subscriber = Subscriber.new
+      ::ActiveSupport::Notifications.subscribe(event, subscriber)
+      ::ActiveSupport::Notifications.subscribe(sql_event, subscriber)
+    end
+  end
+end

data/lib/isolator/orm_adapters/rom_active_support.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "./active_support_subscriber"
+require_relative "active_support_subscriber"
 
 Isolator::ActiveSupportSubscriber.subscribe!("sql.rom")

data/lib/isolator/plugins/concurrent_database_transactions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Isolator
+  class Configuration
+    attr_accessor :disallow_per_thread_concurrent_transactions
+
+    alias_method :disallow_per_thread_concurrent_transactions?, :disallow_per_thread_concurrent_transactions
+  end
+
+  class ConcurrentTransactionError < UnsafeOperationError
+    MESSAGE = "You are trying to open a transaction while there is an open transation to another database." \
+  end
+
+  Isolator.before_isolate do
+    next unless Isolator.config.disallow_per_thread_concurrent_transactions?
+
+    isolated_connections = Isolator.all_transactions.count do |conn_id, depth|
+      depth >= Isolator.connection_threshold(conn_id)
+    end
+
+    next unless isolated_connections > 1
+
+    Isolator.notify(exception: ConcurrentTransactionError.new, backtrace: caller)
+  end
+end

data/lib/isolator/railtie.rb

@@ -2,6 +2,22 @@
 
 module Isolator
   class Railtie < ::Rails::Railtie # :nodoc:
+    module TestFixtures
+      def setup_fixtures(*)
+        super
+        return unless run_in_transaction?
+
+        Isolator.incr_thresholds!
+      end
+
+      def teardown_fixtures(*)
+        if run_in_transaction?
+          Isolator.decr_thresholds!
+        end
+        super
+      end
+    end
+
     initializer "isolator.backtrace_cleaner" do
       ActiveSupport.on_load(:active_record) do
         Isolator.backtrace_cleaner = lambda do |locations|
@@ -31,24 +47,13 @@ module Isolator
 
       next unless Rails.env.test?
 
-      if defined?(::ActiveRecord::TestFixtures)
-        ::ActiveRecord::TestFixtures.prepend(
-          Module.new do
-            def setup_fixtures(*)
-              super
-              return unless run_in_transaction?
-
-              Isolator.incr_thresholds!
-            end
-
-            def teardown_fixtures(*)
-              if run_in_transaction?
-                Isolator.decr_thresholds!
-              end
-              super
-            end
-          end
-        )
+      ActiveSupport.on_load(:active_record_fixtures) do
+        ::ActiveRecord::TestFixtures.prepend(TestFixtures)
+      end
+
+      # Rails 6 doesn't support this load hook, so we can emulate it
+      if ActiveRecord::VERSION::MAJOR < 7 && defined?(::ActiveRecord::TestFixtures)
+        ::ActiveRecord::TestFixtures.prepend(TestFixtures)
       end
     end
   end

data/lib/isolator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Isolator
-  VERSION = "0.10.0"
+  VERSION = "1.0.0"
 end

data/lib/isolator.rb

@@ -94,6 +94,14 @@ module Isolator
       state[:transactions]&.[](connection_id) || 0
     end
 
+    def all_transactions
+      state[:transactions] || {}
+    end
+
+    def connection_threshold(connection_id)
+      state[:thresholds]&.[](connection_id) || default_threshold
+    end
+
     def set_connection_threshold(val, connection_id = default_connection_id.call)
       state[:thresholds] ||= Hash.new { |h, k| h[k] = Isolator.default_threshold }
       state[:thresholds][connection_id] = val
@@ -131,7 +139,14 @@ module Isolator
 
       debug!("Transaction opened for connection #{connection_id} (total: #{state[:transactions][connection_id]}, threshold: #{state[:thresholds]&.fetch(connection_id, default_threshold)})")
 
-      start! if current_transactions(connection_id) == connection_threshold(connection_id)
+      current_depth = current_transactions(connection_id)
+      threshold = connection_threshold(connection_id)
+
+      start! if current_depth == threshold
+      if current_depth >= threshold
+        event = {connection_id: connection_id, depth: current_depth - threshold + 1}.freeze
+        notify!(:begin, event)
+      end
     end
 
     def decr_transactions!(connection_id = default_connection_id.call)
@@ -144,7 +159,15 @@ module Isolator
 
       state[:transactions][connection_id] -= 1
 
-      finish! if current_transactions(connection_id) == (connection_threshold(connection_id) - 1)
+      current_depth = current_transactions(connection_id)
+      threshold = connection_threshold(connection_id)
+
+      if current_depth >= threshold - 1
+        event = {connection_id: connection_id, depth: current_depth - threshold + 1}.freeze
+        notify!(:end, event)
+      end
+
+      finish! if current_depth == (threshold - 1)
 
       state[:transactions].delete(connection_id) if state[:transactions][connection_id].zero?
 
@@ -192,21 +215,25 @@ module Isolator
 
     attr_accessor :state
 
-    def connection_threshold(connection_id)
-      state[:thresholds]&.[](connection_id) || default_threshold
-    end
-
     def debug!(msg)
       return unless debug_enabled
-      msg = "[ISOLATOR DEBUG] #{msg}"
 
-      if backtrace_cleaner && backtrace_length.positive?
-        source = extract_source_location(caller)
+      separator = " ↳ "
 
-        msg = "#{msg}\n  ↳ #{source.join("\n")}" unless source.empty?
+      begin
+        msg = "[ISOLATOR DEBUG] #{msg}"
+        if backtrace_cleaner && backtrace_length.positive?
+          source = extract_source_location(caller)
+
+          msg = "#{msg}\n #{separator}#{source.join("\n")}" unless source.empty?
+        end
+
+        $stdout.puts(colorize_debug(msg))
+      rescue Encoding::CompatibilityError
+        should_retry = separator != " - "
+        separator = " - "
+        retry if should_retry
       end
-
-      $stdout.puts(colorize_debug(msg))
     end
 
     def extract_source_location(locations)
@@ -233,3 +260,6 @@ require "isolator/orm_adapters"
 require "isolator/adapters"
 require "isolator/railtie" if defined?(Rails)
 require "isolator/database_cleaner_support" if defined?(DatabaseCleaner)
+
+# Built-in extensions
+require "isolator/plugins/concurrent_database_transactions"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -313,7 +313,9 @@ files:
 - lib/isolator/orm_adapters.rb
 - lib/isolator/orm_adapters/active_record.rb
 - lib/isolator/orm_adapters/active_support_subscriber.rb
+- lib/isolator/orm_adapters/active_support_transaction_subscriber.rb
 - lib/isolator/orm_adapters/rom_active_support.rb
+- lib/isolator/plugins/concurrent_database_transactions.rb
 - lib/isolator/railtie.rb
 - lib/isolator/simple_hashie.rb
 - lib/isolator/version.rb
@@ -335,14 +337,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Detect non-atomic interactions within DB transactions