active_record_host_pool 0.12.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 902e5e0cb2f51303355efa11fe7d25d357d6c9560310cab1e3e6bc5c0ad1758b
-  data.tar.gz: 9584c62c0572915b4de0aff99b2449a787c6236d3828e3858b6a6c2079ef1882
+  metadata.gz: 5238d6f59f78811a9e9972e613562d674d1137604438b46d0ef3b9a3eb1fa437
+  data.tar.gz: 937e6d46772dc13b3b6faa62841053252aae17f92f8ef205b63927345408ed65
 SHA512:
-  metadata.gz: 400906a1082b28c51d7bbcd3efffed956e4e26ce46c8bc2e71a73431ce1028eafcbfef06a0b3a220647ea3e5865b1d9ac8b2dd34960bba76d7ca059339daaf0a
-  data.tar.gz: 8094cbe8a0497f5d16cb7caa27953d4e78e2945cd46f53e00912654b2fff7cb447c8dc323b0faeebc74f3c425bd9e6a2b86f4546485e46171616a3cd2b6f10e3
+  metadata.gz: bdbd8abf041ad7960996bbd0432fc19c90c0ae0c41328069798c401929cca9c3b9dd510f7160ab833895962b12e86937bf8eb592d851bea2197b94fcdf57b95a
+  data.tar.gz: '068fff2a8be21b0e1ca192a49967c352d90b5c81aae27c11f36128ec825b4c03a9087f56269b10ca2cf406ddea445dc48662110284f1a3870eb4d48df0ceba7b'

data/Readme.md

@@ -1,4 +1,4 @@
-[![Build status](https://circleci.com/gh/zendesk/active_record_host_pool.svg?style=svg)](https://circleci.com/gh/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
 
@@ -24,6 +24,14 @@ You need a local user called 'john-doe'.
     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/clear_query_cache_patch.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+if ActiveRecord.version >= Gem::Version.new('6.0')
+  module ActiveRecordHostPool
+    # 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 ClearQueryCachePatch
+      def clear_query_caches_for_current_thread
+        host_pool_current_database_was = connection.unproxied._host_pool_current_database
+        super
+      ensure
+        # restore in case clearing the cache changed the database
+        connection.unproxied._host_pool_current_database = host_pool_current_database_was
+      end
+    end
+  end
+
+  ActiveRecord::Base.singleton_class.prepend ActiveRecordHostPool::ClearQueryCachePatch
+end

data/lib/active_record_host_pool/connection_adapter_mixin.rb

@@ -85,22 +85,21 @@ module ActiveRecordHostPool
   end
 end
 
+# rubocop:disable Lint/DuplicateMethods
 module ActiveRecord
   module ConnectionAdapters
     class ConnectionHandler
-      if ActiveRecord::VERSION::MAJOR == 5
-        if ActiveRecord::VERSION::MINOR == 0
-          raise "Unsupported version of Rails (v#{ActiveRecord::VERSION::STRING})"
-        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
@@ -116,5 +115,6 @@ module ActiveRecord
     end
   end
 end
+# rubocop:enable Lint/DuplicateMethods
 
 ActiveRecord::ConnectionAdapters::Mysql2Adapter.include(ActiveRecordHostPool::DatabaseSwitch)

data/lib/active_record_host_pool/pool_proxy.rb

@@ -84,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.12.0"
+  VERSION = "1.0.3"
 end

data/test/database.yml

@@ -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

@@ -25,6 +25,13 @@ module ARHPTestSetup
     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)
@@ -60,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,6 +195,13 @@ 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)
@@ -156,4 +212,16 @@ class ActiveRecordHostPoolTest < Minitest::Test
       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,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: active_record_host_pool
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Benjamin Quorning
 - Gabe Martin-Dempesy
 - Pierre Schambacher
 - Ben Osheroff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-21 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -22,7 +22,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -32,7 +32,7 @@ dependencies:
         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
@@ -109,14 +109,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 0.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 0.80.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +145,7 @@ 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
@@ -157,7 +158,7 @@ homepage: https://github.com/zendesk/active_record_host_pool
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-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