isolator 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 529433e0e838e663f335a5fb493f51d10f16fbde2168c89be72e92c968709593
-  data.tar.gz: ef33db058e25204e615fae7ee945c738e516e8ae6d63bb93f9660e6e117cb632
+  metadata.gz: fb3ecc2b4b93f35241a5f03804bc89fab1ab2a6d9d4fe33753ad827bc8a06ea5
+  data.tar.gz: 8385b3b3654b25d1ec2ec178305cac41049523339da8d56c6ba7defb31996640
 SHA512:
-  metadata.gz: 5cb63aa9a96f5931425267193590550cac0614dd15d272bd7d33f7e2aeaad0b7b37a19f5a6f7d8617dce992e946b92c42c3df5829177cbd51b41d8919abdc8c5
-  data.tar.gz: b4997855a9d813a961491235097a42eee75d55598fb7d33d53bb4f7e3828f486ea0a2fb788edd028237e39518a2d8e962824b08a3f4cbed2ce3ac22acdfee9c3
+  metadata.gz: a18d105a45e116af3120e4f9eefd69f1c533b14f1ce26b8bdd9c284fd99f87ddd8e3650ae3e7a73cc54592329726f549d16b374763f5bae6c71163e36499b55a
+  data.tar.gz: cb72be0a0d3aa004dab07392b875e0d70472806517d7d89acdafd133f332a50f59232aed8c919c12ce15cd12399b29f7ef8e33f986e445046b9171765db4ae74

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## master
 
+## 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][])
+
+- Fix query having invalid characters. ([@tagirahmad][])
+
+  Fixes [#43](https://github.com/palkan/isolator/issues/43).
+
 ## 0.9.0 (2023-05-18)
 
 - Support keyword arguments to isolated method in Ruby 3.0. ([@Mange][])
@@ -109,3 +125,5 @@ This, for example, makes Isolator compatible with Rails multi-database apps.
 [@mquan]: https://github.com/mquan
 [@bobbymcwho]: https://github.com/bobbymcwho
 [@Mange]: https://github.com/Mange
+[@tomgi]: https://github.com/tomgi
+[@tagirahmad]: https://github.com/tagirahmad

data/lib/isolator/adapter_builder.rb

@@ -33,7 +33,8 @@ module Isolator
 
         Module.new do
           define_method method_name do |*args, **kwargs, &block|
-            adapter.notify(caller, self, *args, **kwargs)
+            # 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
         end

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

@@ -7,5 +7,6 @@ adapter = Isolator.isolate :webmock,
                    }
 
 WebMock.after_request do |*args|
-  adapter.notify(caller, *args)
+  # check if we are even notifying before calling `caller`, which is well known to be slow
+  adapter.notify(caller, *args) if adapter.notify?(*args)
 end

data/lib/isolator/database_cleaner_support.rb

@@ -1,16 +1,23 @@
 # frozen_string_literal: true
 
 require "database_cleaner/active_record/transaction"
-
 ::DatabaseCleaner::ActiveRecord::Transaction.prepend(
   Module.new do
     def start
       super
-      Isolator.transactions_threshold += 1
+      connection_id = connection_class.connection.object_id
+      Isolator.set_connection_threshold(
+        Isolator.transactions_threshold(connection_id) + 1,
+        connection_id
+      )
     end
 
     def clean
-      Isolator.transactions_threshold -= 1
+      connection_id = connection_class.connection.object_id
+      Isolator.set_connection_threshold(
+        Isolator.transactions_threshold(connection_id) - 1,
+        connection_id
+      )
       super
     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

@@ -2,4 +2,10 @@
 
 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,12 +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
-        Isolator.incr_transactions!(connection_id) if START_PATTERN.match?(query[:sql])
-        Isolator.decr_transactions!(connection_id) if FINISH_PATTERN.match?(query[:sql])
+    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/version.rb

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

data/lib/isolator.rb

@@ -198,15 +198,23 @@ module Isolator
 
     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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -313,6 +313,7 @@ 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/railtie.rb
 - lib/isolator/simple_hashie.rb