active_record_shards 3.22.0 → 4.0.0.beta1

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

@@ -1,56 +0,0 @@
-module ActiveRecordShards
-  module ConnectionSwitcher
-    # Name of the connection pool. Used by ConnectionHandler to retrieve the current connection pool.
-    def connection_pool_name # :nodoc:
-      name = current_shard_selection.shard_name(self)
-
-      # e.g. if "production_replica" is not defined in `Configuration`, fall back to "production"
-      if configurations[name].nil? && on_replica?
-        current_shard_selection.shard_name(self, false)
-      else
-        name
-      end
-    end
-
-    private
-
-    def ensure_shard_connection
-      establish_shard_connection unless connected_to_shard?
-    end
-
-    def establish_shard_connection
-      name = connection_pool_name
-      spec = configurations[name]
-
-      if spec.nil?
-        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.keys.inspect})"
-      end
-
-      specification_cache[name] ||= begin
-        resolver = ActiveRecordShards::ConnectionSpecification::Resolver.new configurations
-        resolver.spec(spec)
-      end
-
-      connection_handler.establish_connection(self, specification_cache[name])
-    end
-
-    def specification_cache
-      @@specification_cache ||= {}
-    end
-
-    # Helper method to clear global state when testing.
-    def clear_specification_cache
-      @@specification_cache = {}
-    end
-
-    def connection_pool_key
-      specification_cache[connection_pool_name]
-    end
-
-    def connected_to_shard?
-      specs_to_pools = Hash[connection_handler.connection_pool_list.map { |pool| [pool.spec, pool] }]
-
-      specs_to_pools.key?(connection_pool_key)
-    end
-  end
-end

data/lib/active_record_shards/connection_switcher-6-0.rb

@@ -1,30 +0,0 @@
-module ActiveRecordShards
-  module ConnectionSwitcher
-    def connection_specification_name
-      name = current_shard_selection.resolve_connection_name(sharded: is_sharded?, configurations: configurations)
-
-      @_ars_connection_specification_names ||= {}
-      unless @_ars_connection_specification_names.include?(name)
-        unless configurations[name] || name == "primary"
-          raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.to_h.keys.inspect})"
-        end
-
-        @_ars_connection_specification_names[name] = true
-      end
-
-      name
-    end
-
-    private
-
-    def ensure_shard_connection
-      # See if we've connected before. If not, call `#establish_connection`
-      # so that ActiveRecord can resolve connection_specification_name to an
-      # ARS connection.
-      spec_name = connection_specification_name
-
-      pool = connection_handler.retrieve_connection_pool(spec_name)
-      connection_handler.establish_connection(spec_name.to_sym) if pool.nil?
-    end
-  end
-end

data/lib/active_record_shards/default_replica_patches.rb

@@ -1,278 +0,0 @@
-# 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/deprecation.rb

@@ -1,12 +0,0 @@
-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,125 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  class Migrator
-    def self.shards_migration_context
-      if ActiveRecord::VERSION::MAJOR >= 6
-        ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths, ActiveRecord::SchemaMigration)
-      elsif ActiveRecord::VERSION::STRING >= '5.2.0'
-        ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths)
-      else
-        self
-      end
-    end
-
-    def initialize_with_sharding(*args)
-      initialize_without_sharding(*args)
-
-      # Rails creates the internal tables on the unsharded DB. We make them
-      # manually on the sharded DBs.
-      ActiveRecord::Base.on_all_shards do
-        ActiveRecord::SchemaMigration.create_table
-        if ActiveRecord::VERSION::MAJOR >= 5
-          ActiveRecord::InternalMetadata.create_table
-        end
-      end
-    end
-    alias_method :initialize_without_sharding, :initialize
-    alias_method :initialize, :initialize_with_sharding
-
-    def run_with_sharding
-      ActiveRecord::Base.on_shard(nil) { run_without_sharding }
-      ActiveRecord::Base.on_all_shards { run_without_sharding }
-    end
-    alias_method :run_without_sharding, :run
-    alias_method :run, :run_with_sharding
-
-    def migrate_with_sharding
-      ActiveRecord::Base.on_shard(nil) { migrate_without_sharding }
-      ActiveRecord::Base.on_all_shards { migrate_without_sharding }
-    end
-    alias_method :migrate_without_sharding, :migrate
-    alias_method :migrate, :migrate_with_sharding
-
-    # don't allow Migrator class to cache versions
-    undef migrated
-    def migrated
-      self.class.shards_migration_context.get_all_versions
-    end
-
-    # list of pending migrations is any migrations that haven't run on all shards.
-    undef pending_migrations
-    def pending_migrations
-      pending, _missing = self.class.shard_status(migrations.map(&:version))
-      pending = pending.values.flatten
-      migrations.select { |m| pending.include?(m.version) }
-    end
-
-    # public
-    # list of pending and missing versions per shard
-    # [{1 => [1234567]}, {1 => [2345678]}]
-    def self.shard_status(versions)
-      pending = {}
-      missing = {}
-
-      collect = lambda do |shard|
-        migrated = shards_migration_context.get_all_versions
-
-        p = versions - migrated
-        pending[shard] = p if p.any?
-
-        m = migrated - versions
-        missing[shard] = m if m.any?
-      end
-
-      ActiveRecord::Base.on_shard(nil) { collect.call(nil) }
-      ActiveRecord::Base.on_all_shards { |shard| collect.call(shard) }
-
-      [pending, missing]
-    end
-  end
-end
-
-module ActiveRecordShards
-  module MigrationClassExtension
-    attr_accessor :migration_shard
-
-    def shard(arg = nil)
-      self.migration_shard = arg
-    end
-  end
-
-  module ActualMigrationExtension
-    def migrate_with_forced_shard(direction)
-      if migration_shard.blank?
-        raise "#{name}: Can't run migrations without a shard spec: this may be :all, :none,
-                 or a specific shard (for data-fixups).  please call shard(arg) in your migration."
-      end
-
-      shard = ActiveRecord::Base.current_shard_selection.shard
-
-      if shard.nil?
-        return if migration_shard != :none
-      else
-        return if migration_shard == :none
-        return if migration_shard != :all && migration_shard.to_s != shard.to_s
-      end
-
-      migrate_without_forced_shard(direction)
-    end
-
-    def migration_shard
-      self.class.migration_shard
-    end
-  end
-end
-
-ActiveRecord::Migration.class_eval do
-  extend ActiveRecordShards::MigrationClassExtension
-  include ActiveRecordShards::ActualMigrationExtension
-
-  alias_method :migrate_without_forced_shard, :migrate
-  alias_method :migrate, :migrate_with_forced_shard
-end
-
-ActiveRecord::MigrationProxy.delegate :migration_shard, to: :migration

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_record_shards/connection_pool'
-require 'active_record_shards/connection_handler'
-require 'active_record_shards/connection_specification'
-
-ActiveRecordShards::ConnectionSpecification = ActiveRecord::ConnectionAdapters::ConnectionSpecification
-methods_to_override = [:establish_connection, :remove_connection, :pool_for, :pool_from_any_process_for]
-ActiveRecordShards.override_connection_handler_methods(methods_to_override)

data/lib/active_record_shards/schema_dumper_extension.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecordShards
-  module SchemaDumperExtension
-    def dump(stream)
-      stream = super(stream)
-      original_connection = @connection
-
-      if ActiveRecord::Base.supports_sharding?
-        ActiveRecord::Base.on_first_shard do
-          @connection = ActiveRecord::Base.connection
-          shard_header(stream)
-          extensions(stream)
-          tables(stream)
-          shard_trailer(stream)
-        end
-      end
-
-      stream
-    ensure
-      @connection = original_connection
-    end
-
-    def shard_header(stream)
-      define_params = @version ? "version: #{@version}" : ""
-
-      stream.puts <<~HEADER
-
-
-        # This section generated by active_record_shards
-
-        ActiveRecord::Base.on_all_shards do
-        ActiveRecord::Schema.define(#{define_params}) do
-
-      HEADER
-    end
-
-    def shard_trailer(stream)
-      stream.puts "end\nend"
-    end
-  end
-end