departure 8.0.0 → 8.2.0

data/lib/active_record/connection_adapters/rails_8_0_departure_adapter.rb

@@ -1,16 +1,18 @@
-require 'active_record/connection_adapters/abstract_mysql_adapter'
-require 'active_record/connection_adapters/statement_pool'
-require 'active_record/connection_adapters/mysql2_adapter'
-require 'active_record/connection_adapters/mysql2/database_statements'
-require 'active_record/connection_adapters/patch_connection_handling'
-require 'active_support/core_ext/string/filters'
-require 'departure'
-require 'forwardable'
+require "active_record/connection_adapters/abstract_mysql_adapter"
+require "active_record/connection_adapters/statement_pool"
+require "active_record/connection_adapters/mysql2_adapter"
+require "active_record/connection_adapters/mysql2/database_statements"
+require "active_record/connection_adapters/patch_connection_handling"
+require "active_support/core_ext/string/filters"
+require "departure"
+require "forwardable"
+require "active_record/connection_adapters/departure_adapter_behavior"
 
 module ActiveRecord
   module ConnectionAdapters
     class Rails80DepartureAdapter < AbstractMysqlAdapter
       include ActiveRecord::ConnectionAdapters::Mysql2::DatabaseStatements
+
       TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) } if defined?(initialize_type_map)
 
       class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
@@ -19,24 +21,11 @@ module ActiveRecord
         end
       end
 
-      class SchemaCreation < ActiveRecord::ConnectionAdapters::MySQL::SchemaCreation
-        def visit_DropForeignKey(name) # rubocop:disable Naming/MethodName
-          fk_name =
-            if name =~ /^__(.+)/
-              Regexp.last_match(1)
-            else
-              "_#{name}"
-            end
-
-          "DROP FOREIGN KEY #{fk_name}"
-        end
-      end
-
       extend Forwardable
 
-      include ForAlterStatements unless method_defined?(:change_column_for_alter)
+      include DepartureAdapterBehavior::SchemaStatements
 
-      ADAPTER_NAME = 'Percona'.freeze
+      ADAPTER_NAME = "Percona".freeze
 
       def self.new_client(config)
         connection_details = Departure::ConnectionDetails.new(config)
@@ -47,7 +36,7 @@ module ActiveRecord
         percona_logger = Departure::LoggerFactory.build(sanitizers: sanitizers, verbose: verbose)
         cli_generator = Departure::CliGenerator.new(connection_details)
 
-        mysql_adapter = ActiveRecord::ConnectionAdapters::Mysql2Adapter.new(config.merge(adapter: 'mysql2'))
+        mysql_adapter = ActiveRecord::ConnectionAdapters::Mysql2Adapter.new(config.merge(adapter: "mysql2"))
 
         Departure::Runner.new(
           percona_logger,
@@ -62,7 +51,7 @@ module ActiveRecord
         @config[:flags] ||= 0
 
         if @config[:flags].is_a? Array
-          @config[:flags].push 'FOUND_ROWS'
+          @config[:flags].push "FOUND_ROWS"
         else
           @config[:flags] |= ::Mysql2::Client::FOUND_ROWS
         end
@@ -81,18 +70,18 @@ module ActiveRecord
 
         @raw_connection.affected_rows
       end
-      alias exec_update exec_delete
+      alias_method :exec_update, :exec_delete
 
       def exec_insert(sql, name, binds, pky = nil, sequence_name = nil, returning: nil) # rubocop:disable Lint/UnusedMethodArgument, Metrics/ParameterLists
         execute(to_sql(sql, binds), name)
       end
 
-      def internal_exec_query(sql, name = 'SQL', _binds = [], **_kwargs) # :nodoc:
+      def internal_exec_query(sql, name = "SQL", _binds = [], **_kwargs) # :nodoc:
         result = execute(sql, name)
         fields = result.fields if defined?(result.fields)
         ActiveRecord::Result.new(fields || [], result.to_a)
       end
-      alias exec_query internal_exec_query
+      alias_method :exec_query, :internal_exec_query
 
       # Executes a SELECT query and returns an array of rows. Each row is an
       # array of field values.
@@ -116,35 +105,6 @@ module ActiveRecord
         Column.new(...)
       end
 
-      # Adds a new index to the table
-      #
-      # @param table_name [String, Symbol]
-      # @param column_name [String, Symbol]
-      # @param options [Hash] optional
-      def add_index(table_name, column_name, options = {})
-        index_definition, = add_index_options(table_name, column_name, **options)
-        execute <<-SQL.squish
-          ALTER TABLE #{quote_table_name(index_definition.table)}
-            ADD #{schema_creation.accept(index_definition)}
-        SQL
-      end
-
-      # Remove the given index from the table.
-      #
-      # @param table_name [String, Symbol]
-      # @param options [Hash] optional
-      def remove_index(table_name, column_name = nil, **options)
-        return if options[:if_exists] && !index_exists?(table_name, column_name, **options)
-
-        index_name = index_name_for_remove(table_name, column_name, options)
-
-        execute "ALTER TABLE #{quote_table_name(table_name)} DROP INDEX #{quote_column_name(index_name)}"
-      end
-
-      def schema_creation
-        SchemaCreation.new(self)
-      end
-
       def change_table(table_name, _options = {})
         recorder = ActiveRecord::Migration::CommandRecorder.new(self)
         yield update_table_definition(table_name, recorder)
@@ -183,21 +143,21 @@ module ActiveRecord
 
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/ParameterLists
       def raw_execute(sql, name = nil, binds = [], prepare: false, async: false, allow_retry: false,
-                      materialize_transactions: true, batch: false)
+        materialize_transactions: true, batch: false)
         type_casted_binds = type_casted_binds(binds)
         log(sql, name, binds, type_casted_binds, async: async) do |notification_payload|
           with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
             perform_query(conn, sql, binds, type_casted_binds, prepare: prepare,
-                                                               notification_payload: notification_payload, batch: batch)
+              notification_payload: notification_payload, batch: batch)
           end
         end
       end
 
       def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false)
         reset_multi_statement = if batch && !multi_statements_enabled?
-                                  raw_connection.set_server_option(::Mysql2::Client::OPTION_MULTI_STATEMENTS_ON)
-                                  true
-                                end
+          raw_connection.set_server_option(::Mysql2::Client::OPTION_MULTI_STATEMENTS_ON)
+          true
+        end
 
         # Make sure we carry over any changes to ActiveRecord.default_timezone that have been
         # made since we established the connection
@@ -216,10 +176,10 @@ module ActiveRecord
             # THIS IS THE CORE CHANGES 1 related to size
             # We will sometimes have a process exit code instead of a result from executing
             @affected_rows_before_warnings = if result.is_a? Process::Status
-                                               result.try(:size) || 0
-                                             else
-                                               result.try(:size) || raw_connection.affected_rows
-                                             end
+              result.try(:size) || 0
+            else
+              result.try(:size) || raw_connection.affected_rows
+            end
           end
         elsif prepare
 

data/lib/active_record/connection_adapters/rails_8_0_trilogy_adapter.rb

@@ -0,0 +1,21 @@
+require "active_record/connection_adapters/abstract_mysql_adapter"
+require "active_record/connection_adapters/trilogy_adapter"
+require "active_record/connection_adapters/patch_connection_handling"
+require "departure"
+require "active_record/connection_adapters/departure_adapter_behavior"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Rails80TrilogyAdapter < ActiveRecord::ConnectionAdapters::TrilogyAdapter
+      class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
+        def adapter
+          Rails80TrilogyAdapter
+        end
+      end
+
+      ADAPTER_NAME = "Percona".freeze
+
+      include DepartureAdapterBehavior::Rails8
+    end
+  end
+end

data/lib/active_record/connection_adapters/rails_8_1_mysql2_adapter.rb

@@ -0,0 +1,23 @@
+require "active_record/connection_adapters/abstract_mysql_adapter"
+require "active_record/connection_adapters/mysql2_adapter"
+require "active_record/connection_adapters/patch_connection_handling"
+require "departure"
+require "active_record/connection_adapters/departure_adapter_behavior"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Rails81Mysql2Adapter < ActiveRecord::ConnectionAdapters::Mysql2Adapter
+      TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) } if defined?(initialize_type_map)
+
+      class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
+        def adapter
+          Rails81Mysql2Adapter
+        end
+      end
+
+      ADAPTER_NAME = "Percona".freeze
+
+      include DepartureAdapterBehavior::Rails8
+    end
+  end
+end

data/lib/active_record/connection_adapters/rails_8_1_trilogy_adapter.rb

@@ -0,0 +1,21 @@
+require "active_record/connection_adapters/abstract_mysql_adapter"
+require "active_record/connection_adapters/trilogy_adapter"
+require "active_record/connection_adapters/patch_connection_handling"
+require "departure"
+require "active_record/connection_adapters/departure_adapter_behavior"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Rails81TrilogyAdapter < ActiveRecord::ConnectionAdapters::TrilogyAdapter
+      class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
+        def adapter
+          Rails81TrilogyAdapter
+        end
+      end
+
+      ADAPTER_NAME = "Percona".freeze
+
+      include DepartureAdapterBehavior::Rails8
+    end
+  end
+end

data/lib/departure/alter_argument.rb

@@ -4,7 +4,7 @@ module Departure
   # Represents the '--alter' argument of Percona's pt-online-schema-change
   # See https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html
   class AlterArgument
-    ALTER_TABLE_REGEX = /\AALTER TABLE [^\s]*[\n]* /
+    ALTER_TABLE_REGEX = /\AALTER TABLE [^\s]*\n* /
 
     attr_reader :table_name
 
@@ -21,8 +21,8 @@ module Departure
       #
       # Removes the grave marks, if they are there, so we can get the table_name
       @table_name = String(match)
-                      .split(' ')[2]
-                      .delete('`')
+        .split(" ")[2]
+        .delete("`")
     end
 
     # Returns the '--alter' pt-online-schema-change argument as a string. See
@@ -40,9 +40,9 @@ module Departure
     # @return [String]
     def parsed_statement
       @parsed_statement ||= statement
-        .gsub(ALTER_TABLE_REGEX, '')
-        .gsub('`', '\\\`')
-        .gsub(/\\n/, '')
+        .gsub(ALTER_TABLE_REGEX, "")
+        .gsub("`", '\\\`')
+        .gsub("\\n", "")
         .gsub('"', '\\\"')
     end
   end

data/lib/departure/cli_generator.rb

@@ -1,24 +1,24 @@
-require 'departure/dsn'
-require 'departure/option'
-require 'departure/alter_argument'
-require 'departure/connection_details'
-require 'departure/user_options'
+require "departure/dsn"
+require "departure/option"
+require "departure/alter_argument"
+require "departure/connection_details"
+require "departure/user_options"
 
 module Departure
   # Generates the equivalent Percona's pt-online-schema-change command to the
   # given SQL statement
   #
   # --no-check-alter is used to allow running CHANGE COLUMN statements. For more details, check:
-  # www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html#cmdoption-pt-online-schema-change--[no]check-alter # rubocop:disable Metrics/LineLength
+  # www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html#cmdoption-pt-online-schema-change--[no]check-alter
   #
   class CliGenerator
-    COMMAND_NAME = 'pt-online-schema-change'.freeze
+    COMMAND_NAME = "pt-online-schema-change".freeze
     DEFAULT_OPTIONS = Set.new(
       [
-        Option.new('execute'),
-        Option.new('statistics'),
-        Option.new('alter-foreign-keys-method', 'auto'),
-        Option.new('no-check-alter')
+        Option.new("execute"),
+        Option.new("statistics"),
+        Option.new("alter-foreign-keys-method", "auto"),
+        Option.new("no-check-alter")
       ]
     ).freeze
 
@@ -78,7 +78,7 @@ module Departure
       env_variable_options = UserOptions.new
       global_configuration_options = UserOptions.new(Departure.configuration.global_percona_args)
       options = env_variable_options.merge(global_configuration_options).merge(DEFAULT_OPTIONS)
-      options.to_a.join(' ')
+      options.to_a.join(" ")
     end
   end
 end

data/lib/departure/command.rb

@@ -86,7 +86,7 @@ module Departure
       if redirect_stderr
         File.read(error_log_path)
       else
-        ''
+        ""
       end
     end
 

data/lib/departure/configuration.rb

@@ -1,11 +1,11 @@
 module Departure
   class Configuration
     attr_accessor :tmp_path, :global_percona_args, :enabled_by_default, :redirect_stderr,
-                  :disable_rails_advisory_lock_patch
+      :disable_rails_advisory_lock_patch
 
     def initialize
-      @tmp_path = '.'.freeze
-      @error_log_filename = 'departure_error.log'.freeze
+      @tmp_path = ".".freeze
+      @error_log_filename = "departure_error.log".freeze
       @global_percona_args = nil
       @enabled_by_default = true
       @redirect_stderr = true

data/lib/departure/connection_details.rb

@@ -1,4 +1,4 @@
-require 'shellwords'
+require "shellwords"
 module Departure
   # Holds the parameters of the DB connection and formats them to string
   class ConnectionDetails
@@ -26,7 +26,7 @@ module Departure
     #
     # @return [String]
     def database
-      ENV.fetch('PERCONA_DB_NAME', connection_data[:database])
+      ENV.fetch("PERCONA_DB_NAME", connection_data[:database])
     end
 
     # Returns the password fragment of the details string if a password is passed
@@ -36,7 +36,7 @@ module Departure
       if password.present?
         %(--password #{Shellwords.escape(password)} )
       else
-        ''
+        ""
       end
     end
 
@@ -77,7 +77,7 @@ module Departure
     #
     # @return [String]
     def host
-      ENV.fetch('PERCONA_DB_HOST', connection_data[:host]) || 'localhost'
+      ENV.fetch("PERCONA_DB_HOST", connection_data[:host]) || "localhost"
     end
 
     # Returns the database user. If PERCONA_DB_USER is passed its value will be
@@ -85,7 +85,7 @@ module Departure
     #
     # @return [String]
     def user
-      ENV.fetch('PERCONA_DB_USER', connection_data[:username])
+      ENV.fetch("PERCONA_DB_USER", connection_data[:username])
     end
 
     # Returns the database user's password. If PERCONA_DB_PASSWORD is passed its
@@ -93,7 +93,7 @@ module Departure
     #
     # @return [String]
     def password
-      ENV.fetch('PERCONA_DB_PASSWORD', connection_data[:password])
+      ENV.fetch("PERCONA_DB_PASSWORD", connection_data[:password])
     end
 
     # Returns the database socket path. If PERCONA_DB_SOCKET is passed its value
@@ -101,7 +101,7 @@ module Departure
     #
     # @return [String]
     def socket
-      ENV.fetch('PERCONA_DB_SOCKET', connection_data[:socket])
+      ENV.fetch("PERCONA_DB_SOCKET", connection_data[:socket])
     end
 
     # Returns the database's port.

data/lib/departure/db_client.rb

@@ -1,6 +1,6 @@
-require 'open3'
+require "open3"
 
-require 'forwardable'
+require "forwardable"
 
 module Departure
   # It executes pt-online-schema-change commands in a new process and gets its
@@ -40,9 +40,9 @@ module Departure
       command_line = @cli_generator.parse_statement(raw_sql_string)
 
       Command.new(command_line,
-                  Departure.configuration.error_log_path,
-                  @logger,
-                  Departure.configuration.redirect_stderr).run
+        Departure.configuration.error_log_path,
+        @logger,
+        Departure.configuration.redirect_stderr).run
     end
 
     def alter_statement?(raw_sql_string)

data/lib/departure/dsn.rb

@@ -9,13 +9,13 @@ module Departure
     def initialize(database, table_name)
       @database = database
       @table_name = table_name
-      @suffix = ENV.fetch('PERCONA_DSN_SUFFIX', nil)
+      @suffix = ENV.fetch("PERCONA_DSN_SUFFIX", nil)
     end
 
     # Returns the pt-online-schema-change DSN string. See
     # https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html#dsn-options
     def to_s
-      "D=#{database},t=#{table_name}#{suffix.nil? ? nil : ',' + suffix}"
+      "D=#{database},t=#{table_name}#{"," + suffix unless suffix.nil?}"
     end
 
     private

data/lib/departure/errors.rb

@@ -5,7 +5,7 @@ module Departure
   # status.
   class NoStatusError < Error
     def message
-      'Status could not be retrieved'.freeze
+      "Status could not be retrieved".freeze
     end
   end
 
@@ -29,7 +29,7 @@ module Departure
 
   class CommandNotFoundError < Error
     def message
-      'Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit for further details'
+      "Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit for further details"
     end
   end
 

data/lib/departure/log_sanitizers/password_sanitizer.rb

@@ -1,7 +1,7 @@
 module Departure
   module LogSanitizers
     class PasswordSanitizer
-      PASSWORD_REPLACEMENT = '[filtered_password]'.freeze
+      PASSWORD_REPLACEMENT = "[filtered_password]".freeze
 
       delegate :password_argument, to: :connection_details
 

data/lib/departure/logger.rb

@@ -14,13 +14,13 @@ module Departure
     # @param message [String]
     # @param subitem [Boolean] whether to show message as a nested log item
     def say(message, subitem = false)
-      write "#{subitem ? '   ->' : '--'} #{message}"
+      write "#{subitem ? "   ->" : "--"} #{message}"
     end
 
     # Outputs the text through the stdout adding a new line at the end
     #
     # @param text [String]
-    def write(text = '')
+    def write(text = "")
       puts(sanitize(text))
     end
 

data/lib/departure/migration.rb

@@ -8,6 +8,8 @@ module Departure
   module Migration
     extend ActiveSupport::Concern
 
+    DEPARTURE_ADAPTERS = %w[percona percona_trilogy].freeze
+
     included do
       # Holds the name of the adapter that was configured by the app.
       mattr_accessor :original_adapter
@@ -53,11 +55,13 @@ module Departure
     # Migrate with or without Departure based on uses_departure class
     # attribute.
     def migrate(direction)
-      if uses_departure?
-        departure_migrate(direction)
-      else
-        reconnect_without_percona
-        active_record_migrate(direction)
+      with_restored_connection_specification_name do
+        if uses_departure?
+          departure_migrate(direction)
+        else
+          reconnect_without_percona
+          active_record_migrate(direction)
+        end
       end
     end
 
@@ -73,15 +77,29 @@ module Departure
     # Make all connections in the connection pool to use PerconaAdapter
     # instead of the current adapter.
     def reconnect_with_percona
-      return if connection_config[:adapter] == 'percona'
-      Departure::ConnectionBase.establish_connection(connection_config.merge(adapter: 'percona'))
+      config = connection_config
+      return if departure_adapter_config?(config)
+
+      departure_adapter = Departure::RailsAdapter.for_current(db_connection_adapter: config[:adapter])
+      Departure::ConnectionBase.establish_connection(
+        config.merge(
+          adapter: departure_adapter.departure_adapter_name,
+          departure_original_adapter: config[:adapter]
+        )
+      )
     end
 
     # Reconnect without percona adapter when Departure is disabled but was
     # enabled in a previous migration.
     def reconnect_without_percona
-      return unless connection_config[:adapter] == 'percona'
-      Departure::OriginalAdapterConnection.establish_connection(connection_config.merge(adapter: original_adapter))
+      config = connection_config
+      return unless departure_adapter_config?(config)
+
+      Departure::OriginalAdapterConnection.establish_connection(
+        config
+          .except(:departure_original_adapter)
+          .merge(adapter: config[:departure_original_adapter] || original_adapter)
+      )
     end
 
     private
@@ -89,12 +107,24 @@ module Departure
     # Capture the type of the adapter configured by the app if not already set.
     def connection_config
       configuration_hash.tap do |config|
-        self.class.original_adapter ||= config[:adapter]
+        self.class.original_adapter ||= config[:departure_original_adapter] || config[:adapter]
       end
     end
 
+    private def departure_adapter_config?(config)
+      DEPARTURE_ADAPTERS.include?(config[:adapter])
+    end
+
     private def configuration_hash
       ActiveRecord::Base.connection_db_config.configuration_hash
     end
+
+    private def with_restored_connection_specification_name
+      connection_specification_name = ActiveRecord::Base.connection_specification_name
+
+      yield
+    ensure
+      ActiveRecord::Base.connection_specification_name = connection_specification_name
+    end
   end
 end

data/lib/departure/option.rb

@@ -27,7 +27,7 @@ module Departure
     def ==(other)
       name == other.name
     end
-    alias eql? ==
+    alias_method :eql?, :==
 
     # Returns the option's hash
     #
@@ -50,7 +50,7 @@ module Departure
     #
     # @return [String]
     def normalize_option(name)
-      if name.start_with?('-')
+      if name.start_with?("-")
         name
       elsif name.length == 1
         "-#{name}"
@@ -64,8 +64,8 @@ module Departure
     # @return [String]
     def value_as_string
       if value.nil?
-        ''
-      elsif value.include?('=')
+        ""
+      elsif value.include?("=")
         " #{value}"
       else
         "=#{value}"