switchman 3.0.24 → 4.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 469ef6bca62776e9ba974a5c6d2a6220fc6ddcf1649956f43247465cbfb24f37
-  data.tar.gz: 9fefef5095835cf28a6c72197ed74f6de9974d7c9c9019ad4ea87209d98c37e9
+  metadata.gz: b26ae7fe0a43054e224f7104377e1a47d8cb56e4a5e05cb443f76045901f8298
+  data.tar.gz: 220c7665740e8ff3cf7a27b0bed847e744bd2d0732c35d93ecd05489b71ccd7c
 SHA512:
-  metadata.gz: 96d01726ff4e0e560e63964c5607417b7272202109b6e7e718769e9ba2cc04f82000f442c70aef8d6140e6dac00925197f0a95c70b790d47fbc2355d9021ae39
-  data.tar.gz: 4b2edb3c0400f3280ba579bfaac61fce263ea5dd0881e5eeb77e675e0d2c1dfe04168e059f7bb91ac601ce2ef210c50c252945258fe2166ee6cf21c458defac0
+  metadata.gz: 2dc2d565571d81b9e222c3b083095a6b11ff2c22b4f756ed0e2e03d859e44d1d3f3e1696a3510ee5fa3e97b4595a2a5def19e70f0a5bd28d547fc6c277ae4631
+  data.tar.gz: 9780190480638be3fedc7b15bd6c34a5e3de8478051e18835684aec755752a894236145f9ba5061fafc483fa3b500d2da51ce4fb95748a809d3c506620cb8167

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 rubocop]
+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,21 +19,25 @@ 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
 
-      def log(*args, &block)
+      def log(...)
         super
       ensure
         @last_query_at = Time.now

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_classes, owner.class.connection_classes].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
 
@@ -50,7 +64,7 @@ module Switchman
         def shard
           if @owner.class.sharded_column?(@reflection.foreign_key) &&
              (foreign_id = @owner[@reflection.foreign_key])
-            Shard.shard_for(foreign_id, @owner.shard)
+            Shard.shard_for(foreign_id, @owner.loaded_from_shard)
           else
             super
           end
@@ -83,10 +97,74 @@ module Switchman
 
       module Preloader
         module Association
+          # significant changes:
+          #  * associate shards with records
+          #  * look on all appropriate shards when loading records
+          module LoaderRecords
+            def populate_keys_to_load_and_already_loaded_records
+              @sharded_keys_to_load = {}
+
+              loaders.each do |loader|
+                multishard = loader.send(:reflection).options[:multishard]
+                belongs_to = loader.send(:reflection).macro == :belongs_to
+                loader.owners_by_key.each do |key, owners|
+                  if (loaded_owner = owners.find { |owner| loader.loaded?(owner) })
+                    already_loaded_records_by_key[key] = loader.target_for(loaded_owner)
+                  else
+                    shard_set = @sharded_keys_to_load[key] ||= Set.new
+                    owner_key_name = loader.send(:owner_key_name)
+                    owners.each do |owner|
+                      if multishard && owner.respond_to?(:associated_shards)
+                        shard_set.merge(owner.associated_shards.map(&:id))
+                      elsif belongs_to && owner.class.sharded_column?(owner_key_name)
+                        shard_set.add(Shard.shard_for(owner[owner_key_name], owner.shard).id)
+                      elsif belongs_to
+                        shard_set.add(Shard.current.id)
+                      else
+                        shard_set.add(owner.shard.id)
+                      end
+                    end
+                  end
+                end
+              end
+
+              @sharded_keys_to_load.delete_if { |key, _shards| already_loaded_records_by_key.include?(key) }
+            end
+
+            def load_records
+              ret = []
+
+              shards_with_keys = @sharded_keys_to_load.each_with_object({}) do |(key, shards), h|
+                shards.each { |shard| (h[shard] ||= []) << key }
+              end
+
+              shards_with_keys.each do |shard, keys|
+                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)
+                      )
+                    )
+                    ret += loader_query.load_records_for_keys(keys) do |record|
+                      loaders.each { |l| l.set_inverse(record) }
+                    end
+                  ensure
+                    loader_query.instance_variable_set(:@scope, scope_was)
+                  end
+                end
+              end
+
+              ret
+            end
+          end
+
           # Copypasta from Activerecord but with added global_id_for goodness.
           def records_for(ids)
             scope.where(association_key_name => ids).load do |record|
-              global_key = if model.connection_classes == UnshardedRecord
+              global_key = if model.connection_class_for_self == UnshardedRecord
                              convert_key(record[association_key_name])
                            else
                              Shard.global_id_for(record[association_key_name], record.shard)
@@ -97,46 +175,37 @@ module Switchman
             end
           end
 
+          # Disabling to keep closer to rails original
+          # rubocop:disable Naming/AccessorMethodName
+          # significant changes:
+          #  * globalize the key to lookup
+          def set_inverse(record)
+            global_key = if model.connection_class_for_self == UnshardedRecord
+                           convert_key(record[association_key_name])
+                         else
+                           Shard.global_id_for(record[association_key_name], record.shard)
+                         end
+
+            if (owners = owners_by_key[convert_key(global_key)])
+              # Processing only the first owner
+              # because the record is modified but not an owner
+              association = owners.first.association(reflection.name)
+              association.set_inverse_instance(record)
+            end
+          end
+          # rubocop:enable Naming/AccessorMethodName
+
           # significant changes:
           #  * partition_by_shard the records_for call
           #  * re-globalize the fetched owner id before looking up in the map
-          def load_records
+          # TODO: the ignored param currently loads records; we should probably not waste effort double-loading them
+          # Change introduced here: https://github.com/rails/rails/commit/c6c0b2e8af64509b699b782aadfecaa430700ece
+          def load_records(raw_records = nil)
             # owners can be duplicated when a relation has a collection association join
             # #compare_by_identity makes such owners different hash keys
             @records_by_owner = {}.compare_by_identity
 
-            if 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_classes))
-                  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
@@ -147,7 +216,7 @@ module Switchman
                                                 record.shard)
               end
 
-              owners_by_key[convert_key(owner_key)].each do |owner|
+              owners_by_key[convert_key(owner_key)]&.each do |owner|
                 entries = (@records_by_owner[owner] ||= [])
 
                 if reflection.collection? || entries.empty?
@@ -184,23 +253,61 @@ module Switchman
           self.shard_source_value = :association
         end
 
-        def shard(*args)
-          scope.shard(*args)
+        def shard(*)
+          scope.shard(*)
         end
       end
 
       module AutosaveAssociation
-        def record_changed?(reflection, record, key)
-          record.new_record? ||
-            (record.has_attribute?(reflection.foreign_key) && record.send(reflection.foreign_key) != key) || # have to use send instead of [] because sharding
-            record.attribute_changed?(reflection.foreign_key)
+        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
+          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_classes_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