active_record_shards 5.3.2 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d54a5e8446f89d23e9c302763e48033f2398a72495d150772ea4bc3ec4fe575
-  data.tar.gz: 9add02d3fec821e54c6f388a021cb09f69320de09846242e49fa2f26269ce948
+  metadata.gz: fbcc8e394ddfa2267939c38fe1612c0c410f549ca6d45fc52469ccd564771fcd
+  data.tar.gz: 2e87a9063cfe63fe47d58d5bf8e7b84dc88755cb39f81b88db3954a8c5a65868
 SHA512:
-  metadata.gz: 27627d24f879c675af2d414c334fd713f9845f2e7d93dd8e6c580194357bba038f5c1ded593be06702a570e7631beeb92e5c2be8e26d8629b5ef84b3333e4b47
-  data.tar.gz: d47b1b6906e5ff40633ebe6128fdc845cac7b81d377a16fd31ece96398a174fe87f8bd2a33406abe3516f53969ab5c910e163a792fb0f93e2e6119c8dfc15267
+  metadata.gz: 5eec3bce25a92f77f583a258efd2f054efce9f58b4e49c72be84e3cf352da02d7a8ab984ba349014dbe0f28b45cf347d2935512e97c88c349a9507b6338ce9f1
+  data.tar.gz: 4d9778bd1883639073fe77cf36a5de42de5d14ac1acd45303e80f4c37998a3c5ec00445578df9367a298c8d2c07111b2dd41e7cd6545b4e3f05f3b95d1eb2386

data/lib/active_record_shards/connection_switcher.rb

@@ -5,6 +5,7 @@ require 'active_record_shards/shard_support'
 module ActiveRecordShards
   module ConnectionSwitcher
     class LegacyConnectionHandlingError < StandardError; end
+    class IsolationLevelError < StandardError; end
 
     case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
     when '6.1', '7.0'
@@ -134,7 +135,8 @@ module ActiveRecordShards
     end
 
     def current_shard_selection
-      Thread.current[:shard_selection] ||= ShardSelection.new
+      cs = Thread.current.thread_variable_get(:shard_selection) || ShardSelection.new
+      Thread.current.thread_variable_set(:shard_selection, cs)
     end
 
     def current_shard_id
@@ -177,6 +179,7 @@ module ActiveRecordShards
 
     def switch_connection(options)
       ensure_legacy_connection_handling if ActiveRecord.version >= Gem::Version.new('6.1')
+      ensure_thread_isolation_level if ActiveRecord.version >= Gem::Version.new('7.0')
 
       if options.any?
         if options.key?(:replica)
@@ -199,6 +202,12 @@ module ActiveRecordShards
       end
     end
 
+    def ensure_thread_isolation_level
+      unless ActiveSupport::IsolatedExecutionState.isolation_level == :thread
+        raise IsolationLevelError, "ActiveRecordShards is _only_ compatible when ActiveSupport::IsolatedExecutionState's isolation_level is set to :thread"
+      end
+    end
+
     def legacy_connection_handling_owner
       @legacy_connection_handling_owner ||=
         case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"

data/lib/active_record_shards/default_replica_patches.rb

@@ -29,21 +29,6 @@ module ActiveRecordShards
       RUBY
     end
 
-    def transaction_with_replica_off(*args, &block)
-      if on_replica_by_default?
-        begin
-          old_val = Thread.current[:_active_record_shards_in_tx]
-          Thread.current[:_active_record_shards_in_tx] = true
-          transaction_without_replica_off(*args, &block)
-        ensure
-          Thread.current[:_active_record_shards_in_tx] = old_val
-        end
-      else
-        transaction_without_replica_off(*args, &block)
-      end
-    end
-    ruby2_keywords(:transaction_with_replica_off) if respond_to?(:ruby2_keywords, true)
-
     module InstanceMethods
       def on_replica_unless_tx
         self.class.on_replica_unless_tx { yield }
@@ -80,17 +65,12 @@ module ActiveRecordShards
 
       base.class_eval do
         include InstanceMethods
-
-        class << self
-          alias_method :transaction_without_replica_off, :transaction
-          alias_method :transaction, :transaction_with_replica_off
-        end
       end
     end
 
     def on_replica_unless_tx(&block)
       return yield if Thread.current[:_active_record_shards_in_migration]
-      return yield if Thread.current[:_active_record_shards_in_tx]
+      return yield if _in_transaction?
 
       if on_replica_by_default?
         on_replica(&block)
@@ -99,6 +79,10 @@ module ActiveRecordShards
       end
     end
 
+    def _in_transaction?
+      connected? && connection.transaction_open?
+    end
+
     def force_on_replica(&block)
       return yield if Thread.current[:_active_record_shards_in_migration]
 
@@ -122,7 +106,7 @@ module ActiveRecordShards
     module Rails52RelationPatches
       def connection
         return super if Thread.current[:_active_record_shards_in_migration]
-        return super if Thread.current[:_active_record_shards_in_tx]
+        return super if _in_transaction?
 
         if @klass.on_replica_by_default?
           @klass.on_replica.connection
@@ -214,7 +198,7 @@ module ActiveRecordShards
     module TypeCasterConnectionConnectionPatch
       def connection
         return super if Thread.current[:_active_record_shards_in_migration]
-        return super if Thread.current[:_active_record_shards_in_tx]
+        return super if ActiveRecord::Base._in_transaction?
 
         if @klass.on_replica_by_default?
           @klass.on_replica.connection

data/lib/active_record_shards/model.rb

@@ -11,26 +11,20 @@ module ActiveRecordShards
     end
 
     def is_sharded? # rubocop:disable Naming/PredicateName
-      # "sharded" here means self.sharded, but actually writing "self.sharded"
-      # doesn't work until Ruby 2.7 (and this gem currently supports 2.6) because
-      # the sharded attr_accessor is private. Private methods must be called without
-      # a receiver, but Ruby 2.7+ does allow an explicit "self" as a receiver.
-      return sharded unless sharded.nil?
+      return @_ars_model_is_sharded unless @_ars_model_is_sharded.nil?
 
-      # Despite self.sharded not working, self.sharded= _DOES_ work. That's an exception
-      # to the "private methods must be called with no receiver" rule (presumably
-      # because it would otherwise be ambiguous with local variable assignment).
-      self.sharded = if self == ActiveRecord::Base
-                       sharded != false && supports_sharding?
-                     elsif self == base_class
-                       if sharded.nil?
-                         ActiveRecord::Base.is_sharded?
-                       else
-                         sharded != false
-                       end
-                     else
-                       base_class.is_sharded?
-                     end
+      @_ars_model_is_sharded =
+        if self == ActiveRecord::Base
+          sharded != false && supports_sharding?
+        elsif self == base_class
+          if sharded.nil?
+            ActiveRecord::Base.is_sharded?
+          else
+            sharded != false
+          end
+        else
+          base_class.is_sharded?
+        end
     end
 
     def on_replica_by_default?

data/lib/active_record_shards.rb

@@ -27,6 +27,17 @@ module ActiveRecordShards
       env || 'development'
     end
   end
+
+  # Busts internal caches kept by active_record_shards, for things which are _supposed_ to be the
+  # same for the life of the process. You shouldn't need to call this unless you're doing something
+  # truly evil like changing RAILS_ENV after boot
+  def self.reset_app_env!
+    @app_env = nil
+    models = [ActiveRecord::Base] + ActiveRecord::Base.descendants
+    models.each do |model|
+      model.remove_instance_variable(:@_ars_model_is_sharded) if model.instance_variable_defined?(:@_ars_model_is_sharded)
+    end
+  end
 end
 
 ActiveRecord::Base.extend(ActiveRecordShards::ConfigurationParser)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 5.3.2
+  version: 5.4.0
 platform: ruby
 authors:
 - Benjamin Quorning
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -83,20 +83,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.10.0
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  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: mysql2
   requirement: !ruby/object:Gem::Requirement