active_record_host_pool 2.1.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ba0aa0ff3c0b19e4895118e76f84cc57f46481baa482c59925946ecd56765bb
-  data.tar.gz: e276dbda95168a03b511a5d7da14f94411ca7b8bc910ea2684631f25c9a22cf1
+  metadata.gz: 1b17ac5ef20d2f62f857a6a4a7d62ff801767e00c1d5e72b0ec05c9c9818c004
+  data.tar.gz: a7a6b9847c9fda19f32c0929f1a99a5362c22193b550b45602d9d8dde7efde27
 SHA512:
-  metadata.gz: 5b455f5fd116f96035fa816b39e0baf7f698d885decece79fd213c690c07db6b2f54e2328d4fa8dab68c536e86b58a9261b3c1a4c8aa45ccf35c1cb7b237168e
-  data.tar.gz: aa7295a9be8e2892ff34452de014ea7627255d58e6eccd6a0d4a18d3b03152adb18fb2e453df017a058eeaf26bf8d4a768db3e436cef7da498f69e03d5f50917
+  metadata.gz: 4d9acc6b59e50dcbeea61b75ed8f3428487ce287136c0cc95b314eb871bfff39ff7380abd779e07870d8388d775864e13d4c3b56dd91be3723904a35618c5afa
+  data.tar.gz: 96e926441b4e9c70fe7ffbe2f46d76eb8ab729438fa01e967eabcfe043073c928c18c3984d51cb644d6bbcef99fd6cc0d57e23af671fda2fea4665acfdbe4a94

data/Changelog.md

@@ -6,6 +6,57 @@ and as of v1.0.0 this project adheres to [Semantic Versioning](https://semver.or
 
 ## [Unreleased]
 
+## [4.1.0]
+
+### Changed
+- Remove dependency on `mutex_m`, instead using `Thread::Mutex` directly.
+
+## [4.0.0]
+
+### Changed
+- Moved `select_db` inside of the `with_raw_connection` block of the `#raw_execute` method. This should allow for using Rails' built-in reconnect & retry logic with the Trilogy adapter or Rails 7.1+.
+- In Rails 7.1+, when a new ConnectionProxy is instantiated the database switch is lazily triggered by the subsequent database query instead of immediately.
+
+### Removed
+- Calling `#clean!` and `#verified!` on connections because it is no longer necessary.
+
+## [3.2.0]
+
+### Added
+- Calls `#verified!` on the connection after `#clean!`.
+
+## [3.1.1]
+
+### Fixed
+- A typo causing `#clean!` to not run.
+
+## [3.1.0]
+
+### Added
+- Calls `#clean!` on the connection after switching databases.
+
+## [3.0.0]
+
+### Added
+- Support and testing for Rails 7.2 & Rails main.
+
+### Removed
+- Support for ActiveRecord's legacy connection handling.
+
+## [2.2.0]
+
+### Removed
+- Support for Ruby 3.0.
+
+### Added
+- Rails 6.1 testing with Trilogy.
+
+### Fixed
+- Fixed using ActiveRecordHostPool and the `activerecord-trilogy-adapter v3.1+`.
+
+### Changed
+-  ActiveRecordHostPool will now raise an exception if you try to use a version of `activerecord-trilogy-adapter < 3.1`.
+
 ## [2.1.0]
 
 ### Changed

data/lib/active_record_host_pool/connection_adapter_mixin.rb

@@ -7,9 +7,8 @@ when :trilogy
   case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
   when "6.1", "7.0"
     require "trilogy_adapter/connection"
-    require "trilogy_adapter/errors"
     ActiveRecord::Base.extend(TrilogyAdapter::Connection)
-  when "7.1"
+  when "7.1", "7.2", "8.0", "8.1"
     require "active_record/connection_adapters/trilogy_adapter"
   else
     raise "Unsupported version of Rails (v#{ActiveRecord::VERSION::STRING})"
@@ -18,31 +17,34 @@ end
 
 module ActiveRecordHostPool
   module DatabaseSwitch
-    attr_reader :_host_pool_current_database
+    attr_reader :_host_pool_desired_database
     def initialize(*)
       @_cached_current_database = nil
       super
     end
 
-    def _host_pool_current_database=(database)
-      @_host_pool_current_database = database
-      @config[:database] = _host_pool_current_database
+    def _host_pool_desired_database=(database)
+      @_host_pool_desired_database = database
+      @config[:database] = _host_pool_desired_database
     end
 
     if ActiveRecord.version >= Gem::Version.new("7.1")
-      # Patch `raw_execute` instead of `execute` since this commit:
-      # https://github.com/rails/rails/commit/f69bbcbc0752ca5d5af327d55922614a26f5c7e9
-      def raw_execute(...)
-        if _host_pool_current_database && !_no_switch
-          _switch_connection
+      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
-        super
       end
     else
       def execute(...)
-        if _host_pool_current_database && !_no_switch
-          _switch_connection
-        end
+        _switch_connection(raw_connection) if _host_pool_desired_database && !_no_switch
         super
       end
     end
@@ -71,31 +73,50 @@ module ActiveRecordHostPool
 
     attr_accessor :_no_switch
 
-    def _switch_connection
-      if _host_pool_current_database &&
+    def _switch_connection(real_connection)
+      if _host_pool_desired_database &&
           (
-            (_host_pool_current_database != @_cached_current_database) ||
-            @connection.object_id != @_cached_connection_object_id
-          )
-        log("select_db #{_host_pool_current_database}", "SQL") do
+           _desired_database_changed? ||
+            _real_connection_changed?
+         )
+        log("select_db #{_host_pool_desired_database}", "SQL") do
           clear_cache!
-          raw_connection.select_db(_host_pool_current_database)
+          real_connection.select_db(_host_pool_desired_database)
         end
-        @_cached_current_database = _host_pool_current_database
-        @_cached_connection_object_id = @connection.object_id
+        @_cached_current_database = _host_pool_desired_database
+        @_cached_connection_object_id = _real_connection_object_id
+      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
     end
+    # rubocop:enable Lint/DuplicateMethods
+
+    def _real_connection_changed?
+      _real_connection_object_id != @_cached_connection_object_id
+    end
 
     # prevent different databases from sharing the same query cache
     def cache_sql(sql, *args)
-      super(_host_pool_current_database.to_s + "/" + sql, *args)
+      super(_host_pool_desired_database.to_s + "/" + sql, *args)
     end
   end
 
   module PoolConfigPatch
     def pool
-      ActiveSupport::ForkTracker.check!
-
       @pool || synchronize { @pool ||= ActiveRecordHostPool::PoolProxy.new(self) }
     end
   end

data/lib/active_record_host_pool/connection_proxy.rb

@@ -14,7 +14,7 @@ module ActiveRecordHostPool
     end
 
     def __getobj__
-      @cx._host_pool_current_database = @database
+      @cx._host_pool_desired_database = @database
       @cx
     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,8 +15,6 @@ require "mutex_m"
 module ActiveRecordHostPool
   # Sits between ConnectionHandler and a bunch of different ConnectionPools (one per host).
   class PoolProxy < Delegator
-    include Mutex_m
-
     case ActiveRecordHostPool.loaded_db_adapter
     when :mysql2
       RESCUABLE_DB_ERROR = Mysql2::Error
@@ -26,9 +23,10 @@ module ActiveRecordHostPool
     end
 
     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,17 +41,35 @@ module ActiveRecordHostPool
 
     attr_reader :pool_config
 
-    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
+    # 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)
+      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 _unproxied_connection(*args)
+        _connection_pool.lease_connection(*args)
+      end
     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
@@ -67,18 +83,55 @@ module ActiveRecordHostPool
       _connection_pool.checkin(cx)
     end
 
-    def with_connection
-      cx = checkout
-      yield cx
-    ensure
-      checkin cx
+    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 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
     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
@@ -164,12 +217,7 @@ module ActiveRecordHostPool
         @connection_proxy_cache ||= {}
         key = [connection, database]
 
-        @connection_proxy_cache[key] ||= begin
-          cx = ActiveRecordHostPool::ConnectionProxy.new(connection, database)
-          cx.raw_execute("SELECT 1", "ARHP SWITCH DB")
-
-          cx
-        end
+        @connection_proxy_cache[key] ||= ActiveRecordHostPool::ConnectionProxy.new(connection, database)
       end
     end
     # standard:enable Lint/DuplicateMethods

data/lib/active_record_host_pool/version.rb

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

data/lib/active_record_host_pool.rb

@@ -15,7 +15,11 @@ if Gem.loaded_specs.include?("mysql2")
   ActiveRecordHostPool.loaded_db_adapter = :mysql2
 elsif Gem.loaded_specs.include?("trilogy")
   require "trilogy"
-  require "activerecord-trilogy-adapter" if ActiveRecord.version < Gem::Version.new("7.1")
+  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
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_host_pool
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Benjamin Quorning
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-19 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -20,9 +20,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,9 +27,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
 description: ''
 email:
 - bquorning@zendesk.com
@@ -65,14 +59,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Allow ActiveRecord to share a connection to multiple databases on the same