isolator 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00d85d8a62a5a34bd39ef9295e1e8ad9c13599fc17648bbda7a5012f9a89ddfa
-  data.tar.gz: cf7a441154f63bc40258b4a78e57e3d3f46158b915167c1631d717530571dcd2
+  metadata.gz: 529433e0e838e663f335a5fb493f51d10f16fbde2168c89be72e92c968709593
+  data.tar.gz: ef33db058e25204e615fae7ee945c738e516e8ae6d63bb93f9660e6e117cb632
 SHA512:
-  metadata.gz: a088b0f2e24c8afd8a2ec3fd65df4ef5e2d550f55c8376132955db8f870f68a28f021b8079024b413ef2692a474136f3d7da56c098a89d2e3b3aa52deb0ce334
-  data.tar.gz: d3667e26d54697e09eaefd7cdee7e9c5586e307c371ce41215d8eca88dc514c652079088bba2af3aeb654b9bfbdad3a3ab6080c5f20b47867291cf4734f16cda
+  metadata.gz: 5cb63aa9a96f5931425267193590550cac0614dd15d272bd7d33f7e2aeaad0b7b37a19f5a6f7d8617dce992e946b92c42c3df5829177cbd51b41d8919abdc8c5
+  data.tar.gz: b4997855a9d813a961491235097a42eee75d55598fb7d33d53bb4f7e3828f486ea0a2fb788edd028237e39518a2d8e962824b08a3f4cbed2ce3ac22acdfee9c3

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master
 
+## 0.9.0 (2023-05-18)
+
+- Support keyword arguments to isolated method in Ruby 3.0. ([@Mange][])
+- Raise an error when an ignore file does not parse to a hash. ([@bobbymcwho][])
+- Log all filtered backtrace lines to the logger ([@bobbymcwho][])
+- Add support for removing dynamic adapters. ([@Mange][])
+- Allow aliases in .isolator_todo.yml and .isolator_ignore.yml ([@tomgi][])
+
+## 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][])
@@ -93,3 +107,5 @@ This, for example, makes Isolator compatible with Rails multi-database apps.
 [@shivanshgaur]: https://github.com/shivanshgaur
 [@iiwo]: https://github.com/iiwo
 [@mquan]: https://github.com/mquan
+[@bobbymcwho]: https://github.com/bobbymcwho
+[@Mange]: https://github.com/Mange

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2020 Vladimir Dementyev
+Copyright (c) 2018-2023 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

@@ -104,24 +104,24 @@ Isolator.configure do |config|
 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).
 
 ### Transactional tests support
 
- - Rails' baked-in [use_transactional_tests](api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html#class-ActiveRecord::FixtureSet-label-Transactional+Tests)
+ - Rails' baked-in [use_transactional_tests](https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html#class-ActiveRecord::FixtureSet-label-Transactional+Tests)
  - [database_cleaner](https://github.com/DatabaseCleaner/database_cleaner) gem. Make sure that you require isolator _after_ database_cleaner.
 
 ### Supported ORMs
 
-- `ActiveRecord` >= 4.1
+- `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`
@@ -159,9 +159,32 @@ 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.
+
+If you're using Rails and want to use isolator in development and staging, then here is a way to do this.
+
+```ruby
+
+# Gemfile
+gem "isolator", require: false # so it delays loading till after sidekiq/testing
+
+# config/initializers/isolator.rb
+require "sidekiq/testing" if Rails.env.test?
+
+unless Rails.env.production? # so we get it in staging too
+  require "isolator"
+  Isolator.configure do |config|
+    config.send_notifications = true # ...
+  end
+end
+```
+
 ### 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:
@@ -169,8 +192,20 @@ sidekiq:
   - app/models/sales/**/*.rb
 ```
 
+You can ignore the same files in multiple adapters using YML aliases in the following way:
+
+```
+http_common: &http_common
+  - app/models/user.rb:20
+
+http: *http_common
+webmock: *http_common
+```
+
 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::Ignorer.prepare(path:)`, for instance `Isolator::Ignorer.prepare(path: "./config/.isolator_todo.yml")`
@@ -196,16 +231,43 @@ 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) {
+  details_message: ->(obj) {
     "#{obj.class.name}(#{obj.arguments})"
   }
+
+Isolator.isolate :promoter,
+  target: UserPromoter,
+  method_name: :call,
+  details_message: ->(obj_, args, kwargs) {
+    # UserPromoter.call(user, role, by: nil)
+    user, role = args
+    by = kwargs[:by]
+    "#{user.name} promoted to #{role} by #{by&.name || "system"})"
+  }
+```
+
+Trying to register the same adapter name twice will raise an error. You can guard for it, or remove old adapters before in order to replace them.
+
+```ruby
+unless Isolator.has_adapter?(:promoter)
+  Isolator.isolate(:promoter, *rest)
+end
+```
+
+```ruby
+# Handle code reloading
+class Messager
+end
+
+Isolator.remove_adapter(:messager)
+Isolator.isolate(:messager, target: Messager, **rest)
 ```
 
 You can also add some callbacks to be run before and after the transaction:

data/lib/isolator/adapter_builder.rb

@@ -5,29 +5,39 @@ require "isolator/adapters/base"
 module Isolator
   # Builds adapter from provided params
   module AdapterBuilder
-    def self.call(target: nil, method_name: nil, **options)
-      adapter = Module.new do
-        extend Isolator::Adapters::Base
+    class << self
+      def call(target: nil, method_name: nil, **options)
+        adapter = Module.new do
+          extend Isolator::Adapters::Base
 
-        self.exception_class = options[:exception_class] if options.key?(:exception_class)
-        self.exception_message = options[:exception_message] if options.key?(:exception_message)
-        self.details_message = options[:details_message] if options.key?(:details_message)
+          self.exception_class = options[:exception_class] if options.key?(:exception_class)
+          self.exception_message = options[:exception_message] if options.key?(:exception_message)
+          self.details_message = options[:details_message] if options.key?(:details_message)
+        end
+
+        mod = build_mod(method_name, adapter)
+        if target && mod
+          target.prepend(mod)
+          adapter.define_singleton_method(:restore) do
+            mod.remove_method(method_name)
+          end
+        end
+
+        adapter
       end
 
-      add_patch_method(adapter, target, method_name) if
-        target && method_name
-      adapter
-    end
+      private
+
+      def build_mod(method_name, adapter)
+        return nil unless method_name
 
-    def self.add_patch_method(adapter, base, method_name)
-      mod = Module.new do
-        define_method method_name do |*args, &block|
-          adapter.notify(caller, self, *args)
-          super(*args, &block)
+        Module.new do
+          define_method method_name do |*args, **kwargs, &block|
+            adapter.notify(caller, self, *args, **kwargs)
+            super(*args, **kwargs, &block)
+          end
         end
       end
-
-      base.prepend mod
     end
   end
 end

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

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

data/lib/isolator/adapters/base.rb

@@ -22,13 +22,13 @@ module Isolator
         @disabled == true
       end
 
-      def notify(backtrace, obj, *args)
-        return unless notify?(*args)
-        Isolator.notify(exception: build_exception(obj, args), backtrace: backtrace)
+      def notify(backtrace, obj, *args, **kwargs)
+        return unless notify?(*args, **kwargs)
+        Isolator.notify(exception: build_exception(obj, args, kwargs), backtrace: backtrace)
       end
 
-      def notify?(*args)
-        enabled? && Isolator.enabled? && Isolator.within_transaction? && !ignored?(*args)
+      def notify?(*args, **kwargs)
+        enabled? && Isolator.enabled? && Isolator.within_transaction? && !ignored?(*args, **kwargs)
       end
 
       def ignore_if(&block)
@@ -39,17 +39,36 @@ module Isolator
         @ignores ||= []
       end
 
-      def ignored?(*args)
-        ignores.any? { |block| block.call(*args) }
+      def ignored?(*args, **kwargs)
+        ignores.any? { |block| block.call(*args, **kwargs) }
       end
 
       private
 
-      def build_exception(obj, args)
+      def build_exception(obj, args, kwargs = {})
         klass = exception_class || Isolator::UnsafeOperationError
-        details = details_message.call(obj, args) if details_message
+        details = build_details(obj, args, kwargs)
         klass.new(exception_message, details: details)
       end
+
+      def build_details(obj, args, kwargs)
+        return nil unless details_message
+
+        case details_message.arity
+        when 2, -2
+          # Older users of details_message expected only two arguments. Add
+          # kwargs hash as last argument, like in older Ruby.
+          details_message.call(obj, args + [kwargs])
+        when 3, -3
+          # New signature separates args from kwargs
+          details_message.call(obj, args, kwargs)
+        when 1
+          # Callback does not care about any args
+          details_message.call(obj)
+        else
+          raise "Unexpected arity (#{details_message.arity}) for #{details_message.inspect}"
+        end
+      end
     end
   end
 end

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

@@ -2,7 +2,7 @@
 
 adapter = Isolator.isolate :webmock,
   exception_class: Isolator::HTTPError,
-  details_message: ->(obj, _args) {
+  details_message: ->(obj) {
                      "#{obj.method.to_s.upcase} #{obj.uri}"
                    }
 

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

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

data/lib/isolator/configuration.rb

@@ -28,8 +28,8 @@ module Isolator
       @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

@@ -3,16 +3,31 @@
 module Isolator
   # Handle ignoring isolator errors using a yml file
   class Ignorer
-    TODO_PATH = ".isolator_todo.yml"
+    class ParseError < StandardError
+      def initialize(file_path, klass)
+        @file_path = file_path
+        @klass = klass
+      end
+
+      def message
+        "Unable to parse ignore config file #{@file_path}. Expected Hash, got #{@klass}."
+      end
+    end
 
     class << self
-      def prepare(path: TODO_PATH, regex_string: "^.*(#ignores#):.*$")
+      def prepare(path:, regex_string: "^.*(#ignores#):.*$")
         return unless File.exist?(path)
 
-        todos = YAML.load_file(path)
+        ignores = begin
+          YAML.load_file(path, aliases: true)
+        rescue ArgumentError # support for older rubies https://github.com/rails/rails/commit/179d0a1f474ada02e0030ac3bd062fc653765dbe
+          YAML.load_file(path)
+        end
+
+        raise ParseError.new(path, ignores.class) unless ignores.respond_to?(:fetch)
 
         Isolator.adapters.each do |id, adapter|
-          ignored_paths = todos.fetch(id, [])
+          ignored_paths = ignores.fetch(id, [])
           AdapterIgnore.new(adapter: adapter, ignored_paths: ignored_paths, regex_string: regex_string).prepare
         end
       end

data/lib/isolator/isolate.rb

@@ -4,9 +4,15 @@ module Isolator
   # Add .isolate function to build and register adapters
   module Isolate
     def isolate(id, **options)
-      raise "Adapter already registered: #{id}" if Isolator.adapters.key?(id.to_s)
+      raise "Adapter already registered: #{id}" if Isolator.has_adapter?(id)
       adapter = AdapterBuilder.call(**options)
       Isolator.adapters[id.to_s] = adapter
     end
+
+    def remove_adapter(id)
+      if (adapter = Isolator.adapters.delete(id.to_s))
+        adapter.restore if adapter.respond_to?(:restore)
+      end
+    end
   end
 end

data/lib/isolator/notifier.rb

@@ -29,12 +29,12 @@ module Isolator
     def log_exception
       return unless Isolator.config.logger
 
-      offense_line = filtered_backtrace.first
-
       msg = "[ISOLATOR EXCEPTION]\n" \
             "#{exception.message}"
 
-      msg += "\n  ↳ #{offense_line}" if offense_line
+      filtered_backtrace.each do |offense_line|
+        msg += "\n  ↳ #{offense_line}"
+      end
 
       Isolator.config.logger.warn(msg)
     end

data/lib/isolator/railtie.rb

@@ -15,7 +15,19 @@ module Isolator
       # (when all deps are likely to be loaded).
       load File.join(__dir__, "adapters.rb")
 
-      Isolator.config.ignorer&.prepare
+      # Try to load Rails base classes to trigger their load hooks
+      begin
+        ::ActionMailer::Base
+      rescue NameError
+      end
+
+      begin
+        ::ActiveJob::Base
+      rescue NameError
+      end
+
+      Isolator.config.ignorer&.prepare(path: ".isolator_todo.yml")
+      Isolator.config.ignorer&.prepare(path: ".isolator_ignore.yml")
 
       next unless Rails.env.test?
 

data/lib/isolator/version.rb

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

data/lib/isolator.rb

@@ -135,6 +135,13 @@ module Isolator
     end
 
     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)
@@ -167,6 +174,10 @@ module Isolator
       @adapters ||= Isolator::SimpleHashie.new
     end
 
+    def has_adapter?(id)
+      adapters.key?(id.to_s)
+    end
+
     def load_ignore_config(path)
       warn "[DEPRECATION] `load_ignore_config` is deprecated. Please use `Isolator::Ignorer.prepare` instead."
       Isolator::Ignorer.prepare(path: path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +248,34 @@ dependencies:
     - - ">="
       - !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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Detect non-atomic interactions within DB transactions
 email:
 - dementiev.vm@gmail.com
@@ -298,7 +326,8 @@ metadata:
   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: 
+  funding_uri: https://github.com/sponsors/palkan
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -306,15 +335,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.8
+signing_key:
 specification_version: 4
 summary: Detect non-atomic interactions within DB transactions
 test_files: []