active_record_shards 3.19.2 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c92296c3b3a78ff97323797b16a0f110a473bf149713e901b178eac343148d18
-  data.tar.gz: b74a33acb7c8a55cfecc211013e7871ca8710b726c969cadb8937495a6fdfba3
+  metadata.gz: aadf0c3e7681201dfc6b2f9ff1c9a33164d7e9b17394052e09601f807926c73a
+  data.tar.gz: 3e1eaac98dbcdeb6133787447fdd4a7c56aa4056013e9b01aa2082f00a6bc733
 SHA512:
-  metadata.gz: 0b2a16d3380ebf680180c848bd7b64b838e9bb729470943e7016e3cca2f07135a4b8c45c11ab8d4476b76dc1c3a8b735ac29ed14de95d1972d0aaca327ff0892
-  data.tar.gz: 9afeb1052dd9a4f79f1c49e9c69a9e148e226ae90e8bee891376994e061988bd7290ca56fa36f992597dd978c7adb6fdcc753b89f1d8355c03766f38a890f5f8
+  metadata.gz: eecd43504f6dcb074c97128d96a2b5bbeeea08bc92e6c005bc3b8d3952670ea7a201856709b50c0ad5e4d91db1eb9aac9bba02762a424eaa3a23bb44c00fbdbd
+  data.tar.gz: 1f91bc255828d9bae15bf5267a5a836049e12eef663751dbad63de1f35e84cea566f071f290db96f84accc4bb20c2d52c82cbedbe79a6bc637769cae7aeafa75

data/README.md

@@ -148,12 +148,16 @@ ActiveRecord::Base.on_replica do
 end
 ```
 
-This will perform the query on the replica, and mark the returned instances as read only. There is also a shortcut for this:
+This will perform the query on the replica, and mark the returned instances as read-only. There is also a shortcut for this:
 
 ```ruby
 Account.on_replica.find_by_big_expensive_query
 ```
 
+If you do not want instances returned from replicas to be marked as read-only, this can be disabled globally:
+
+`ActiveRecordShards.disable_replica_readonly_records = true`
+
 ## Debugging
 
 Show if a query went to primary or replica in the logs:

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

@@ -0,0 +1,30 @@
+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/connection_switcher.rb

@@ -125,7 +125,7 @@ module ActiveRecordShards
 
       # we avoid_readonly_scope to prevent some stack overflow problems, like when
       # .columns calls .with_scope which calls .columns and onward, endlessly.
-      if self == ActiveRecord::Base || !switch_to_replica || construct_ro_scope == false
+      if self == ActiveRecord::Base || !switch_to_replica || construct_ro_scope == false || ActiveRecordShards.disable_replica_readonly_records == true
         yield
       else
         readonly.scoping(&block)
@@ -153,18 +153,27 @@ module ActiveRecordShards
     end
 
     def shard_names
-      unless config = configurations[shard_env]
-        raise "Did not find #{shard_env} in configurations, did you forget to add it to your database config? (configurations: #{configurations.to_h.keys.inspect})"
-      end
-      unless config.fetch(SHARD_NAMES_CONFIG_KEY, []).all? { |shard_name| shard_name.is_a?(Integer) }
-        raise "All shard names must be integers: #{config[SHARD_NAMES_CONFIG_KEY].inspect}."
+      unless config_for_env.fetch(SHARD_NAMES_CONFIG_KEY, []).all? { |shard_name| shard_name.is_a?(Integer) }
+        raise "All shard names must be integers: #{config_for_env[SHARD_NAMES_CONFIG_KEY].inspect}."
       end
 
-      config[SHARD_NAMES_CONFIG_KEY] || []
+      config_for_env[SHARD_NAMES_CONFIG_KEY] || []
     end
 
     private
 
+    def config_for_env
+      @_ars_config_for_env ||= {}
+      @_ars_config_for_env[shard_env] ||= begin
+        unless config = configurations[shard_env]
+          raise "Did not find #{shard_env} in configurations, did you forget to add it to your database config? (configurations: #{configurations.to_h.keys.inspect})"
+        end
+
+        config
+      end
+    end
+    alias_method :check_config_for_env, :config_for_env
+
     def switch_connection(options)
       if options.any?
         if options.key?(:replica)
@@ -172,9 +181,7 @@ module ActiveRecordShards
         end
 
         if options.key?(:shard)
-          unless configurations[shard_env]
-            raise "Did not find #{shard_env} in configurations, did you forget to add it to your database config? (configurations: #{configurations.to_h.keys.inspect})"
-          end
+          check_config_for_env
 
           current_shard_selection.shard = options[:shard]
         end
@@ -184,7 +191,7 @@ module ActiveRecordShards
     end
 
     def shard_env
-      ActiveRecordShards.rails_env
+      ActiveRecordShards.app_env
     end
 
     # Make these few schema related methods available before having switched to
@@ -231,8 +238,10 @@ when '4.2'
   require 'active_record_shards/connection_switcher-4-2'
 when '5.0'
   require 'active_record_shards/connection_switcher-5-0'
-when '5.1', '5.2', '6.0'
+when '5.1', '5.2'
   require 'active_record_shards/connection_switcher-5-1'
+when '6.0'
+  require 'active_record_shards/connection_switcher-6-0'
 else
   raise "ActiveRecordShards is not compatible with #{ActiveRecord::VERSION::STRING}"
 end

data/lib/active_record_shards/shard_selection.rb

@@ -26,11 +26,11 @@ module ActiveRecordShards
         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_replica] ||= {}
-        @shard_names[ActiveRecordShards.rails_env][the_shard][try_replica][@on_replica] ||= begin
-          s = ActiveRecordShards.rails_env.dup
+        @shard_names[ActiveRecordShards.app_env] ||= {}
+        @shard_names[ActiveRecordShards.app_env][the_shard] ||= {}
+        @shard_names[ActiveRecordShards.app_env][the_shard][try_replica] ||= {}
+        @shard_names[ActiveRecordShards.app_env][the_shard][try_replica][@on_replica] ||= begin
+          s = ActiveRecordShards.app_env.dup
           s << "_shard_#{the_shard}" if the_shard
           s << "_replica"            if @on_replica && try_replica
           s
@@ -50,7 +50,7 @@ module ActiveRecordShards
       PRIMARY = "primary"
       def resolve_connection_name(sharded:, configurations:)
         resolved_shard = sharded ? shard : nil
-        env = ActiveRecordShards.rails_env
+        env = ActiveRecordShards.app_env
 
         @connection_names ||= {}
         @connection_names[env] ||= {}

data/lib/active_record_shards/tasks.rb

@@ -10,7 +10,7 @@ namespace :db do
   desc 'Drops the database for the current RAILS_ENV including shards'
   task drop: :load_config do
     ActiveRecord::Base.configurations.to_h.each do |key, conf|
-      next if !key.start_with?(ActiveRecordShards.rails_env) || key.end_with?("_replica", "_slave")
+      next if !key.start_with?(ActiveRecordShards.app_env) || key.end_with?("_replica", "_slave")
 
       begin
         ActiveRecordShards::Tasks.root_connection(conf).drop_database(conf['database'])
@@ -31,7 +31,7 @@ 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.to_h.each do |key, conf|
-      next if !key.start_with?(ActiveRecordShards.rails_env) || key.end_with?("_replica", "_slave")
+      next if !key.start_with?(ActiveRecordShards.app_env) || key.end_with?("_replica", "_slave")
 
       begin
         # MysqlAdapter takes charset instead of encoding in Rails 4.2 or greater
@@ -48,7 +48,7 @@ namespace :db do
         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"

data/lib/active_record_shards.rb

@@ -12,10 +12,16 @@ require 'active_record_shards/default_replica_patches'
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 3.19.2
+  version: 3.21.0
 platform: ruby
 authors:
 - Benjamin Quorning
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -201,6 +201,7 @@ files:
 - lib/active_record_shards/connection_switcher-4-2.rb
 - lib/active_record_shards/connection_switcher-5-0.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/default_replica_patches.rb
 - lib/active_record_shards/default_slave_patches.rb
@@ -232,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.1
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Simple database switching for ActiveRecord.