active_record_host_pool 4.0.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8149f10e7b7b05c8ce36cb00ee2c0a77c6df40df5e594eb66cdcfbd42c265ddf
-  data.tar.gz: d9464ea5f9f1d310259c54b22d0d7df40c8b04d0a0568d378893174861675f7b
+  metadata.gz: bbf1c2173865a9d635564bb5cb677e42dedff46a8f44ec186799fdfd78500267
+  data.tar.gz: 4e4c49fd589cf06671b0d2a94042179a38321b5c2720cdfc5114366eb7448166
 SHA512:
-  metadata.gz: e5454f3f23ffd85a74e0fea41588b4b4093578893dfbf4d4c7e25a18b05ea45749249acbf9cb0755d1921c37c2e3016c8ec006171c21d4e8f79cee25488c0ba2
-  data.tar.gz: c8e2aa410f402b5272d37fd2c6e0405b4771469325c660e865f22a8adffcb0d6f9a1c574bab9952b81c81ef0186df9884042e35564a91cdc23b89ba5bf85f120
+  metadata.gz: 670fba2e8c6ca93ea22af70ba7b3642ef22d9dcf60a9afc9dedfd8f7443b47cbd127e910092d61029b41ab99eb273d1dad3ec98be52238011d2c756195168a4a
+  data.tar.gz: 7bc8ea4b1998f22474b880e4deee809c8f1f29e9eee7a87befa315e5ab2b46bd4a38c1fa79e629ecb04e37f8a334ecd95c85d02a809b95bc9dd8ab70cc10315c

data/Changelog.md

@@ -6,6 +6,39 @@ and as of v1.0.0 this project adheres to [Semantic Versioning](https://semver.or
 
 ## [Unreleased]
 
+## [4.3.1]
+
+- Better compatibility with Rails 8.2 alpha.
+
+## [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
+- ActiveRecordHostPool can now work with `mysql2` and `trilogy` if both gems are loaded.
+
+### Added
+- Testing with Rails 8.0.
+
+### Removed
+- Support for Rails 6.1 & 7.0.
+- Support for Ruby 3.1.
+
+## [4.1.0]
+
+### Changed
+- Remove dependency on `mutex_m`, instead using `Thread::Mutex` directly.
+
 ## [4.0.0]
 
 ### Changed
@@ -23,7 +56,7 @@ and as of v1.0.0 this project adheres to [Semantic Versioning](https://semver.or
 ## [3.1.1]
 
 ### Fixed
-- A typo causing `#clean!` to not run. 
+- A typo causing `#clean!` to not run.
 
 ## [3.1.0]
 

data/Readme.md

@@ -50,24 +50,35 @@ Postgres, from an informal reading of the docs, will never support the concept o
 
     $ gem install active_record_host_pool
 
-and make sure to require 'active\_record\_host\_pool' in some way.
+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
 
+### Releasing a new version
+A new version is published to RubyGems.org every time a change to `version.rb` is pushed to the `main` branch.
+In short, follow these steps:
+1. Update `version.rb`,
+2. update version in all `Gemfile.lock` files,
+3. merge this change into `main`, and
+4. look at [the action](https://github.com/zendesk/active_record_host_pool/actions/workflows/publish.yml) for output.
+
+To create a pre-release from a non-main branch:
+1. change the version in `version.rb` to something like `1.2.0.pre.1` or `2.0.0.beta.2`,
+2. push this change to your branch,
+3. go to [Actions → “Publish to RubyGems.org” on GitHub](https://github.com/zendesk/active_record_host_pool/actions/workflows/publish.yml),
+4. click the “Run workflow” button,
+5. pick your branch from a dropdown.
+
 ## Copyright
 
 Copyright (c) 2011 Zendesk. See MIT-LICENSE for details.

data/lib/active_record_host_pool/connection_adapter_mixin.rb

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
 
-case ActiveRecordHostPool.loaded_db_adapter
-when :mysql2
+begin
   require "active_record/connection_adapters/mysql2_adapter"
-when :trilogy
-  case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-  when "6.1", "7.0"
-    require "trilogy_adapter/connection"
-    ActiveRecord::Base.extend(TrilogyAdapter::Connection)
-  when "7.1", "7.2", "8.0"
-    require "active_record/connection_adapters/trilogy_adapter"
-  else
-    raise "Unsupported version of Rails (v#{ActiveRecord::VERSION::STRING})"
-  end
+rescue LoadError
+  :noop
+end
+
+begin
+  require "active_record/connection_adapters/trilogy_adapter"
+rescue LoadError
+  :noop
 end
 
 module ActiveRecordHostPool
@@ -28,24 +25,10 @@ module ActiveRecordHostPool
       @config[:database] = _host_pool_desired_database
     end
 
-    if ActiveRecord.version >= Gem::Version.new("7.1")
-      def with_raw_connection(...)
-        super do |real_connection|
-          _switch_connection(real_connection) if _host_pool_desired_database && !_no_switch
-          yield real_connection
-        end
-      end
-    elsif ActiveRecordHostPool.loaded_db_adapter == :trilogy
-      def with_trilogy_connection(...)
-        super do |real_connection|
-          _switch_connection(real_connection) if _host_pool_desired_database && !_no_switch
-          yield real_connection
-        end
-      end
-    else
-      def execute(...)
-        _switch_connection(raw_connection) if _host_pool_desired_database && !_no_switch
-        super
+    def with_raw_connection(...)
+      super do |real_connection|
+        _switch_connection(real_connection) if _host_pool_desired_database && !_no_switch
+        yield real_connection
       end
     end
 
@@ -79,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
@@ -88,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(adapter: self, 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 "6.1", "7.0", "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
@@ -122,11 +106,6 @@ module ActiveRecordHostPool
   end
 end
 
-case ActiveRecordHostPool.loaded_db_adapter
-when :mysql2
-  ActiveRecord::ConnectionAdapters::Mysql2Adapter.prepend(ActiveRecordHostPool::DatabaseSwitch)
-when :trilogy
-  ActiveRecord::ConnectionAdapters::TrilogyAdapter.prepend(ActiveRecordHostPool::DatabaseSwitch)
-end
-
+ActiveRecord::ConnectionAdapters::Mysql2Adapter.prepend(ActiveRecordHostPool::DatabaseSwitch) if defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+ActiveRecord::ConnectionAdapters::TrilogyAdapter.prepend(ActiveRecordHostPool::DatabaseSwitch) if defined?(ActiveRecord::ConnectionAdapters::TrilogyAdapter)
 ActiveRecord::ConnectionAdapters::PoolConfig.prepend(ActiveRecordHostPool::PoolConfigPatch)

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

@@ -3,7 +3,6 @@
 require "delegate"
 require "active_record"
 require "active_record_host_pool/connection_adapter_mixin"
-require "mutex_m"
 
 # this module sits in between ConnectionHandler and a bunch of different ConnectionPools (one per host).
 # when a connection is requested, it goes like:
@@ -16,19 +15,28 @@ require "mutex_m"
 module ActiveRecordHostPool
   # Sits between ConnectionHandler and a bunch of different ConnectionPools (one per host).
   class PoolProxy < Delegator
-    include Mutex_m
+    rescuable_db_error = []
+    begin
+      require "mysql2"
+      rescuable_db_error << Mysql2::Error
+    rescue LoadError
+      :noop
+    end
 
-    case ActiveRecordHostPool.loaded_db_adapter
-    when :mysql2
-      RESCUABLE_DB_ERROR = Mysql2::Error
-    when :trilogy
-      RESCUABLE_DB_ERROR = Trilogy::ProtocolError
+    begin
+      require "trilogy"
+      rescuable_db_error << Trilogy::ProtocolError
+    rescue LoadError
+      :noop
     end
 
+    RESCUABLE_DB_ERROR = rescuable_db_error.freeze
+
     def initialize(pool_config)
-      super(pool_config)
+      super
       @pool_config = pool_config
       @config = pool_config.db_config.configuration_hash
+      @mutex = Mutex.new
     end
 
     def __getobj__
@@ -43,35 +51,18 @@ module ActiveRecordHostPool
 
     attr_reader :pool_config
 
-    # rubocop:disable Lint/DuplicateMethods
-    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-    when "6.1", "7.0", "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
@@ -85,55 +76,45 @@ module ActiveRecordHostPool
       _connection_pool.checkin(cx)
     end
 
-    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-    when "6.1", "7.0", "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)
       return unless p
 
-      synchronize do
+      @mutex.synchronize do
         p.disconnect!
         p.automatic_reconnect = true
         _clear_connection_proxy_cache
@@ -199,30 +180,12 @@ module ActiveRecordHostPool
       pool
     end
 
-    # Work around https://github.com/rails/rails/pull/48061/commits/63c0d6b31bcd0fc33745ec6fd278b2d1aab9be54
-    # standard:disable Lint/DuplicateMethods
-    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-    when "6.1", "7.0"
-      def _connection_proxy_for(connection, database)
-        @connection_proxy_cache ||= {}
-        key = [connection, database]
+    def _connection_proxy_for(connection, database)
+      @connection_proxy_cache ||= {}
+      key = [connection, database]
 
-        @connection_proxy_cache[key] ||= begin
-          cx = ActiveRecordHostPool::ConnectionProxy.new(connection, database)
-          cx.execute("SELECT 1")
-
-          cx
-        end
-      end
-    else
-      def _connection_proxy_for(connection, database)
-        @connection_proxy_cache ||= {}
-        key = [connection, database]
-
-        @connection_proxy_cache[key] ||= ActiveRecordHostPool::ConnectionProxy.new(connection, database)
-      end
+      @connection_proxy_cache[key] ||= ActiveRecordHostPool::ConnectionProxy.new(connection, database)
     end
-    # standard:enable Lint/DuplicateMethods
 
     def _clear_connection_proxy_cache
       @connection_proxy_cache = {}

data/lib/active_record_host_pool/version.rb

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

data/lib/active_record_host_pool.rb

@@ -4,26 +4,18 @@ require "active_record"
 require "active_record/base"
 require "active_record/connection_adapters/abstract_adapter"
 
-module ActiveRecordHostPool
-  class << self
-    attr_accessor :loaded_db_adapter
-  end
+begin
+  require "mysql2"
+rescue LoadError
+  :noop
 end
 
-if Gem.loaded_specs.include?("mysql2")
-  require "mysql2"
-  ActiveRecordHostPool.loaded_db_adapter = :mysql2
-elsif Gem.loaded_specs.include?("trilogy")
+begin
   require "trilogy"
-  if ActiveRecord.version < Gem::Version.new("7.1")
-    require "activerecord-trilogy-adapter"
-    require "trilogy_adapter/version"
-    raise "ActiveRecordHostPool is only compatible with activerecord-trilogy-adapter v3.1+" if Gem::Version.new("3.1") > TrilogyAdapter::VERSION
-  end
-  ActiveRecordHostPool.loaded_db_adapter = :trilogy
+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,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: active_record_host_pool
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.3.1
 platform: ruby
 authors:
 - Benjamin Quorning
 - Gabe Martin-Dempesy
 - Pierre Schambacher
 - Ben Osheroff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2025-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 7.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.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
@@ -51,7 +50,7 @@ homepage: https://github.com/zendesk/active_record_host_pool
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +58,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Allow ActiveRecord to share a connection to multiple databases on the same
   host

data/lib/active_record_host_pool/clear_query_cache_patch.rb

@@ -1,45 +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
-
-  # For Rails 6.1 & 7.0.
-  module ClearOnHandlerPatch
-    def clear_on_handler(handler)
-      handler.all_connection_pools.each 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)
-when "6.1", "7.0"
-  ActiveRecord::Base.singleton_class.prepend(ActiveRecordHostPool::ClearOnHandlerPatch)
-end