switchman 3.3.1 → 4.0.0

data/lib/switchman/active_record/query_methods.rb

@@ -3,6 +3,19 @@
 module Switchman
   module ActiveRecord
     module QueryMethods
+      # Use this class to prevent a value from getting transposed across shards
+      class NonTransposingValue < SimpleDelegator
+        def class
+          __getobj__.class
+        end
+
+        def is_a?(other)
+          return true if other == NonTransposingValue
+
+          __getobj__.is_a?(other)
+        end
+      end
+
       # shard_value is one of:
       #   A shard
       #   An array or relation of shards
@@ -84,6 +97,14 @@ module Switchman
         super(other.shard(primary_shard))
       end
 
+      # use a temp variable so that the new where clause is built before self.where_clause is read,
+      # since build_where_clause might mutate self.where_clause
+      def where!(opts, *rest)
+        new_clause = build_where_clause(opts, rest)
+        self.where_clause += new_clause
+        self
+      end
+
       protected
 
       def remove_nonlocal_primary_keys!
@@ -93,7 +114,7 @@ module Switchman
             predicate.left.relation.klass == klass &&
             (predicate.is_a?(::Arel::Nodes::Equality) || predicate.is_a?(::Arel::Nodes::HomogeneousIn))
 
-          value.is_a?(Integer) && value > Shard::IDS_PER_SHARD ? [] : value
+          (value.is_a?(Integer) && value > Shard::IDS_PER_SHARD) ? [] : value
         end
         self
       end
@@ -104,7 +125,9 @@ module Switchman
         return unless klass.integral_id?
 
         primary_key = predicates.detect do |predicate|
-          (predicate.is_a?(::Arel::Nodes::Binary) || predicate.is_a?(::Arel::Nodes::HomogeneousIn)) &&
+          (predicate.is_a?(::Arel::Nodes::Equality) ||
+           predicate.is_a?(::Arel::Nodes::In) ||
+           predicate.is_a?(::Arel::Nodes::HomogeneousIn)) &&
             predicate.left.is_a?(::Arel::Attributes::Attribute) &&
             predicate.left.relation.is_a?(::Arel::Table) && predicate.left.relation.klass == klass &&
             klass.primary_key == predicate.left.name
@@ -167,19 +190,19 @@ module Switchman
       end
 
       def sharded_foreign_key?(relation, column)
-        models_for_table(relation.table_name).any? { |m| m.sharded_column?(column) }
+        models_for_table(relation.name).any? { |m| m.sharded_column?(column) }
       end
 
       def sharded_primary_key?(relation, column)
         column = column.to_s
-        return column == 'id' if relation.klass == ::ActiveRecord::Base
+        return column == "id" if relation.klass == ::ActiveRecord::Base
 
         relation.klass.primary_key == column && relation.klass.integral_id?
       end
 
       def source_shard_for_foreign_key(relation, column)
         reflection = nil
-        models_for_table(relation.table_name).each do |model|
+        models_for_table(relation.name).each do |model|
           reflection = model.send(:reflection_for_integer_attribute, column)
           break if reflection
         end
@@ -199,12 +222,11 @@ module Switchman
 
         case opts
         when String, Array
-          values = Hash === rest.first ? rest.first.values : rest
+          values = (Hash === rest.first) ? rest.first.values : rest
 
-          values.grep(ActiveRecord::Relation) do |rel|
-            # serialize subqueries against the same shard as the outer query is currently
-            # targeted to run against
-            rel.shard!(primary_shard) if rel.shard_source_value == :implicit && rel.primary_shard != primary_shard
+          if shard_source_value != :explicit && values.grep(ActiveRecord::Relation).first
+            raise "Sub-queries are not allowed as simple substitutions; " \
+                  "please build your relation with more structured methods so that Switchman is able to introspect it."
           end
 
           super
@@ -254,9 +276,10 @@ module Switchman
         send(clause_setter, new_clause)
       end
 
-      def each_transposable_predicate(predicates = nil, &block)
+      def each_transposable_predicate(predicates, &block)
         each_predicate(predicates) do |predicate|
-          if predicate.is_a?(::Arel::Nodes::Grouping)
+          case predicate
+          when ::Arel::Nodes::Grouping
             next predicate unless predicate.expr.is_a?(::Arel::Nodes::Or)
 
             or_expr = predicate.expr
@@ -267,6 +290,40 @@ module Switchman
             next predicate if new_left == old_left && new_right == old_right
 
             next predicate.class.new predicate.expr.class.new(new_left, new_right)
+          when ::Arel::Nodes::SelectStatement
+            new_cores = predicate.cores.map do |core|
+              next core unless core.is_a?(::Arel::Nodes::SelectCore) # just in case something weird is going on
+
+              new_wheres = each_transposable_predicate(core.wheres, &block)
+              new_havings = each_transposable_predicate(core.havings, &block)
+
+              next core if core.wheres == new_wheres && core.havings == new_havings
+
+              new_core = core.clone
+              new_core.wheres = new_wheres
+              new_core.havings = new_havings
+              new_core
+            end
+
+            next predicate if predicate.cores == new_cores
+
+            new_node = predicate.clone
+            new_node.instance_variable_set(:@cores, new_cores)
+            next new_node
+          when ::Arel::Nodes::Not
+            old_value = predicate.expr
+            new_value = each_transposable_predicate([old_value], &block).first
+
+            next predicate if old_value == new_value
+
+            next predicate.class.new(new_value)
+          when ::Arel::Nodes::Exists
+            old_value = predicate.expressions
+            new_value = each_transposable_predicate([old_value], &block).first
+
+            next predicate if old_value == new_value
+
+            next predicate.class.new(new_value)
           end
 
           next predicate unless predicate.is_a?(::Arel::Nodes::Binary) || predicate.is_a?(::Arel::Nodes::HomogeneousIn)
@@ -279,54 +336,56 @@ module Switchman
         end
       end
 
-      def each_transposable_predicate_value(predicates = nil)
+      def each_transposable_predicate_value(predicates = nil, &block)
         each_transposable_predicate(predicates) do |predicate, relation, column, type|
-          each_transposable_predicate_value_cb(predicate) do |value|
+          each_transposable_predicate_value_cb(predicate, block) do |value|
             yield(value, predicate, relation, column, type)
           end
         end
       end
 
-      def each_transposable_predicate_value_cb(node, &block)
+      def each_transposable_predicate_value_cb(node, original_block, &block)
         case node
         when Array
-          node.map { |val| each_transposable_predicate_value_cb(val, &block).presence }.compact
+          node.filter_map { |val| each_transposable_predicate_value_cb(val, original_block, &block).presence }
         when ::ActiveModel::Attribute
           old_value = node.value_before_type_cast
-          new_value = each_transposable_predicate_value_cb(old_value, &block)
+          new_value = each_transposable_predicate_value_cb(old_value, original_block, &block)
 
-          old_value == new_value ? node : node.class.new(node.name, new_value, node.type)
+          (old_value == new_value) ? node : node.class.new(node.name, new_value, node.type)
         when ::Arel::Nodes::And
           old_value = node.children
-          new_value = each_transposable_predicate_value_cb(old_value, &block)
+          new_value = each_transposable_predicate_value_cb(old_value, original_block, &block)
 
-          old_value == new_value ? node : node.class.new(new_value)
+          (old_value == new_value) ? node : node.class.new(new_value)
         when ::Arel::Nodes::BindParam
           old_value = node.value
-          new_value = each_transposable_predicate_value_cb(old_value, &block)
+          new_value = each_transposable_predicate_value_cb(old_value, original_block, &block)
 
-          old_value == new_value ? node : node.class.new(new_value)
+          (old_value == new_value) ? node : node.class.new(new_value)
         when ::Arel::Nodes::Casted
           old_value = node.value
-          new_value = each_transposable_predicate_value_cb(old_value, &block)
+          new_value = each_transposable_predicate_value_cb(old_value, original_block, &block)
 
-          old_value == new_value ? node : node.class.new(new_value, node.attribute)
+          (old_value == new_value) ? node : node.class.new(new_value, node.attribute)
         when ::Arel::Nodes::HomogeneousIn
           old_value = node.values
-          new_value = each_transposable_predicate_value_cb(old_value, &block)
+          new_value = each_transposable_predicate_value_cb(old_value, original_block, &block)
 
           # switch to a regular In, so that Relation::WhereClause#contradiction? knows about it
           if new_value.empty?
-            klass = node.type == :in ? ::Arel::Nodes::In : ::Arel::Nodes::NotIn
+            klass = (node.type == :in) ? ::Arel::Nodes::In : ::Arel::Nodes::NotIn
             klass.new(node.attribute, new_value)
           else
-            old_value == new_value ? node : node.class.new(new_value, node.attribute, node.type)
+            (old_value == new_value) ? node : node.class.new(new_value, node.attribute, node.type)
           end
         when ::Arel::Nodes::Binary
           old_value = node.right
-          new_value = each_transposable_predicate_value_cb(old_value, &block)
+          new_value = each_transposable_predicate_value_cb(old_value, original_block, &block)
 
-          old_value == new_value ? node : node.class.new(node.left, new_value)
+          (old_value == new_value) ? node : node.class.new(node.left, new_value)
+        when ::Arel::Nodes::SelectStatement
+          each_transposable_predicate_value([node], &original_block).first
         else
           yield(node)
         end
@@ -343,6 +402,8 @@ module Switchman
               Shard.current(klass.connection_class_for_self)
             elsif type == :foreign
               source_shard_for_foreign_key(relation, column)
+            else
+              primary_shard
             end
 
           transpose_predicate_value(value, current_source_shard, target_shard, type)
@@ -350,7 +411,9 @@ module Switchman
       end
 
       def transpose_predicate_value(value, current_shard, target_shard, attribute_type)
-        if value.is_a?(::ActiveRecord::StatementCache::Substitute)
+        if value.is_a?(NonTransposingValue)
+          value
+        elsif value.is_a?(::ActiveRecord::StatementCache::Substitute)
           value.sharded = true # mark for transposition later
           value.primary = true if attribute_type == :primary
           value

data/lib/switchman/active_record/relation.rb

@@ -4,7 +4,7 @@ module Switchman
   module ActiveRecord
     module Relation
       def self.prepended(klass)
-        klass::SINGLE_VALUE_METHODS.concat %i[shard shard_source]
+        klass::SINGLE_VALUE_METHODS.push(:shard, :shard_source)
       end
 
       def initialize(*, **)
@@ -44,12 +44,18 @@ module Switchman
         primary_shard.activate(klass.connection_class_for_self) { super }
       end
 
-      def explain
-        activate { |relation| relation.call_super(:explain, Relation) }
+      if ::Rails.version > "7.1.2"
+        def transaction(...)
+          primary_shard.activate(klass.connection_class_for_self) { super }
+        end
+      end
+
+      def explain(*args)
+        activate { |relation| relation.call_super(:explain, Relation, *args) }
       end
 
       def load(&block)
-        if !loaded? || (::Rails.version >= '7.0' && scheduled?)
+        if !loaded? || scheduled?
           @records = activate { |relation| relation.send(:exec_queries, &block) }
           @loaded = true
         end
@@ -58,10 +64,9 @@ module Switchman
       end
 
       %I[update_all delete_all].each do |method|
-        arg_params = RUBY_VERSION <= '2.8' ? '*args' : '*args, **kwargs'
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{method}(#{arg_params})
-            result = self.activate(unordered: true) { |relation| relation.call_super(#{method.inspect}, Relation, #{arg_params}) }
+          def #{method}(*args, **kwargs)
+            result = self.activate(unordered: true) { |relation| relation.call_super(#{method.inspect}, Relation, *args, **kwargs) }
             result = result.sum if result.is_a?(Array)
             result
           end
@@ -73,12 +78,16 @@ module Switchman
         loose_mode = options[:loose] && is_integer
         # loose_mode: if we don't care about getting exactly batch_size ids in between
         # don't get the max - just get the min and add batch_size so we get that many _at most_
-        values = loose_mode ? 'MIN(id)' : 'MIN(id), MAX(id)'
+        values = loose_mode ? "MIN(id)" : "MIN(id), MAX(id)"
 
         batch_size = options[:batch_size].try(:to_i) || 1000
-        quoted_primary_key = "#{klass.connection.quote_local_table_name(table_name)}.#{klass.connection.quote_column_name(primary_key)}"
-        as_id = ' AS id' unless primary_key == 'id'
-        subquery_scope = except(:select).select("#{quoted_primary_key}#{as_id}").reorder(primary_key.to_sym).limit(loose_mode ? 1 : batch_size)
+        quoted_primary_key =
+          "#{klass.connection.quote_local_table_name(table_name)}.#{klass.connection.quote_column_name(primary_key)}"
+        as_id = " AS id" unless primary_key == "id"
+        subquery_scope = except(:select)
+                         .select("#{quoted_primary_key}#{as_id}")
+                         .reorder(primary_key.to_sym)
+                         .limit(loose_mode ? 1 : batch_size)
         subquery_scope = subquery_scope.where("#{quoted_primary_key} <= ?", options[:end_at]) if options[:end_at]
 
         first_subquery_scope = if options[:start_at]
@@ -121,7 +130,9 @@ module Switchman
             relation = shard(Shard.current(klass.connection_class_for_self))
             relation.remove_nonlocal_primary_keys!
             # do a minimal query if possible
-            relation = relation.limit(limit_value - result_count) if limit_value && !result_count.zero? && order_values.empty?
+            if limit_value && !result_count.zero? && order_values.empty?
+              relation = relation.limit(limit_value - result_count)
+            end
 
             shard_results = relation.activate(&block)
 

data/lib/switchman/active_record/spawn_methods.rb

@@ -17,7 +17,7 @@ module Switchman
             final_shard_source_value = %i[explicit association].detect do |source_value|
               shard_source_value == source_value || rhs.shard_source_value == source_value
             end
-            raise 'unknown shard_source_value' unless final_shard_source_value
+            raise "unknown shard_source_value" unless final_shard_source_value
 
             # have to merge shard_value
             lhs_shard_value = all_shards
@@ -36,7 +36,7 @@ module Switchman
           final_shard_source_value = %i[explicit association implicit].detect do |source_value|
             shard_source_value == source_value || rhs.shard_source_value == source_value
           end
-          raise 'unknown shard_source_value' unless final_shard_source_value
+          raise "unknown shard_source_value" unless final_shard_source_value
         end
 
         [final_shard_value, final_primary_shard, final_shard_source_value]

data/lib/switchman/active_record/statement_cache.rb

@@ -4,8 +4,8 @@ module Switchman
   module ActiveRecord
     module StatementCache
       module ClassMethods
-        def create(connection, &block)
-          relation = block.call ::ActiveRecord::StatementCache::Params.new
+        def create(connection)
+          relation = yield ::ActiveRecord::StatementCache::Params.new
 
           _query_builder, binds = connection.cacheable_query(self, relation.arel)
           bind_map = ::ActiveRecord::StatementCache::BindMap.new(binds)

data/lib/switchman/active_record/tasks/database_tasks.rb

@@ -7,9 +7,14 @@ module Switchman
         def drop(*)
           super
           # no really, it's gone
-          Switchman.cache.delete('default_shard')
+          Switchman.cache.delete("default_shard")
           Shard.default(reload: true)
         end
+
+        def raise_for_multi_db(*)
+          # ignore; Switchman doesn't use namespaced tasks for multiple shards; it uses
+          # environment variables to filter which shards you want to target
+        end
       end
     end
   end

data/lib/switchman/active_record/test_fixtures.rb

@@ -12,31 +12,41 @@ module Switchman
         # Replace the one that activerecord natively uses with a switchman-optimized one
         ::ActiveSupport::Notifications.unsubscribe(@connection_subscriber)
         # Code adapted from the code in rails proper
-        @connection_subscriber = ::ActiveSupport::Notifications.subscribe('!connection.active_record') do |_, _, _, _, payload|
-          spec_name = payload[:spec_name] if payload.key?(:spec_name)
-          shard = payload[:shard] if payload.key?(:shard)
-          setup_shared_connection_pool
+        @connection_subscriber =
+          ::ActiveSupport::Notifications.subscribe("!connection.active_record") do |_, _, _, _, payload|
+            spec_name = if ::Rails.version < "7.1"
+                          payload[:spec_name] if payload.key?(:spec_name)
+                        elsif payload.key?(:connection_name)
+                          payload[:connection_name]
+                        end
+            shard = payload[:shard] if payload.key?(:shard)
 
-          if spec_name && !FORBIDDEN_DB_ENVS.include?(shard)
-            begin
-              connection = ::ActiveRecord::Base.connection_handler.retrieve_connection(spec_name, shard: shard)
-            rescue ::ActiveRecord::ConnectionNotEstablished, ::ActiveRecord::NoDatabaseError
-              connection = nil
-            end
+            if spec_name && !FORBIDDEN_DB_ENVS.include?(shard)
+              begin
+                connection = ::ActiveRecord::Base.connection_handler.retrieve_connection(spec_name, shard: shard)
+                connection.connect! if ::Rails.version >= "7.1" # eagerly validate the connection
+              rescue ::ActiveRecord::ConnectionNotEstablished, ::ActiveRecord::NoDatabaseError
+                connection = nil
+              end
 
-            if connection && !@fixture_connections.include?(connection)
-              connection.begin_transaction joinable: false, _lazy: false
-              connection.pool.lock_thread = true if lock_threads
-              @fixture_connections << connection
+              if connection
+                setup_shared_connection_pool
+                unless @fixture_connections.include?(connection)
+                  connection.begin_transaction joinable: false, _lazy: false
+                  connection.pool.lock_thread = true if lock_threads
+                  @fixture_connections << connection
+                end
+              end
             end
           end
-        end
       end
 
       def enlist_fixture_connections
         setup_shared_connection_pool
 
-        ::ActiveRecord::Base.connection_handler.connection_pool_list.reject { |cp| FORBIDDEN_DB_ENVS.include?(cp.db_config.env_name.to_sym) }.map(&:connection)
+        ::ActiveRecord::Base.connection_handler.connection_pool_list(:primary).reject do |cp|
+          FORBIDDEN_DB_ENVS.include?(cp.db_config.env_name.to_sym)
+        end.map(&:connection)
       end
     end
   end

data/lib/switchman/active_support/cache.rb

@@ -22,9 +22,14 @@ module Switchman
 
         def lookup_store(*store_options)
           store = super
-          # can't use defined?, because it's a _ruby_ autoloaded constant,
-          # so just checking that will cause it to get required
-          ::ActiveSupport::Cache::RedisCacheStore.prepend(RedisCacheStore) if store.instance_of?(ActiveSupport::Cache::RedisCacheStore) && !::ActiveSupport::Cache::RedisCacheStore.ancestors.include?(RedisCacheStore)
+          # must use the string name, otherwise it will try to auto-load the constant
+          # and we don't want to require redis in this file (since it's not a hard dependency)
+          # rubocop:disable Style/ClassEqualityComparison
+          if store.class.name == "ActiveSupport::Cache::RedisCacheStore" &&
+             !(::ActiveSupport::Cache::RedisCacheStore <= RedisCacheStore)
+            ::ActiveSupport::Cache::RedisCacheStore.prepend(RedisCacheStore)
+          end
+          # rubocop:enable Style/ClassEqualityComparison
           store.options[:namespace] ||= -> { Shard.current.default? ? nil : "shard_#{Shard.current.id}" }
           store
         end
@@ -33,7 +38,7 @@ module Switchman
       module RedisCacheStore
         def clear(namespace: nil, **)
           # RedisCacheStore tries to be smart and only clear the cache under your namespace, if you have one set
-          # unfortunately, it uses the keys command, which is extraordinarily inefficient in a large redis instance
+          # unfortunately, it doesn't work using redis clustering because of the way redis keys are distributed
           # fortunately, we can assume we control the entire instance, because we set up the namespacing, so just
           # always unset it temporarily for clear calls
           namespace = nil # rubocop:disable Lint/ShadowedArgument

data/lib/switchman/arel.rb

@@ -13,38 +13,54 @@ module Switchman
         # rubocop:disable Naming/MethodName
         # rubocop:disable Naming/MethodParameterName
 
+        def visit_Arel_Nodes_Cte(o, collector)
+          collector << quote_local_table_name(o.name)
+          collector << " AS "
+
+          case o.materialized
+          when true
+            collector << "MATERIALIZED "
+          when false
+            collector << "NOT MATERIALIZED "
+          end
+
+          visit o.relation, collector
+        end
+
         def visit_Arel_Nodes_TableAlias(o, collector)
           collector = visit o.relation, collector
-          collector << ' '
+          collector << " "
           collector << quote_local_table_name(o.name)
         end
 
         def visit_Arel_Attributes_Attribute(o, collector)
           join_name = o.relation.table_alias || o.relation.name
-          collector << quote_local_table_name(join_name) << '.' << quote_column_name(o.name)
+          collector << quote_local_table_name(join_name) << "." << quote_column_name(o.name)
         end
 
-        def visit_Arel_Nodes_HomogeneousIn(o, collector)
-          collector.preparable = false
+        if ::Rails.version < "7.1"
+          def visit_Arel_Nodes_HomogeneousIn(o, collector)
+            collector.preparable = false
 
-          collector << quote_local_table_name(o.table_name) << '.' << quote_column_name(o.column_name)
+            collector << quote_local_table_name(o.table_name) << "." << quote_column_name(o.column_name)
 
-          collector << if o.type == :in
-                         ' IN ('
-                       else
-                         ' NOT IN ('
-                       end
+            collector << if o.type == :in
+                           " IN ("
+                         else
+                           " NOT IN ("
+                         end
 
-          values = o.casted_values
+            values = o.casted_values
 
-          if values.empty?
-            collector << @connection.quote(nil)
-          else
-            collector.add_binds(values, o.proc_for_binds, &bind_block)
-          end
+            if values.empty?
+              collector << @connection.quote(nil)
+            else
+              collector.add_binds(values, o.proc_for_binds, &bind_block)
+            end
 
-          collector << ')'
-          collector
+            collector << ")"
+            collector
+          end
         end
 
         # rubocop:enable Naming/MethodName

data/lib/switchman/call_super.rb

@@ -12,14 +12,8 @@ module Switchman
       method.super_method
     end
 
-    if RUBY_VERSION <= '2.8'
-      def call_super(method, above_module, *args, &block)
-        super_method_above(method, above_module).call(*args, &block)
-      end
-    else
-      def call_super(method, above_module, *args, **kwargs, &block)
-        super_method_above(method, above_module).call(*args, **kwargs, &block)
-      end
+    def call_super(method, above_module, ...)
+      super_method_above(method, above_module).call(...)
     end
   end
 end