switchman 3.1.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48b27124d5233adf585aed105d0b2522c76249bdd1e13fbcfd7e904241d3a624
-  data.tar.gz: fea1ccc0ad63f00633fb90bee1d7bd4606f6de0e18564250865c1b1dde61ef8d
+  metadata.gz: 1f6f878b1a2a9ba1dc0c75ce4fcd5d299178ea7940a048190bd4b181ae306339
+  data.tar.gz: 19b31ce1e456fbecf2a9ba9b15644bc6073cd521b6a604da81a0c5f8977f579a
 SHA512:
-  metadata.gz: c05b445111dd0e4b16ecbfaea6ab84557fa2cbadc6102fa0af6fb43cff2f6bbb6606e825f76ed20f6b8a4a2a2966e31babadf66c5eb065a6c4d8a7eea6a8b92a
-  data.tar.gz: 0af9e15706142f90772d24e2187db93ec83331997bccbb25c1b89cec2dde1bd2414d2774fec3785c7bea1a1b06d3fa5ad49e15b716f0aa35794e2e5734c848a8
+  metadata.gz: bad542adf6c09d1e1e50ef3054a8ca8d106bd3eedb7cb9dbbe544e44dd88c7f19226e7dd0d805ad5a5685009be7b9c9fe20623182c8c624c88724d00d7bc5656
+  data.tar.gz: 43b76369798a3683f838e392466cec0628d0c4a309354db7ccadcafca604f6eeffdcc460e036ca8d0f105c7abed2987baa23d51b830e628951c057adb554f305

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/associations.rb

@@ -24,10 +24,15 @@ module Switchman
 
       module CollectionAssociation
         def find_target
-          shards = reflection.options[:multishard] && owner.respond_to?(:associated_shards) ? owner.associated_shards : [shard]
+          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
+          Shard.with_each_shard(shards,
+                                [klass.connection_class_for_self, owner.class.connection_class_for_self].uniq) do
             super
           end
         end
@@ -50,7 +55,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,16 +88,67 @@ module Switchman
 
       module Preloader
         module Association
-          module LoaderQuery
-            def load_records_in_batch(loaders)
-              # While in theory loading multiple associations that end up being effectively the same would be nice
-              # it's not very switchman compatible, so just don't bother trying to use that logic
-              # raw_records = records_for(loaders)
+          # 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|
-                loader.load_records(nil)
-                loader.run
+                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
 
@@ -110,6 +166,26 @@ module Switchman
             end
           end
 
+          # Disabling to keep closer to rails original
+          # rubocop:disable Naming/AccessorMethodName, Style/GuardClause
+          # 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, Style/GuardClause
+
           # significant changes:
           #  * partition_by_shard the records_for call
           #  * re-globalize the fetched owner id before looking up in the map
@@ -120,7 +196,9 @@ module Switchman
             # #compare_by_identity makes such owners different hash keys
             @records_by_owner = {}.compare_by_identity
 
-            if ::Rails.version < '7.0' && owner_keys.empty?
+            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
@@ -142,7 +220,8 @@ module Switchman
                 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,
+                    key = Shard.relative_id_for(key,
+                                                owner.shard,
                                                 Shard.current(klass.connection_class_for_self))
                   end
                   convert_key(key)
@@ -162,7 +241,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?
@@ -205,10 +284,11 @@ module Switchman
       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?
+
+          # have to use send instead of _read_attribute because sharding
+          record.has_attribute?(reflection.foreign_key) && record.send(reflection.foreign_key) != key
         end
 
         def save_belongs_to_association(reflection)

data/lib/switchman/active_record/attribute_methods.rb

@@ -31,8 +31,16 @@ module Switchman
           # 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__)
+          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__)
         end
 
         protected
@@ -46,20 +54,21 @@ module Switchman
           raise if connection.open_transactions.positive?
         end
 
-        # rubocop:disable Naming/MethodParameterName
         def define_cached_method(owner, name, namespace:, as:, &block)
-          if ::Rails.version < '7.0'
+          if ::Rails.version < "7.0"
             yield owner
             owner.rename_method(as, name)
           else
             owner.define_cached_method(name, namespace: namespace, as: as, &block)
           end
         end
-        # rubocop:enable Naming/MethodParameterName
 
         def define_method_global_attribute(attr_name, owner:)
           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,
+                                 "global_#{attr_name}",
+                                 as: "sharded_global_#{attr_name}",
+                                 namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def sharded_global_#{attr_name}
                   raw_value = original_#{attr_name}
@@ -71,13 +80,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:)
           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,
+                                 "local_#{attr_name}",
+                                 as: "sharded_local_#{attr_name}",
+                                 namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def sharded_local_#{attr_name}
                   raw_value = original_#{attr_name}
@@ -87,7 +99,7 @@ module Switchman
               RUBY
             end
           else
-            define_method_unsharded_column(attr_name, 'local', owner)
+            define_method_unsharded_column(attr_name, "local", owner)
           end
         end
 
@@ -99,7 +111,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
-              "read_attribute(:#{reflection.foreign_type})&.constantize&.connection_class_for_self"
+              <<~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}"
@@ -113,9 +131,14 @@ module Switchman
           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,
+                                 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)
             end
           else
             define_cached_method(owner, attr_name, as: "plain_#{attr_name}", namespace: :switchman) do |batch|
@@ -136,7 +159,7 @@ module Switchman
 
               abs_raw_value = raw_value.abs
               current_shard = ::Switchman::Shard.current(#{attr_connection_class})
-              same_shard = shard == current_shard
+              same_shard = loaded_from_shard == current_shard
               return raw_value if same_shard && abs_raw_value < ::Switchman::Shard::IDS_PER_SHARD
 
               value_shard_id = abs_raw_value / ::Switchman::Shard::IDS_PER_SHARD
@@ -144,9 +167,9 @@ module Switchman
               # of a local id
               return raw_value % ::Switchman::Shard::IDS_PER_SHARD if value_shard_id == current_shard.id
               return raw_value if !same_shard && abs_raw_value > ::Switchman::Shard::IDS_PER_SHARD
-              return shard.global_id_for(raw_value) if !same_shard && abs_raw_value < ::Switchman::Shard::IDS_PER_SHARD
+              return loaded_from_shard.global_id_for(raw_value) if !same_shard && abs_raw_value < ::Switchman::Shard::IDS_PER_SHARD
 
-              ::Switchman::Shard.relative_id_for(raw_value, shard, current_shard)
+              ::Switchman::Shard.relative_id_for(raw_value, loaded_from_shard, current_shard)
             end
           RUBY
         end
@@ -155,8 +178,11 @@ module Switchman
           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,
+                                 "#{attr_name}=",
+                                 as: "sharded_#{safe_class_name}_#{attr_name}=",
+                                 namespace: :switchman) do |batch|
               batch << build_sharded_setter("sharded_#{safe_class_name}_#{attr_name}", attr_name, class_name)
             end
           else
@@ -173,14 +199,17 @@ module Switchman
         def build_sharded_setter(attr_name, attr_field, attr_connection_class)
           <<-RUBY
             def #{attr_name}=(new_value)
-              self.original_#{attr_field} = ::Switchman::Shard.relative_id_for(new_value, ::Switchman::Shard.current(#{attr_connection_class}), shard)
+              self.original_#{attr_field} = ::Switchman::Shard.relative_id_for(new_value, ::Switchman::Shard.current(#{attr_connection_class}), loaded_from_shard)
             end
           RUBY
         end
 
         def define_method_original_attribute(attr_name, owner:)
           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,
+                                 "original_#{attr_name}",
+                                 as: "sharded_original_#{attr_name}",
+                                 namespace: :switchman) do |batch|
               batch << <<-RUBY
                 def sharded_original_#{attr_name}
                   _read_attribute("#{attr_name}") { |n| missing_attribute(n, caller) }
@@ -188,14 +217,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:)
           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,
+                               "original_#{attr_name}=",
+                               as: "sharded_original_#{attr_name}=",
+                               namespace: :switchman) do |batch|
             batch << <<-RUBY
               def sharded_original_#{attr_name}=(new_value)
                 _write_attribute('#{attr_name}', new_value)
@@ -205,9 +237,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,
+                               "#{prefix}_#{attr_name}",
+                               as: "unsharded_#{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?"
@@ -219,8 +254,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
@@ -228,7 +263,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)
@@ -238,7 +277,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(::Switchman::Shard.relative_id_for(
+          new_value,
+          ::Switchman::Shard.current(connection_class_for_self_for_reflection(reflection)),
+          shard
+        ))
       end
 
       def global_attribute(attr_name)
@@ -251,25 +294,11 @@ module Switchman
 
       def local_attribute(attr_name)
         if self.class.sharded_column?(attr_name)
-          ::Switchman::Shard.local_id_for(attribute(attr_name), shard).first
+          ::Switchman::Shard.local_id_for(attribute(attr_name)).first
         else
           attribute(attr_name)
         end
       end
-
-      private
-
-      def connection_class_for_self_for_reflection(reflection)
-        if reflection
-          if reflection.options[:polymorphic]
-            read_attribute(reflection.foreign_type)&.constantize&.connection_class_for_self
-          else
-            reflection.klass.connection_class_for_self
-          end
-        else
-          self.class.connection_class_for_self
-        end
-      end
     end
   end
 end