switchman 3.4.1 → 4.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e080637567925bab42e7d6c87a2963486b16fb5a09eab87ef61fd8056d773ddf
-  data.tar.gz: 2694d7353b3cb7df6976aa812897540f1a9fc2188c5a6d2cc15bebfbbabb1371
+  metadata.gz: 4676a4e97375d1094b6775fa2a10f907218bbd2cb73f365c801a698822f779a0
+  data.tar.gz: 4f88954e9074fcd122ecbb8d965e1b16edb63c63d69fa5311f7e0a97e400c3d5
 SHA512:
-  metadata.gz: b3318e8323ebda712ad41873279793ddd5b0d5849a536c9f2dc0fcd3addefb35ff4d364882f27eb59d0c8e27e7c5d79e5c5edc6de66a73024746f79fed23170f
-  data.tar.gz: a2d2a1b1682febaffe2856dbdee8eca77241d5781e60fe037677f39c5c77b30d4d4ec5d6b0ff5e8c6cdd947fa79171fc99f0b19ffc3a5a77185bb400069ab537
+  metadata.gz: f043f994b2014ce1c980d6fe73a8137a5b497831bbe87592e0c3140e777d10bcbe1460216e3dcf7cc4d1c71cdbda98d3c2b0e5a6a9859f48120cbc2b9425c24f
+  data.tar.gz: 943659f21c0c99d8b1db896009a24601a8e698f13d0b2920e3532829a1bf0b1c5a319487d766d24c47b33a975b597ec4dc57e051ee0376e4b4dc6405515e38c8

data/Rakefile

@@ -2,37 +2,38 @@
 # frozen_string_literal: true
 
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 begin
-  require 'rdoc/task'
+  require "rdoc/task"
 rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
   RDoc::Task = Rake::RDocTask
 end
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Switchman'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Switchman"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
-load 'rails/tasks/engine.rake'
+load "./spec/tasks/coverage.rake"
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
 
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 
 RuboCop::RakeTask.new do |task|
-  task.options = ['-S']
+  task.options = ["-S"]
 end
 
 task default: %i[spec]

data/db/migrate/20180828183945_add_default_shard_index.rb

@@ -5,7 +5,7 @@ class AddDefaultShardIndex < ActiveRecord::Migration[4.2]
     Switchman::Shard.where(default: nil).update_all(default: false) if Switchman::Shard.current.default?
     change_column_default :switchman_shards, :default, false
     change_column_null :switchman_shards, :default, false
-    options = if connection.adapter_name == 'PostgreSQL'
+    options = if connection.adapter_name == "PostgreSQL"
                 { unique: true, where: '"default"' }
               else
                 {}

data/db/migrate/20190114212900_add_unique_name_indexes.rb

@@ -3,9 +3,15 @@
 class AddUniqueNameIndexes < ActiveRecord::Migration[4.2]
   def change
     add_index :switchman_shards, %i[database_server_id name], unique: true
-    add_index :switchman_shards, :database_server_id, unique: true, where: 'name IS NULL',
-                                                      name: 'index_switchman_shards_unique_primary_shard'
-    add_index :switchman_shards, '(true)', unique: true, where: 'database_server_id IS NULL AND name IS NULL',
-                                           name: 'index_switchman_shards_unique_primary_db_and_shard'
+    add_index :switchman_shards,
+              :database_server_id,
+              unique: true,
+              where: "name IS NULL",
+              name: "index_switchman_shards_unique_primary_shard"
+    add_index :switchman_shards,
+              "(true)",
+              unique: true,
+              where: "database_server_id IS NULL AND name IS NULL",
+              name: "index_switchman_shards_unique_primary_db_and_shard"
   end
 end

data/lib/switchman/active_record/abstract_adapter.rb

@@ -5,7 +5,7 @@ module Switchman
     module AbstractAdapter
       module ForeignKeyCheck
         def add_column(table, name, type, limit: nil, **)
-          Switchman.foreign_key_check(name, type, limit: limit)
+          Switchman.foreign_key_check(name, type, limit:)
           super
         end
       end
@@ -19,16 +19,20 @@ module Switchman
 
       def initialize(*args)
         super
-        @instrumenter = Switchman::ShardedInstrumenter.new(@instrumenter, self)
+
+        @instrumenter = Switchman::ShardedInstrumenter.new(@instrumenter, self) if ::Rails.version < "8.0"
+
         @last_query_at = Time.now
       end
 
-      def quote_local_table_name(name)
-        quote_table_name(name)
+      if ::Rails.version >= "8.0"
+        def instrumenter # :nodoc:
+          @instrumenter ||= Switchman::ShardedInstrumenter.new(::ActiveSupport::Notifications.instrumenter, self)
+        end
       end
 
-      def schema_migration
-        ::ActiveRecord::SchemaMigration
+      def quote_local_table_name(name)
+        quote_table_name(name)
       end
 
       protected

data/lib/switchman/active_record/associations.rb

@@ -23,12 +23,26 @@ module Switchman
       end
 
       module CollectionAssociation
-        def find_target
-          shards = reflection.options[:multishard] && owner.respond_to?(:associated_shards) ? owner.associated_shards : [shard]
+        def find_target(async: false)
+          shards = if reflection.options[:multishard] && owner.respond_to?(:associated_shards)
+                     owner.associated_shards
+                   else
+                     [shard]
+                   end
           # activate both the owner and the target's shard category, so that Reflection#join_id_for,
           # when called for the owner, will be returned relative to shard the query will execute on
-          Shard.with_each_shard(shards, [klass.connection_class_for_self, owner.class.connection_class_for_self].uniq) do
-            super
+          Shard.with_each_shard(shards,
+                                [klass.connection_class_for_self, owner.class.connection_class_for_self].uniq) do
+            if reflection.options[:multishard] && owner.respond_to?(:associated_shards) && reflection.has_scope?
+              # Prevent duplicate results when reflection has a scope (when it would use the skip_statement_cache? path)
+              # otherwise, the super call will set the shard_value to the object, causing it to iterate too many times
+              # over the associated shards
+              scope.shard(Shard.current(scope.klass.connection_class_for_self), :association).to_a
+            elsif ::Rails.version < "8.0"
+              super()
+            else
+              super
+            end
           end
         end
 
@@ -128,7 +142,12 @@ module Switchman
                 Shard.lookup(shard).activate do
                   scope_was = loader_query.scope
                   begin
-                    loader_query.instance_variable_set(:@scope, loader_query.scope.shard(Shard.current(loader_query.scope.model.connection_class_for_self)))
+                    loader_query.instance_variable_set(
+                      :@scope,
+                      loader_query.scope.shard(
+                        Shard.current(loader_query.scope.model.connection_class_for_self)
+                      )
+                    )
                     ret += loader_query.load_records_for_keys(keys) do |record|
                       loaders.each { |l| l.set_inverse(record) }
                     end
@@ -157,7 +176,7 @@ module Switchman
           end
 
           # Disabling to keep closer to rails original
-          # rubocop:disable Naming/AccessorMethodName, Style/GuardClause
+          # rubocop:disable Naming/AccessorMethodName
           # significant changes:
           #  * globalize the key to lookup
           def set_inverse(record)
@@ -174,7 +193,7 @@ module Switchman
               association.set_inverse_instance(record)
             end
           end
-          # rubocop:enable Naming/AccessorMethodName, Style/GuardClause
+          # rubocop:enable Naming/AccessorMethodName
 
           # significant changes:
           #  * partition_by_shard the records_for call
@@ -186,40 +205,7 @@ module Switchman
             # #compare_by_identity makes such owners different hash keys
             @records_by_owner = {}.compare_by_identity
 
-            if ::Rails.version >= '7.0'
-              raw_records ||= loader_query.records_for([self])
-            elsif owner_keys.empty?
-              raw_records ||= []
-            else
-              # determine the shard to search for each owner
-              if reflection.macro == :belongs_to
-                # for belongs_to, it's the shard of the foreign_key
-                partition_proc = lambda do |owner|
-                  if owner.class.sharded_column?(owner_key_name)
-                    Shard.shard_for(owner[owner_key_name], owner.shard)
-                  else
-                    Shard.current
-                  end
-                end
-              elsif !reflection.options[:multishard]
-                # for non-multishard associations, it's *just* the owner's shard
-                partition_proc = ->(owner) { owner.shard }
-              end
-
-              raw_records ||= Shard.partition_by_shard(owners, partition_proc) do |partitioned_owners|
-                relative_owner_keys = partitioned_owners.map do |owner|
-                  key = owner[owner_key_name]
-                  if key && owner.class.sharded_column?(owner_key_name)
-                    key = Shard.relative_id_for(key, owner.shard,
-                                                Shard.current(klass.connection_class_for_self))
-                  end
-                  convert_key(key)
-                end
-                relative_owner_keys.compact!
-                relative_owner_keys.uniq!
-                records_for(relative_owner_keys)
-              end
-            end
+            raw_records ||= loader_query.records_for([self])
 
             @preloaded_records = raw_records.select do |record|
               assignments = false
@@ -267,8 +253,8 @@ module Switchman
           self.shard_source_value = :association
         end
 
-        def shard(*args)
-          scope.shard(*args)
+        def shard(*)
+          scope.shard(*)
         end
       end
 
@@ -276,15 +262,52 @@ module Switchman
         def association_foreign_key_changed?(reflection, record, key)
           return false if reflection.through_reflection?
 
+          foreign_key = Array(reflection.foreign_key)
+          return false unless foreign_key.all? { |k| record._has_attribute?(k) }
+
           # have to use send instead of _read_attribute because sharding
-          record.has_attribute?(reflection.foreign_key) && record.send(reflection.foreign_key) != key
+          foreign_key.map { |k| record.send(k) } != Array(key)
         end
 
         def save_belongs_to_association(reflection)
-          # this seems counter-intuitive, but the autosave code will assign to attribute bypassing switchman,
-          # after reading the id attribute _without_ bypassing switchman. So we need Shard.current for the
-          # category of the associated record to match Shard.current for the category of self
-          shard.activate(connection_class_for_self_for_reflection(reflection)) { super }
+          association = association_instance_get(reflection.name)
+          return unless association&.loaded? && !association.stale_target?
+
+          record = association.load_target
+          return unless record && !record.destroyed?
+
+          autosave = reflection.options[:autosave]
+
+          if autosave && record.marked_for_destruction?
+            foreign_key = Array(reflection.foreign_key)
+            foreign_key.each { |key| self[key] = nil }
+            record.destroy
+          elsif autosave != false
+            saved = record.save(validate: !autosave) if record.new_record? || (autosave && record.changed_for_autosave?)
+
+            if association.updated?
+              primary_key = Array(compute_primary_key(reflection, record)).map(&:to_s)
+              foreign_key = Array(reflection.foreign_key)
+
+              primary_key_foreign_key_pairs = primary_key.zip(foreign_key)
+              primary_key_foreign_key_pairs.each do |pk, fk|
+                # Notable change: add relative_id_for here
+                association_id = if record.class.sharded_column?(pk)
+                                   Shard.relative_id_for(
+                                     record._read_attribute(pk),
+                                     record.shard,
+                                     shard
+                                   )
+                                 else
+                                   record._read_attribute(pk)
+                                 end
+                self[fk] = association_id unless self[fk] == association_id
+              end
+              association.loaded!
+            end
+
+            saved if autosave
+          end
         end
       end
     end

data/lib/switchman/active_record/attribute_methods.rb

@@ -26,13 +26,22 @@ module Switchman
         end
 
         def define_attribute_methods
-          super
+          result = super
           # ensure that we're using the sharded attribute method
           # and not the silly one in AR::AttributeMethods::PrimaryKey
-          return unless sharded_column?(@primary_key)
-
-          class_eval(build_sharded_getter('id', '_read_attribute(@primary_key)', "::#{connection_class_for_self.name}"), __FILE__, __LINE__)
-          class_eval(build_sharded_setter('id', @primary_key, "::#{connection_class_for_self.name}"), __FILE__, __LINE__)
+          return result unless sharded_column?(@primary_key)
+
+          class_eval(
+            build_sharded_getter("id",
+                                 "_read_attribute(@primary_key)",
+                                 "::#{connection_class_for_self.name}"),
+            __FILE__,
+            __LINE__
+          )
+          class_eval(build_sharded_setter("id", @primary_key, "::#{connection_class_for_self.name}"),
+                     __FILE__,
+                     __LINE__)
+          result
         end
 
         protected
@@ -46,18 +55,22 @@ module Switchman
           raise if connection.open_transactions.positive?
         end
 
-        def define_cached_method(owner, name, namespace:, as:, &block)
-          if ::Rails.version < '7.0'
-            yield owner
-            owner.rename_method(as, name)
+        def define_cached_method(owner, name, namespace:, as:, &)
+          if ::Rails.version < "7.1.4"
+            # https://github.com/rails/rails/commit/a2a12fc2e3f4e6d06f81d4c74c88f8e6b3369ee6#diff-5b59ece6d9396b596f06271cec0ea726e3360911383511c49b1a66f454bfc2b6L30
+            # These arguments were effectively swapped in Rails 7.1.4, so previous versions need them reversed
+            owner.define_cached_method(as, namespace:, as: name, &)
           else
-            owner.define_cached_method(name, namespace: namespace, as: as, &block)
+            owner.define_cached_method(name, namespace:, as:, &)
           end
         end
 
-        def define_method_global_attribute(attr_name, owner:)
+        def define_method_global_attribute(attr_name, owner:, as: attr_name)
           if sharded_column?(attr_name)
-            define_cached_method(owner, "global_#{attr_name}", as: "sharded_global_#{attr_name}", namespace: :switchman) do |batch|
+            define_cached_method(owner,
+                                 "sharded_global_#{attr_name}",
+                                 as: "global_#{as}",
+                                 namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def sharded_global_#{attr_name}
                   raw_value = original_#{attr_name}
@@ -69,13 +82,16 @@ module Switchman
               RUBY
             end
           else
-            define_method_unsharded_column(attr_name, 'global', owner)
+            define_method_unsharded_column(attr_name, "global", owner)
           end
         end
 
-        def define_method_local_attribute(attr_name, owner:)
+        def define_method_local_attribute(attr_name, owner:, as: attr_name)
           if sharded_column?(attr_name)
-            define_cached_method(owner, "local_#{attr_name}", as: "sharded_local_#{attr_name}", namespace: :switchman) do |batch|
+            define_cached_method(owner,
+                                 "sharded_local_#{attr_name}",
+                                 as: "local_#{as}",
+                                 namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def sharded_local_#{attr_name}
                   raw_value = original_#{attr_name}
@@ -85,7 +101,7 @@ module Switchman
               RUBY
             end
           else
-            define_method_unsharded_column(attr_name, 'local', owner)
+            define_method_unsharded_column(attr_name, "local", owner)
           end
         end
 
@@ -97,7 +113,13 @@ module Switchman
             if reflection.options[:polymorphic]
               # a polymorphic association has to be discovered at runtime. This code ends up being something like
               # context_type.&.constantize&.connection_class_for_self
-              "begin;read_attribute(:#{reflection.foreign_type})&.constantize&.connection_class_for_self;rescue NameError;::ActiveRecord::Base;end"
+              <<~RUBY
+                begin
+                  read_attribute(:#{reflection.foreign_type})&.constantize&.connection_class_for_self
+                rescue NameError
+                  ::ActiveRecord::Base
+                end
+              RUBY
             else
               # otherwise we can just return a symbol for the statically known type of the association
               "::#{reflection.klass.connection_class_for_self.name}"
@@ -107,16 +129,21 @@ module Switchman
           end
         end
 
-        def define_method_attribute(attr_name, owner:)
+        def define_method_attribute(attr_name, owner:, as: attr_name)
           if sharded_column?(attr_name)
             reflection = reflection_for_integer_attribute(attr_name)
             class_name = connection_class_for_self_code_for_reflection(reflection)
-            safe_class_name = class_name.unpack1('h*')
-            define_cached_method(owner, attr_name, as: "sharded_#{safe_class_name}_#{attr_name}", namespace: :switchman) do |batch|
-              batch << build_sharded_getter("sharded_#{safe_class_name}_#{attr_name}", "original_#{attr_name}", class_name)
+            safe_class_name = class_name.unpack1("h*")
+            define_cached_method(owner,
+                                 "sharded_#{safe_class_name}_#{attr_name}",
+                                 as:,
+                                 namespace: :switchman) do |batch|
+              batch << build_sharded_getter("sharded_#{safe_class_name}_#{attr_name}",
+                                            "original_#{as}",
+                                            class_name)
             end
           else
-            define_cached_method(owner, attr_name, as: "plain_#{attr_name}", namespace: :switchman) do |batch|
+            define_cached_method(owner, "plain_#{attr_name}", as:, namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def plain_#{attr_name}
                   _read_attribute("#{attr_name}") { |n| missing_attribute(n, caller) }
@@ -149,16 +176,19 @@ module Switchman
           RUBY
         end
 
-        def define_method_attribute=(attr_name, owner:)
+        def define_method_attribute=(attr_name, owner:, as: attr_name)
           if sharded_column?(attr_name)
             reflection = reflection_for_integer_attribute(attr_name)
             class_name = connection_class_for_self_code_for_reflection(reflection)
-            safe_class_name = class_name.unpack1('h*')
-            define_cached_method(owner, "#{attr_name}=", as: "sharded_#{safe_class_name}_#{attr_name}=", namespace: :switchman) do |batch|
+            safe_class_name = class_name.unpack1("h*")
+            define_cached_method(owner,
+                                 "sharded_#{safe_class_name}_#{attr_name}=",
+                                 as: "#{as}=",
+                                 namespace: :switchman) do |batch|
               batch << build_sharded_setter("sharded_#{safe_class_name}_#{attr_name}", attr_name, class_name)
             end
           else
-            define_cached_method(owner, "#{attr_name}=", as: "plain_#{attr_name}=", namespace: :switchman) do |batch|
+            define_cached_method(owner, "plain_#{attr_name}=", as: "#{as}=", namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def plain_#{attr_name}=(new_value)
                   _write_attribute('#{attr_name}', new_value)
@@ -176,9 +206,12 @@ module Switchman
           RUBY
         end
 
-        def define_method_original_attribute(attr_name, owner:)
+        def define_method_original_attribute(attr_name, owner:, as: attr_name)
           if sharded_column?(attr_name)
-            define_cached_method(owner, "original_#{attr_name}", as: "sharded_original_#{attr_name}", namespace: :switchman) do |batch|
+            define_cached_method(owner,
+                                 "sharded_original_#{attr_name}",
+                                 as: "original_#{as}",
+                                 namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def sharded_original_#{attr_name}
                   _read_attribute("#{attr_name}") { |n| missing_attribute(n, caller) }
@@ -186,14 +219,17 @@ module Switchman
               RUBY
             end
           else
-            define_method_unsharded_column(attr_name, 'global', owner)
+            define_method_unsharded_column(attr_name, "global", owner)
           end
         end
 
-        def define_method_original_attribute=(attr_name, owner:)
+        def define_method_original_attribute=(attr_name, owner:, as: attr_name)
           return unless sharded_column?(attr_name)
 
-          define_cached_method(owner, "original_#{attr_name}=", as: "sharded_original_#{attr_name}=", namespace: :switchman) do |batch|
+          define_cached_method(owner,
+                               "sharded_original_#{attr_name}=",
+                               as: "original_#{as}=",
+                               namespace: :switchman) do |batch|
             batch << <<-RUBY
               def sharded_original_#{attr_name}=(new_value)
                 _write_attribute('#{attr_name}', new_value)
@@ -203,9 +239,12 @@ module Switchman
         end
 
         def define_method_unsharded_column(attr_name, prefix, owner)
-          return if columns_hash["#{prefix}_#{attr_name}"] || attr_name == 'id'
+          return if columns_hash["#{prefix}_#{attr_name}"] || attr_name == "id"
 
-          define_cached_method(owner, "#{prefix}_#{attr_name}", as: "unsharded_#{prefix}_#{attr_name}", namespace: :switchman) do |batch|
+          define_cached_method(owner,
+                               "unsharded_#{prefix}_#{attr_name}",
+                               as: "#{prefix}_#{attr_name}",
+                               namespace: :switchman) do |batch|
             batch << <<-RUBY
               def unsharded_#{prefix}_#{attr_name}
                 raise NoMethodError, "undefined method `#{prefix}_#{attr_name}'; are you missing an association?"
@@ -217,8 +256,8 @@ module Switchman
 
       def self.prepended(klass)
         klass.singleton_class.prepend(ClassMethods)
-        klass.attribute_method_prefix 'global_', 'local_', 'original_'
-        klass.attribute_method_affix prefix: 'original_', suffix: '='
+        klass.attribute_method_prefix "global_", "local_", "original_"
+        klass.attribute_method_affix prefix: "original_", suffix: "="
       end
 
       # these are called if the specific methods haven't been defined yet
@@ -226,7 +265,11 @@ module Switchman
         return super unless self.class.sharded_column?(attr_name)
 
         reflection = self.class.send(:reflection_for_integer_attribute, attr_name)
-        ::Switchman::Shard.relative_id_for(super, shard, ::Switchman::Shard.current(connection_class_for_self_for_reflection(reflection)))
+        ::Switchman::Shard.relative_id_for(
+          super,
+          shard,
+          ::Switchman::Shard.current(connection_class_for_self_for_reflection(reflection))
+        )
       end
 
       def attribute=(attr_name, new_value)
@@ -236,7 +279,11 @@ module Switchman
         end
 
         reflection = self.class.send(:reflection_for_integer_attribute, attr_name)
-        super(::Switchman::Shard.relative_id_for(new_value, ::Switchman::Shard.current(connection_class_for_self_for_reflection(reflection)), shard))
+        super(attr_name, ::Switchman::Shard.relative_id_for(
+          new_value,
+          ::Switchman::Shard.current(connection_class_for_self_for_reflection(reflection)),
+          shard
+        ))
       end
 
       def global_attribute(attr_name)