active_record_shards 3.16.0 → 3.19.1

data/lib/active_record_shards/default_replica_patches.rb

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+module ActiveRecordShards
+  module DefaultReplicaPatches
+    def self.wrap_method_in_on_replica(class_method, base, method, force_on_replica: false)
+      base_methods =
+        if class_method
+          base.methods + base.private_methods
+        else
+          base.instance_methods + base.private_instance_methods
+        end
+
+      return unless base_methods.include?(method)
+
+      _, method, punctuation = method.to_s.match(/^(.*?)([\?\!]?)$/).to_a
+      # _ALWAYS_ on replica, or only for on `on_replica_by_default = true` models?
+      wrapper = force_on_replica ? 'force_on_replica' : 'on_replica_unless_tx'
+      base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        #{class_method ? 'class << self' : ''}
+          def #{method}_with_default_replica#{punctuation}(*args, &block)
+            #{wrapper} do
+              #{method}_without_default_replica#{punctuation}(*args, &block)
+            end
+          end
+
+          alias_method :#{method}_without_default_replica#{punctuation}, :#{method}#{punctuation}
+          alias_method :#{method}#{punctuation}, :#{method}_with_default_replica#{punctuation}
+        #{class_method ? 'end' : ''}
+      RUBY
+    end
+
+    def self.wrap_method_in_on_slave(*args)
+      ActiveRecordShards::Deprecation.deprecation_warning(
+        :'self.wrap_method_in_on_slave',
+        :'self.wrap_method_in_on_replica'
+      )
+      wrap_method_in_on_replica(*args)
+    end
+
+    def transaction_with_replica_off(*args, &block)
+      if on_replica_by_default?
+        begin
+          old_val = Thread.current[:_active_record_shards_in_tx]
+          Thread.current[:_active_record_shards_in_tx] = true
+          transaction_without_replica_off(*args, &block)
+        ensure
+          Thread.current[:_active_record_shards_in_tx] = old_val
+        end
+      else
+        transaction_without_replica_off(*args, &block)
+      end
+    end
+    alias_method :transaction_with_slave_off, :transaction_with_replica_off
+
+    module InstanceMethods
+      # fix ActiveRecord to do the right thing, and use our aliased quote_value
+      def quote_value(*args, &block)
+        self.class.quote_value(*args, &block)
+      end
+
+      def on_replica_unless_tx
+        self.class.on_replica_unless_tx { yield }
+      end
+    end
+
+    CLASS_REPLICA_METHODS = [
+      :calculate,
+      :count_by_sql,
+      :exists?,
+      :find,
+      :find_by,
+      :find_by_sql,
+      :find_every,
+      :find_one,
+      :find_some,
+      :get_primary_key
+    ].freeze
+
+    CLASS_FORCE_REPLICA_METHODS = [
+      :replace_bind_variable,
+      :replace_bind_variables,
+      :sanitize_sql_array,
+      :sanitize_sql_hash_for_assignment,
+      :table_exists?
+    ].freeze
+
+    CLASS_SLAVE_METHODS = CLASS_REPLICA_METHODS
+    CLASS_FORCE_SLAVE_METHODS = CLASS_FORCE_REPLICA_METHODS
+
+    def self.extended(base)
+      CLASS_REPLICA_METHODS.each { |m| ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(true, base, m) }
+      CLASS_FORCE_REPLICA_METHODS.each { |m| ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(true, base, m, force_on_replica: true) }
+
+      if ActiveRecord::VERSION::MAJOR >= 5
+        ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(true, base, :load_schema!, force_on_replica: true)
+      else
+        ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(true, base, :columns, force_on_replica: true)
+      end
+
+      ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(false, base, :reload)
+
+      base.class_eval do
+        include InstanceMethods
+
+        class << self
+          alias_method :transaction_without_replica_off, :transaction
+          alias_method :transaction, :transaction_with_replica_off
+        end
+      end
+    end
+
+    def on_replica_unless_tx(&block)
+      return yield if Thread.current[:_active_record_shards_in_migration]
+      return yield if Thread.current[:_active_record_shards_in_tx]
+
+      if on_replica_by_default?
+        on_replica(&block)
+      else
+        yield
+      end
+    end
+    alias_method :on_slave_unless_tx, :on_replica_unless_tx
+
+    def force_on_replica(&block)
+      return yield if Thread.current[:_active_record_shards_in_migration]
+
+      on_cx_switch_block(:replica, construct_ro_scope: false, force: true, &block)
+    end
+
+    module ActiveRelationPatches
+      def self.included(base)
+        [:calculate, :exists?, :pluck, :load].each do |m|
+          ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(false, base, m)
+        end
+
+        if ActiveRecord::VERSION::MAJOR == 4
+          # `where` and `having` clauses call `create_binds`, which will use the primary connection
+          ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(false, base, :create_binds, force_on_replica: true)
+        end
+
+        ActiveRecordShards::DefaultReplicaPatches.wrap_method_in_on_replica(false, base, :to_sql, force_on_replica: true)
+      end
+
+      def on_replica_unless_tx
+        @klass.on_replica_unless_tx { yield }
+      end
+    end
+
+    module Rails52RelationPatches
+      def connection
+        return super if Thread.current[:_active_record_shards_in_migration]
+        return super if Thread.current[:_active_record_shards_in_tx]
+
+        if @klass.on_replica_by_default?
+          @klass.on_replica.connection
+        else
+          super
+        end
+      end
+    end
+
+    # in rails 4.1+, they create a join class that's used to pull in records for HABTM.
+    # this simplifies the hell out of our existence, because all we have to do is inerit on-replica-by-default
+    # down from the parent now.
+    module Rails41HasAndBelongsToManyBuilderExtension
+      def self.included(base)
+        base.class_eval do
+          alias_method :through_model_without_inherit_default_replica_from_lhs, :through_model
+          alias_method :through_model, :through_model_with_inherit_default_replica_from_lhs
+        end
+      end
+
+      def through_model_with_inherit_default_replica_from_lhs
+        model = through_model_without_inherit_default_replica_from_lhs
+        def model.on_replica_by_default?
+          left_reflection.klass.on_replica_by_default?
+        end
+
+        # also transfer the sharded-ness of the left table to the join model
+        model.not_sharded unless model.left_reflection.klass.is_sharded?
+        model
+      end
+    end
+
+    module AssociationsAssociationAssociationScopePatch
+      def association_scope
+        if klass
+          on_replica_unless_tx { super }
+        else
+          super
+        end
+      end
+
+      def on_replica_unless_tx
+        klass.on_replica_unless_tx { yield }
+      end
+    end
+
+    module AssociationsAssociationFindTargetPatch
+      def find_target
+        if klass
+          on_replica_unless_tx { super }
+        else
+          super
+        end
+      end
+
+      def on_replica_unless_tx
+        klass.on_replica_unless_tx { yield }
+      end
+    end
+
+    module AssociationsAssociationGetRecordsPatch
+      def get_records # rubocop:disable Naming/AccessorMethodName
+        if klass
+          on_replica_unless_tx { super }
+        else
+          super
+        end
+      end
+
+      def on_replica_unless_tx
+        klass.on_replica_unless_tx { yield }
+      end
+    end
+
+    module AssociationsPreloaderAssociationAssociatedRecordsByOwnerPatch
+      def associated_records_by_owner(preloader)
+        if klass
+          on_replica_unless_tx { super }
+        else
+          super
+        end
+      end
+
+      def on_replica_unless_tx
+        klass.on_replica_unless_tx { yield }
+      end
+    end
+
+    module AssociationsPreloaderAssociationLoadRecordsPatch
+      def load_records
+        if klass
+          on_replica_unless_tx { super }
+        else
+          super
+        end
+      end
+
+      def on_replica_unless_tx
+        klass.on_replica_unless_tx { yield }
+      end
+    end
+
+    module TypeCasterConnectionConnectionPatch
+      def connection
+        return super if Thread.current[:_active_record_shards_in_migration]
+        return super if Thread.current[:_active_record_shards_in_tx]
+
+        if @klass.on_replica_by_default?
+          @klass.on_replica.connection
+        else
+          super
+        end
+      end
+    end
+
+    module SchemaDefinePatch
+      def define(info, &block)
+        old_val = Thread.current[:_active_record_shards_in_migration]
+        Thread.current[:_active_record_shards_in_migration] = true
+        super
+      ensure
+        Thread.current[:_active_record_shards_in_migration] = old_val
+      end
+    end
+  end
+end

data/lib/active_record_shards/default_slave_patches.rb

@@ -1,142 +1,5 @@
-# frozen_string_literal: true
-module ActiveRecordShards
-  module DefaultSlavePatches
-    def self.wrap_method_in_on_slave(class_method, base, method, force_on_slave: false)
-      base_methods =
-        if class_method
-          base.methods + base.private_methods
-        else
-          base.instance_methods + base.private_instance_methods
-        end
-
-      return unless base_methods.include?(method)
-      _, method, punctuation = method.to_s.match(/^(.*?)([\?\!]?)$/).to_a
-      # _ALWAYS_ on slave, or only for on `on_slave_by_default = true` models?
-      wrapper = force_on_slave ? 'force_on_slave' : 'on_slave_unless_tx'
-      base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        #{class_method ? 'class << self' : ''}
-          def #{method}_with_default_slave#{punctuation}(*args, &block)
-            #{wrapper} do
-              #{method}_without_default_slave#{punctuation}(*args, &block)
-            end
-          end
-
-          alias_method :#{method}_without_default_slave#{punctuation}, :#{method}#{punctuation}
-          alias_method :#{method}#{punctuation}, :#{method}_with_default_slave#{punctuation}
-        #{class_method ? 'end' : ''}
-      RUBY
-    end
-
-    def transaction_with_slave_off(*args, &block)
-      if on_slave_by_default?
-        begin
-          old_val = Thread.current[:_active_record_shards_slave_off]
-          Thread.current[:_active_record_shards_slave_off] = true
-          transaction_without_slave_off(*args, &block)
-        ensure
-          Thread.current[:_active_record_shards_slave_off] = old_val
-        end
-      else
-        transaction_without_slave_off(*args, &block)
-      end
-    end
-
-    module InstanceMethods
-      # fix ActiveRecord to do the right thing, and use our aliased quote_value
-      def quote_value(*args, &block)
-        self.class.quote_value(*args, &block)
-      end
-    end
-
-    CLASS_SLAVE_METHODS = [
-      :calculate,
-      :count_by_sql,
-      :exists?,
-      :find_by_sql,
-      :find_every,
-      :find_one,
-      :find_some
-    ].freeze
-
-    CLASS_FORCE_SLAVE_METHODS = [
-      :columns,
-      :replace_bind_variable,
-      :replace_bind_variables,
-      :sanitize_sql_array,
-      :sanitize_sql_hash_for_assignment,
-      :table_exists?
-    ].freeze
-
-    def self.extended(base)
-      CLASS_SLAVE_METHODS.each { |m| ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(true, base, m) }
-      CLASS_FORCE_SLAVE_METHODS.each { |m| ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(true, base, m, force_on_slave: true) }
-
-      base.class_eval do
-        include InstanceMethods
-
-        class << self
-          alias_method :transaction_without_slave_off, :transaction
-          alias_method :transaction, :transaction_with_slave_off
-        end
-      end
-      if ActiveRecord::Associations.const_defined?(:HasAndBelongsToManyAssociation)
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, ActiveRecord::Associations::HasAndBelongsToManyAssociation, :construct_sql)
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, ActiveRecord::Associations::HasAndBelongsToManyAssociation, :construct_find_options!)
-      end
-    end
+ActiveRecordShards::Deprecation.warn('`DefaultSlavePatches` is deprecated, please use `DefaultReplicaPatches`.')
 
-    def on_slave_unless_tx(&block)
-      if on_slave_by_default? && !Thread.current[:_active_record_shards_slave_off]
-        on_slave(&block)
-      else
-        yield
-      end
-    end
-
-    def force_on_slave(&block)
-      on_cx_switch_block(:slave, construct_ro_scope: false, force: true, &block)
-    end
-
-    module ActiveRelationPatches
-      def self.included(base)
-        [:calculate, :exists?, :pluck, :load].each do |m|
-          ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, m)
-        end
-
-        if ActiveRecord::VERSION::MAJOR == 4
-          # `where` and `having` clauses call `create_binds`, which will use the master connection
-          ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :create_binds, force_on_slave: true)
-        end
-
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :to_sql, force_on_slave: true)
-      end
-
-      def on_slave_unless_tx(&block)
-        @klass.on_slave_unless_tx(&block)
-      end
-    end
-
-    # in rails 4.1+, they create a join class that's used to pull in records for HABTM.
-    # this simplifies the hell out of our existence, because all we have to do is inerit on-slave-by-default
-    # down from the parent now.
-    module Rails41HasAndBelongsToManyBuilderExtension
-      def self.included(base)
-        base.class_eval do
-          alias_method :through_model_without_inherit_default_slave_from_lhs, :through_model
-          alias_method :through_model, :through_model_with_inherit_default_slave_from_lhs
-        end
-      end
-
-      def through_model_with_inherit_default_slave_from_lhs
-        model = through_model_without_inherit_default_slave_from_lhs
-        def model.on_slave_by_default?
-          left_reflection.klass.on_slave_by_default?
-        end
-
-        # also transfer the sharded-ness of the left table to the join model
-        model.not_sharded unless model.left_reflection.klass.is_sharded?
-        model
-      end
-    end
-  end
+module ActiveRecordShards
+  DefaultSlavePatches = DefaultReplicaPatches
 end

data/lib/active_record_shards/deprecation.rb

@@ -0,0 +1,12 @@
+module ActiveRecordShards
+  class Deprecation < ActiveSupport::Deprecation
+    # This allows us to define separate deprecation behavior for ActiveRecordShards, but defaults to
+    # the same behavior globally configured with ActiveSupport.
+    #
+    # For example, this allows us to silence our own deprecation warnings in test while still being
+    # able to fail tests for upstream deprecation warnings.
+    def behavior
+      @behavior ||= ActiveSupport::Deprecation.behavior
+    end
+  end
+end

data/lib/active_record_shards/migration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveRecord
   class Migrator
     def self.shards_migration_context

data/lib/active_record_shards/model.rb

@@ -6,6 +6,7 @@ module ActiveRecordShards
       if self != ActiveRecord::Base && self != base_class
         raise "You should only call not_sharded on direct descendants of ActiveRecord::Base"
       end
+
       self.sharded = false
     end
 
@@ -23,34 +24,38 @@ module ActiveRecordShards
       end
     end
 
-    def on_slave_by_default?
+    def on_replica_by_default?
       if self == ActiveRecord::Base
         false
       else
         base = base_class
-        if base.instance_variable_defined?(:@on_slave_by_default)
-          base.instance_variable_get(:@on_slave_by_default)
+        if base.instance_variable_defined?(:@on_replica_by_default)
+          base.instance_variable_get(:@on_replica_by_default)
         end
       end
     end
+    alias_method :on_slave_by_default?, :on_replica_by_default?
 
-    def on_slave_by_default=(value)
+    def on_replica_by_default=(value)
       if self == ActiveRecord::Base
-        raise ArgumentError, "Cannot set on_slave_by_default on ActiveRecord::Base"
+        raise ArgumentError, "Cannot set on_replica_by_default on ActiveRecord::Base"
       else
-        base_class.instance_variable_set(:@on_slave_by_default, value)
+        base_class.instance_variable_set(:@on_replica_by_default, value)
       end
     end
+    alias_method :on_slave_by_default=, :on_replica_by_default=
 
     module InstanceMethods
-      def initialize_shard_and_slave
-        @from_slave = !!self.class.current_shard_selection.options[:slave]
+      def initialize_shard_and_replica
+        @from_replica = !!self.class.current_shard_selection.options[:replica]
         @from_shard = self.class.current_shard_selection.options[:shard]
       end
+      alias_method :initialize_shard_and_slave, :initialize_shard_and_replica
 
-      def from_slave?
-        @from_slave
+      def from_replica?
+        @from_replica
       end
+      alias_method :from_slave?, :from_replica?
 
       def from_shard
         @from_shard
@@ -59,7 +64,7 @@ module ActiveRecordShards
 
     def self.extended(base)
       base.send(:include, InstanceMethods)
-      base.after_initialize :initialize_shard_and_slave
+      base.after_initialize :initialize_shard_and_replica
     end
 
     private

data/lib/active_record_shards/patches-4-2.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_record_shards/connection_pool'
 require 'active_record_shards/connection_handler'
 require 'active_record_shards/connection_specification'

data/lib/active_record_shards/schema_dumper_extension.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveRecordShards
   module SchemaDumperExtension
     def dump(stream)
@@ -23,15 +24,15 @@ module ActiveRecordShards
     def shard_header(stream)
       define_params = @version ? "version: #{@version}" : ""
 
-      stream.puts <<HEADER
+      stream.puts <<~HEADER
 
 
-# This section generated by active_record_shards
+        # This section generated by active_record_shards
 
-ActiveRecord::Base.on_all_shards do
-ActiveRecord::Schema.define(#{define_params}) do
+        ActiveRecord::Base.on_all_shards do
+        ActiveRecord::Schema.define(#{define_params}) do
 
-HEADER
+      HEADER
     end
 
     def shard_trailer(stream)

data/lib/active_record_shards/shard_selection.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 module ActiveRecordShards
   class ShardSelection
     NO_SHARD = :_no_shard
     cattr_accessor :default_shard
 
     def initialize
-      @on_slave = false
+      @on_replica = false
       @shard = nil
     end
 
@@ -21,17 +22,17 @@ module ActiveRecordShards
         end
       end
 
-      def shard_name(klass = nil, try_slave = true)
+      def shard_name(klass = nil, try_replica = true)
         the_shard = shard(klass)
 
         @shard_names ||= {}
         @shard_names[ActiveRecordShards.rails_env] ||= {}
         @shard_names[ActiveRecordShards.rails_env][the_shard] ||= {}
-        @shard_names[ActiveRecordShards.rails_env][the_shard][try_slave] ||= {}
-        @shard_names[ActiveRecordShards.rails_env][the_shard][try_slave][@on_slave] ||= begin
+        @shard_names[ActiveRecordShards.rails_env][the_shard][try_replica] ||= {}
+        @shard_names[ActiveRecordShards.rails_env][the_shard][try_replica][@on_replica] ||= begin
           s = ActiveRecordShards.rails_env.dup
           s << "_shard_#{the_shard}" if the_shard
-          s << "_slave"              if @on_slave && try_slave
+          s << "_replica"            if @on_replica && try_replica
           s
         end
       end
@@ -46,7 +47,7 @@ module ActiveRecordShards
         end
       end
 
-      PRIMARY = "primary".freeze
+      PRIMARY = "primary"
       def resolve_connection_name(sharded:, configurations:)
         resolved_shard = sharded ? shard : nil
         env = ActiveRecordShards.rails_env
@@ -54,11 +55,11 @@ module ActiveRecordShards
         @connection_names ||= {}
         @connection_names[env] ||= {}
         @connection_names[env][resolved_shard] ||= {}
-        @connection_names[env][resolved_shard][@on_slave] ||= begin
+        @connection_names[env][resolved_shard][@on_replica] ||= begin
           name = env.dup
           name << "_shard_#{resolved_shard}" if resolved_shard
-          if @on_slave && configurations["#{name}_slave"]
-            "#{name}_slave"
+          if @on_replica && configurations["#{name}_replica"]
+            "#{name}_replica"
           else
             # ActiveRecord always names its default connection pool 'primary'
             # while everything else is named by the configuration name
@@ -73,16 +74,18 @@ module ActiveRecordShards
       @shard = (new_shard || NO_SHARD)
     end
 
-    def on_slave?
-      @on_slave
+    def on_replica?
+      @on_replica
     end
+    alias_method :on_slave?, :on_replica?
 
-    def on_slave=(new_slave)
-      @on_slave = (new_slave == true)
+    def on_replica=(new_replica)
+      @on_replica = (new_replica == true)
     end
+    alias_method :on_slave=, :on_replica=
 
     def options
-      { shard: @shard, slave: @on_slave }
+      { shard: @shard, replica: @on_replica }
     end
   end
 end

data/lib/active_record_shards/shard_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveRecordShards
   class ShardSupport
     class ShardEnumerator

data/lib/active_record_shards/sql_comments.rb

@@ -1,16 +1,19 @@
-# show which connection was picked to debug master/slave slowness when both servers are the same
+# show which connection was picked to debug primary/replica slowness when both servers are the same
 module ActiveRecordShards
   module SqlComments
     module Methods
       def execute(query, name = nil)
-        slave = ActiveRecord::Base.current_shard_selection.on_slave?
-        query += " /* #{slave ? 'slave' : 'master'} */"
+        shard = ActiveRecord::Base.current_shard_selection.shard
+        shard_text = shard ? "shard #{shard}" : 'unsharded'
+        replica = ActiveRecord::Base.current_shard_selection.on_replica?
+        replica_text = replica ? 'replica' : 'primary'
+        query = "/* #{shard_text} #{replica_text} */ " + query
         super(query, name)
       end
     end
 
     def self.enable
-      ActiveRecord::Base.on_slave do
+      ActiveRecord::Base.on_replica do
         ActiveRecord::Base.on_shard(nil) do
           ActiveRecord::Base.connection.class.prepend(Methods)
         end