isolator 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5c027f6c2e795b8aeb009340efd8a920556cfb47553a06d93f4feab8d7c79de
-  data.tar.gz: 3ae481ffdf7eba4d080402d44c7355c558363b0228053091ca96edc55bd26847
+  metadata.gz: 5c40700b0b2f7e5025ed7cbfb80580ac9ee1516a1295146bf0fa9db1de6e2a7f
+  data.tar.gz: 7d605d3790733c0b1bcd44e6188c30050900879042ef604950cc38b36d6214d0
 SHA512:
-  metadata.gz: '008f26a3b4e3d059332e25a0b193dcec4586a17b6d6df9259b8b13e94a85e214e2c16aa37197a5490e92ba3cc288ce656c3ae1e1061e7ae7968ff4b967d327f1'
-  data.tar.gz: 2a4237282734486458d04f45474eee2a75367724808f8079801645ffe978981725f6d46e6db1de041d8c36d2cd1a5832b7f09f44e2773c609013560bd9ee5904
+  metadata.gz: d3a05d4ccad1f80171a67f0f124cb2d37548803a5451338cb9d821c16042dc94c407f9a4a155597742268cbf8ee939594a166c49835f35f5f4d2ec4d1d9a0567
+  data.tar.gz: a287d291ca6465f3c8acfc8cb8c1c5ba898315c6aae80156855153d13a3c7c763864d97127ef38b04331bb7c99b23b417783eada86afdf8c26282c694dfe22bd

data/CHANGELOG.md

@@ -2,6 +2,39 @@
 
 ## master
 
+## 0.8.0 (2021-12-29)
+
+- Drop Ruby 2.5 support.
+
+- Add .isolator_ignore.yml configuration file for Rails application.
+
+## 0.7.0 (2020-09-25)
+
+- Add debug mode. ([@palkan][])
+
+Use `ISOLATOR_DEBUG=true` to turn on debug mode, which prints some useful information: when a transaction is tracked,
+thresholds are changed, etc.
+
+- Track transactions for different connections independently. ([@mquan][], [@palkan][])
+
+This, for example, makes Isolator compatible with Rails multi-database apps.
+
+- Allow custom ignorer usage. ([@iiwo][])
+
+- `Isolator.load_ignore_config` is deprecated in favor of `Isolator::Ignorer.prepare`. ([@iiwo][])
+
+## 0.6.2 (2020-03-20)
+
+- Make Sniffer version requirement open-ended. ([@palkan][])
+
+- **Support Ruby 2.5+** ([@palkan][])
+
+## 0.6.1 (2019-09-06)
+
+- Fix Sniffer integration. ([@palkan][])
+
+  Fixes [#21](https://github.com/palkan/isolator/issues/21).
+
 ## 0.6.0 (2019-04-12) 🚀
 
 - Add support for exceptions message details. ([@palkan][])
@@ -64,3 +97,5 @@
 [@Envek]: https://github.com/Envek
 [@DmitryTsepelev]: https://github.com/DmitryTsepelev
 [@shivanshgaur]: https://github.com/shivanshgaur
+[@iiwo]: https://github.com/iiwo
+[@mquan]: https://github.com/mquan

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Vladimir Dementyev
+Copyright (c) 2018-2020 Vladimir Dementyev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 [![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](http://cultofmartians.com/tasks/isolator.html)
 [![Gem Version](https://badge.fury.io/rb/isolator.svg)](https://badge.fury.io/rb/isolator)
-[![Build Status](https://travis-ci.org/palkan/isolator.svg?branch=master)](https://travis-ci.org/palkan/isolator)
+![Build](https://github.com/palkan/isolator/workflows/Build/badge.svg)
 
 # Isolator
 
@@ -79,6 +79,8 @@ However, there are some potential caveats:
 
 3) Isolator tries to detect the `test` environment and slightly change its behavior: first, it respect _transactional tests_; secondly, error raising is turned on by default (see [below](#configuration)).
 
+4) Experimental [multiple databases](https://guides.rubyonrails.org/active_record_multiple_databases.html) has been added in v0.7.0. Please, let us know if you encounter any issues.
+
 ### Configuration
 
 ```ruby
@@ -95,10 +97,14 @@ Isolator.configure do |config|
   # Customize backtrace filtering (provide a callable)
   # By default, just takes the top-5 lines
   config.backtrace_filter = ->(backtrace) { backtrace.take(5) }
+
+  # Define a custom ignorer class (must implement .prepare)
+  # uses a row number based list from the .isolator_todo.yml file
+  config.ignorer = Isolator::Ignorer
 end
 ```
 
-Isolator relys on [uniform_notifier][] to send custom notifications.
+Isolator relies on [uniform_notifier][] to send custom notifications.
 
 **NOTE:** `uniform_notifier` should be installed separately (i.e., added to Gemfile).
 
@@ -109,13 +115,13 @@ Isolator relys on [uniform_notifier][] to send custom notifications.
 
 ### Supported ORMs
 
-- `ActiveRecord` >= 4.1
-- `ROM::SQL` (only if Active Support instrumentation extenstion is loaded)
+- `ActiveRecord` >= 5.1 (4.2 likely till works, but we do not test against it anymore)
+- `ROM::SQL` (only if Active Support instrumentation extension is loaded)
 
 ### Adapters
 
 Isolator has a bunch of built-in adapters:
-- `:http` – built on top of [Sniffer][]
+- `:http` – built on top of [Sniffer][]
 - `:active_job`
 - `:sidekiq`
 - `:resque`
@@ -155,7 +161,7 @@ You can add as many _ignores_ as you want, the offense is registered iff all of
 
 ### Using with legacy Rails codebases
 
-If you already have a huge Rails project it can be a tricky to turn Isolator on because you'll immediately get a lot of failed specs. If you want to fix detected issues one by one, you can list all of them in the special file `.isolator_todo.yml` in a following way:
+If you already have a huge Rails project it can be tricky to turn Isolator on because you'll immediately get a lot of failed specs. If you want to fix detected issues one by one, you can list all of them in the special files `.isolator_todo.yml` and `.isolator_ignore.yml` in the following way:
 
 ```
 sidekiq:
@@ -165,9 +171,11 @@ sidekiq:
 
 All the exceptions raised in the listed lines will be ignored.
 
+The `.isolator_todo.yml` file is intended to point to the code that should be fixed later, and `.isolator_ignore.yml` points to the code that for some reasons is not expected to be fixed. (See https://github.com/palkan/isolator/issues/40)
+
 ### Using with legacy Ruby codebases
 
-If you are not using Rails, you'll have to load ignores from file manually, using `Isolator#load_ignore_config`, for instance `Isolator.load_ignore_config("./config/.isolator_todo.yml")`
+If you are not using Rails, you'll have to load ignores from file manually, using `Isolator::Ignorer.prepare(path:)`, for instance `Isolator::Ignorer.prepare(path: "./config/.isolator_todo.yml")`
 
 ## Custom Adapters
 
@@ -183,23 +191,23 @@ Suppose that you have a class `Danger` with a method `#explode`, which is not sa
 # the third one is a method name.
 Isolator.isolate :danger, Danger, :explode, options
 
-# NOTE: if you want to isolate a class method, use signleton_class instead
+# NOTE: if you want to isolate a class method, use singleton_class instead
 Isolator.isolate :danger, Danger.singleton_class, :explode, options
 ```
 
 Possible `options` are:
 - `exception_class` – an exception class to raise in case of offense
 - `exception_message` – custom exception message (could be specified without a class)
-- `details_message` – a block to generate additional exceptin message information:
+- `details_message` – a block to generate additional exception message information:
 
 ```ruby
 Isolator.isolate :active_job,
-                 target: ActiveJob::Base,
-                 method_name: :enqueue,
-                 exception_class: Isolator::BackgroundJobError,
-                 details_message: ->(obj, _args) {
-                   "#{obj.class.name}(#{obj.arguments})"
-                 }
+  target: ActiveJob::Base,
+  method_name: :enqueue,
+  exception_class: Isolator::BackgroundJobError,
+  details_message: ->(obj, _args) {
+    "#{obj.class.name}(#{obj.arguments})"
+  }
 ```
 
 You can also add some callbacks to be run before and after the transaction:
@@ -210,10 +218,22 @@ Isolator.before_isolate do
 end
 
 Isolator.after_isolate do
- # right after the transaction has been committed/rollbacked
+ # right after the transaction has been committed/rolled back
 end
 ```
 
+## Troubleshooting
+
+### Verbose output
+
+In most cases, turning on verbose output for Isolator helps to identify the issue. To do that, you can either specify `ISOLATOR_DEBUG=true` environment variable or set `Isolator.debug_enabled` manually.
+
+### Tests failing after upgrading to Rails 6.0.3 while using [Combustion](https://github.com/pat/combustion)
+
+The reason is that Rails started using a [separate connection pool for advisory locks](https://github.com/rails/rails/pull/38235) since 6.0.3. Since Combustion usually applies migrations for every test run, this pool becomse visible to [test fixtures](https://github.com/rails/rails/blob/b738f1930f3c82f51741ef7241c1fee691d7deb2/activerecord/lib/active_record/test_fixtures.rb#L123-L127), which resulted in 2 transactional commits tracked by Isolator, which only expects one. That leads to false negatives.
+
+To fix this disable migrations advisory locks by adding `advisory_locks: false` to your database configuration in `(spec|test)/internal/config/database.yml`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/palkan/isolator.

data/lib/isolator/adapters/background_jobs/active_job.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 Isolator.isolate :active_job,
-                 target: ActiveJob::Base,
-                 method_name: :enqueue,
-                 exception_class: Isolator::BackgroundJobError,
-                 details_message: ->(obj, _args) {
-                   "#{obj.class.name}" \
-                   "#{obj.arguments.any? ? " (#{obj.arguments.join(', ')})" : ''}"
-                 }
+  target: ActiveJob::Base,
+  method_name: :enqueue,
+  exception_class: Isolator::BackgroundJobError,
+  details_message: ->(obj, _args) {
+    "#{obj.class.name}" \
+    "#{obj.arguments.any? ? " (#{obj.arguments.join(", ")})" : ""}"
+  }

data/lib/isolator/adapters/background_jobs/resque.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 Isolator.isolate :resque,
-                 target: Resque.singleton_class,
-                 method_name: :enqueue,
-                 exception_class: Isolator::BackgroundJobError,
-                 details_message: ->(_obj, args) {
-                   args.join(", ")
-                 }
+  target: Resque.singleton_class,
+  method_name: :enqueue,
+  exception_class: Isolator::BackgroundJobError,
+  details_message: ->(_obj, args) {
+    args.join(", ")
+  }

data/lib/isolator/adapters/background_jobs/resque_scheduler.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 Isolator.isolate :resque_scheduler,
-                 target: Resque.singleton_class,
-                 method_name: :enqueue_at,
-                 exception_class: Isolator::BackgroundJobError,
-                 details_message: ->(_obj, (ts, *args)) {
-                   "#{args.join(', ')} (at #{ts})"
-                 }
+  target: Resque.singleton_class,
+  method_name: :enqueue_at,
+  exception_class: Isolator::BackgroundJobError,
+  details_message: ->(_obj, (ts, *args)) {
+    "#{args.join(", ")} (at #{ts})"
+  }

data/lib/isolator/adapters/background_jobs/sidekiq.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 Isolator.isolate :sidekiq,
-                 target: Sidekiq::Client,
-                 method_name: :raw_push,
-                 exception_class: Isolator::BackgroundJobError,
-                 details_message: ->(_obj, args) {
-                   args.first.map do |job|
-                     "#{job['class']} (#{job['args']})"
-                   end.join("\n")
-                 }
+  target: Sidekiq::Client,
+  method_name: :raw_push,
+  exception_class: Isolator::BackgroundJobError,
+  details_message: ->(_obj, args) {
+    args.first.map do |job|
+      "#{job["class"]} (#{job["args"]})"
+    end.join("\n")
+  }

data/lib/isolator/adapters/background_jobs/sucker_punch.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 Isolator.isolate :sucker_punch,
-                 target: SuckerPunch::Queue.singleton_class,
-                 method_name: :find_or_create,
-                 exception_class: Isolator::BackgroundJobError,
-                 details_message: ->(_obj, args) {
-                   args.compact.join(", ")
-                 }
+  target: SuckerPunch::Queue.singleton_class,
+  method_name: :find_or_create,
+  exception_class: Isolator::BackgroundJobError,
+  details_message: ->(_obj, args) {
+    args.compact.join(", ")
+  }

data/lib/isolator/adapters/base.rb

@@ -31,8 +31,8 @@ module Isolator
         enabled? && Isolator.enabled? && Isolator.within_transaction? && !ignored?(*args)
       end
 
-      def ignore_if
-        ignores << Proc.new
+      def ignore_if(&block)
+        ignores << block
       end
 
       def ignores

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

@@ -10,7 +10,7 @@ Isolator.isolate :http, target: Sniffer.singleton_class,
                         exception_class: Isolator::HTTPError,
                         details_message: ->(_obj, args) {
                           req = args.first.request
-                          "#{req[:method]} #{req[:host]}/#{req[:query]}"
+                          "#{req.method} #{req.host}:#{req.port}#{req.query}"
                         }
 
 Isolator.before_isolate do

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 adapter = Isolator.isolate :webmock,
-                           exception_class: Isolator::HTTPError,
-                           details_message: ->(obj, _args) {
-                                              "#{obj.method.to_s.upcase} #{obj.uri}"
-                                            }
+  exception_class: Isolator::HTTPError,
+  details_message: ->(obj, _args) {
+                     "#{obj.method.to_s.upcase} #{obj.uri}"
+                   }
 
 WebMock.after_request do |*args|
   adapter.notify(caller, *args)

data/lib/isolator/configuration.rb

@@ -5,25 +5,31 @@ module Isolator
   #
   # - `raise_exceptions` - whether to raise an exception in case of offense;
   #   defaults to true in test env and false otherwise.
-  #   NOTE: env is infered from RACK_ENV and RAILS_ENV.
+  #   NOTE: env is inferred from RACK_ENV and RAILS_ENV.
   #
   # - `logger` - logger instance (nil by default)
   #
   # - `send_notifications` - whether to send notifications (through uniform_notifier);
-  #   defauls to false
+  #   defaults to false
+  #
+  # - `backtrace_filter` - define a custom backtrace filtering (provide a callable)
+  #
+  # - `ignorer` - define a custom ignorer (must implement .prepare)
+  #
   class Configuration
     attr_accessor :raise_exceptions, :logger, :send_notifications,
-                  :backtrace_filter
+      :backtrace_filter, :ignorer
 
     def initialize
       @logger = nil
       @raise_exceptions = test_env?
       @send_notifications = false
       @backtrace_filter = ->(backtrace) { backtrace.take(5) }
+      @ignorer = Isolator::Ignorer
     end
 
-    alias raise_exceptions? raise_exceptions
-    alias send_notifications? send_notifications
+    alias_method :raise_exceptions?, :raise_exceptions
+    alias_method :send_notifications?, :send_notifications
 
     def test_env?
       ENV["RACK_ENV"] == "test" || ENV["RAILS_ENV"] == "test"

data/lib/isolator/ignorer.rb

@@ -1,39 +1,59 @@
 # frozen_string_literal: true
 
 module Isolator
-  # Add .load_ignore_config function for ignoring patterns from file
-  module Ignorer
-    def load_ignore_config(path)
-      return unless File.exist?(path)
+  # Handle ignoring isolator errors using a yml file
+  class Ignorer
+    TODO_PATH = ".isolator_todo.yml"
 
-      todos = YAML.load_file(path)
+    class << self
+      def prepare(path: TODO_PATH, regex_string: "^.*(#ignores#):.*$")
+        return unless File.exist?(path)
 
-      adapters.each do |id, adapter|
-        ignored_paths = todos.fetch(id, [])
-        configure_adapter(adapter, ignored_paths)
+        todos = YAML.load_file(path)
+
+        Isolator.adapters.each do |id, adapter|
+          ignored_paths = todos.fetch(id, [])
+          AdapterIgnore.new(adapter: adapter, ignored_paths: ignored_paths, regex_string: regex_string).prepare
+        end
       end
     end
 
     private
 
-    def configure_adapter(adapter, ignored_paths)
-      ignores = build_ignore_list(ignored_paths)
-      return if ignores.blank?
+    class AdapterIgnore
+      def initialize(adapter:, ignored_paths:, regex_string:)
+        self.adapter = adapter
+        self.ignored_paths = ignored_paths
+        self.regex_string = regex_string
+      end
+
+      def prepare
+        return if ignores.blank?
 
-      regex = Regexp.new("^.*(#{ignores.join('|')}):.*$")
-      adapter.ignore_if { caller.any? { |row| regex =~ row } }
-    end
+        adapter.ignore_if { caller.any? { |row| regex =~ row } }
+      end
 
-    def build_ignore_list(ignored_paths)
-      ignored_paths.each_with_object([]) do |path, result|
-        ignored_files = Dir[path]
+      private
 
-        if ignored_files.blank?
-          result << path.to_s
-        else
-          result.concat(ignored_files)
+      attr_accessor :adapter, :ignored_paths, :regex_string
+
+      def ignores
+        return @ignores if defined? @ignores
+
+        @ignores = ignored_paths.each_with_object([]) do |path, result|
+          ignored_files = Dir[path]
+
+          if ignored_files.blank?
+            result << path.to_s
+          else
+            result.concat(ignored_files)
+          end
         end
       end
+
+      def regex
+        Regexp.new(regex_string.gsub("#ignores#", ignores.join("|")))
+      end
     end
   end
 end

data/lib/isolator/isolate.rb

@@ -5,7 +5,7 @@ module Isolator
   module Isolate
     def isolate(id, **options)
       raise "Adapter already registered: #{id}" if Isolator.adapters.key?(id.to_s)
-      adapter = AdapterBuilder.call(options)
+      adapter = AdapterBuilder.call(**options)
       Isolator.adapters[id.to_s] = adapter
     end
   end

data/lib/isolator/orm_adapters/active_support_subscriber.rb

@@ -9,8 +9,9 @@ module Isolator
 
     def self.subscribe!(event)
       ::ActiveSupport::Notifications.subscribe(event) do |_name, _start, _finish, _id, query|
-        Isolator.incr_transactions! if query[:sql] =~ START_PATTERN
-        Isolator.decr_transactions! if query[:sql] =~ FINISH_PATTERN
+        connection_id = query[:connection_id] || query[:connection]&.object_id || 0
+        Isolator.incr_transactions!(connection_id) if START_PATTERN.match?(query[:sql])
+        Isolator.decr_transactions!(connection_id) if FINISH_PATTERN.match?(query[:sql])
       end
     end
   end

data/lib/isolator/railtie.rb

@@ -2,12 +2,21 @@
 
 module Isolator
   class Railtie < ::Rails::Railtie # :nodoc:
+    initializer "isolator.backtrace_cleaner" do
+      ActiveSupport.on_load(:active_record) do
+        Isolator.backtrace_cleaner = lambda do |locations|
+          ::Rails.backtrace_cleaner.clean(locations)
+        end
+      end
+    end
+
     config.after_initialize do
       # Forec load adapters after application initialization
       # (when all deps are likely to be loaded).
       load File.join(__dir__, "adapters.rb")
 
-      Isolator.load_ignore_config(Rails.root.join(".isolator_todo.yml"))
+      Isolator.config.ignorer&.prepare
+      Isolator.config.ignorer&.prepare(path: ".isolator_ignore.yml")
 
       next unless Rails.env.test?
 
@@ -18,14 +27,12 @@ module Isolator
               super
               return unless run_in_transaction?
 
-              open_count = ActiveRecord::Base.connection.open_transactions
-              Isolator.transactions_threshold += open_count
+              Isolator.incr_thresholds!
             end
 
             def teardown_fixtures(*)
               if run_in_transaction?
-                open_count = ActiveRecord::Base.connection.open_transactions
-                Isolator.transactions_threshold -= open_count
+                Isolator.decr_thresholds!
               end
               super
             end

data/lib/isolator/version.rb

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

data/lib/isolator.rb

@@ -17,7 +17,25 @@ require "isolator/ext/thread_fetch"
 module Isolator
   using Isolator::ThreadFetch
 
+  class ThreadStateProxy
+    attr_reader :prefix
+
+    def initilize(prefix = "isolator_")
+      @prefix = prefix
+    end
+
+    def [](key)
+      Thread.current[:"#{prefix}#{key}"]
+    end
+
+    def []=(key, value)
+      Thread.current[:"#{prefix}#{key}"] = value
+    end
+  end
+
   class << self
+    attr_accessor :default_threshold, :default_connection_id
+
     def config
       @config ||= Configuration.new
     end
@@ -31,11 +49,11 @@ module Isolator
     end
 
     def enable!
-      Thread.current[:isolator_disabled] = false
+      state[:disabled] = false
     end
 
     def disable!
-      Thread.current[:isolator_disabled] = true
+      state[:disabled] = true
     end
 
     # Accepts block and disable Isolator within
@@ -64,32 +82,84 @@ module Isolator
       res
     end
 
-    def transactions_threshold
-      Thread.current.fetch(:isolator_threshold, 1)
+    def transactions_threshold=(val)
+      set_connection_threshold(val)
     end
 
-    def transactions_threshold=(val)
-      Thread.current[:isolator_threshold] = val
+    def transactions_threshold(connection_id = default_connection_id.call)
+      connection_threshold(connection_id)
     end
 
-    def incr_transactions!
-      Thread.current[:isolator_transactions] =
-        Thread.current.fetch(:isolator_transactions, 0) + 1
-      start! if Thread.current.fetch(:isolator_transactions) == transactions_threshold
+    def current_transactions(connection_id = default_connection_id.call)
+      state[:transactions]&.[](connection_id) || 0
+    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
+
+      debug!("Threshold value was changed for connection #{connection_id}: #{val}")
+    end
+
+    def incr_thresholds!
+      self.default_threshold += 1
+      return unless state[:thresholds]
+
+      state[:thresholds].transform_values!(&:succ)
+
+      debug!("Thresholds were incremented")
+    end
+
+    def decr_thresholds!
+      self.default_threshold -= 1
+      return unless state[:thresholds]
+
+      state[:thresholds].transform_values!(&:pred)
+
+      debug!("Thresholds were decremented")
+    end
+
+    def incr_transactions!(connection_id = default_connection_id.call)
+      state[:transactions] ||= Hash.new { |h, k| h[k] = 0 }
+      state[:transactions][connection_id] += 1
+
+      # Workaround to track threshold changes made before opening a connection
+      pending_threshold = state[:thresholds]&.delete(0)
+      if pending_threshold
+        state[:thresholds][connection_id] = pending_threshold
+      end
+
+      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)
     end
 
-    def decr_transactions!
-      Thread.current[:isolator_transactions] =
-        Thread.current.fetch(:isolator_transactions) - 1
-      finish! if Thread.current.fetch(:isolator_transactions) == (transactions_threshold - 1)
+    def decr_transactions!(connection_id = default_connection_id.call)
+      current = state[:transactions]&.[](connection_id) || 0
+
+      if current <= 0
+        warn "Trying to finalize an untracked transaction"
+        return
+      end
+
+      state[:transactions][connection_id] -= 1
+
+      finish! if current_transactions(connection_id) == (connection_threshold(connection_id) - 1)
+
+      state[:transactions].delete(connection_id) if state[:transactions][connection_id].zero?
+
+      debug!("Transaction closed for connection #{connection_id} (total: #{state[:transactions][connection_id]}, threshold: #{state[:thresholds]&.[](connection_id) || default_threshold})")
     end
 
     def clear_transactions!
-      Thread.current[:isolator_transactions] = 0
+      state[:transactions]&.clear
     end
 
     def within_transaction?
-      Thread.current.fetch(:isolator_transactions, 0) >= transactions_threshold
+      state[:transactions]&.each do |connection_id, transaction_count|
+        return true if transaction_count >= connection_threshold(connection_id)
+      end
+      false
     end
 
     def enabled?
@@ -97,17 +167,61 @@ module Isolator
     end
 
     def disabled?
-      Thread.current[:isolator_disabled] == true
+      state[:disabled] == true
     end
 
     def adapters
       @adapters ||= Isolator::SimpleHashie.new
     end
 
+    def load_ignore_config(path)
+      warn "[DEPRECATION] `load_ignore_config` is deprecated. Please use `Isolator::Ignorer.prepare` instead."
+      Isolator::Ignorer.prepare(path: path)
+    end
+
     include Isolator::Isolate
     include Isolator::Callbacks
-    include Isolator::Ignorer
+
+    attr_accessor :debug_enabled, :backtrace_cleaner, :backtrace_length
+
+    private
+
+    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)
+
+        msg = "#{msg}\n  ↳ #{source.join("\n")}" unless source.empty?
+      end
+
+      $stdout.puts(colorize_debug(msg))
+    end
+
+    def extract_source_location(locations)
+      backtrace_cleaner.call(locations.lazy)
+        .take(backtrace_length).to_a
+    end
+
+    def colorize_debug(msg)
+      return msg unless $stdout.tty?
+
+      "\u001b[31;1m#{msg}\u001b[0m"
+    end
   end
+
+  self.state = ThreadStateProxy.new
+  self.default_threshold = 1
+  self.default_connection_id = -> { ActiveRecord::Base.connected? ? ActiveRecord::Base.connection.object_id : 0 }
+  self.debug_enabled = ENV["ISOLATOR_DEBUG"] == "true"
+  self.backtrace_length = ENV.fetch("ISOLATOR_BACKTRACE_LENGTH", 1).to_i
 end
 
 require "isolator/orm_adapters"

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-13 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.1
 - !ruby/object:Gem::Dependency
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +70,14 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -95,77 +95,77 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.10.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-md
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: test_after_commit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: test_after_commit
+  name: fakeredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: resque
+  name: resque-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeredis
+  name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: resque-scheduler
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sucker_punch
+  name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +221,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: after_commit_everywhere
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uniform_notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -241,22 +283,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- gemfiles/activerecord42.gemfile
-- gemfiles/jruby.gemfile
-- gemfiles/rails6.gemfile
-- gemfiles/railsmaster.gemfile
-- gemfiles/ruby_2.2.2.gemfile
-- isolator.gemspec
 - lib/isolator.rb
 - lib/isolator/adapter_builder.rb
 - lib/isolator/adapters.rb
@@ -291,8 +320,13 @@ files:
 homepage: https://github.com/palkan/isolator
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: http://github.com/palkan/isolator/issues
+  changelog_uri: https://github.com/palkan/isolator/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/palkan/isolator
+  homepage_uri: http://github.com/palkan/isolator
+  source_code_uri: http://github.com/palkan/isolator
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -300,15 +334,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Detect non-atomic interactions within DB transactions
 test_files: []

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.gem
-gemfiles/*.lock
-Gemfile.local
-.rspec_status

data/.rubocop.yml

@@ -1,70 +0,0 @@
-require:
-  - rubocop-md
-
-AllCops:
-  Include:
-    - 'lib/**/*.rb'
-    - 'lib/**/*.rake'
-    - 'spec/**/*.rb'
-  Exclude:
-    - 'bin/**/*'
-    - 'gemfiles/**/*'
-    - 'spec/dummy/**/*'
-    - 'vendor/**/*'
-    - 'tmp/**/*'
-    - 'Rakefile'
-    - 'Gemfile'
-    - '*.gemspec'
-  DisplayCopNames: true
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.2.2
-
-Rails:
-  Enabled: false
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Style/NumericPredicate:
-  Enabled: false
-
-Layout/SpaceInsideStringInterpolation:
-  EnforcedStyle: no_space
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 100
-  Exclude:
-    - 'spec/**/*.rb'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Style/MutableConstant:
-  Enabled: false

data/.travis.yml

@@ -1,35 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-
-notifications:
-  email: false
-
-before_install:
-  - (ruby -v | grep '2.2.2') || gem update --system
-  - gem install bundler -v '< 2'
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: jruby-9.1.0.0
-      gemfile: gemfiles/jruby.gemfile
-    - rvm: 2.6.1
-      gemfile: gemfiles/rails6.gemfile
-    - rvm: 2.5.0
-      gemfile: Gemfile
-    - rvm: 2.4.3
-      gemfile: Gemfile
-    - rvm: 2.3.1
-      gemfile: gemfiles/activerecord42.gemfile
-    - rvm: 2.2.2
-      gemfile: gemfiles/ruby_2.2.2.gemfile
-  allow_failures:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: jruby-9.1.0.0
-      gemfile: gemfiles/jruby.gemfile

data/Gemfile

@@ -1,20 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in isolator.gemspec
-gemspec
-
-gem "pry-byebug"
-
-gem "sqlite3", "~> 1.3.0"
-
-local_gemfile = File.join(__dir__, "Gemfile.local")
-
-if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
-else
-  gem "rails", "~> 5.0"
-end
-
-gem 'uniform_notifier', '~> 1.11'

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
-
-task default: [:rubocop, :spec]

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "isolator"
-
-require "pry"
-Pry.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/gemfiles/activerecord42.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", "~> 4.2"
-gem "sqlite3", "~> 1.3.0"
-gem 'uniform_notifier', '~> 1.11'
-
-gemspec path: ".."

data/gemfiles/jruby.gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gem "activerecord-jdbcsqlite3-adapter", "~> 50.0"
-gem "jdbc-sqlite3"
-gem "rails", "~> 5.0"
-gem 'uniform_notifier', '~> 1.11'
-
-gemspec path: ".."

data/gemfiles/rails6.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", "6.0.0.beta3"
-gem "sqlite3", "~> 1.3"
-gem 'uniform_notifier', '~> 1.11'
-
-gemspec path: ".."

data/gemfiles/railsmaster.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", github: "rails/rails"
-gem "sqlite3"
-gem 'uniform_notifier', '~> 1.11'
-
-gemspec path: ".."

data/gemfiles/ruby_2.2.2.gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", "~> 4.2"
-gem "sqlite3", "~> 1.3.0"
-gem 'uniform_notifier', '1.11'
-gem 'anyway_config', '1.2'
-
-gemspec path: ".."

data/isolator.gemspec

@@ -1,41 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "isolator/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "isolator"
-  spec.version       = Isolator::VERSION
-  spec.authors       = ["Vladimir Dementyev"]
-  spec.email         = ["dementiev.vm@gmail.com"]
-
-  spec.summary       = "Detect non-atomic interactions within DB transactions"
-  spec.description   = "Detect non-atomic interactions within DB transactions"
-  spec.homepage      = "https://github.com/palkan/isolator"
-  spec.license       = "MIT"
-
-  spec.required_ruby_version = ">= 2.2.2"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "sniffer", "~> 0.3.1"
-
-  spec.add_development_dependency "bundler", ">= 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "minitest", "~> 5.10.0"
-  spec.add_development_dependency "rubocop", "~> 0.56.0"
-  spec.add_development_dependency "rubocop-md", "~> 0.2"
-
-  spec.add_development_dependency "sidekiq", "~> 5.0"
-  spec.add_development_dependency "webmock", "~> 3.1"
-  spec.add_development_dependency "test_after_commit", "~> 1.1"
-  spec.add_development_dependency "resque"
-  spec.add_development_dependency "fakeredis"
-  spec.add_development_dependency "resque-scheduler"
-  spec.add_development_dependency "sucker_punch"
-  spec.add_development_dependency "database_cleaner"
-end