active_record_shards 4.0.0.beta8 → 5.1.0

data/lib/active_record_shards/tasks.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_record_shards'
 
 %w[db:drop db:create db:abort_if_pending_migrations db:reset db:test:purge].each do |name|
@@ -8,14 +9,15 @@ end
 namespace :db do
   desc 'Drops the database for the current RAILS_ENV including shards'
   task drop: :load_config do
-    ActiveRecord::Base.configurations.each do |key, conf|
-      next if !key.starts_with?(ActiveRecordShards.rails_env) || key.ends_with?("_slave")
+    ActiveRecord::Base.configurations.to_h.each do |key, conf|
+      next if !key.start_with?(ActiveRecordShards.app_env) || key.end_with?("_replica")
+
       begin
         ActiveRecordShards::Tasks.root_connection(conf).drop_database(conf['database'])
       # rescue ActiveRecord::NoDatabaseError # TODO: exists in AR but never is raised here ...
       #   $stderr.puts "Database '#{conf['database']}' does not exist"
-      rescue StandardError => error
-        warn error, *error.backtrace
+      rescue StandardError => e
+        warn e, *e.backtrace
         warn "Couldn't drop #{conf['database']}"
       end
     end
@@ -28,36 +30,45 @@ namespace :db do
 
   desc "Create the database defined in config/database.yml for the current RAILS_ENV including shards"
   task create: :load_config do
-    ActiveRecord::Base.configurations.each do |key, conf|
-      next if !key.starts_with?(ActiveRecordShards.rails_env) || key.ends_with?("_slave")
+    ActiveRecord::Base.configurations.to_h.each do |key, conf|
+      next if !key.start_with?(ActiveRecordShards.app_env) || key.end_with?("_replica")
+
       begin
-        # MysqlAdapter takes charset instead of encoding in Rails 4
-        # https://github.com/rails/rails/commit/78b30fed9336336694fb2cb5d2825f95800b541c
+        # MysqlAdapter takes charset instead of encoding in Rails 4.2 or greater
+        # https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/tasks/mysql_database_tasks.rb#L85-L96
         symbolized_configuration = conf.symbolize_keys
         symbolized_configuration[:charset] = symbolized_configuration[:encoding]
 
         ActiveRecordShards::Tasks.root_connection(conf).create_database(conf['database'], symbolized_configuration)
-      rescue ActiveRecord::StatementInvalid => ex
-        if ex.message.include?('database exists')
+      rescue ActiveRecord::StatementInvalid => e
+        if e.message.include?('database exists')
           puts "#{conf['database']} already exists"
         else
-          raise ex
+          raise e
         end
       end
     end
-    ActiveRecord::Base.establish_connection(ActiveRecordShards.rails_env.to_sym)
+    ActiveRecord::Base.establish_connection(ActiveRecordShards.app_env.to_sym)
   end
 
   desc "Raises an error if there are pending migrations"
   task abort_if_pending_migrations: :environment do
     if defined? ActiveRecord
       pending_migrations =
-        ActiveRecord::Base.on_shard(nil) { ActiveRecord::Migrator.open(ActiveRecord::Migrator.migrations_paths).pending_migrations }
+        if ActiveRecord::VERSION::MAJOR >= 6
+          migrations = ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths, ActiveRecord::SchemaMigration).migrations
+          ActiveRecord::Migrator.new(:up, migrations, ActiveRecord::SchemaMigration).pending_migrations
+        elsif ActiveRecord::VERSION::STRING >= "5.2.0"
+          migrations = ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths).migrations
+          ActiveRecord::Migrator.new(:up, migrations).pending_migrations
+        else
+          ActiveRecord::Base.on_shard(nil) { ActiveRecord::Migrator.open(ActiveRecord::Migrator.migrations_paths).pending_migrations }
+        end
 
       if pending_migrations.any?
-        puts "You have #{pending_migrations.size} pending migrations:"
+        warn "You have #{pending_migrations.size} pending migrations:"
         pending_migrations.each do |pending_migration|
-          puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+          warn '  %4d %s' % [pending_migration.version, pending_migration.name]
         end
         abort %(Run "rake db:migrate" to update your database then try again.)
       end
@@ -67,26 +78,39 @@ namespace :db do
   namespace :test do
     desc 'Purges the test databases by dropping and creating'
     task purge: :load_config do |t|
-      begin
-        saved_env = Rails.env
-        Rails.env = 'test'
-        Rake.application.lookup('db:drop', t.scope).execute
-        Rake.application.lookup('db:create', t.scope).execute
-      ensure
-        Rails.env = saved_env
-      end
+      saved_env = Rails.env
+      Rails.env = 'test'
+      Rake.application.lookup('db:drop', t.scope).execute
+      Rake.application.lookup('db:create', t.scope).execute
+    ensure
+      Rails.env = saved_env
     end
   end
 end
 
 module ActiveRecordShards
   module Tasks
-    def self.root_connection(conf)
-      # this will trigger rails to load the adapter
-      conf = conf.merge('database' => nil)
-      resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(ActiveRecord::Base.configurations)
-      resolver.spec(conf)
-      ActiveRecord::Base.send("#{conf['adapter']}_connection", conf)
+    class << self
+      def root_connection(conf)
+        conf = conf.merge('database' => nil)
+        spec = spec_for(conf)
+        if "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}" == '6.1'
+          ActiveRecord::Base.send("#{conf['adapter']}_connection", spec.db_config.configuration_hash)
+        else
+          ActiveRecord::Base.send("#{conf['adapter']}_connection", spec.config)
+        end
+      end
+
+      private
+
+      def spec_for(conf)
+        if "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}" == '6.1'
+          ActiveRecord::Base.connection_handler.send(:resolve_pool_config, conf, ActiveRecord::Base)
+        else
+          resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(ActiveRecord::Base.configurations)
+          resolver.spec(conf)
+        end
+      end
     end
   end
 end

data/lib/active_record_shards.rb

@@ -1,32 +1,80 @@
 # frozen_string_literal: true
+
 require 'active_record'
 require 'active_record/base'
-require 'active_record_shards/base_config'
-require 'active_record_shards/connection_resolver'
 require 'active_record_shards/configuration_parser'
 require 'active_record_shards/model'
-require 'active_record_shards/slave_db'
 require 'active_record_shards/shard_selection'
-require 'active_record_shards/no_shard_selection'
 require 'active_record_shards/connection_switcher'
-require 'active_record_shards/sharded_model'
 require 'active_record_shards/association_collection_connection_selection'
-require 'active_record_shards/default_slave_patches'
+require 'active_record_shards/migration'
+require 'active_record_shards/default_replica_patches'
+require 'active_record_shards/default_shard'
+require 'active_record_shards/schema_dumper_extension'
 
 module ActiveRecordShards
-  def self.rails_env
+  class << self
+    attr_accessor :disable_replica_readonly_records
+  end
+
+  def self.app_env
     env = Rails.env if defined?(Rails.env)
     env ||= RAILS_ENV if Object.const_defined?(:RAILS_ENV)
     env ||= ENV['RAILS_ENV']
+    env ||= APP_ENV if Object.const_defined?(:APP_ENV)
+    env ||= ENV['APP_ENV']
     env || 'development'
   end
 end
 
-ActiveRecord::Base.extend(ActiveRecordShards::BaseConfig)
 ActiveRecord::Base.extend(ActiveRecordShards::ConfigurationParser)
 ActiveRecord::Base.extend(ActiveRecordShards::Model)
-ActiveRecord::Base.extend(ActiveRecordShards::SlaveDb)
-ActiveRecord::Base.extend(ActiveRecordShards::DefaultSlavePatches)
-ActiveRecord::Relation.include(ActiveRecordShards::DefaultSlavePatches::ActiveRelationPatches)
+ActiveRecord::Base.extend(ActiveRecordShards::ConnectionSwitcher)
+ActiveRecord::Base.extend(ActiveRecordShards::DefaultReplicaPatches)
+ActiveRecord::Relation.include(ActiveRecordShards::DefaultReplicaPatches::ActiveRelationPatches)
 ActiveRecord::Associations::CollectionProxy.include(ActiveRecordShards::AssociationCollectionConnectionSelection)
-ActiveRecord::Associations::Builder::HasAndBelongsToMany.include(ActiveRecordShards::DefaultSlavePatches::HasAndBelongsToManyBuilderExtension)
+ActiveRecord::Associations::Builder::HasAndBelongsToMany.include(ActiveRecordShards::DefaultReplicaPatches::Rails41HasAndBelongsToManyBuilderExtension)
+ActiveRecord::SchemaDumper.prepend(ActiveRecordShards::SchemaDumperExtension)
+
+case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+when '5.1'
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/association.rb#L97
+  ActiveRecord::Associations::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationAssociationScopePatch)
+
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/singular_association.rb#L41
+  ActiveRecord::Associations::SingularAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/collection_association.rb#L305
+  ActiveRecord::Associations::CollectionAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/preloader/association.rb#L120
+  ActiveRecord::Associations::Preloader::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsPreloaderAssociationLoadRecordsPatch)
+when '5.2'
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/relation.rb#L530
+  # But the #exec_queries method also calls #connection, and I don't know if we should patch that one, too...
+  ActiveRecord::Relation.prepend(ActiveRecordShards::DefaultReplicaPatches::Rails52RelationPatches)
+
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/associations/singular_association.rb#L42
+  ActiveRecord::Associations::SingularAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/associations/collection_association.rb#L308
+  ActiveRecord::Associations::CollectionAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/associations/preloader/association.rb#L96
+  ActiveRecord::Associations::Preloader::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsPreloaderAssociationLoadRecordsPatch)
+when '6.0', '6.1'
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/type_caster/connection.rb#L28
+  ActiveRecord::TypeCaster::Connection.prepend(ActiveRecordShards::DefaultReplicaPatches::TypeCasterConnectionConnectionPatch)
+
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/schema.rb#L53-L54
+  ActiveRecord::Schema.prepend(ActiveRecordShards::DefaultReplicaPatches::SchemaDefinePatch)
+
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/relation.rb#L739
+  # But the #exec_queries and #compute_cache_version methods also call #connection, and I don't know if we should patch those, too...
+  ActiveRecord::Relation.prepend(ActiveRecordShards::DefaultReplicaPatches::Rails52RelationPatches)
+
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/associations/association.rb#L213
+  ActiveRecord::Associations::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+else
+  raise "ActiveRecordShards is not compatible with #{ActiveRecord::VERSION::STRING}"
+end

metadata

@@ -1,45 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta8
+  version: 5.1.0
 platform: ruby
 authors:
+- Benjamin Quorning
+- Gabe Martin-Dempesy
+- Pierre Schambacher
 - Mick Staugaard
 - Eric Chapweske
 - Ben Osheroff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +75,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.10.0
 - !ruby/object:Gem::Dependency
   name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
@@ -88,14 +103,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -111,66 +126,67 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: phenix
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Easily run queries on shard and slave databases.
+        version: 1.5.1
+description: Easily run queries on shard and replica databases.
 email:
+- bquorning@zendesk.com
+- gabe@zendesk.com
+- pschambacher@zendesk.com
 - mick@staugaard.com
-- eac@zendesk.com
-- ben@gimbo.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -178,43 +194,40 @@ files:
 - README.md
 - lib/active_record_shards.rb
 - lib/active_record_shards/association_collection_connection_selection.rb
-- lib/active_record_shards/base_config.rb
 - lib/active_record_shards/configuration_parser.rb
-- lib/active_record_shards/connection_resolver.rb
+- lib/active_record_shards/connection_switcher-5-1.rb
+- lib/active_record_shards/connection_switcher-6-0.rb
 - lib/active_record_shards/connection_switcher.rb
-- lib/active_record_shards/connection_switcher_5_0.rb
-- lib/active_record_shards/connection_switcher_5_1.rb
-- lib/active_record_shards/default_slave_patches.rb
+- lib/active_record_shards/default_replica_patches.rb
+- lib/active_record_shards/default_shard.rb
+- lib/active_record_shards/migration.rb
 - lib/active_record_shards/model.rb
-- lib/active_record_shards/no_shard_selection.rb
+- lib/active_record_shards/schema_dumper_extension.rb
 - lib/active_record_shards/shard_selection.rb
 - lib/active_record_shards/shard_support.rb
-- lib/active_record_shards/sharded_model.rb
-- lib/active_record_shards/slave_db.rb
 - lib/active_record_shards/sql_comments.rb
 - lib/active_record_shards/tasks.rb
 homepage: https://github.com/zendesk/active_record_shards
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Simple database switching for ActiveRecord.
 test_files: []

data/lib/active_record_shards/base_config.rb

@@ -1,26 +0,0 @@
-module ActiveRecordShards
-  module BaseConfig
-    def connection_config
-      { shard: nil, sharded: false }
-    end
-
-    def connection_specification_name
-      name = connection_resolver.resolve_connection_name(connection_config)
-
-      unless configurations[name] || name == "primary"
-        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.inspect})"
-      end
-
-      name
-    end
-
-    def connection_resolver
-      Thread.current[:connection_resolver] ||=
-        ActiveRecordShards::ConnectionResolver.new(configurations)
-    end
-
-    def reset_connection_resolver
-      Thread.current[:connection_resolver] = nil
-    end
-  end
-end

data/lib/active_record_shards/connection_resolver.rb

@@ -1,31 +0,0 @@
-module ActiveRecordShards
-  class ConnectionResolver
-    attr_reader :configurations
-
-    def initialize(configurations)
-      @configurations = configurations
-    end
-
-    PRIMARY = "primary".freeze
-    def resolve_connection_name(slave:, shard:, sharded:)
-      resolved_shard = sharded ? shard : nil
-
-      if !resolved_shard && !slave
-        return PRIMARY
-      end
-
-      @shard_names ||= {}
-      @shard_names[ActiveRecordShards.rails_env] ||= {}
-      @shard_names[ActiveRecordShards.rails_env][resolved_shard] ||= {}
-      @shard_names[ActiveRecordShards.rails_env][resolved_shard][slave] ||= begin
-        s = ActiveRecordShards.rails_env.dup
-        s << "_shard_#{resolved_shard}" if resolved_shard
-
-        if slave && configurations["#{s}_slave"] # fall back to master connection
-          s << "_slave"
-        end
-        s
-      end
-    end
-  end
-end

data/lib/active_record_shards/connection_switcher_5_0.rb

@@ -1,19 +0,0 @@
-module ActiveRecordShards
-  module BaseConfig
-    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)
-      if pool.nil?
-        resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
-        spec = resolver.spec(spec_name.to_sym, spec_name)
-        connection_handler.establish_connection(spec)
-      end
-    end
-  end
-end