strong_migrations 0.6.0 → 2.3.0

data/lib/strong_migrations/checker.rb

@@ -1,368 +1,277 @@
 module StrongMigrations
   class Checker
-    attr_accessor :direction
+    include Checks
+    include SafeMethods
+
+    attr_accessor :direction, :transaction_disabled, :timeouts_set
+
+    class << self
+      attr_accessor :safe
+    end
 
     def initialize(migration)
       @migration = migration
+      reset
+    end
+
+    def reset
       @new_tables = []
-      @safe = false
+      @new_columns = []
       @timeouts_set = false
+      @committed = false
+      @transaction_disabled = false
+      @skip_retries = false
     end
 
-    def safety_assured
-      previous_value = @safe
+    def self.safety_assured
+      previous_value = safe
       begin
-        @safe = true
+        self.safe = true
         yield
       ensure
-        @safe = previous_value
+        self.safe = previous_value
       end
     end
 
-    def perform(method, *args)
+    def perform(method, *args, &block)
+      return yield if skip?
+
+      check_adapter
+      check_version_supported
       set_timeouts
+      check_lock_timeout
 
-      unless safe?
+      if !safe? || safe_by_default_method?(method)
+        # TODO better pattern
+        # see checks.rb for methods
         case method
-        when :remove_column, :remove_columns, :remove_timestamps, :remove_reference, :remove_belongs_to
-          columns =
-            case method
-            when :remove_timestamps
-              ["created_at", "updated_at"]
-            when :remove_column
-              [args[1].to_s]
-            when :remove_columns
-              args[1..-1].map(&:to_s)
-            else
-              options = args[2] || {}
-              reference = args[1]
-              cols = []
-              cols << "#{reference}_type" if options[:polymorphic]
-              cols << "#{reference}_id"
-              cols
-            end
-
-          code = "self.ignored_columns = #{columns.inspect}"
-
-          raise_error :remove_column,
-            model: args[0].to_s.classify,
-            code: code,
-            command: command_str(method, args),
-            column_suffix: columns.size > 1 ? "s" : ""
-        when :change_table
-          raise_error :change_table, header: "Possibly dangerous operation"
-        when :rename_table
-          raise_error :rename_table
-        when :rename_column
-          raise_error :rename_column
-        when :add_index
-          table, columns, options = args
-          options ||= {}
-
-          if columns.is_a?(Array) && columns.size > 3 && !options[:unique]
-            raise_error :add_index_columns, header: "Best practice"
-          end
-          if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
-            raise_error :add_index, command: command_str("add_index", [table, columns, options.merge(algorithm: :concurrently)])
-          end
-        when :remove_index
-          table, options = args
-          unless options.is_a?(Hash)
-            options = {column: options}
-          end
-          options ||= {}
-
-          if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
-            raise_error :remove_index, command: command_str("remove_index", [table, options.merge(algorithm: :concurrently)])
-          end
+        when :add_check_constraint
+          check_add_check_constraint(*args)
         when :add_column
-          table, column, type, options = args
-          options ||= {}
-          default = options[:default]
-
-          if !default.nil? && !((postgresql? && postgresql_version >= Gem::Version.new("11")) || (mysql? && mysql_version >= Gem::Version.new("8.0.12")) || (mariadb? && mariadb_version >= Gem::Version.new("10.3.2")))
-
-            if options[:null] == false
-              options = options.except(:null)
-              append = "
-
-Then add the NOT NULL constraint."
-            end
-
-            raise_error :add_column_default,
-              add_command: command_str("add_column", [table, column, type, options.except(:default)]),
-              change_command: command_str("change_column_default", [table, column, default]),
-              remove_command: command_str("remove_column", [table, column]),
-              code: backfill_code(table, column, default),
-              append: append
-          end
-
-          if type.to_s == "json" && postgresql?
-            raise_error :add_column_json
-          end
+          check_add_column(*args)
+        when :add_exclusion_constraint
+          check_add_exclusion_constraint(*args)
+        when :add_foreign_key
+          check_add_foreign_key(*args)
+        when :add_index
+          check_add_index(*args)
+        when :add_reference, :add_belongs_to
+          check_add_reference(method, *args)
+        when :add_unique_constraint
+          check_add_unique_constraint(*args)
         when :change_column
-          table, column, type = args
-
-          safe = false
-          # assume Postgres 9.1+ since previous versions are EOL
-          if postgresql? && type.to_s == "text"
-            found_column = connection.columns(table).find { |c| c.name.to_s == column.to_s }
-            safe = found_column && found_column.type == :string
-          end
-          raise_error :change_column unless safe
+          check_change_column(*args)
+        when :change_column_default
+          check_change_column_default(*args)
+        when :change_column_null
+          check_change_column_null(*args)
+        when :change_table
+          check_change_table
+        when :create_join_table
+          check_create_join_table(*args)
         when :create_table
-          table, options = args
-          options ||= {}
-
-          raise_error :create_table if options[:force]
-
-          # keep track of new tables of add_index check
-          @new_tables << table.to_s
-        when :add_reference, :add_belongs_to
-          table, reference, options = args
-          options ||= {}
-
-          index_value = options.fetch(:index, true)
-          concurrently_set = index_value.is_a?(Hash) && index_value[:algorithm] == :concurrently
-
-          if postgresql? && index_value && !concurrently_set
-            columns = options[:polymorphic] ? [:"#{reference}_type", :"#{reference}_id"] : :"#{reference}_id"
-
-            if index_value.is_a?(Hash)
-              options[:index] = options[:index].merge(algorithm: :concurrently)
-            else
-              options = options.merge(index: {algorithm: :concurrently})
-            end
-
-            raise_error :add_reference, command: command_str(method, [table, reference, options])
-          end
+          check_create_table(*args)
         when :execute
-          raise_error :execute, header: "Possibly dangerous operation"
-        when :change_column_null
-          table, column, null, default = args
-          if !null
-            if postgresql?
-              if helpers?
-                raise_error :change_column_null_postgresql_helper,
-                  command: command_str(:add_null_constraint_safely, [table, column])
-              else
-                # match https://github.com/nullobject/rein
-                constraint_name = "#{table}_#{column}_null"
-
-                raise_error :change_column_null_postgresql,
-                  add_constraint_code: constraint_str("ALTER TABLE %s ADD CONSTRAINT %s CHECK (%s IS NOT NULL) NOT VALID", [table, constraint_name, column]),
-                  validate_constraint_code: constraint_str("ALTER TABLE %s VALIDATE CONSTRAINT %s", [table, constraint_name])
-              end
-            elsif mysql? || mariadb?
-              raise_error :change_column_null_mysql
-            elsif !default.nil?
-              raise_error :change_column_null,
-                code: backfill_code(table, column, default)
-            end
-          end
-        when :add_foreign_key
-          from_table, to_table, options = args
-          options ||= {}
-
-          # always validated before 5.2
-          validate = options.fetch(:validate, true) || ActiveRecord::VERSION::STRING < "5.2"
-
-          if postgresql? && validate
-            if helpers?
-              raise_error :add_foreign_key_helper,
-                command: command_str(:add_foreign_key_safely, [from_table, to_table, options])
-            elsif ActiveRecord::VERSION::STRING < "5.2"
-              # fk name logic from rails
-              primary_key = options[:primary_key] || "id"
-              column = options[:column] || "#{to_table.to_s.singularize}_id"
-              hashed_identifier = Digest::SHA256.hexdigest("#{from_table}_#{column}_fk").first(10)
-              fk_name = options[:name] || "fk_rails_#{hashed_identifier}"
-
-              raise_error :add_foreign_key,
-                add_foreign_key_code: constraint_str("ALTER TABLE %s ADD CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s (%s) NOT VALID", [from_table, fk_name, column, to_table, primary_key]),
-                validate_foreign_key_code: constraint_str("ALTER TABLE %s VALIDATE CONSTRAINT %s", [from_table, fk_name])
-            else
-              raise_error :add_foreign_key,
-                add_foreign_key_code: command_str("add_foreign_key", [from_table, to_table, options.merge(validate: false)]),
-                validate_foreign_key_code: command_str("validate_foreign_key", [from_table, to_table])
-            end
-          end
+          check_execute
+        when :remove_column, :remove_columns, :remove_timestamps, :remove_reference, :remove_belongs_to
+          check_remove_column(method, *args)
+        when :remove_index
+          check_remove_index(*args)
+        when :rename_column
+          check_rename_column
+        when :rename_table
+          check_rename_table
+        when :validate_check_constraint
+          check_validate_check_constraint
+        when :validate_foreign_key
+          check_validate_foreign_key
+        when :commit_db_transaction
+          # if committed, likely no longer in DDL transaction
+          # and no longer eligible to be retried at migration level
+          # okay to have false positives
+          @committed = true
         end
 
-        StrongMigrations.checks.each do |check|
-          @migration.instance_exec(method, args, &check)
+        if !safe?
+          # custom checks
+          StrongMigrations.checks.each do |check|
+            @migration.instance_exec(method, args, &check)
+          end
         end
       end
 
-      result = yield
+      result =
+        if retry_lock_timeouts?(method)
+          # TODO figure out how to handle methods that generate multiple statements
+          # like add_reference(table, ref, index: {algorithm: :concurrently})
+          # lock timeout after first statement will cause retry to fail
+          retry_lock_timeouts { perform_method(method, *args, &block) }
+        else
+          perform_method(method, *args, &block)
+        end
 
+      # outdated statistics + a new index can hurt performance of existing queries
       if StrongMigrations.auto_analyze && direction == :up && method == :add_index
-        if postgresql?
-          connection.execute "ANALYZE VERBOSE #{connection.quote_table_name(args[0].to_s)}"
-        elsif mariadb? || mysql?
-          connection.execute "ANALYZE TABLE #{connection.quote_table_name(args[0].to_s)}"
-        end
+        adapter.analyze_table(args[0])
       end
 
       result
     end
 
-    def set_timeouts
-      if !@timeouts_set
-        if StrongMigrations.statement_timeout
-          statement =
-            if postgresql?
-              "SET statement_timeout TO #{connection.quote(StrongMigrations.statement_timeout)}"
-            elsif mysql?
-              "SET max_execution_time = #{connection.quote(StrongMigrations.statement_timeout.to_i * 1000)}"
-            elsif mariadb?
-              "SET max_statement_time = #{connection.quote(StrongMigrations.statement_timeout)}"
-            else
-              raise StrongMigrations::Error, "Statement timeout not supported for this database"
-            end
-
-          connection.select_all(statement)
-        end
-
-        if StrongMigrations.lock_timeout
-          statement =
-            if postgresql?
-              "SET lock_timeout TO #{connection.quote(StrongMigrations.lock_timeout)}"
-            elsif mysql? || mariadb?
-              "SET lock_wait_timeout = #{connection.quote(StrongMigrations.lock_timeout)}"
-            else
-              raise StrongMigrations::Error, "Lock timeout not supported for this database"
-            end
-
-          connection.select_all(statement)
-        end
-
-        @timeouts_set = true
+    def perform_method(method, *args)
+      if StrongMigrations.remove_invalid_indexes && direction == :up && method == :add_index && postgresql?
+        remove_invalid_index_if_needed(*args)
       end
+      yield
     end
 
-    private
-
-    def connection
-      @migration.connection
-    end
-
-    def version
-      @migration.version
-    end
-
-    def safe?
-      @safe || ENV["SAFETY_ASSURED"] || @migration.is_a?(ActiveRecord::Schema) || direction == :down || version_safe?
+    def retry_lock_timeouts(check_committed: false)
+      retries = 0
+      begin
+        yield
+      rescue ActiveRecord::LockWaitTimeout => e
+        if retries < StrongMigrations.lock_timeout_retries && !(check_committed && @committed)
+          retries += 1
+          delay = StrongMigrations.lock_timeout_retry_delay
+          @migration.say("Lock timeout. Retrying in #{delay} seconds...")
+          sleep(delay)
+          retry
+        end
+        raise e
+      end
     end
 
     def version_safe?
       version && version <= StrongMigrations.start_after
     end
 
-    def postgresql?
-      connection.adapter_name =~ /postg/i # PostgreSQL, PostGIS
+    def skip?
+      StrongMigrations.skipped_databases.map(&:to_s).include?(db_config_name)
     end
 
-    def postgresql_version
-      @postgresql_version ||= begin
-        target_version(StrongMigrations.target_postgresql_version) do
-          connection.select_all("SHOW server_version").first["server_version"]
-        end
-      end
-    end
+    private
 
-    def mysql?
-      connection.adapter_name =~ /mysql/i && !connection.try(:mariadb?)
-    end
+    def check_adapter
+      return if defined?(@adapter_checked)
 
-    def mysql_version
-      @mysql_version ||= begin
-        target_version(StrongMigrations.target_mysql_version) do
-          connection.select_all("SELECT VERSION()").first["VERSION()"].split("-").first
-        end
+      if adapter.instance_of?(Adapters::AbstractAdapter)
+        warn "[strong_migrations] Unsupported adapter: #{connection.adapter_name}. Use StrongMigrations.skip_database(#{db_config_name.to_sym.inspect}) to silence this warning."
       end
-    end
 
-    def mariadb?
-      connection.adapter_name =~ /mysql/i && connection.try(:mariadb?)
+      @adapter_checked = true
     end
 
-    def mariadb_version
-      @mariadb_version ||= begin
-        target_version(StrongMigrations.target_mariadb_version) do
-          connection.select_all("SELECT VERSION()").first["VERSION()"].split("-").first
+    def check_version_supported
+      return if defined?(@version_checked)
+
+      min_version = adapter.min_version
+      if min_version
+        version = adapter.server_version
+        if version < Gem::Version.new(min_version)
+          raise UnsupportedVersion, "#{adapter.name} version (#{version}) not supported in this version of Strong Migrations (#{StrongMigrations::VERSION})"
         end
       end
-    end
 
-    def target_version(target_version)
-      version =
-        if target_version && defined?(Rails) && (Rails.env.development? || Rails.env.test?)
-          target_version.to_s
-        else
-          yield
-        end
-      Gem::Version.new(version)
+      @version_checked = true
     end
 
-    def helpers?
-      StrongMigrations.helpers
-    end
+    def set_timeouts
+      return if @timeouts_set
 
-    def raise_error(message_key, header: nil, **vars)
-      return unless StrongMigrations.check_enabled?(message_key, version: version)
+      if StrongMigrations.statement_timeout
+        adapter.set_statement_timeout(StrongMigrations.statement_timeout)
+      end
+      if StrongMigrations.lock_timeout
+        adapter.set_lock_timeout(StrongMigrations.lock_timeout)
+      end
 
-      message = StrongMigrations.error_messages[message_key] || "Missing message"
+      @timeouts_set = true
+    end
 
-      vars[:migration_name] = @migration.class.name
-      vars[:migration_suffix] = "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      vars[:base_model] = "ApplicationRecord"
+    def check_lock_timeout
+      return if defined?(@lock_timeout_checked)
 
-      # interpolate variables in appended code
-      if vars[:append]
-        vars[:append] = vars[:append].gsub(/%(?!{)/, "%%") % vars
+      if StrongMigrations.lock_timeout_limit
+        adapter.check_lock_timeout(StrongMigrations.lock_timeout_limit)
       end
 
-      # escape % not followed by {
-      @migration.stop!(message.gsub(/%(?!{)/, "%%") % vars, header: header || "Dangerous operation detected")
+      @lock_timeout_checked = true
     end
 
-    def constraint_str(statement, identifiers)
-      # not all identifiers are tables, but this method of quoting should be fine
-      code = statement % identifiers.map { |v| connection.quote_table_name(v) }
-      "safety_assured do\n      execute '#{code}' \n    end"
+    def safe?
+      self.class.safe || ENV["SAFETY_ASSURED"] || (direction == :down && !StrongMigrations.check_down) || version_safe? || @migration.reverting?
+    end
+
+    def version
+      @migration.version
     end
 
-    def command_str(command, args)
-      str_args = args[0..-2].map { |a| a.inspect }
-
-      # prettier last arg
-      last_arg = args[-1]
-      if last_arg.is_a?(Hash)
-        if last_arg.any?
-          str_args << last_arg.map do |k, v|
-            if v.is_a?(Hash)
-              # pretty index: {algorithm: :concurrently}
-              "#{k}: {#{v.map { |k2, v2| "#{k2}: #{v2.inspect}" }.join(", ")}}"
+    def adapter
+      @adapter ||= begin
+        cls =
+          case connection.adapter_name
+          when /postg/i # PostgreSQL, PostGIS
+            Adapters::PostgreSQLAdapter
+          when /mysql|trilogy/i
+            if connection.try(:mariadb?)
+              Adapters::MariaDBAdapter
             else
-              "#{k}: #{v.inspect}"
+              Adapters::MySQLAdapter
             end
-          end.join(", ")
-        end
-      else
-        str_args << last_arg.inspect
+          else
+            Adapters::AbstractAdapter
+          end
+
+        cls.new(self)
       end
+    end
+
+    def connection
+      @migration.connection
+    end
+
+    def db_config_name
+      connection.pool.db_config.name
+    end
 
-      "#{command} #{str_args.join(", ")}"
+    def retry_lock_timeouts?(method)
+      (
+        StrongMigrations.lock_timeout_retries > 0 &&
+        !in_transaction? &&
+        method != :transaction &&
+        !@skip_retries
+      )
     end
 
-    def backfill_code(table, column, default)
-      model = table.to_s.classify
-      "#{model}.unscoped.in_batches do |relation| \n      relation.update_all #{column}: #{default.inspect}\n      sleep(0.01)\n    end"
+    def without_retries
+      previous_value = @skip_retries
+      begin
+        @skip_retries = true
+        yield
+      ensure
+        @skip_retries = previous_value
+      end
     end
 
-    def new_table?(table)
-      @new_tables.include?(table.to_s)
+    # REINDEX INDEX CONCURRENTLY leaves a new invalid index if it fails, so use remove_index instead
+    def remove_invalid_index_if_needed(*args)
+      options = args.extract_options!
+
+      # ensures has same options as existing index
+      # check args to avoid errors with index_exists?
+      return unless args.size == 2 && connection.index_exists?(*args, **options.merge(valid: false))
+
+      table, columns = args
+      index_name = options.fetch(:name, connection.index_name(table, columns))
+
+      # valid option is ignored for Active Record < 7.1, so check name as well
+      return if ar_version < 7.1 && !adapter.index_invalid?(table, index_name)
+
+      @migration.say("Attempting to remove invalid index")
+      without_retries do
+        # TODO pass index schema for extra safety?
+        @migration.remove_index(table, **{name: index_name}.merge(options.slice(:algorithm)))
+      end
     end
   end
 end