replica_pools 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 462aae1dab48a6627d29f3181b50f1c3308dad3ba815a29bb42f99e8a5e8d52f
-  data.tar.gz: 6104dc1df24757864e2be2db306c2dd52781453c80c6c7b268e2302659766a90
+  metadata.gz: 1af9dd473884c12967be5648f4ff8e1cc2a029544bb27a76f7166698215b45f5
+  data.tar.gz: be05c7e623ec0cae9b3d6841edb6a6e5de1ada29c79a5f11854fc98000e63f7e
 SHA512:
-  metadata.gz: d023920b32b935399f3ecf0ee44d74a1050a63c836ce3ea56ce22046b09994aa490df66d0c3ba5d1b578e8fbdf70470158028612f2f1c3fac883c72aeb7713cf
-  data.tar.gz: 8bfe386f6d12b1a706852cc734f3eef33dcf6c686a1726bebf628bee42b0e57030abb9ac58afa67ba579d22e118bf2a49b4e37c182367d536bff8b2990518543
+  metadata.gz: 99628a0df9823b14dae7a3dd2bd7d8ecb8e0333827616e06a56a352024fe27b89e6521af6a06e7dda243c92884aeb75437c8faad573c9598b7468e0fac1a87e3
+  data.tar.gz: e2ea27e89f05990765bb7025508ed590030f86763a44066f4f4372ec4239a71718fa0267e87b1027b0d0fb4ef4282dee24d2d1ec594a51d593d24be93ea7552e

data/README.md

@@ -2,8 +2,7 @@
 
 Easy Single Leader / Multiple Replica Setup for use in Ruby/Rails projects
 
-[![Build
-Status](https://travis-ci.org/kickstarter/replica_pools.png?branch=owningit)](https://travis-ci.org/kickstarter/replica_pools)
+[![Spec](https://github.com/kickstarter/replica_pools/actions/workflows/spec.yml/badge.svg)](https://github.com/kickstarter/replica_pools/actions/workflows/spec.yml)
 
 ## Overview
 
@@ -11,22 +10,22 @@ ReplicaPools replaces ActiveRecord's connection with a proxy that routes databas
 
 ReplicaPools also provides helpers so you can customize your replica strategy. You can organize replicas into pools and cycle through them (e.g. in a before_filter). You can make the connection default to the leader, or the default replica pool, and then use block helpers to temporarily change the behavior (e.g. in an around_filter).
 
-* Uses a naming convention in database.yml to designate replica pools.
-* Defaults to a given replica pool, but may also be configured to default to leader.
-* Routes database interactions (queries) to the right connection
-  * Whitelisted queries go to the current connection (might be a replica).
-  * All queries inside a transaction run on leader.
-  * All other queries are also sent to the leader connection.
-* Supports ActiveRecord's in-memory query caching.
-* Helper methods can be used to easily load balance replicas, route traffic to different replica pools, or run directly against leader. (examples below)
+- Uses a naming convention in database.yml to designate replica pools.
+- Defaults to a given replica pool, but may also be configured to default to leader.
+- Routes database interactions (queries) to the right connection
+  - Whitelisted queries go to the current connection (might be a replica).
+  - All queries inside a transaction run on leader.
+  - All other queries are also sent to the leader connection.
+- Supports ActiveRecord's in-memory query caching.
+- Helper methods can be used to easily load balance replicas, route traffic to different replica pools, or run directly against leader. (examples below)
 
 ## Not Supported
 
-* Sharding.
-* Automatic load balancing strategies.
-* Replica weights. You can accomplish this in your own load balancing strategy.
-* Whitelisting models that always use leader.
-* Blacklisting poorly performing replicas. This could cause load spikes on your leader. Whatever provisions your database.yml should make this choice.
+- Sharding.
+- Automatic load balancing strategies.
+- Replica weights. You can accomplish this in your own load balancing strategy.
+- Whitelisting models that always use leader.
+- Blacklisting poorly performing replicas. This could cause load spikes on your leader. Whatever provisions your database.yml should make this choice.
 
 ## Installation and Setup
 
@@ -166,7 +165,7 @@ To disable queries to the leader database -- for instance, in a production
 console -- set the disable_leader configuration to false. This will raise
 a ReplicaPools::LeaderDisabled error:
 
-  ReplicaPools.config.disable_leader = false
+ReplicaPools.config.disable_leader = false
 
 ## Running specs
 
@@ -194,7 +193,7 @@ First bump the version as appropriate in `lib/replica_pools/version.rb` and then
 
 Author: Dan Drabik, Lance Ivy
 
-Copyright (c) 2012-2019, Kickstarter
+Copyright (c) 2012-2021, Kickstarter
 
 Released under the MIT license
 
@@ -204,10 +203,10 @@ Released under the MIT license
 
 The project is based on:
 
-* https://github.com/schoefmax/multi_db
+- https://github.com/schoefmax/multi_db
 
 ### Masochism
 
 The original leader/replica plugin:
 
-* http://github.com/technoweenie/masochism
+- http://github.com/technoweenie/masochism

data/lib/replica_pools/connection_proxy.rb

@@ -11,26 +11,18 @@ module ReplicaPools
     class << self
       def generate_safe_delegations
         ReplicaPools.config.safe_methods.each do |method|
-          generate_safe_delegation(method) unless instance_methods.include?(method)
+          self.define_method(method) do |*args, &block|
+            route_to(current, method, *args, &block)
+          end unless instance_methods.include?(method)
         end
       end
-
-      protected
-
-      def generate_safe_delegation(method)
-        class_eval <<-END, __FILE__, __LINE__ + 1
-          def #{method}(*args, &block)
-            route_to(current, :#{method}, *args, &block)
-          end
-        END
-      end
     end
 
     def initialize(leader, pools)
-      @leader       = leader
-      @replica_pools  = pools
-      @leader_depth = 0
-      @current_pool = default_pool
+      @leader        = leader
+      @replica_pools = pools
+      @leader_depth  = 0
+      @current_pool  = default_pool
 
       if ReplicaPools.config.defaults_to_leader
         @current = leader
@@ -41,7 +33,7 @@ module ReplicaPools
       # this ivar is for ConnectionAdapter compatibility
       # some gems (e.g. newrelic_rpm) will actually use
       # instance_variable_get(:@config) to find it.
-      @config = current.connection_config
+      @config = current.connection_db_config
     end
 
     def with_pool(pool_name = 'default')
@@ -91,7 +83,13 @@ module ReplicaPools
     # Safe methods have been generated during `setup!`.
     # Creates a method to speed up subsequent calls.
     def method_missing(method, *args, &block)
-      generate_unsafe_delegation(method)
+      self.class.define_method(method) do |*args, &block|
+        route_to(leader, method, *args, &block).tap do
+          if %i[insert delete update].include?(method)
+            leader.retrieve_connection.clear_query_cache
+          end
+        end
+      end
       send(method, *args, &block)
     end
 
@@ -99,14 +97,6 @@ module ReplicaPools
       leader_depth > 0
     end
 
-    def generate_unsafe_delegation(method)
-      self.class_eval <<-END, __FILE__, __LINE__ + 1
-        def #{method}(*args, &block)
-          route_to(leader, :#{method}, *args, &block)
-        end
-      END
-    end
-
     def route_to(conn, method, *args, &block)
       raise ReplicaPools::LeaderDisabled.new if ReplicaPools.config.disable_leader && conn == leader
       conn.retrieve_connection.send(method, *args, &block)

data/lib/replica_pools/engine.rb

@@ -10,26 +10,70 @@ module ReplicaPools
 
       ReplicaPools.config.safe_methods =
         if ActiveRecord::VERSION::MAJOR == 3
-          [
-            :select_all, :select_one, :select_value, :select_values,
-            :select_rows, :select, :verify!, :raw_connection, :active?, :reconnect!,
-            :disconnect!, :reset_runtime, :log, :log_info
+          %i[
+            active?
+            disconnect!
+            log
+            log_info
+            raw_connection
+            reconnect!
+            reset_runtime
+            select
+            select_all
+            select_one
+            select_rows
+            select_value
+            select_values
+            verify!
           ]
         elsif ActiveRecord::VERSION::MAJOR == 4
-          [
-            :select_all, :select_one, :select_value, :select_values,
-            :select_rows, :select, :verify!, :raw_connection, :active?, :reconnect!,
-            :disconnect!, :reset_runtime, :log
+          %i[
+            active?
+            disconnect!
+            log
+            raw_connection
+            reconnect!
+            reset_runtime
+            select
+            select_all
+            select_one
+            select_rows
+            select_value
+            select_values
+            verify!
           ]
         elsif [5, 6].include?(ActiveRecord::VERSION::MAJOR)
-          [
-           :select_all, :select_one, :select_value, :select_values,
-           :select_rows, :select, :select_prepared, :verify!, :raw_connection,
-           :active?, :reconnect!, :disconnect!, :reset_runtime, :log,
-           :lookup_cast_type_from_column, :sanitize_limit,
-           :combine_bind_parameters, :quote_table_name, :quote, :quote_column_names, :quote_table_names, :table_alias_for,
-           :case_sensitive_comparison, :case_insensitive_comparison,
-           :schema_cache, :cacheable_query, :prepared_statements, :clear_cache!, :column_name_for_operation
+          %i[
+           active?
+           cacheable_query
+           case_insensitive_comparison
+           case_sensitive_comparison
+           clear_cache!
+           column_name_for_operation
+           column_name_with_order_matcher
+           combine_bind_parameters
+           disconnect!
+           log
+           lookup_cast_type_from_column
+           prepared_statements
+           quote
+           quote_column_names
+           quote_table_name
+           quote_table_names
+           raw_connection
+           reconnect!
+           reset_runtime
+           sanitize_limit
+           schema_cache
+           select
+           select_all
+           select_one
+           select_prepared
+           select_rows
+           select_value
+           select_values
+           table_alias_for
+           verify!
           ]
         else
           warn "Unsupported ActiveRecord version #{ActiveRecord.version}. Please whitelist the safe methods."

data/lib/replica_pools/pools.rb

@@ -6,12 +6,12 @@ module ReplicaPools
 
     def initialize
       pools = {}
-      pool_configurations.group_by{|_, name, _| name }.each do |name, set|
+      pool_configurations.group_by{ |_, name, _| name }.each do |name, set|
         pools[name.to_sym] = ReplicaPools::Pool.new(
           name,
-          set.map{ |conn_name, _, replica_name|
+          set.map do |conn_name, _, replica_name|
             connection_class(name, replica_name, conn_name)
-          }
+          end
         )
       end
 
@@ -36,7 +36,9 @@ module ReplicaPools
     def config_hash
       if ActiveRecord::VERSION::MAJOR >= 6
         # in Rails >= 6, `configurations` is an instance of ActiveRecord::DatabaseConfigurations
-        ActiveRecord::Base.configurations.to_h
+        ActiveRecord::Base.configurations.configs_for.map do |c|
+          [c.env_name, c.configuration_hash.transform_keys(&:to_s)]
+        end.to_h
       else
         # in Rails < 6, it's just a hash
         ActiveRecord::Base.configurations
@@ -47,16 +49,16 @@ module ReplicaPools
     def connection_class(pool_name, replica_name, connection_name)
       class_name = "#{pool_name.camelize}#{replica_name.camelize}"
 
-      ReplicaPools.module_eval %Q{
-        class #{class_name} < ActiveRecord::Base
-          self.abstract_class = true
-          establish_connection :#{connection_name}
-          def self.connection_config
-            configurations[#{connection_name.to_s.inspect}]
-          end
+      ReplicaPools.const_set(class_name, Class.new(ActiveRecord::Base) do |c|
+        c.abstract_class = true
+        c.define_singleton_method(:connection_config) do
+          configurations.configs_for(connection_name.to_s)
         end
-      }, __FILE__, __LINE__
-      ReplicaPools.const_get(class_name)
+      end)
+
+      ReplicaPools.const_get(class_name).tap do |c|
+        c.establish_connection(connection_name.to_sym)
+      end
     end
   end
 end

data/lib/replica_pools/query_cache.rb

@@ -10,11 +10,9 @@ module ReplicaPools
 
     # these methods can all use the leader connection
     (query_cache_methods - [:select_all]).each do |method_name|
-      module_eval <<-END, __FILE__, __LINE__ + 1
-        def #{method_name}(*a, &b)
-          ActiveRecord::Base.connection.#{method_name}(*a, &b)
-        end
-      END
+      define_method(method_name) do |*args, &block|
+        ActiveRecord::Base.connection.send(method_name, *args, &block)
+      end
     end
 
     # select_all is trickier. it needs to use the leader
@@ -24,6 +22,8 @@ module ReplicaPools
       # there may be more args for Rails 5.0+, but we only care about arel, name, and binds for caching.
       relation, name, raw_binds = args
 
+      # Rails 6.2 breaks this method as locked? is no longer available
+      # https://github.com/kickstarter/replica_pools/issues/26
       if !query_cache_enabled || locked?(relation)
         return route_to(current, :select_all, *args)
       end
@@ -32,7 +32,7 @@ module ReplicaPools
       if raw_binds.blank? && relation.is_a?(ActiveRecord::Relation)
         arel, binds = relation.arel, relation.bind_values
       else
-        arel, binds = relation, raw_binds
+        arel, binds = relation, Array(raw_binds)
       end
 
       sql = to_sql(arel, binds)

data/lib/replica_pools/version.rb

@@ -1,3 +1,3 @@
 module ReplicaPools
-  VERSION = "2.2.0"
+  VERSION = "2.3.1"
 end

data/lib/replica_pools.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 require 'active_record'
 require 'replica_pools/config'
 require 'replica_pools/pool'
@@ -64,7 +66,7 @@ module ReplicaPools
     end
 
     def logger
-      ActiveRecord::Base.logger
+      ActiveRecord::Base.logger || Logger.new(STDOUT)
     end
   end
 end

data/spec/query_cache_spec.rb

@@ -1,5 +1,6 @@
 require 'rack'
 require_relative 'spec_helper'
+require_relative 'config/test_model'
 
 describe ReplicaPools::QueryCache do
   before(:each) do
@@ -103,4 +104,16 @@ describe ReplicaPools::QueryCache do
       end
     end
   end
+
+  describe '.pluck regression test' do
+    it 'should work with query caching' do
+      TestModel.connection.enable_query_cache!
+      expect(TestModel.pluck(:id).count).to eql TestModel.all.count
+    end
+
+    it 'should work if query cache is not enabled' do
+      TestModel.connection.disable_query_cache!
+      expect(TestModel.pluck(:id).count).to eql TestModel.all.count
+    end
+  end
 end

metadata

@@ -1,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: replica_pools
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Dan Drabik
 - Lance Ivy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.12
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.12
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Connection proxy for ActiveRecord for leader / replica setups.
 email: dan@kickstarter.com
 executables: []
@@ -123,7 +137,7 @@ homepage: https://github.com/kickstarter/replica_pools
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '1.2'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Connection proxy for ActiveRecord for leader / replica setups.
 test_files: