switchman 3.3.1 → 4.0.0

data/lib/switchman/active_record/database_configurations.rb

@@ -7,14 +7,26 @@ module Switchman
       # since all should point to the same data, even if multiple are writable
       # (Picks 'primary' since it is guaranteed to exist and switchman handles activating
       # deploy through other means)
-      def configs_for(include_replicas: false, name: nil, **)
-        res = super
-        if name && !include_replicas
-          return nil unless name.end_with?('primary')
-        elsif !include_replicas
-          return res.select { |config| config.name.end_with?('primary') }
+      if ::Rails.version < "7.1"
+        def configs_for(include_replicas: false, name: nil, **)
+          res = super
+          if name && !include_replicas
+            return nil unless name.end_with?("primary")
+          elsif !include_replicas
+            return res.select { |config| config.name.end_with?("primary") }
+          end
+          res
+        end
+      else
+        def configs_for(include_hidden: false, name: nil, **)
+          res = super
+          if name && !include_hidden
+            return nil unless name.end_with?("primary")
+          elsif !include_hidden
+            return res.select { |config| config.name.end_with?("primary") }
+          end
+          res
         end
-        res
       end
 
       private
@@ -27,21 +39,31 @@ module Switchman
         return configs if configs.is_a?(Array)
 
         db_configs = configs.flat_map do |env_name, config|
-          # It would be nice to do the auto-fallback that we want here, but we haven't
-          # actually done that for years (or maybe ever) and it will be a big lift to get working
-          roles = config.keys.select { |k| config[k].is_a?(Hash) || (config[k].is_a?(Array) && config[k].all? { |ck| ck.is_a?(Hash) }) }
-          base_config = config.except(*roles)
+          if config.is_a?(Hash)
+            # It would be nice to do the auto-fallback that we want here, but we haven't
+            # actually done that for years (or maybe ever) and it will be a big lift to get working
+            roles = config.keys.select do |k|
+              config[k].is_a?(Hash) || (config[k].is_a?(Array) && config[k].all?(Hash))
+            end
+            base_config = config.except(*roles)
+          else
+            base_config = config
+            roles = []
+          end
 
           name = "#{env_name}/primary"
-          name = 'primary' if env_name == default_env
+          name = "primary" if env_name == default_env
           base_db = build_db_config_from_raw_config(env_name, name, base_config)
           [base_db] + roles.map do |role|
-            build_db_config_from_raw_config(env_name, "#{env_name}/#{role}",
-                                            base_config.merge(config[role].is_a?(Array) ? config[role].first : config[role]))
+            build_db_config_from_raw_config(
+              env_name,
+              "#{env_name}/#{role}",
+              base_config.merge(config[role].is_a?(Array) ? config[role].first : config[role])
+            )
           end
         end
 
-        db_configs << environment_url_config(default_env, 'primary', {}) unless db_configs.find(&:for_current_env?)
+        db_configs << environment_url_config(default_env, "primary", {}) unless db_configs.find(&:for_current_env?)
 
         merge_db_environment_variables(default_env, db_configs.compact)
       end

data/lib/switchman/active_record/finder_methods.rb

@@ -42,26 +42,56 @@ module Switchman
         primary_shard.activate { super }
       end
 
-      def exists?(conditions = :none)
-        conditions = conditions.id if ::ActiveRecord::Base === conditions
-        return false unless conditions
+      if ::Rails.version < "7.1"
+        def exists?(conditions = :none)
+          conditions = conditions.id if ::ActiveRecord::Base === conditions
+          return false unless conditions
 
-        relation = apply_join_dependency(eager_loading: false)
-        return false if ::ActiveRecord::NullRelation === relation
+          relation = apply_join_dependency(eager_loading: false)
+          return false if ::ActiveRecord::NullRelation === relation
 
-        relation = relation.except(:select, :order).select('1 AS one').limit(1)
+          relation = relation.except(:select, :order).select("1 AS one").limit(1)
 
-        case conditions
-        when Array, Hash
-          relation = relation.where(conditions)
-        else
-          relation = relation.where(table[primary_key].eq(conditions)) if conditions != :none
+          case conditions
+          when Array, Hash
+            relation = relation.where(conditions)
+          else
+            relation = relation.where(table[primary_key].eq(conditions)) if conditions != :none
+          end
+
+          relation.activate do |shard_rel|
+            return true if connection.select_value(shard_rel.arel, "#{name} Exists")
+          end
+          false
         end
+      else
+        def exists?(conditions = :none)
+          return false if @none
+
+          if Base === conditions
+            raise ArgumentError, <<-TEXT.squish
+              You are passing an instance of ActiveRecord::Base to `exists?`.
+              Please pass the id of the object by calling `.id`.
+            TEXT
+          end
 
-        relation.activate do |shard_rel|
-          return true if connection.select_value(shard_rel.arel, "#{name} Exists")
+          return false if !conditions || limit_value == 0 # rubocop:disable Style/NumericPredicate
+
+          if eager_loading?
+            relation = apply_join_dependency(eager_loading: false)
+            return relation.exists?(conditions)
+          end
+
+          relation = construct_relation_for_exists(conditions)
+          return false if relation.where_clause.contradiction?
+
+          relation.activate do |shard_rel|
+            return true if skip_query_cache_if_necessary do
+                             connection.select_rows(shard_rel.arel, "#{name} Exists?").size == 1
+                           end
+          end
+          false
         end
-        false
       end
     end
   end

data/lib/switchman/active_record/log_subscriber.rb

@@ -5,8 +5,10 @@ module Switchman
     module LogSubscriber
       # sadly, have to completely replace this
       def sql(event)
-        self.class.runtime += event.duration
-        return unless logger.debug?
+        if ::Rails.version < "7.1"
+          self.class.runtime += event.duration
+          return unless logger.debug?
+        end
 
         payload = event.payload
 
@@ -14,20 +16,24 @@ module Switchman
 
         name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
         name  = "CACHE #{name}" if payload[:cached]
-        sql   = payload[:sql].squeeze(' ')
+        sql   = payload[:sql].squeeze(" ")
         binds = nil
         shard = payload[:shard]
         shard = "  [#{shard[:database_server_id]}:#{shard[:id]} #{shard[:env]}]" if shard
 
         unless (payload[:binds] || []).empty?
           casted_params = type_casted_binds(payload[:type_casted_binds])
-          binds = '  ' + payload[:binds].zip(casted_params).map do |attr, value|
+          binds = "  " + payload[:binds].zip(casted_params).map do |attr, value|
             render_bind(attr, value)
           end.inspect
         end
 
         name = colorize_payload_name(name, payload[:name])
-        sql  = color(sql, sql_color(sql), true)
+        sql  = if ::Rails.version < "7.1"
+                 color(sql, sql_color(sql), true)
+               else
+                 color(sql, sql_color(sql), bold: true)
+               end
 
         debug "  #{name}  #{sql}#{binds}#{shard}"
       end

data/lib/switchman/active_record/migration.rb

@@ -14,7 +14,9 @@ module Switchman
 
       def connection
         conn = super
-        ::ActiveRecord::Base.connection_pool.switch_database(conn) if conn.shard != ::ActiveRecord::Base.current_switchman_shard
+        if conn.shard != ::ActiveRecord::Base.current_switchman_shard
+          ::ActiveRecord::Base.connection_pool.switch_database(conn)
+        end
         conn
       end
     end
@@ -27,7 +29,11 @@ module Switchman
         db_name_hash = Zlib.crc32(Shard.current.name)
         shard_name_hash = ::ActiveRecord::Migrator::MIGRATOR_SALT * db_name_hash
         # Store in internalmetadata to allow other tools to be able to lock out migrations
-        ::ActiveRecord::InternalMetadata[:migrator_advisory_lock_id] = shard_name_hash
+        if ::Rails.version < "7.1"
+          ::ActiveRecord::InternalMetadata[:migrator_advisory_lock_id] = shard_name_hash
+        else
+          ::ActiveRecord::InternalMetadata.new(connection)[:migrator_advisory_lock_id] = shard_name_hash
+        end
         shard_name_hash
       end
 
@@ -44,13 +50,49 @@ module Switchman
     end
 
     module MigrationContext
+      def migrate(...)
+        connection = ::ActiveRecord::Base.connection
+        schema_cache_holder = ::ActiveRecord::Base.connection_pool
+        schema_cache_holder = schema_cache_holder.schema_reflection if ::Rails.version >= "7.1"
+        previous_schema_cache = if ::Rails.version < "7.1"
+                                  schema_cache_holder.get_schema_cache(connection)
+                                else
+                                  schema_cache_holder.instance_variable_get(:@cache)
+                                end
+
+        if ::Rails.version < "7.1"
+          temporary_schema_cache = ::ActiveRecord::ConnectionAdapters::SchemaCache.new(connection)
+
+          reset_column_information
+          schema_cache_holder.set_schema_cache(temporary_schema_cache)
+        else
+          schema_cache_holder.instance_variable_get(:@cache)
+
+          reset_column_information
+          schema_cache_holder.clear!
+        end
+
+        begin
+          super(...)
+        ensure
+          schema_cache_holder.set_schema_cache(previous_schema_cache)
+          reset_column_information
+        end
+      end
+
       def migrations
         return @migrations if instance_variable_defined?(:@migrations)
 
         migrations_cache = Thread.current[:migrations_cache] ||= {}
-        key = Digest::MD5.hexdigest(migration_files.sort.join(','))
+        key = Digest::MD5.hexdigest(migration_files.sort.join(","))
         @migrations = migrations_cache[key] ||= super
       end
+
+      private
+
+      def reset_column_information
+        ::ActiveRecord::Base.descendants.reject { |m| m <= UnshardedRecord }.each(&:reset_column_information)
+      end
     end
   end
 end

data/lib/switchman/active_record/pending_migration_connection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Switchman
+  module ActiveRecord
+    module PendingMigrationConnection
+      module ClassMethods
+        def current_role
+          ::ActiveRecord::Base.current_role
+        end
+
+        def current_switchman_shard
+          ::ActiveRecord::Base.current_switchman_shard
+        end
+      end
+    end
+  end
+end

data/lib/switchman/active_record/persistence.rb

@@ -5,10 +5,12 @@ module Switchman
     module Persistence
       # touch reads the id attribute directly, so it's not relative to the current shard
       def touch(*, **)
+        writable_shadow_record_warning
         shard.activate(self.class.connection_class_for_self) { super }
       end
 
       def update_columns(*)
+        writable_shadow_record_warning
         shard.activate(self.class.connection_class_for_self) { super }
       end
 
@@ -16,6 +18,34 @@ module Switchman
         db = shard.database_server
         db.unguard { super }
       end
+
+      def destroy
+        writable_shadow_record_warning
+        super
+      end
+
+      def create_or_update(**, &block)
+        writable_shadow_record_warning
+        super
+      end
+
+      def reload(*)
+        res = super
+        # When a shadow record is reloaded the real record is returned. So
+        # we need to ensure the loaded_from_shard is set correctly after a reload.
+        @loaded_from_shard = @shard
+        if @readonly_from_shadow
+          @readonly_from_shadow = false
+          @readonly = false
+        end
+        res
+      end
+
+      def writable_shadow_record_warning
+        return unless shadow_record? && Switchman.config[:writable_shadow_records]
+
+        Switchman::Deprecation.warn("writing to shadow records is not supported")
+      end
     end
   end
 end

data/lib/switchman/active_record/postgresql_adapter.rb

@@ -5,9 +5,9 @@ module Switchman
     module PostgreSQLAdapter
       # copy/paste; use quote_local_table_name
       def create_database(name, options = {})
-        options = { encoding: 'utf8' }.merge!(options.symbolize_keys)
+        options = { encoding: "utf8" }.merge!(options.symbolize_keys)
 
-        option_string = options.sum('') do |key, value|
+        option_string = options.sum("") do |key, value|
           case key
           when :owner
             " OWNER = \"#{value}\""
@@ -24,7 +24,7 @@ module Switchman
           when :connection_limit
             " CONNECTION LIMIT = #{value}"
           else
-            ''
+            ""
           end
         end
 
@@ -37,7 +37,7 @@ module Switchman
       end
 
       def current_schemas
-        select_values('SELECT * FROM unnest(current_schemas(false))')
+        select_values("SELECT * FROM unnest(current_schemas(false))")
       end
 
       def extract_schema_qualified_name(string)
@@ -49,13 +49,13 @@ module Switchman
       # significant change: use the shard name if no explicit schema
       def quoted_scope(name = nil, type: nil)
         schema, name = extract_schema_qualified_name(name)
-        type = \
+        type =
           case type # rubocop:disable Style/HashLikeCase
-          when 'BASE TABLE'
+          when "BASE TABLE"
             "'r','p'"
-          when 'VIEW'
+          when "VIEW"
             "'v','m'"
-          when 'FOREIGN TABLE'
+          when "FOREIGN TABLE"
             "'f'"
           end
         scope = {}
@@ -67,7 +67,8 @@ module Switchman
 
       def foreign_keys(table_name)
         super.each do |fk|
-          to_table_qualified_name = ::ActiveRecord::ConnectionAdapters::PostgreSQL::Utils.extract_schema_qualified_name(fk.to_table)
+          to_table_qualified_name =
+            ::ActiveRecord::ConnectionAdapters::PostgreSQL::Utils.extract_schema_qualified_name(fk.to_table)
           fk.to_table = to_table_qualified_name.identifier if to_table_qualified_name.schema == shard.name
         end
       end
@@ -101,7 +102,7 @@ module Switchman
 
       def add_index_options(_table_name, _column_name, **)
         index, algorithm, if_not_exists = super
-        algorithm = nil if DatabaseServer.creating_new_shard && algorithm == 'CONCURRENTLY'
+        algorithm = nil if DatabaseServer.creating_new_shard && algorithm == "CONCURRENTLY"
         [index, algorithm, if_not_exists]
       end
 

data/lib/switchman/active_record/predicate_builder.rb

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

data/lib/switchman/active_record/query_cache.rb

@@ -5,28 +5,57 @@ module Switchman
     module QueryCache
       private
 
-      def cache_sql(sql, name, binds)
-        # have to include the shard id in the cache key because of switching dbs on the same connection
-        sql = "#{shard.id}::#{sql}"
-        @lock.synchronize do
-          result =
-            if query_cache[sql].key?(binds)
-              args = {
-                sql: sql,
-                binds: binds,
-                name: name,
-                connection_id: object_id,
-                cached: true,
-                type_casted_binds: -> { type_casted_binds(binds) }
-              }
-              ::ActiveSupport::Notifications.instrument(
-                'sql.active_record',
-                args
-              )
-              query_cache[sql][binds]
+      if ::Rails.version < "7.1"
+        def cache_sql(sql, name, binds)
+          # have to include the shard id in the cache key because of switching dbs on the same connection
+          sql = "#{shard.id}::#{sql}"
+          @lock.synchronize do
+            result =
+              if query_cache[sql].key?(binds)
+                args = {
+                  sql: sql,
+                  binds: binds,
+                  name: name,
+                  connection_id: object_id,
+                  cached: true,
+                  type_casted_binds: -> { type_casted_binds(binds) }
+                }
+                ::ActiveSupport::Notifications.instrument(
+                  "sql.active_record",
+                  args
+                )
+                query_cache[sql][binds]
+              else
+                query_cache[sql][binds] = yield
+              end
+            result.dup
+          end
+        end
+      else
+        def cache_sql(sql, name, binds)
+          # have to include the shard id in the cache key because of switching dbs on the same connection
+          sql = "#{shard.id}::#{sql}"
+          key = binds.empty? ? sql : [sql, binds]
+          result = nil
+          hit = false
+
+          @lock.synchronize do
+            if (result = @query_cache.delete(key))
+              hit = true
+              @query_cache[key] = result
             else
-              query_cache[sql][binds] = yield
+              result = @query_cache[key] = yield
+              @query_cache.shift if @query_cache_max_size && @query_cache.size > @query_cache_max_size
             end
+          end
+
+          if hit
+            ::ActiveSupport::Notifications.instrument(
+              "sql.active_record",
+              cache_notification_info(sql, name, binds)
+            )
+          end
+
           result.dup
         end
       end