active_record_host_pool 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3944318de7c004909c8bc75a447e01e9ec1c5a44d0eb99f0449cc53880ec0d74
-  data.tar.gz: 1b0ec3c13a90206c9a2f02a6c0c51b92a9053ba3858a979268eea071c52c26ae
+  metadata.gz: fced473565b601f6ec0a0e682b254c251d653c10be16690c46470d418dd9f346
+  data.tar.gz: 7281ce45c44d5209f16444e55caaaf4c2a059981d6a41a48d45d0f394c08b4a3
 SHA512:
-  metadata.gz: b9742fce5b0960f281e1e119f2e326b1b90a921f534da452f2fd67c289d18cbbdec6324dafab53e6053745f5a5bd69f01b927dcde2005fe6daaab184943758de
-  data.tar.gz: 69766e4f3747c105c4b98b86609faa3cb9eee8105951faa82627da8117c4eb36f66c4b5edf34e59f6fb44b25c0a47ca9242065de1eef65dcc15636a7188312bd
+  metadata.gz: a053ec7e487686f9ab3aa0b5c01912292aee086f3d9e2444e715c99f9ef278c564b2a48b8eceb68030972c10ac20c04b20745689e88efdd9ae333256a033a371
+  data.tar.gz: d6f6bc52d1e46987faf4b7d57b7e6df43464e60ed978b3337056957f3e8d5b98ed1fc38f156ea1766b7c299ee1094a68e3ec6a13e8741117e311cb23d54ce385

data/Changelog.md

@@ -6,6 +6,18 @@ and as of v1.0.0 this project adheres to [Semantic Versioning](https://semver.or
 
 ## [Unreleased]
 
+## [4.3.0]
+
+### Changed
+- `.class_eval` now raises an exception when called on `ConnectionProxy`. Use `.arhp_connection_proxy_class_eval` if you _really_ need to modify the `ConnectionProxy` class.
+
+### Added
+- Testing with Rails 8.1.
+
+### Removed
+- `ConnectionProxy` no longer overrides `#class` to return the class of the proxied connection adapter.
+- Support for Rails 7.1.
+
 ## [4.2.0]
 
 ### Changed

data/Readme.md

@@ -53,18 +53,14 @@ Postgres, from an informal reading of the docs, will never support the concept o
 and make sure to require 'active_record_host_pool' in some way.
 
 ## Testing
-You need a local user called 'john-doe'.
 
-    mysql -uroot
-    CREATE USER 'john-doe'@'localhost';
-    GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX  ON *.* TO 'john-doe'@'localhost';
-    FLUSH PRIVILEGES;
+TestContainers will take care of setting up the necessary MySQL servers for you. You just need to have e.g. Docker running.
 
-With mysql running locally, run
+Run e.g.
 
     BUNDLE_GEMFILE=gemfiles/rails6.1.gemfile bundle exec rake test
 
- Or
+or
 
     BUNDLE_GEMFILE=gemfiles/rails6.1.gemfile ruby test/test_arhp.rb --seed 19911 --verbose
 

data/lib/active_record_host_pool/connection_adapter_mixin.rb

@@ -62,7 +62,7 @@ module ActiveRecordHostPool
            _desired_database_changed? ||
             _real_connection_changed?
          )
-        log("select_db #{_host_pool_desired_database}", "SQL") do
+        log(select_db_log_arg, "SQL") do
           clear_cache!
           real_connection.select_db(_host_pool_desired_database)
         end
@@ -71,22 +71,23 @@ module ActiveRecordHostPool
       end
     end
 
+    if ActiveRecord.version < Gem::Version.new("8.2.a")
+      def select_db_log_arg
+        "select_db #{_host_pool_desired_database}"
+      end
+    else
+      def select_db_log_arg
+        ActiveRecord::ConnectionAdapters::QueryIntent.new(processed_sql: "select_db #{_host_pool_desired_database}")
+      end
+    end
+
     def _desired_database_changed?
       _host_pool_desired_database != @_cached_current_database
     end
 
-    # rubocop:disable Lint/DuplicateMethods
-    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-    when "7.1"
-      def _real_connection_object_id
-        @connection.object_id
-      end
-    else
-      def _real_connection_object_id
-        @raw_connection.object_id
-      end
+    def _real_connection_object_id
+      @raw_connection.object_id
     end
-    # rubocop:enable Lint/DuplicateMethods
 
     def _real_connection_changed?
       _real_connection_object_id != @_cached_connection_object_id

data/lib/active_record_host_pool/connection_proxy.rb

@@ -6,6 +6,16 @@ require "delegate"
 # for each call to the connection.  upon executing a statement, the connection will switch to that database.
 module ActiveRecordHostPool
   class ConnectionProxy < Delegator
+    class << self
+      def class_eval
+        raise "You probably want to call .class_eval on the ActiveRecord connection adapter and not on ActiveRecordHostPool's connection proxy. Use .arhp_connection_proxy_class_eval if you _really_ know what you're doing."
+      end
+
+      def arhp_connection_proxy_class_eval(...)
+        method(:class_eval).super_method.call(...)
+      end
+    end
+
     attr_reader :database
     def initialize(cx, database)
       super(cx)
@@ -26,11 +36,6 @@ module ActiveRecordHostPool
       @cx
     end
 
-    # this is bad.  I know.  but it allows folks who class_eval on connection.class to do so
-    def class
-      @cx.class
-    end
-
     def expects(*args)
       @cx.send(:expects, *args)
     end

data/lib/active_record_host_pool/pool_proxy.rb

@@ -51,35 +51,18 @@ module ActiveRecordHostPool
 
     attr_reader :pool_config
 
-    # rubocop:disable Lint/DuplicateMethods
-    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-    when "7.1"
-      def connection(*args)
-        real_connection = _unproxied_connection(*args)
-        _connection_proxy_for(real_connection, @config[:database])
-      rescue *RESCUABLE_DB_ERROR, ActiveRecord::NoDatabaseError, ActiveRecord::StatementInvalid
-        _connection_pools.delete(_pool_key)
-        Kernel.raise
-      end
-
-      def _unproxied_connection(*args)
-        _connection_pool.connection(*args)
-      end
-    else
-      def lease_connection(*args)
-        real_connection = _unproxied_connection(*args)
-        _connection_proxy_for(real_connection, @config[:database])
-      rescue *RESCUABLE_DB_ERROR, ActiveRecord::NoDatabaseError, ActiveRecord::StatementInvalid
-        _connection_pools.delete(_pool_key)
-        Kernel.raise
-      end
-      alias_method :connection, :lease_connection
+    def lease_connection(*args)
+      real_connection = _unproxied_connection(*args)
+      _connection_proxy_for(real_connection, @config[:database])
+    rescue *RESCUABLE_DB_ERROR, ActiveRecord::NoDatabaseError, ActiveRecord::StatementInvalid
+      _connection_pools.delete(_pool_key)
+      Kernel.raise
+    end
+    alias_method :connection, :lease_connection
 
-      def _unproxied_connection(*args)
-        _connection_pool.lease_connection(*args)
-      end
+    def _unproxied_connection(*args)
+      _connection_pool.lease_connection(*args)
     end
-    # rubocop:enable Lint/DuplicateMethods
 
     # by the time we are patched into ActiveRecord, the current thread has already established
     # a connection.  thus we need to patch both connection and checkout/checkin
@@ -93,49 +76,39 @@ module ActiveRecordHostPool
       _connection_pool.checkin(cx)
     end
 
-    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-    when "7.1"
-      def with_connection
-        cx = checkout
-        yield cx
-      ensure
-        checkin cx
-      end
-    else
-      def with_connection(prevent_permanent_checkout: false) # rubocop:disable Lint/DuplicateMethods
-        real_connection_lease = _connection_pool.send(:connection_lease)
-        sticky_was = real_connection_lease.sticky
-        real_connection_lease.sticky = false if prevent_permanent_checkout
-
-        if real_connection_lease.connection
-          begin
-            yield _connection_proxy_for(real_connection_lease.connection, @config[:database])
-          ensure
-            real_connection_lease.sticky = sticky_was if prevent_permanent_checkout && !sticky_was
-          end
-        else
-          begin
-            real_connection_lease.connection = _unproxied_connection
-            yield _connection_proxy_for(real_connection_lease.connection, @config[:database])
-          ensure
-            real_connection_lease.sticky = sticky_was if prevent_permanent_checkout && !sticky_was
-            _connection_pool.release_connection(real_connection_lease) unless real_connection_lease.sticky
-          end
-        end
-      end
+    def with_connection(prevent_permanent_checkout: false) # rubocop:disable Lint/DuplicateMethods
+      real_connection_lease = _connection_pool.send(:connection_lease)
+      sticky_was = real_connection_lease.sticky
+      real_connection_lease.sticky = false if prevent_permanent_checkout
 
-      def active_connection?
-        real_connection_lease = _connection_pool.send(:connection_lease)
-        if real_connection_lease.connection
-          _connection_proxy_for(real_connection_lease.connection, @config[:database])
+      if real_connection_lease.connection
+        begin
+          yield _connection_proxy_for(real_connection_lease.connection, @config[:database])
+        ensure
+          real_connection_lease.sticky = sticky_was if prevent_permanent_checkout && !sticky_was
+        end
+      else
+        begin
+          real_connection_lease.connection = _unproxied_connection
+          yield _connection_proxy_for(real_connection_lease.connection, @config[:database])
+        ensure
+          real_connection_lease.sticky = sticky_was if prevent_permanent_checkout && !sticky_was
+          _connection_pool.release_connection(real_connection_lease) unless real_connection_lease.sticky
         end
       end
-      alias_method :active_connection, :active_connection?
+    end
 
-      def schema_cache
-        @schema_cache ||= ActiveRecord::ConnectionAdapters::BoundSchemaReflection.new(_connection_pool.schema_reflection, self)
+    def active_connection?
+      real_connection_lease = _connection_pool.send(:connection_lease)
+      if real_connection_lease.connection
+        _connection_proxy_for(real_connection_lease.connection, @config[:database])
       end
     end
+    alias_method :active_connection, :active_connection?
+
+    def schema_cache
+      @schema_cache ||= ActiveRecord::ConnectionAdapters::BoundSchemaReflection.new(_connection_pool.schema_reflection, self)
+    end
 
     def disconnect!
       p = _connection_pool(false)

data/lib/active_record_host_pool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordHostPool
-  VERSION = "4.2.0"
+  VERSION = "4.3.0"
 end

data/lib/active_record_host_pool.rb

@@ -16,7 +16,6 @@ rescue LoadError
   :noop
 end
 
-require "active_record_host_pool/clear_query_cache_patch"
 require "active_record_host_pool/connection_proxy"
 require "active_record_host_pool/pool_proxy"
 require "active_record_host_pool/connection_adapter_mixin"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_host_pool
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Benjamin Quorning
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 2025-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
 description: ''
 email:
 - bquorning@zendesk.com
@@ -42,7 +42,6 @@ files:
 - MIT-LICENSE
 - Readme.md
 - lib/active_record_host_pool.rb
-- lib/active_record_host_pool/clear_query_cache_patch.rb
 - lib/active_record_host_pool/connection_adapter_mixin.rb
 - lib/active_record_host_pool/connection_proxy.rb
 - lib/active_record_host_pool/pool_proxy.rb

data/lib/active_record_host_pool/clear_query_cache_patch.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-# ActiveRecord 6.0 introduced multiple database support. With that, an update
-# has been made in https://github.com/rails/rails/pull/35089 to ensure that
-# all query caches are cleared across connection handlers and pools. If you
-# write on one connection, the other connection will have the update that
-# occurred.
-#
-# This broke ARHP which implements its own pool, allowing you to access
-# multiple databases with the same connection (e.g. 1 connection for 100
-# shards on the same server).
-#
-# This patch maintains the reference to the database during the cache clearing
-# to ensure that the database doesn't get swapped out mid-way into an
-# operation.
-#
-# This is a private Rails API and may change in future releases as they're
-# actively working on sharding in Rails 6 and above.
-module ActiveRecordHostPool
-  # For Rails 7.1.
-  module ClearQueryCachePatch
-    def clear_query_caches_for_current_thread
-      connection_handler.each_connection_pool do |pool|
-        pool._unproxied_connection.clear_query_cache if pool.active_connection?
-      end
-    end
-  end
-end
-
-case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-when "7.1"
-  # Fix https://github.com/rails/rails/commit/401e2f24161ed6047ae33c322aaf6584b7728ab9
-  ActiveRecord::Base.singleton_class.prepend(ActiveRecordHostPool::ClearQueryCachePatch)
-end