isolator 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a0299bddb8abe783af8113fcd57b0e9926a1e6f714d29a6ed258b876c9c7062
-  data.tar.gz: 06551a9aab8237dccf214eae3cf841d96f15c61c4e26b4f623979711ba5e8ddc
+  metadata.gz: 0c72b8d090e9f2d9f0aa40981298f62bb562d5a1064868f771c2e5cd8af029bc
+  data.tar.gz: 7aef3385898b9db409b4251becfc85f3bb7004d411be4240d8126bb9d9c4d5b7
 SHA512:
-  metadata.gz: 1ad13d02cca26c6e0ae19e24be82e8bd08f53904c8adbb134ce0f4dc9faa7375c681c3fa62532d8284f104a97b3f51858e2e5f87c02b089108564e0064b3c5c4
-  data.tar.gz: 3b02cb4f11b42f6ccfbae0717cf53d5661bc92e211a99bff80b17b4c82fca6cb37b7c905ae98e74b2370c99b7d7f83e1194966b9194c11319cc5473c2ee29ce4
+  metadata.gz: eaeff564dc8bb7288b3249325144c60096e35066b994b8ebb7365d8ee949a5b44b47d276eedbcb8580c0d460fa5c46a9d1529e002c0904f04452e96bb02069fc
+  data.tar.gz: 6d068fab30b04a15e58afddc1ee23a2a0492051b0d3b9d20784da421aced0d2e1aa548b3ea74b4d9e395c84ff275660baf8ab0fd6825f9f8e9b9c947220b7be3

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## 1.1.0 (2024-08-12)
+
+- Add support for `ActiveJob::Base.enqueue_after_transaction_commit`. ([@joshuay03][])
+
+- Add `ignore_on: (obj) -> bool` option for adapters. ([@palkan][])
+
+- Add ActionCable adapter. ([@arthurWD][])
+
 ## 1.0.1 (2023-12-01) ❄️
 
 - Fix Rails 7.0 support. ([@palkan][])
@@ -141,3 +149,5 @@ This, for example, makes Isolator compatible with Rails multi-database apps.
 [@Mange]: https://github.com/Mange
 [@tomgi]: https://github.com/tomgi
 [@tagirahmad]: https://github.com/tagirahmad
+[@arthurWD]: https://github.com/arthurWD
+[@joshuay03]: https://github.com/joshuay03

data/README.md

@@ -75,11 +75,16 @@ However, there are some potential caveats:
 
 1) Isolator tries to detect the environment automatically and includes only necessary adapters. Thus the order of loading gems matters: make sure that `isolator` is required in the end (NOTE: in Rails, all adapters loaded after application initialization).
 
-2) Isolator does not distinguish framework-level adapters. For example, `:active_job` spy doesn't take into account which AJ adapter you use; if you are using a safe one (e.g. `Que`) just disable the `:active_job` adapter to avoid false negatives (i.e. `Isolator.adapters.active_job.disable!`).
+2) Isolator does not distinguish framework-level adapters. For example, `:active_job` spy doesn't take into account which AJ adapter you use; if you are using a safe one (e.g. `Que`) just disable the `:active_job` adapter to avoid false negatives. You can do this by adding an initializer:
 
-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)).
+    ```rb
+    require "active_job/base"
+    Isolator.adapters.active_job.disable!
+    ```
 
-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.
+4) 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)).
+
+5) 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
 
@@ -160,6 +165,7 @@ Isolator has a bunch of built-in adapters:
 - `:sucker_punch`
 - `:mailer`
 - `:webmock` – track mocked HTTP requests (unseen by Sniffer) in tests
+- `:action_cable`
 
 You can dynamically enable/disable adapters, e.g.:
 
@@ -172,6 +178,8 @@ Isolator.adapters.http.disable!
 Isolator.adapters.http.enable!
 ```
 
+For `active_job`, be sure to first `require "active_job/base"`.
+
 ### Fix Offenses
 
 For the actions that should be executed only after successful transaction commit (which is mostly always so), you can try to use the `after_commit` callback from [after_commit_everywhere] gem (or use native AR callback in models if it's applicable).

data/lib/isolator/adapter_builder.rb

@@ -13,6 +13,9 @@ module Isolator
           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)
+          if options.key?(:ignore_on)
+            define_singleton_method(:ignore_on?, &options[:ignore_on])
+          end
         end
 
         mod = build_mod(method_name, adapter)
@@ -39,7 +42,7 @@ module Isolator
           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?(...)
+              #{adapter_name}.notify(caller, self, ...) if #{adapter_name}.notify_on?(self, ...)
               super
             end
           RUBY

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

@@ -7,4 +7,9 @@ Isolator.isolate :active_job,
   details_message: ->(obj) {
     "#{obj.class.name}" \
     "#{obj.arguments.any? ? " (#{obj.arguments.join(", ")})" : ""}"
-  }
+  },
+  ignore_on: ->(job) {
+               config = job.class.try(:enqueue_after_transaction_commit)
+               config == :always || (config == :default &&
+                 ActiveJob::Base.queue_adapter.try(:enqueue_after_transaction_commit?) == true)
+             }

data/lib/isolator/adapters/base.rb

@@ -27,6 +27,10 @@ module Isolator
         Isolator.notify(exception: build_exception(obj, args, kwargs), backtrace: backtrace)
       end
 
+      def notify_on?(obj, *args, **kwargs)
+        !ignore_on?(obj) && notify?(*args, **kwargs)
+      end
+
       def notify?(...)
         enabled? && Isolator.enabled? && Isolator.within_transaction? && !ignored?(...)
       end
@@ -43,6 +47,10 @@ module Isolator
         ignores.any? { |block| block.call(*args, **kwargs) }
       end
 
+      def ignore_on?(_obj)
+        false
+      end
+
       private
 
       def build_exception(obj, args, kwargs = {})

data/lib/isolator/adapters/websockets/action_cable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Isolator.isolate :action_cable,
+  target: ActionCable::Server::Base,
+  method_name: :broadcast,
+  exception_class: Isolator::WebsocketError,
+  details_message: ->(_obj, args) {
+    channel = args.first
+
+    "Broadcasting to #{channel}"
+  }

data/lib/isolator/adapters/websockets.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+if defined?(ActiveSupport)
+  ActiveSupport.on_load(:action_cable) do
+    require "isolator/adapters/websockets/action_cable"
+  end
+end

data/lib/isolator/adapters.rb

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

data/lib/isolator/errors.rb

@@ -22,4 +22,8 @@ module Isolator # :nodoc: all
   class MailerError < UnsafeOperationError
     MESSAGE = "You are trying to send email inside db transaction."
   end
+
+  class WebsocketError < UnsafeOperationError
+    MESSAGE = "You are trying to broadcast to a websocket connection inside db transaction. "
+  end
 end

data/lib/isolator/version.rb

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

data/lib/isolator.rb

@@ -111,20 +111,20 @@ module Isolator
 
     def incr_thresholds!
       self.default_threshold += 1
+      debug!("Thresholds were incremented")
+
       return unless state[:thresholds]
 
       state[:thresholds].transform_values!(&:succ)
-
-      debug!("Thresholds were incremented")
     end
 
     def decr_thresholds!
       self.default_threshold -= 1
+      debug!("Thresholds were incremented")
+
       return unless state[:thresholds]
 
       state[:thresholds].transform_values!(&:pred)
-
-      debug!("Thresholds were decremented")
     end
 
     def incr_transactions!(connection_id = default_connection_id.call)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2024-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -302,6 +302,8 @@ files:
 - lib/isolator/adapters/http/webmock.rb
 - lib/isolator/adapters/mailers.rb
 - lib/isolator/adapters/mailers/mail.rb
+- lib/isolator/adapters/websockets.rb
+- lib/isolator/adapters/websockets/action_cable.rb
 - lib/isolator/callbacks.rb
 - lib/isolator/configuration.rb
 - lib/isolator/database_cleaner_support.rb
@@ -329,7 +331,7 @@ metadata:
   homepage_uri: http://github.com/palkan/isolator
   source_code_uri: http://github.com/palkan/isolator
   funding_uri: https://github.com/sponsors/palkan
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -344,8 +346,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: Detect non-atomic interactions within DB transactions
 test_files: []