isolator 0.1.0.pre2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d70c61a526af789744667a5ef87f3b396e261102c414f004c874278a3a7af7cd
-  data.tar.gz: 75432a1b9d3ad708269b55cfb675168abb8b2b83efabcb19a709f7da19ade6a8
+  metadata.gz: a15f425ab4ff004a59412c6c5f74da93ac998f90c50d5131ed244baa3b631174
+  data.tar.gz: 511c6210a02513d4c922dc7b00b89ea887be9601b9cf2892b913fc59e81ff74a
 SHA512:
-  metadata.gz: 77d6b9bd87e603fd10415e234421ec60852228e50217f2ed37dac5aa837500fbfc6febaaa2aa8442375f6ca52a4e68474eb9d381ea99d19222ae1810eff03efa
-  data.tar.gz: '0782abd5aede38aee2f303738629cc0c4fd4487163555691ad37622f673aa57b99b12ea1112bb609ab10225cf0e027237dac12c60bc213d6fcfbd46076c4f624'
+  metadata.gz: d6f2b7ca96011162f5436593bb42b60da26d720cfef028c7edee29abc703fb31a67d69d270c276a7c156265fb00e6f828b752f6957bec54f72440fafd762348d
+  data.tar.gz: c4ee00bd87e118a2d7c66ae90854f5cd3fc39a448cb30bb1a49aabd2eb11a75dc1579b47d9f95a11ccaabf37cc341a39b45906cd45d77d31159c5329d9e146af

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## 0.1.0 (2018-02-19)
+
+- Add `test_after_commit` patch. ([@palkan][])
+
+- [PR [#7](https://github.com/palkan/isolator/pull/7)] Add WebMock adapter. ([@palkan][])
+
+- Add `ignore_if` modifier to adapter. ([@palkan][])
+
 - [PR [#5](https://github.com/palkan/isolator/pull/5)] Add `mail` adapter. ([@alexshgov][])
 
 - Initial version. ([@palkan][], [@TheSmartnik][], [@alexshgov][])

data/README.md

@@ -109,6 +109,7 @@ Isolator has a bunch of built-in adapters:
 - `:active_job`
 - `:sidekiq`
 - `:mailer`
+- `:webmock` – track mocked HTTP requests (unseen by Sniffer) in tests
 
 You can dynamically enable/disable adapters, e.g.:
 
@@ -121,6 +122,20 @@ Isolator.adapters.http.disable!
 Isolator.adapters.http.enable!
 ```
 
+### Ignore Offenses
+
+Since Isolator adapter is just a wrapper over original code, it may lead to false positives when there is another library patching the same behaviour. In that case you might want to ignore some offenses.
+
+Consider an example: we use Sidekiq along with [`sidekiq-postpone`](https://github.com/marshall-lee/sidekiq-postpone)–gem that patches `Sidekiq::Client#raw_push` and allows you to postpone jobs enqueueing (e.g. to enqueue everything when a transaction is commited–we don't want to raise exceptions in such situation).
+
+To ignore offenses when `sidekiq-postpone` is active, you can add an ignore `proc`:
+
+```ruby
+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.
+
 ## Custom Adapters
 
 An adapter is just a combination of a _method wrapper_ and lifecycle hooks.

data/isolator.gemspec

@@ -32,4 +32,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "uniform_notifier", "~> 1.11"
   spec.add_development_dependency "sidekiq", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.1"
+  spec.add_development_dependency "test_after_commit", "~> 1.1"
 end

data/lib/isolator.rb

@@ -37,6 +37,32 @@ module Isolator
       Thread.current[:isolator_disabled] = true
     end
 
+    # Accepts block and disable Isolator within
+    def disable
+      return yield if disabled?
+      res = nil
+      begin
+        disable!
+        res = yield
+      ensure
+        enable!
+      end
+      res
+    end
+
+    # Accepts block and enable Isolator within
+    def enable
+      return yield if enabled?
+      res = nil
+      begin
+        enable!
+        res = yield
+      ensure
+        disable!
+      end
+      res
+    end
+
     def transactions_threshold
       Thread.current.fetch(:isolator_threshold)
     end
@@ -46,14 +72,12 @@ module Isolator
     end
 
     def incr_transactions!
-      return unless enabled?
       Thread.current[:isolator_transactions] =
         Thread.current.fetch(:isolator_transactions, 0) + 1
       start! if Thread.current.fetch(:isolator_transactions) == transactions_threshold
     end
 
     def decr_transactions!
-      return unless enabled?
       Thread.current[:isolator_transactions] =
         Thread.current.fetch(:isolator_transactions) - 1
       finish! if Thread.current.fetch(:isolator_transactions) == (transactions_threshold - 1)
@@ -68,7 +92,11 @@ module Isolator
     end
 
     def enabled?
-      Thread.current[:isolator_disabled] != true
+      !disabled?
+    end
+
+    def disabled?
+      Thread.current[:isolator_disabled] == true
     end
 
     def adapters
@@ -84,10 +112,5 @@ end
 
 require "isolator/orm_adapters"
 
-# Load adapters after application initialization
-# (when all deps are likely loaded).
-if defined?(Rails)
-  require "isolator/railtie"
-else
-  require "isolator/adapters"
-end
+require "isolator/adapters"
+require "isolator/railtie" if defined?(Rails)

data/lib/isolator/adapter_builder.rb

@@ -5,7 +5,7 @@ require "isolator/adapters/base"
 module Isolator
   # Builds adapter from provided params
   module AdapterBuilder
-    def self.call(target, method_name, **options)
+    def self.call(target: nil, method_name: nil, **options)
       adapter = Module.new do
         extend Isolator::Adapters::Base
 
@@ -13,14 +13,15 @@ module Isolator
         self.exception_message = options[:exception_message] if options.key?(:exception_message)
       end
 
-      add_patch_method adapter, target, method_name
+      add_patch_method(adapter, target, method_name) if
+        target && method_name
       adapter
     end
 
     def self.add_patch_method(adapter, base, method_name)
       mod = Module.new do
         define_method method_name do |*args, &block|
-          adapter.notify(caller) if adapter.notify_isolator?
+          adapter.notify(caller, *args)
           super(*args, &block)
         end
       end

data/lib/isolator/adapters.rb

@@ -3,3 +3,4 @@
 require "isolator/adapters/http"
 require "isolator/adapters/background_jobs"
 require "isolator/adapters/mailers"
+require "isolator/adapters/after_commit" if defined?(::TestAfterCommit)

data/lib/isolator/adapters/after_commit.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(Module.new do
+  def test_commit_records
+    ::Isolator.disable { super }
+  end
+end)

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

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
-Isolator.isolate :active_job, ActiveJob::Base,
-                 :enqueue, exception_class: Isolator::BackgroundJobError
+Isolator.isolate :active_job,
+                 target: ActiveJob::Base,
+                 method_name: :enqueue,
+                 exception_class: Isolator::BackgroundJobError

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

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
-Isolator.isolate :sidekiq, Sidekiq::Client,
-                 :push, exception_class: Isolator::BackgroundJobError
+Isolator.isolate :sidekiq,
+                 target: Sidekiq::Client,
+                 method_name: :raw_push,
+                 exception_class: Isolator::BackgroundJobError

data/lib/isolator/adapters/base.rb

@@ -15,17 +15,36 @@ module Isolator
       end
 
       def enabled?
-        @disabled != true
+        !disabled?
       end
 
-      def notify(backtrace)
+      def disabled?
+        @disabled == true
+      end
+
+      def notify(backtrace, *args)
+        return unless notify?(*args)
         Isolator.notify(exception: build_exception, backtrace: backtrace)
       end
 
-      def notify_isolator?
-        enabled? && Isolator.within_transaction?
+      def notify?(*args)
+        enabled? && Isolator.enabled? && Isolator.within_transaction? && !ignored?(*args)
       end
 
+      def ignore_if
+        ignores << Proc.new
+      end
+
+      def ignores
+        @ignores ||= []
+      end
+
+      def ignored?(*args)
+        ignores.any? { |block| block.call(*args) }
+      end
+
+      private
+
       def build_exception
         klass = exception_class || Isolator::UnsafeOperationError
         klass.new(exception_message)

data/lib/isolator/adapters/http.rb

@@ -1,20 +1,5 @@
 # frozen_string_literal: true
 
-require "sniffer"
+require "isolator/adapters/http/sniffer"
 
-Sniffer.config do |c|
-  # Disable Sniffer logger
-  c.logger = Logger.new(IO::NULL)
-end
-
-Isolator.isolate :http, Sniffer.singleton_class,
-                 :store, exception_class: Isolator::HTTPError
-
-Isolator.before_isolate do
-  Sniffer.enable!
-end
-
-Isolator.after_isolate do
-  Sniffer.clear!
-  Sniffer.disable!
-end
+require "isolator/adapters/http/webmock" if defined?(::WebMock)

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "sniffer"
+
+# Disable Sniffer logger
+Sniffer::Config.defaults["logger"] = Logger.new(IO::NULL)
+
+Isolator.isolate :http, target: Sniffer.singleton_class,
+                        method_name: :store,
+                        exception_class: Isolator::HTTPError
+
+Isolator.before_isolate do
+  next if Isolator.adapters.http.disabled?
+  Sniffer.enable!
+end
+
+Isolator.after_isolate do
+  next if Isolator.adapters.http.disabled?
+  Sniffer.clear!
+  Sniffer.disable!
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+adapter = Isolator.isolate :webmock, exception_class: Isolator::HTTPError
+
+WebMock.after_request do |*args|
+  adapter.notify(caller, *args)
+end

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

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-Isolator.isolate :mailer, Mail::Message, :deliver,
-                 exception_class: Isolator::MailerError
+Isolator.isolate :mailer, target: Mail::Message, method_name: :deliver,
+                          exception_class: Isolator::MailerError

data/lib/isolator/callbacks.rb

@@ -12,10 +12,12 @@ module Isolator
     end
 
     def start!
+      return if Isolator.disabled?
       before_isolate_callbacks.each(&:call)
     end
 
     def finish!
+      return if Isolator.disabled?
       after_isolate_callbacks.each(&:call)
     end
 

data/lib/isolator/isolate.rb

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

data/lib/isolator/notifier.rb

@@ -28,11 +28,15 @@ module Isolator
 
     def log_exception
       return unless Isolator.config.logger
-      Isolator.config.logger.warn(
-        "[ISOLATOR EXCEPTION]\n" \
-        "#{exception.message}\n" \
-        "  ↳ #{filtered_backtrace.first}"
-      )
+
+      offense_line = filtered_backtrace.first
+
+      msg = "[ISOLATOR EXCEPTION]\n" \
+            "#{exception.message}"
+
+      msg += "\n  ↳ #{offense_line}" if offense_line
+
+      Isolator.config.logger.warn(msg)
     end
 
     def send_notifications
@@ -44,7 +48,7 @@ module Isolator
     end
 
     def filtered_backtrace
-      backtrace.reject { |line| line =~ /gems/ }.take_while { |line| line !~ /ruby/ }
+      backtrace.reject { |line| line =~ /\/(gems|ruby)/ }.take_while { |line| line !~ /ruby/ }
     end
 
     def uniform_notifier_loaded?

data/lib/isolator/railtie.rb

@@ -3,8 +3,9 @@
 module Isolator
   class Railtie < ::Rails::Railtie # :nodoc:
     config.after_initialize do
-      # Load adapters
-      require "isolator/adapters"
+      # Forec load adapters after application initialization
+      # (when all deps are likely to be loaded).
+      load File.join(__dir__, "adapters.rb")
 
       next unless Rails.env.test?
 

data/lib/isolator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Isolator
-  VERSION = "0.1.0.pre2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre2
+  version: 0.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-18 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -150,6 +150,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: test_after_commit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Detect non-atomic interactions within DB transactions
 email:
 - dementiev.vm@gmail.com
@@ -174,11 +202,14 @@ files:
 - lib/isolator.rb
 - lib/isolator/adapter_builder.rb
 - lib/isolator/adapters.rb
+- lib/isolator/adapters/after_commit.rb
 - lib/isolator/adapters/background_jobs.rb
 - lib/isolator/adapters/background_jobs/active_job.rb
 - lib/isolator/adapters/background_jobs/sidekiq.rb
 - lib/isolator/adapters/base.rb
 - lib/isolator/adapters/http.rb
+- lib/isolator/adapters/http/sniffer.rb
+- lib/isolator/adapters/http/webmock.rb
 - lib/isolator/adapters/mailers.rb
 - lib/isolator/adapters/mailers/mail.rb
 - lib/isolator/callbacks.rb
@@ -209,9 +240,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.4