activerecord 5.2.8.1 → 6.0.6.1

data/lib/active_record/migration.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require "benchmark"
 require "set"
 require "zlib"
 require "active_support/core_ext/module/attribute_accessors"
+require "active_support/actionable_error"
 
 module ActiveRecord
-  class MigrationError < ActiveRecordError#:nodoc:
+  class MigrationError < ActiveRecordError #:nodoc:
     def initialize(message = nil)
       message = "\n\n#{message}\n\n" if message
       super
@@ -22,7 +24,7 @@ module ActiveRecord
   #         t.string :zipcode
   #       end
   #
-  #       execute <<-SQL
+  #       execute <<~SQL
   #         ALTER TABLE distributors
   #           ADD CONSTRAINT zipchk
   #             CHECK (char_length(zipcode) = 5) NO INHERIT;
@@ -40,7 +42,7 @@ module ActiveRecord
   #        t.string :zipcode
   #      end
   #
-  #      execute <<-SQL
+  #      execute <<~SQL
   #        ALTER TABLE distributors
   #          ADD CONSTRAINT zipchk
   #            CHECK (char_length(zipcode) = 5) NO INHERIT;
@@ -48,7 +50,7 @@ module ActiveRecord
   #    end
   #
   #    def down
-  #      execute <<-SQL
+  #      execute <<~SQL
   #        ALTER TABLE distributors
   #          DROP CONSTRAINT zipchk
   #      SQL
@@ -67,7 +69,7 @@ module ActiveRecord
   #
   #       reversible do |dir|
   #         dir.up do
-  #           execute <<-SQL
+  #           execute <<~SQL
   #             ALTER TABLE distributors
   #               ADD CONSTRAINT zipchk
   #                 CHECK (char_length(zipcode) = 5) NO INHERIT;
@@ -75,7 +77,7 @@ module ActiveRecord
   #         end
   #
   #         dir.down do
-  #           execute <<-SQL
+  #           execute <<~SQL
   #             ALTER TABLE distributors
   #               DROP CONSTRAINT zipchk
   #           SQL
@@ -86,7 +88,7 @@ module ActiveRecord
   class IrreversibleMigration < MigrationError
   end
 
-  class DuplicateMigrationVersionError < MigrationError#:nodoc:
+  class DuplicateMigrationVersionError < MigrationError #:nodoc:
     def initialize(version = nil)
       if version
         super("Multiple migrations have the version number #{version}.")
@@ -96,7 +98,7 @@ module ActiveRecord
     end
   end
 
-  class DuplicateMigrationNameError < MigrationError#:nodoc:
+  class DuplicateMigrationNameError < MigrationError #:nodoc:
     def initialize(name = nil)
       if name
         super("Multiple migrations have the name #{name}.")
@@ -116,7 +118,7 @@ module ActiveRecord
     end
   end
 
-  class IllegalMigrationNameError < MigrationError#:nodoc:
+  class IllegalMigrationNameError < MigrationError #:nodoc:
     def initialize(name = nil)
       if name
         super("Illegal name for migration file: #{name}\n\t(only lower case letters, numbers, and '_' allowed).")
@@ -126,12 +128,18 @@ module ActiveRecord
     end
   end
 
-  class PendingMigrationError < MigrationError#:nodoc:
+  class PendingMigrationError < MigrationError #:nodoc:
+    include ActiveSupport::ActionableError
+
+    action "Run pending migrations" do
+      ActiveRecord::Tasks::DatabaseTasks.migrate
+    end
+
     def initialize(message = nil)
       if !message && defined?(Rails.env)
-        super("Migrations are pending. To resolve this issue, run:\n\n        bin/rails db:migrate RAILS_ENV=#{::Rails.env}")
+        super("Migrations are pending. To resolve this issue, run:\n\n        rails db:migrate RAILS_ENV=#{::Rails.env}")
       elsif !message
-        super("Migrations are pending. To resolve this issue, run:\n\n        bin/rails db:migrate")
+        super("Migrations are pending. To resolve this issue, run:\n\n        rails db:migrate")
       else
         super
       end
@@ -139,8 +147,8 @@ module ActiveRecord
   end
 
   class ConcurrentMigrationError < MigrationError #:nodoc:
-    DEFAULT_MESSAGE = "Cannot run migrations because another migration process is currently running.".freeze
-    RELEASE_LOCK_FAILED_MESSAGE = "Failed to release advisory lock".freeze
+    DEFAULT_MESSAGE = "Cannot run migrations because another migration process is currently running."
+    RELEASE_LOCK_FAILED_MESSAGE = "Failed to release advisory lock"
 
     def initialize(message = DEFAULT_MESSAGE)
       super
@@ -149,7 +157,7 @@ module ActiveRecord
 
   class NoEnvironmentInSchemaError < MigrationError #:nodoc:
     def initialize
-      msg = "Environment data not found in the schema. To resolve this issue, run: \n\n        bin/rails db:environment:set"
+      msg = "Environment data not found in the schema. To resolve this issue, run: \n\n        rails db:environment:set"
       if defined?(Rails.env)
         super("#{msg} RAILS_ENV=#{::Rails.env}")
       else
@@ -160,7 +168,7 @@ module ActiveRecord
 
   class ProtectedEnvironmentError < ActiveRecordError #:nodoc:
     def initialize(env = "production")
-      msg = "You are attempting to run a destructive action against your '#{env}' database.\n".dup
+      msg = +"You are attempting to run a destructive action against your '#{env}' database.\n"
       msg << "If you are sure you want to continue, run the same command with the environment variable:\n"
       msg << "DISABLE_DATABASE_ENVIRONMENT_CHECK=1"
       super(msg)
@@ -169,10 +177,10 @@ module ActiveRecord
 
   class EnvironmentMismatchError < ActiveRecordError
     def initialize(current: nil, stored: nil)
-      msg =  "You are attempting to modify a database that was last run in `#{ stored }` environment.\n".dup
+      msg = +"You are attempting to modify a database that was last run in `#{ stored }` environment.\n"
       msg << "You are running in `#{ current }` environment. "
       msg << "If you are sure you want to continue, first set the environment using:\n\n"
-      msg << "        bin/rails db:environment:set"
+      msg << "        rails db:environment:set"
       if defined?(Rails.env)
         super("#{msg} RAILS_ENV=#{::Rails.env}\n\n")
       else
@@ -307,7 +315,7 @@ module ActiveRecord
   #   named +column_name+ from the table called +table_name+.
   # * <tt>remove_columns(table_name, *column_names)</tt>: Removes the given
   #   columns from the table definition.
-  # * <tt>remove_foreign_key(from_table, options_or_to_table)</tt>: Removes the
+  # * <tt>remove_foreign_key(from_table, to_table = nil, **options)</tt>: Removes the
   #   given foreign key from the table called +table_name+.
   # * <tt>remove_index(table_name, column: column_names)</tt>: Removes the index
   #   specified by +column_names+.
@@ -351,7 +359,7 @@ module ActiveRecord
   # <tt>rails db:migrate</tt>. This will update the database by running all of the
   # pending migrations, creating the <tt>schema_migrations</tt> table
   # (see "About the schema_migrations table" section below) if missing. It will also
-  # invoke the db:schema:dump task, which will update your db/schema.rb file
+  # invoke the db:schema:dump command, which will update your db/schema.rb file
   # to match the structure of your database.
   #
   # To roll the database back to a previous migration version, use
@@ -486,9 +494,9 @@ module ActiveRecord
   # This migration will create the horses table for you on the way up, and
   # automatically figure out how to drop the table on the way down.
   #
-  # Some commands like +remove_column+ cannot be reversed.  If you care to
-  # define how to move up and down in these cases, you should define the +up+
-  # and +down+ methods as before.
+  # Some commands cannot be reversed. If you care to define how to move up
+  # and down in these cases, you should define the +up+ and +down+ methods
+  # as before.
   #
   # If a command cannot be reversed, an
   # <tt>ActiveRecord::IrreversibleMigration</tt> exception will be raised when
@@ -519,10 +527,10 @@ module ActiveRecord
     autoload :Compatibility, "active_record/migration/compatibility"
 
     # This must be defined before the inherited hook, below
-    class Current < Migration # :nodoc:
+    class Current < Migration #:nodoc:
     end
 
-    def self.inherited(subclass) # :nodoc:
+    def self.inherited(subclass) #:nodoc:
       super
       if subclass.superclass == Migration
         raise StandardError, "Directly inheriting from ActiveRecord::Migration is not supported. " \
@@ -540,7 +548,7 @@ module ActiveRecord
       ActiveRecord::VERSION::STRING.to_f
     end
 
-    MigrationFilenameRegexp = /\A([0-9]+)_([_a-z0-9]*)\.?([_a-z0-9]*)?\.rb\z/ # :nodoc:
+    MigrationFilenameRegexp = /\A([0-9]+)_([_a-z0-9]*)\.?([_a-z0-9]*)?\.rb\z/ #:nodoc:
 
     # This class is used to verify that all migrations have been run before
     # loading a web page if <tt>config.active_record.migration_error</tt> is set to :page_load
@@ -560,17 +568,16 @@ module ActiveRecord
       end
 
       private
-
         def connection
           ActiveRecord::Base.connection
         end
     end
 
     class << self
-      attr_accessor :delegate # :nodoc:
-      attr_accessor :disable_ddl_transaction # :nodoc:
+      attr_accessor :delegate #:nodoc:
+      attr_accessor :disable_ddl_transaction #:nodoc:
 
-      def nearest_delegate # :nodoc:
+      def nearest_delegate #:nodoc:
         delegate || superclass.nearest_delegate
       end
 
@@ -580,29 +587,38 @@ module ActiveRecord
       end
 
       def load_schema_if_pending!
-        if Base.connection.migration_context.needs_migration? || !Base.connection.migration_context.any_migrations?
+        current_config = Base.connection_config
+        all_configs = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env)
+
+        needs_update = !all_configs.all? do |db_config|
+          Tasks::DatabaseTasks.schema_up_to_date?(db_config.config, ActiveRecord::Base.schema_format, nil, Rails.env, db_config.spec_name)
+        end
+
+        if needs_update
           # Roundtrip to Rake to allow plugins to hook into database initialization.
           root = defined?(ENGINE_ROOT) ? ENGINE_ROOT : Rails.root
           FileUtils.cd(root) do
-            current_config = Base.connection_config
             Base.clear_all_connections!
             system("bin/rails db:test:prepare")
-            # Establish a new connection, the old database may be gone (db:test:prepare uses purge)
-            Base.establish_connection(current_config)
           end
-          check_pending!
         end
+
+        # Establish a new connection, the old database may be gone (db:test:prepare uses purge)
+        Base.establish_connection(current_config)
+
+        check_pending!
       end
 
-      def maintain_test_schema! # :nodoc:
+      def maintain_test_schema! #:nodoc:
         if ActiveRecord::Base.maintain_test_schema
           suppress_messages { load_schema_if_pending! }
         end
       end
 
-      def method_missing(name, *args, &block) # :nodoc:
+      def method_missing(name, *args, &block) #:nodoc:
         nearest_delegate.send(name, *args, &block)
       end
+      ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
       def migrate(direction)
         new.migrate direction
@@ -617,7 +633,7 @@ module ActiveRecord
       end
     end
 
-    def disable_ddl_transaction # :nodoc:
+    def disable_ddl_transaction #:nodoc:
       self.class.disable_ddl_transaction
     end
 
@@ -677,15 +693,13 @@ module ActiveRecord
         if connection.respond_to? :revert
           connection.revert { yield }
         else
-          recorder = CommandRecorder.new(connection)
+          recorder = command_recorder
           @connection = recorder
           suppress_messages do
             connection.revert { yield }
           end
           @connection = recorder.delegate
-          recorder.commands.each do |cmd, args, block|
-            send(cmd, *args, &block)
-          end
+          recorder.replay(self)
         end
       end
     end
@@ -694,7 +708,7 @@ module ActiveRecord
       connection.respond_to?(:reverting) && connection.reverting
     end
 
-    ReversibleBlockHelper = Struct.new(:reverting) do # :nodoc:
+    ReversibleBlockHelper = Struct.new(:reverting) do #:nodoc:
       def up
         yield unless reverting
       end
@@ -830,10 +844,14 @@ module ActiveRecord
       write "== %s %s" % [text, "=" * length]
     end
 
+    # Takes a message argument and outputs it as is.
+    # A second boolean argument can be passed to specify whether to indent or not.
     def say(message, subitem = false)
       write "#{subitem ? "   ->" : "--"} #{message}"
     end
 
+    # Outputs text along with how long it took to run its block.
+    # If the block returns an integer it assumes it is the number of rows affected.
     def say_with_time(message)
       say(message)
       result = nil
@@ -843,6 +861,7 @@ module ActiveRecord
       result
     end
 
+    # Takes a block as an argument and suppresses any output generated by the block.
     def suppress_messages
       save, self.verbose = verbose, false
       yield
@@ -871,21 +890,23 @@ module ActiveRecord
         connection.send(method, *arguments, &block)
       end
     end
+    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
     def copy(destination, sources, options = {})
       copied = []
+      schema_migration = options[:schema_migration] || ActiveRecord::SchemaMigration
 
       FileUtils.mkdir_p(destination) unless File.exist?(destination)
 
-      destination_migrations = ActiveRecord::MigrationContext.new(destination).migrations
+      destination_migrations = ActiveRecord::MigrationContext.new(destination, schema_migration).migrations
       last = destination_migrations.last
       sources.each do |scope, path|
-        source_migrations = ActiveRecord::MigrationContext.new(path).migrations
+        source_migrations = ActiveRecord::MigrationContext.new(path, schema_migration).migrations
 
         source_migrations.each do |migration|
           source = File.binread(migration.filename)
           inserted_comment = "# This migration comes from #{scope} (originally #{migration.version})\n"
-          magic_comments = "".dup
+          magic_comments = +""
           loop do
             # If we have a magic comment in the original migration,
             # insert our comment after the first newline(end of the magic comment line)
@@ -956,6 +977,10 @@ module ActiveRecord
           yield
         end
       end
+
+      def command_recorder
+        CommandRecorder.new(connection)
+      end
   end
 
   # MigrationProxy is used to defer loading of the actual migration classes
@@ -977,7 +1002,6 @@ module ActiveRecord
     delegate :migrate, :announce, :write, :disable_ddl_transaction, to: :migration
 
     private
-
       def migration
         @migration ||= load_migration
       end
@@ -998,11 +1022,12 @@ module ActiveRecord
     end
   end
 
-  class MigrationContext # :nodoc:
-    attr_reader :migrations_paths
+  class MigrationContext #:nodoc:
+    attr_reader :migrations_paths, :schema_migration
 
-    def initialize(migrations_paths)
+    def initialize(migrations_paths, schema_migration)
       @migrations_paths = migrations_paths
+      @schema_migration = schema_migration
     end
 
     def migrate(target_version = nil, &block)
@@ -1033,7 +1058,7 @@ module ActiveRecord
         migrations
       end
 
-      Migrator.new(:up, selected_migrations, target_version).migrate
+      Migrator.new(:up, selected_migrations, schema_migration, target_version).migrate
     end
 
     def down(target_version = nil)
@@ -1043,20 +1068,20 @@ module ActiveRecord
         migrations
       end
 
-      Migrator.new(:down, selected_migrations, target_version).migrate
+      Migrator.new(:down, selected_migrations, schema_migration, target_version).migrate
     end
 
     def run(direction, target_version)
-      Migrator.new(direction, migrations, target_version).run
+      Migrator.new(direction, migrations, schema_migration, target_version).run
     end
 
     def open
-      Migrator.new(:up, migrations, nil)
+      Migrator.new(:up, migrations, schema_migration)
     end
 
     def get_all_versions
-      if SchemaMigration.table_exists?
-        SchemaMigration.all_versions.map(&:to_i)
+      if schema_migration.table_exists?
+        schema_migration.all_versions.map(&:to_i)
       else
         []
       end
@@ -1079,10 +1104,6 @@ module ActiveRecord
       migrations.last || NullMigration.new
     end
 
-    def parse_migration_filename(filename) # :nodoc:
-      File.basename(filename).scan(Migration::MigrationFilenameRegexp).first
-    end
-
     def migrations
       migrations = migration_files.map do |file|
         version, name, scope = parse_migration_filename(file)
@@ -1097,12 +1118,12 @@ module ActiveRecord
     end
 
     def migrations_status
-      db_list = ActiveRecord::SchemaMigration.normalized_versions
+      db_list = schema_migration.normalized_versions
 
       file_list = migration_files.map do |file|
         version, name, scope = parse_migration_filename(file)
         raise IllegalMigrationNameError.new(file) unless version
-        version = ActiveRecord::SchemaMigration.normalize_migration_number(version)
+        version = schema_migration.normalize_migration_number(version)
         status = db_list.delete(version) ? "up" : "down"
         [status, version, (name + scope).humanize]
       end.compact
@@ -1114,11 +1135,6 @@ module ActiveRecord
       (db_list + file_list).sort_by { |_, version, _| version }
     end
 
-    def migration_files
-      paths = Array(migrations_paths)
-      Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
-    end
-
     def current_environment
       ActiveRecord::ConnectionHandling::DEFAULT_ENV.call
     end
@@ -1137,8 +1153,17 @@ module ActiveRecord
     end
 
     private
+      def migration_files
+        paths = Array(migrations_paths)
+        Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+      end
+
+      def parse_migration_filename(filename)
+        File.basename(filename).scan(Migration::MigrationFilenameRegexp).first
+      end
+
       def move(direction, steps)
-        migrator = Migrator.new(direction, migrations)
+        migrator = Migrator.new(direction, migrations, schema_migration)
 
         if current_version != 0 && !migrator.current_migration
           raise UnknownMigrationVersionError.new(current_version)
@@ -1161,30 +1186,24 @@ module ActiveRecord
     class << self
       attr_accessor :migrations_paths
 
-      def migrations_path=(path)
-        ActiveSupport::Deprecation.warn \
-          "`ActiveRecord::Migrator.migrations_path=` is now deprecated and will be removed in Rails 6.0. " \
-          "You can set the `migrations_paths` on the `connection` instead through the `database.yml`."
-        self.migrations_paths = [path]
-      end
-
       # For cases where a table doesn't exist like loading from schema cache
       def current_version
-        MigrationContext.new(migrations_paths).current_version
+        MigrationContext.new(migrations_paths, SchemaMigration).current_version
       end
     end
 
     self.migrations_paths = ["db/migrate"]
 
-    def initialize(direction, migrations, target_version = nil)
+    def initialize(direction, migrations, schema_migration, target_version = nil)
       @direction         = direction
       @target_version    = target_version
       @migrated_versions = nil
       @migrations        = migrations
+      @schema_migration  = schema_migration
 
       validate(@migrations)
 
-      ActiveRecord::SchemaMigration.create_table
+      @schema_migration.create_table
       ActiveRecord::InternalMetadata.create_table
     end
 
@@ -1238,11 +1257,10 @@ module ActiveRecord
     end
 
     def load_migrated
-      @migrated_versions = Set.new(Base.connection.migration_context.get_all_versions)
+      @migrated_versions = Set.new(@schema_migration.all_versions.map(&:to_i))
     end
 
     private
-
       # Used for running a specific migration.
       def run_without_lock
         migration = migrations.detect { |m| m.version == @target_version }
@@ -1293,7 +1311,7 @@ module ActiveRecord
           record_version_state_after_migrating(migration.version)
         end
       rescue => e
-        msg = "An error has occurred, ".dup
+        msg = +"An error has occurred, "
         msg << "this and " if use_transaction?(migration)
         msg << "all later migrations canceled:\n\n#{e}"
         raise StandardError, msg, e.backtrace
@@ -1322,10 +1340,10 @@ module ActiveRecord
       def record_version_state_after_migrating(version)
         if down?
           migrated.delete(version)
-          ActiveRecord::SchemaMigration.where(version: version.to_s).delete_all
+          @schema_migration.delete_by(version: version.to_s)
         else
           migrated << version
-          ActiveRecord::SchemaMigration.create!(version: version.to_s)
+          @schema_migration.create!(version: version.to_s)
         end
       end
 
@@ -1351,12 +1369,13 @@ module ActiveRecord
       end
 
       def use_advisory_lock?
-        Base.connection.supports_advisory_locks?
+        Base.connection.advisory_locks_enabled?
       end
 
       def with_advisory_lock
         lock_id = generate_migrator_advisory_lock_id
-        connection = Base.connection
+        AdvisoryLockBase.establish_connection(ActiveRecord::Base.connection_config) unless AdvisoryLockBase.connected?
+        connection = AdvisoryLockBase.connection
         got_lock = connection.get_advisory_lock(lock_id)
         raise ConcurrentMigrationError unless got_lock
         load_migrated # reload schema_migrations to be sure it wasn't changed by another process before we got the lock