active_record_host_pool 0.11.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018bdc07dc5428ae890589b96fbf3748d46ef5abc2625c61278ac50ffa079923'
-  data.tar.gz: 101a032eba4e5628106fd4ae8a83c66f52bb68d89f0baad5180ec41c83a932ab
+  metadata.gz: 5eb359cbe2626874bf6836ee5b5b1826ccf02fef7b474f81f5eec273435232d0
+  data.tar.gz: 40383e9f54da681dd340b7dba75aac65613a34fd083862bf96a905f766c9f7ea
 SHA512:
-  metadata.gz: 1ea8bf1c7704be6d72c97be06dfc084a2a66aa0e64848fcabcbbbcb6c73b360517f9737eac8d0e6459e8b6c85d236d36ea7f2a8bf8ed697a46c9d2eb0eca5d3a
-  data.tar.gz: 6eeb13fbd13582106e01bd8fc8a560eeef690d4c375926d17ebccae96b385ca8d4d3e2a75372fc99efad09e7e1bc90e06fc4417d21b3e5deada1ee940f8e347a
+  metadata.gz: 84d8eaafd2a6ebd88a42e89c8a52113b1ae3654123bf6d6735256e4787563862024af288b9755c254d445151c43d35502f52608e468beed6daad309225fb4480
+  data.tar.gz: 9a6493969b78849cea22220f562371e25a8215015ee747c5bf8ca533dfca4db21a637336c127c7abc50e6eee7d31843dd75b14fcbe7f329e461e2a24dc0fbd35

data/Readme.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/zendesk/active_record_host_pool.svg?branch=master)](https://travis-ci.org/zendesk/active_record_host_pool)
+[![Build Status](https://github.com/zendesk/active_record_host_pool/workflows/CI/badge.svg)](https://github.com/zendesk/active_record_host_pool/actions?query=workflow%3ACI)
 
 # ActiveRecord host pooling
 
@@ -17,13 +17,21 @@ 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 'travis'.
+You need a local user called 'john-doe'.
 
     mysql -uroot
-    CREATE USER 'travis'@'localhost';
-    GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX  ON *.* TO 'travis'@'localhost';
+    CREATE USER 'john-doe'@'localhost';
+    GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX  ON *.* TO 'john-doe'@'localhost';
     FLUSH PRIVILEGES;
 
+With mysql running locally, run
+
+    BUNDLE_GEMFILE=gemfiles/rails5.2.gemfile bundle exec rake test
+
+ Or
+
+    BUNDLE_GEMFILE=gemfiles/rails5.2.gemfile ruby test/test_arhp.rb --seed 19911 --verbose
+
 ## Copyright
 
 Copyright (c) 2011 Zendesk. See MIT-LICENSE for details.

data/lib/active_record_host_pool.rb

@@ -4,6 +4,7 @@ require 'active_record'
 require 'active_record/base'
 require 'active_record/connection_adapters/abstract_adapter'
 
+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'

data/lib/active_record_host_pool/connection_adapter_mixin.rb

@@ -85,46 +85,36 @@ module ActiveRecordHostPool
   end
 end
 
+# rubocop:disable Lint/DuplicateMethods
 module ActiveRecord
   module ConnectionAdapters
     class ConnectionHandler
-      if ActiveRecord::VERSION::MAJOR == 5
-        if ActiveRecord::VERSION::MINOR == 0
-          def establish_connection(spec)
-            owner_to_pool[spec.name] = ActiveRecordHostPool::PoolProxy.new(spec)
-          end
-        else
-          def establish_connection(spec)
-            resolver = ConnectionAdapters::ConnectionSpecification::Resolver.new(Base.configurations)
-            spec = resolver.spec(spec)
-
-            owner_to_pool[spec.name] = ActiveRecordHostPool::PoolProxy.new(spec)
-          end
+      case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+      when '5.1', '5.2', '6.0'
+
+        def establish_connection(spec)
+          resolver = ConnectionAdapters::ConnectionSpecification::Resolver.new(Base.configurations)
+          spec = resolver.spec(spec)
+
+          owner_to_pool[spec.name] = ActiveRecordHostPool::PoolProxy.new(spec)
         end
 
-      elsif ActiveRecord::VERSION::MAJOR == 4
+      when '4.2'
 
         def establish_connection(owner, spec)
           @class_to_pool.clear
           raise "Anonymous class is not allowed." unless owner.name
-          owner_to_pool[owner.name] = ActiveRecordHostPool::PoolProxy.new(spec)
-        end
-
-      elsif ActiveRecord::VERSION::MAJOR == 3
 
-        def establish_connection(owner, spec)
-          @connection_pools[spec] ||= ActiveRecordHostPool::PoolProxy.new(spec)
-          @class_to_pool[owner] = @connection_pools[spec]
+          owner_to_pool[owner.name] = ActiveRecordHostPool::PoolProxy.new(spec)
         end
 
       else
 
-        def establish_connection(owner, spec)
-          @connection_pools[owner] = ActiveRecordHostPool::PoolProxy.new(spec)
-        end
+        raise "Unsupported version of Rails (v#{ActiveRecord::VERSION::STRING})"
       end
     end
   end
 end
+# rubocop:enable Lint/DuplicateMethods
 
 ActiveRecord::ConnectionAdapters::Mysql2Adapter.include(ActiveRecordHostPool::DatabaseSwitch)

data/lib/active_record_host_pool/pool_proxy.rb

@@ -66,6 +66,7 @@ module ActiveRecordHostPool
     def disconnect!
       p = _connection_pool(false)
       return unless p
+
       p.disconnect!
       p.automatic_reconnect = true if p.respond_to?(:automatic_reconnect=)
       _clear_connection_proxy_cache
@@ -74,6 +75,7 @@ module ActiveRecordHostPool
     def automatic_reconnect=(value)
       p = _connection_pool(false)
       return unless p
+
       p.automatic_reconnect = value if p.respond_to?(:automatic_reconnect=)
     end
 
@@ -82,6 +84,34 @@ module ActiveRecordHostPool
       _clear_connection_proxy_cache
     end
 
+    def release_connection(*args)
+      p = _connection_pool(false)
+      return unless p
+
+      p.release_connection(*args)
+    end
+
+    def flush!
+      p = _connection_pool(false)
+      return unless p
+
+      p.flush!
+    end
+
+    def discard!
+      p = _connection_pool(false)
+      return unless p
+
+      p.discard!
+
+      # All connections in the pool (even if they're currently
+      # leased!) have just been discarded, along with the pool itself.
+      # Any further interaction with the pool (except #spec and #schema_cache)
+      # is undefined.
+      # Remove the connection for the given key so a new one can be created in its place
+      _connection_pools.delete(_pool_key)
+    end
+
     private
 
     def rescuable_errors

data/lib/active_record_host_pool/version.rb

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

data/test/database.yml

@@ -52,7 +52,7 @@ test_host_2_db_5:
   adapter: mysql2
   encoding: utf8
   database: arhp_test_4
-  username: travis
+  username: john-doe
   password:
   host: <%= mysql.host %>
   port: <%= mysql.port %>
@@ -66,3 +66,12 @@ test_host_1_db_not_there:
   password: <%= mysql.password %>
   host: <%= mysql.host %>
   reconnect: true
+
+test_host_1_db_shard:
+  adapter: mysql2
+  encoding: utf8
+  database: arhp_test_1_shard
+  username: <%= mysql.user %>
+  password: <%= mysql.password %>
+  host: <%= mysql.host %>
+  reconnect: true

data/test/helper.rb

@@ -15,15 +15,23 @@ Minitest::Test = MiniTest::Unit::TestCase unless defined?(::Minitest::Test)
 ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/test.log')
 
 Phenix.configure do |config|
-  config.skip_database = ->(name, conf) { name =~ /not_there/ || conf['username'] == 'travis' }
+  config.skip_database = ->(name, conf) { name =~ /not_there/ || conf['username'] == 'john-doe' }
 end
 
 module ARHPTestSetup
   private
 
   def arhp_create_models
-    return if Object.const_defined?('Test1')
+    return if ARHPTestSetup.const_defined?('Test1')
+
     eval <<-RUBY
+      # The placement of the Test1Shard class is important so that its
+      # connection will not be the most recent connection established
+      # for test_host_1.
+      class Test1Shard < ::ActiveRecord::Base
+        establish_connection(:test_host_1_db_shard)
+      end
+
       class Test1 < ActiveRecord::Base
         self.table_name = "tests"
         establish_connection(:test_host_1_db_1)
@@ -59,4 +67,15 @@ module ARHPTestSetup
   def current_database(klass)
     klass.connection.select_value('select DATABASE()')
   end
+
+  # Remove a method from a given module that fixes something.
+  # Execute the passed in block.
+  # Re-add the method back to the module.
+  def without_module_patch(mod, method_name)
+    method_body = mod.instance_method(method_name)
+    mod.remove_method(method_name)
+    yield if block_given?
+  ensure
+    mod.define_method(method_name, method_body)
+  end
 end

data/test/schema.rb

@@ -2,7 +2,15 @@
 
 require_relative 'helper'
 ActiveRecord::Schema.define(version: 1) do
-  create_table 'tests' do |t|
+  create_table 'tests', force: true do |t|
     t.string   'val'
   end
+
+  # Add a table only the shard database will have. Conditional
+  # exists since Phenix loads the schema file for every database.
+  if ActiveRecord::Base.connection.current_database == 'arhp_test_1_shard'
+    create_table 'test1_shards' do |t|
+      t.string 'name'
+    end
+  end
 end

data/test/test_arhp.rb

@@ -13,6 +13,23 @@ class ActiveRecordHostPoolTest < Minitest::Test
     Phenix.burn!
   end
 
+  def test_process_forking_with_connections
+    # Ensure we have a connection already
+    assert_equal(true, ActiveRecord::Base.connected?)
+
+    # Verify that when we fork, the process doesn't crash
+    pid = Process.fork do
+      if ActiveRecord.version >= Gem::Version.new('5.2')
+        assert_equal(false, ActiveRecord::Base.connected?) # New to Rails 5.2
+      else
+        assert_equal(true, ActiveRecord::Base.connected?)
+      end
+    end
+    Process.wait(pid)
+    # Cleanup any connections we may have left around
+    ActiveRecord::Base.connection_handler.clear_all_connections!
+  end
+
   def test_models_with_matching_hosts_should_share_a_connection
     assert_equal(Test1.connection.raw_connection, Test2.connection.raw_connection)
     assert_equal(Test3.connection.raw_connection, Test4.connection.raw_connection)
@@ -38,6 +55,38 @@ class ActiveRecordHostPoolTest < Minitest::Test
     assert_action_uses_correct_database(:insert, "insert into tests values(NULL, 'foo')")
   end
 
+  def test_models_with_matching_hosts_and_non_matching_databases_should_share_a_connection
+    simulate_rails_app_active_record_railties
+    assert_equal(Test1.connection.raw_connection, Test1Shard.connection.raw_connection)
+  end
+
+  if ActiveRecord.version >= Gem::Version.new('6.0')
+    def test_models_with_matching_hosts_and_non_matching_databases_issue_exists_without_arhp_patch
+      simulate_rails_app_active_record_railties
+
+      # Remove patch that fixes an issue in Rails 6+ to ensure it still
+      # exists. If this begins to fail then it may mean that Rails has fixed
+      # the issue so that it no longer occurs.
+      without_module_patch(ActiveRecordHostPool::ClearQueryCachePatch, :clear_query_caches_for_current_thread) do
+        exception = assert_raises(ActiveRecord::StatementInvalid) do
+          ActiveRecord::Base.cache { Test1Shard.create! }
+        end
+
+        assert_equal("Mysql2::Error: Table 'arhp_test_2.test1_shards' doesn't exist", exception.message)
+      end
+    end
+
+    def test_models_with_matching_hosts_and_non_matching_databases_do_not_mix_up_underlying_database
+      simulate_rails_app_active_record_railties
+
+      # ActiveRecord 6.0 introduced a change that surfaced a problematic code
+      # path in active_record_host_pool when clearing caches across connection
+      # handlers which can cause the database to change.
+      # See ActiveRecordHostPool::ClearQueryCachePatch
+      ActiveRecord::Base.cache { Test1Shard.create! }
+    end
+  end
+
   def test_connection_returns_a_proxy
     assert_kind_of ActiveRecordHostPool::ConnectionProxy, Test1.connection
   end
@@ -146,14 +195,33 @@ class ActiveRecordHostPoolTest < Minitest::Test
     assert_equal expected_database, current_database(switch_to_klass)
   end
 
+  def test_release_connection
+    pool = ActiveRecord::Base.connection_pool
+    conn = pool.connection
+    pool.expects(:checkin).with(conn)
+    pool.release_connection
+  end
+
   private
 
   def assert_action_uses_correct_database(action, sql)
     (1..4).each do |i|
-      klass = eval "Test#{i}"
+      klass = ARHPTestSetup.const_get("Test#{i}")
       desired_db = "arhp_test_#{i}"
       klass.connection.send(action, sql)
       assert_equal desired_db, current_database(klass)
     end
   end
+
+  def simulate_rails_app_active_record_railties
+    if ActiveRecord.version >= Gem::Version.new('6.0')
+      # Necessary for testing ActiveRecord 6.0 which uses the connection
+      # handlers when clearing query caches across all handlers when
+      # an operation that dirties the cache is involved (e.g. create/insert,
+      # update, delete/destroy, truncate, etc.)
+      ActiveRecord::Base.connection_handlers = {
+        ActiveRecord::Base.writing_role => ActiveRecord::Base.default_connection_handler
+      }
+    end
+  end
 end

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: active_record_host_pool
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.2
 platform: ruby
 authors:
+- Benjamin Quorning
+- Gabe Martin-Dempesy
+- Pierre Schambacher
 - Ben Osheroff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +19,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -104,16 +107,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.80.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -128,23 +131,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: wwtd
-  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'
 description: ''
 email:
-- ben@gimbo.net
+- bquorning@zendesk.com
+- gabe@zendesk.com
+- pschambacher@zendesk.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -166,7 +157,7 @@ homepage: https://github.com/zendesk/active_record_host_pool
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: Allow ActiveRecord to share a connection to multiple databases on the same
   host