switchman 2.0.9 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af9f8893be986771668662ceca8d3e36e28f5babf889a18e1e3efc237f7eae66
-  data.tar.gz: 675bd5b18076e8da86feb8a6e6271fffc1cd27939dedc1eb51c61bf165122b63
+  metadata.gz: a4ef7325514ffe64ab4fd53de062392b9edba2e7089ff35a8bbebfa475338a9d
+  data.tar.gz: cb74519796fee752ec5dc5e5469e39db240fbf819b38ea8d1ff5ae75c939601a
 SHA512:
-  metadata.gz: aadb4a342920dfe24e6110546380aa83a9aa4f61722e8c4c7265d0bf4494a2e8e04975d00504f7a26f143b87595bdb8c47ea09b4f9344f4925af08055c9d23e5
-  data.tar.gz: 295a3b4490f511380dcaeb44a6a6985cdf97745e678054eaf46315fc89d3adafd7a84a7a3665ec4521a6baa3b9f787adfccdc6d814baab10999c148b75041773
+  metadata.gz: 6583450d651aa95d06ad5d53a294bb2247ceee6fca42659a666da13378422fdaeeced89a772622de5671812fd7990531f470fd3d630870e6306d53e3e1ebc873
+  data.tar.gz: d1c21d744f5b926620f32540ca5c5c68b86ba97355b1fb8548ea829ccb05702173228eb40bf25e729a773be210436cfeb369ac2918a8aacea4da63d59b294404

data/app/models/switchman/shard.rb

@@ -18,7 +18,7 @@ module Switchman
           :unsharded => [Shard]
       }
     private_constant :CATEGORIES
-    @connection_specification_name = @shard_category = :unsharded
+    @connection_specification_name = 'unsharded'
 
     if defined?(::ProtectedAttributes)
       attr_accessible :default, :name, :database_server
@@ -283,17 +283,28 @@ module Switchman
 
                   with_each_shard(subscope, categories, options) { yield }
                   exception_pipe.last.close
-                rescue => e
+                rescue Exception => e
                   begin
                     dumped = Marshal.dump(e)
+                    dumped = nil if dumped.length > 64 * 1024
                   rescue
+                    dumped = nil
+                  end
+
+                  if dumped.nil?
                     # couldn't dump the exception; create a copy with just
                     # the message and the backtrace
                     e2 = e.class.new(e.message)
-                    e2.set_backtrace(e.backtrace)
+                    backtrace = e.backtrace
+                    # truncate excessively long backtraces
+                    if backtrace.length > 50
+                      backtrace = backtrace[0...25] + ['...'] + backtrace[-25..-1]
+                    end
+                    e2.set_backtrace(backtrace)
                     e2.instance_variable_set(:@active_shards, e.instance_variable_get(:@active_shards))
                     dumped = Marshal.dump(e2)
                   end
+
                   exception_pipe.last.set_encoding(dumped.encoding)
                   exception_pipe.last.write(dumped)
                   exception_pipe.last.flush

data/lib/switchman.rb

@@ -17,4 +17,6 @@ module Switchman
   def self.cache=(cache)
     @cache = cache
   end
+
+  class OrderOnMultiShardQuery < RuntimeError; end
 end

data/lib/switchman/active_record/association.rb

@@ -87,7 +87,7 @@ module Switchman
           # 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 record.class.shard_category == :unsharded
+              global_key = if model.shard_category == :unsharded
                              convert_key(record[association_key_name])
                            else
                              Shard.global_id_for(record[association_key_name], record.shard)

data/lib/switchman/active_record/calculations.rb

@@ -51,7 +51,7 @@ module Switchman
 
       def calculate_simple_average(column_name, distinct)
         # See activerecord#execute_simple_calculation
-        relation = reorder(nil)
+        relation = except(:order)
         column = aggregate_column(column_name)
         relation.select_values = [operation_over_aggregate_column(column, "average", distinct).as("average"),
                                   operation_over_aggregate_column(column, "count", distinct).as("count")]

data/lib/switchman/active_record/connection_handler.rb

@@ -112,8 +112,20 @@ module Switchman
       end
 
       def remove_connection(spec_name)
+        # also remove pools based on the same spec name that are for shard category purposes
+        # can't just use delete_if, because it's a Concurrent::Map, not a Hash
+        owner_to_pool.keys.each do |k|
+          next if k == spec_name
+
+          v = owner_to_pool[k]
+          owner_to_pool.delete(k) if v.is_a?(ConnectionPoolProxy) && v.spec.name == spec_name
+        end
+
+        # unwrap the pool from inside a ConnectionPoolProxy
         pool = owner_to_pool[spec_name]
         owner_to_pool[spec_name] = pool.default_pool if pool.is_a?(ConnectionPoolProxy)
+
+        # now let Rails do its thing with the data type it expects
         super
       end
 
@@ -128,15 +140,21 @@ module Switchman
             else
               ancestor_pool.spec
             end
-            pool = establish_connection(spec.to_hash)
-            pool.instance_variable_set(:@schema_cache, ancestor_pool.schema_cache) if ancestor_pool.schema_cache
-            pool
-          elsif spec_name != "primary"
+            # avoid copying "duplicate" pools that implement shard categories.
+            # they'll have a spec.name of primary, but a spec_name of something else, like unsharded
+            if spec.name == spec_name
+              pool = establish_connection(spec.to_hash)
+              pool.instance_variable_set(:@schema_cache, ancestor_pool.schema_cache) if ancestor_pool.schema_cache
+              next pool
+            end
+          end
+
+          if spec_name != "primary"
             primary_pool = retrieve_connection_pool("primary")
             if primary_pool.is_a?(ConnectionPoolProxy)
               pool = ConnectionPoolProxy.new(spec_name.to_sym, primary_pool.default_pool, @shard_connection_pools)
               pool.schema_cache.copy_references(primary_pool.schema_cache)
-              pool
+              owner_to_pool[spec_name] = pool
             else
               primary_pool
             end

data/lib/switchman/active_record/postgresql_adapter.rb

@@ -215,6 +215,10 @@ module Switchman
         name.quoted
       end
 
+      def with_global_table_name(&block)
+        with_local_table_name(false, &block)
+      end
+
       def with_local_table_name(enable = true)
         old_value = @use_local_table_name
         @use_local_table_name = enable

data/lib/switchman/active_record/predicate_builder.rb

@@ -15,7 +15,7 @@ module Switchman
         def convert_to_id(value)
           case value
           when ::ActiveRecord::Base
-            value.send(primary_key)
+            value.id
           else
             super
           end

data/lib/switchman/active_record/query_methods.rb

@@ -233,6 +233,10 @@ module Switchman
         connection.with_local_table_name { super }
       end
 
+      def table_name_matches?(from)
+        connection.with_global_table_name { super }
+      end
+
       # semi-private
       public
       def transpose_predicates(predicates,
@@ -242,6 +246,18 @@ module Switchman
                                binds: nil,
                                dup_binds_on_mutation: false)
         result = predicates.map do |predicate|
+          if ::Rails.version >= '5.2' && predicate.is_a?(::Arel::Nodes::And)
+            new_predicates, _binds = transpose_predicates(predicate.children, source_shard, target_shard,
+              remove_nonlocal_primary_keys,
+              binds: binds,
+              dup_binds_on_mutation: dup_binds_on_mutation)
+            next (if new_predicates == predicate.children
+              predicate
+            else
+              ::Arel::Nodes::And.new(new_predicates)
+            end)
+          end
+
           next predicate unless predicate.is_a?(::Arel::Nodes::Binary)
           next predicate unless predicate.left.is_a?(::Arel::Attributes::Attribute)
           relation, column = relation_and_column(predicate.left)
@@ -250,7 +266,7 @@ module Switchman
           remove = true if type == :primary &&
               remove_nonlocal_primary_keys &&
               predicate.left.relation.model == klass &&
-              predicate.is_a?(::Arel::Nodes::Equality)
+              (predicate.is_a?(::Arel::Nodes::Equality) || predicate.is_a?(::Arel::Nodes::In))
 
           current_source_shard =
               if source_shard
@@ -265,7 +281,7 @@ module Switchman
             new_right_value =
               case predicate.right
               when Array
-                predicate.right.map {|val| transpose_predicate_value(val, current_source_shard, target_shard, type, remove) }
+                predicate.right.map {|val| transpose_predicate_value(val, current_source_shard, target_shard, type, remove).presence }.compact
               else
                 transpose_predicate_value(predicate.right, current_source_shard, target_shard, type, remove)
               end
@@ -340,7 +356,7 @@ module Switchman
             value
           else
             local_id = Shard.relative_id_for(current_id, current_shard, target_shard) || current_id
-            local_id = [] if remove_non_local_ids && local_id.is_a?(Integer) && local_id > Shard::IDS_PER_SHARD
+            return nil if remove_non_local_ids && local_id.is_a?(Integer) && local_id > Shard::IDS_PER_SHARD
             if current_id != local_id
               # make a new bind param
               ::Arel::Nodes::BindParam.new(query_att.class.new(query_att.name, local_id, query_att.type))

data/lib/switchman/active_record/reflection.rb

@@ -28,15 +28,26 @@ module Switchman
         # this technically belongs on AssociationReflection, but we put it on
         # ThroughReflection as well, instead of delegating to its internal
         # HasManyAssociation, losing its proper `klass`
-        def association_scope_cache(conn, owner, &block)
-          key = conn.prepared_statements
-          if polymorphic?
-            key = [key, owner._read_attribute(@foreign_type)]
+        if ::Rails.version < '6.0.4'
+          def association_scope_cache(conn, owner, &block)
+            key = conn.prepared_statements
+            if polymorphic?
+              key = [key, owner._read_attribute(@foreign_type)]
+            end
+            key = [key, shard(owner).id].flatten
+            @association_scope_cache[key] ||= @scope_lock.synchronize {
+              @association_scope_cache[key] ||= (::Rails.version >= "5.2" ? ::ActiveRecord::StatementCache.create(conn, &block) : block.call)
+            }
+          end
+        else
+          def association_scope_cache(klass, owner, &block)
+            key = self
+            if polymorphic?
+              key = [key, owner._read_attribute(@foreign_type)]
+            end
+            key = [key, shard(owner).id].flatten
+            klass.cached_find_by_statement(key, &block)
           end
-          key = [key, shard(owner).id].flatten
-          @association_scope_cache[key] ||= @scope_lock.synchronize {
-            @association_scope_cache[key] ||= (::Rails.version >= "5.2" ? ::ActiveRecord::StatementCache.create(conn, &block) : block.call)
-          }
         end
       end
 

data/lib/switchman/active_record/relation.rb

@@ -62,7 +62,7 @@ module Switchman
       %I{update_all delete_all}.each do |method|
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{method}(*args)
-            result = self.activate { |relation| relation.call_super(#{method.inspect}, Relation, *args) }
+            result = self.activate(unordered: true) { |relation| relation.call_super(#{method.inspect}, Relation, *args) }
             result = result.sum if result.is_a?(Array)
             result
           end
@@ -97,7 +97,7 @@ module Switchman
         end
       end
 
-      def activate(&block)
+      def activate(unordered: false, &block)
         shards = all_shards
         if (Array === shards && shards.length == 1)
           if shards.first == DefaultShard || shards.first == Shard.current(klass.shard_category)
@@ -106,10 +106,64 @@ module Switchman
             shards.first.activate(klass.shard_category) { yield(self, shards.first) }
           end
         else
-          # TODO: implement local limit to avoid querying extra shards
-          Shard.with_each_shard(shards, [klass.shard_category]) do
-            shard(Shard.current(klass.shard_category), :to_a).activate(&block)
+          result_count = 0
+          can_order = false
+          result = Shard.with_each_shard(shards, [klass.shard_category]) do
+            # don't even query other shards if we're already past the limit
+            next if limit_value && result_count >= limit_value && order_values.empty?
+
+            relation = shard(Shard.current(klass.shard_category), :to_a)
+            # do a minimal query if possible
+            relation = relation.limit(limit_value - result_count) if limit_value && !result_count.zero? && order_values.empty?
+
+            shard_results = relation.activate(&block)
+
+            if shard_results.present? && !unordered
+              can_order ||= can_order_cross_shard_results? unless order_values.empty?
+              raise OrderOnMultiShardQuery if !can_order && !order_values.empty? && result_count.positive?
+
+              result_count += shard_results.is_a?(Array) ? shard_results.length : 1
+            end
+            shard_results
+          end
+
+          result = reorder_cross_shard_results(result) if can_order
+          result.slice!(limit_value..-1) if limit_value
+          result
+        end
+      end
+
+      def can_order_cross_shard_results?
+        # we only presume to be able to post-sort the most basic of orderings
+        order_values.all? { |ov| ov.is_a?(::Arel::Nodes::Ordering) && ov.expr.is_a?(::Arel::Attributes::Attribute) }
+      end
+
+      def reorder_cross_shard_results(results)
+        results.sort! do |l, r|
+          result = 0
+          order_values.each do |ov|
+            if !l.is_a?(::ActiveRecord::Base)
+              a, b = l, r
+            elsif l.respond_to?(ov.expr.name)
+              a = l.send(ov.expr.name)
+              b = r.send(ov.expr.name)
+            else
+              a = l.attributes[ov.expr.name]
+              b = r.attributes[ov.expr.name]
+            end
+            next if a == b
+
+            if a.nil? || b.nil?
+              result = 1 if a.nil?
+              result *= -1 if ov.is_a?(::Arel::Nodes::Descending)
+            else
+              result = a <=> b
+            end
+
+            result *= -1 if ov.is_a?(::Arel::Nodes::Descending)
+            break unless result.zero?
           end
+          result
         end
       end
     end

data/lib/switchman/engine.rb

@@ -142,6 +142,7 @@ module Switchman
 
         ::ActiveRecord::Relation::WhereClauseFactory.prepend(ActiveRecord::WhereClauseFactory)
         ::ActiveRecord::PredicateBuilder::AssociationQueryValue.prepend(ActiveRecord::PredicateBuilder::AssociationQueryValue)
+        ::ActiveRecord::PredicateBuilder::PolymorphicArrayValue.prepend(ActiveRecord::PredicateBuilder::AssociationQueryValue)
         ::ActiveRecord::TypeCaster::Map.include(ActiveRecord::TypeCaster::Map)
         ::ActiveRecord::TypeCaster::Connection.include(ActiveRecord::TypeCaster::Connection)
 

data/lib/switchman/test_helper.rb

@@ -17,13 +17,7 @@ module Switchman
           Shard.default(reload: true)
         end
 
-        # can't auto-create a new shard on the default shard's db server if the
-        # default shard is split across multiple db servers
-        if ::ActiveRecord::Base.connection_handler.connection_pool_list.length > 1
-          server1 = DatabaseServer.create(Shard.default.database_server.config)
-        else
-          server1 = Shard.default.database_server
-        end
+        server1 = Shard.default.database_server
         server2 = DatabaseServer.create(Shard.default.database_server.config.merge(server2: true))
 
         if server1 == Shard.default.database_server && server1.config[:shard1] && server1.config[:shard2]

data/lib/switchman/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Switchman
-  VERSION = "2.0.9"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switchman
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.1.0
 platform: ruby
 authors:
 - Cody Cutrer
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties