departure 6.6.0 → 6.8.0

data/lib/active_record/connection_adapters/rails_7_2_departure_adapter.rb

@@ -0,0 +1,215 @@
+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/patch_connection_handling'
+require 'active_support/core_ext/string/filters'
+require 'departure'
+require 'forwardable'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Rails72DepartureAdapter < AbstractMysqlAdapter
+      TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) } if defined?(initialize_type_map)
+
+      class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
+        def adapter
+          Rails72DepartureAdapter
+        end
+      end
+
+      class SchemaCreation < ActiveRecord::ConnectionAdapters::MySQL::SchemaCreation
+        def visit_DropForeignKey(name) # rubocop:disable Style/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)
+
+      ADAPTER_NAME = 'Percona'.freeze
+
+      def self.new_client(config)
+        connection_details = Departure::ConnectionDetails.new(config)
+        verbose = ActiveRecord::Migration.verbose
+        sanitizers = [
+          Departure::LogSanitizers::PasswordSanitizer.new(connection_details)
+        ]
+        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'))
+
+        Departure::Runner.new(
+          percona_logger,
+          cli_generator,
+          mysql_adapter
+        )
+      end
+
+      def initialize(config)
+        super
+
+        @config[:flags] ||= 0
+
+        if @config[:flags].is_a? Array
+          @config[:flags].push 'FOUND_ROWS'
+        else
+          @config[:flags] |= ::Mysql2::Client::FOUND_ROWS
+        end
+
+        @prepared_statements = false
+      end
+
+      def write_query?(sql) # :nodoc:
+        !ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(
+          :desc, :describe, :set, :show, :use
+        ).match?(sql)
+      end
+
+      def exec_delete(sql, name, binds)
+        execute(to_sql(sql, binds), name)
+
+        @raw_connection.affected_rows
+      end
+      alias exec_update exec_delete
+
+      def exec_insert(sql, name, binds, pky = nil, sequence_name = nil, returning: nil) # rubocop:disable Lint/UnusedMethodArgument, Metrics/Metrics/ParameterLists
+        execute(to_sql(sql, binds), name)
+      end
+
+      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
+
+      # Executes a SELECT query and returns an array of rows. Each row is an
+      # array of field values.
+
+      def select_rows(arel, name = nil, binds = [])
+        select_all(arel, name, binds).rows
+      end
+
+      # Executes a SELECT query and returns an array of record hashes with the
+      # column names as keys and column values as values.
+      def select(sql, name = nil, binds = [], **kwargs)
+        exec_query(sql, name, binds, **kwargs)
+      end
+
+      # Returns true, as this adapter supports migrations
+      def supports_migrations?
+        true
+      end
+
+      def new_column(...)
+        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)
+        bulk_change_table(table_name, recorder.commands)
+      end
+
+      def full_version
+        get_full_version
+      end
+
+      def get_full_version # rubocop:disable Style/AccessorMethodName
+        return @get_full_version if defined? @get_full_version
+
+        with_raw_connection do |conn|
+          @get_full_version = conn.database_adapter.get_database_version.full_version_string
+        end
+      end
+
+      def last_inserted_id(result)
+        @raw_connection.database_adapter.send(:last_inserted_id, result)
+      end
+
+      private
+
+      attr_reader :mysql_adapter
+
+      def each_hash(result, &block) # :nodoc:
+        @raw_connection.database_adapter.each_hash(result, &block)
+      end
+
+      # Must return the MySQL error number from the exception, if the exception has an
+      # error number.
+      def error_number(exception)
+        @raw_connection.database_adapter.error_number(exception)
+      end
+
+      def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
+        log(sql, name, async: async) do |notification_payload|
+          with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
+            sync_timezone_changes(conn)
+            result = conn.query(sql)
+            verified! if allow_retry
+            handle_warnings(sql)
+            if result.is_a? Process::Status
+              notification_payload[:exit_code] = result.exitstatus
+              notification_payload[:exit_pid] = result.pid
+            elsif result.respond_to?(:size)
+              notification_payload[:row_count] = result.size
+            end
+            result
+          end
+        end
+      end
+
+      def connect
+        @raw_connection = self.class.new_client(@config)
+      rescue ConnectionNotEstablished => e
+        raise e.set_pool(@pool)
+      end
+
+      def reconnect
+        @lock.synchronize do
+          @raw_connection&.close
+          @raw_connection = nil
+          connect
+        end
+      end
+    end
+  end
+end

data/lib/departure/command.rb

@@ -42,7 +42,7 @@ module Departure
     # execution status
     def run_in_process
       Open3.popen3(full_command) do |_stdin, stdout, _stderr, waith_thr|
-        begin
+        begin # rubocop:disable Style/RedundantBegin
           loop do
             IO.select([stdout])
             data = stdout.read_nonblock(8192)
@@ -83,7 +83,11 @@ module Departure
     #
     # @return [String]
     def error_message
-      File.read(error_log_path)
+      if redirect_stderr
+        File.read(error_log_path)
+      else
+        ''
+      end
     end
 
     # Logs when the execution started

data/lib/departure/configuration.rb

@@ -1,6 +1,7 @@
 module Departure
   class Configuration
-    attr_accessor :tmp_path, :global_percona_args, :enabled_by_default, :redirect_stderr
+    attr_accessor :tmp_path, :global_percona_args, :enabled_by_default, :redirect_stderr,
+                  :disable_rails_advisory_lock_patch
 
     def initialize
       @tmp_path = '.'.freeze

data/lib/departure/rails_adapter.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Departure
+  class RailsAdapter
+    extend Forwardable
+
+    class << self
+      def current_version
+        ActiveRecord::VERSION
+      end
+
+      def for_current
+        self.for(current_version)
+      end
+
+      def for(ar_version)
+        if ar_version::MAJOR >= 7 && ar_version::MINOR >= 2
+          V7_2_Adapter
+        else
+          BaseAdapter
+        end
+      end
+    end
+
+    class BaseAdapter
+      class << self
+        def register_integrations
+          require 'active_record/connection_adapters/percona_adapter'
+
+          ActiveSupport.on_load(:active_record) do
+            ActiveRecord::Migration.class_eval do
+              include Departure::Migration
+            end
+
+            if ActiveRecord::VERSION::MAJOR == 7 && ActiveRecord::VERSION::MINOR == 1
+              require 'departure/rails_patches/active_record_migrator_with_advisory_lock_patch'
+
+              ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
+            end
+          end
+        end
+
+        # ActiveRecord::ConnectionAdapters::Mysql2Adapter
+        def create_connection_adapter(**config)
+          mysql2_adapter = ActiveRecord::Base.mysql2_connection(config)
+
+          connection_details = Departure::ConnectionDetails.new(config)
+          verbose = ActiveRecord::Migration.verbose
+          sanitizers = [
+            Departure::LogSanitizers::PasswordSanitizer.new(connection_details)
+          ]
+          percona_logger = Departure::LoggerFactory.build(sanitizers: sanitizers, verbose: verbose)
+          cli_generator = Departure::CliGenerator.new(connection_details)
+
+          runner = Departure::Runner.new(
+            percona_logger,
+            cli_generator,
+            mysql2_adapter
+          )
+
+          connection_options = { mysql_adapter: mysql2_adapter }
+
+          ActiveRecord::ConnectionAdapters::DepartureAdapter.new(
+            runner,
+            percona_logger,
+            connection_options,
+            config
+          )
+        end
+
+        def sql_column
+          ::ActiveRecord::ConnectionAdapters::DepartureAdapter::Column
+        end
+      end
+    end
+
+    class V7_2_Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
+      class << self
+        def register_integrations
+          require 'active_record/connection_adapters/rails_7_2_departure_adapter'
+          require 'departure/rails_patches/active_record_migrator_with_advisory_lock_patch'
+
+          ActiveSupport.on_load(:active_record) do
+            ActiveRecord::Migration.class_eval do
+              include Departure::Migration
+            end
+
+            ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
+          end
+
+          ActiveRecord::ConnectionAdapters.register 'percona',
+                                                    'ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter',
+                                                    'active_record/connection_adapters/rails_7_2_departure_adapter'
+        end
+
+        def create_connection_adapter(**config)
+          ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter.new(config)
+        end
+
+        def sql_column
+          ::ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter::Column
+        end
+      end
+    end
+  end
+end

data/lib/departure/rails_patches/active_record_migrator_with_advisory_lock_patch.rb

@@ -0,0 +1,25 @@
+module Departure
+  module RailsPatches
+    module ActiveRecordMigratorWithAdvisoryLockPatch
+      RELEASE_LOCK_FAILED_MESSAGE = 'Failed to release advisory lock from ActiveRecordMigratorWithAdvisoryLockPatch'
+                                      .freeze
+
+      def with_advisory_lock
+        return super if Departure.configuration.disable_rails_advisory_lock_patch
+
+        lock_id = generate_migrator_advisory_lock_id
+        @__original_connection = connection
+
+        got_lock = @__original_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
+        yield
+      ensure
+        if got_lock && !@__original_connection.release_advisory_lock(lock_id)
+          raise ConcurrentMigrationError, RELEASE_LOCK_FAILED_MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/departure/runner.rb

@@ -4,6 +4,10 @@ module Departure
   # It executes pt-online-schema-change commands in a new process and gets its
   # output and status
   class Runner
+    extend Forwardable
+
+    def_delegators :raw_connection, :execute, :escape, :close, :affected_rows
+
     # Constructor
     #
     # @param logger [#say, #write]
@@ -14,8 +18,16 @@ module Departure
       @logger = logger
       @cli_generator = cli_generator
       @mysql_adapter = mysql_adapter
-      @error_log_path = config.error_log_path
-      @redirect_stderr = config.redirect_stderr
+      @error_log_path = config&.error_log_path
+      @redirect_stderr = config&.redirect_stderr
+    end
+
+    def database_adapter
+      @mysql_adapter
+    end
+
+    def raw_connection
+      database_adapter.raw_connection
     end
 
     # Executes the passed sql statement using pt-online-schema-change for ALTER
@@ -27,7 +39,7 @@ module Departure
         command_line = cli_generator.parse_statement(sql)
         execute(command_line)
       else
-        mysql_adapter.execute(sql)
+        database_adapter.execute(sql)
       end
     end
 
@@ -36,7 +48,7 @@ module Departure
     #
     # @return [Integer]
     def affected_rows
-      mysql_adapter.raw_connection.affected_rows
+      raw_connection.affected_rows
     end
 
     # TODO: rename it so we don't confuse it with AR's #execute

data/lib/departure/version.rb

@@ -1,3 +1,3 @@
 module Departure
-  VERSION = '6.6.0'.freeze
+  VERSION = '6.8.0'.freeze
 end

data/lib/departure.rb

@@ -15,17 +15,14 @@ require 'departure/errors'
 require 'departure/command'
 require 'departure/connection_base'
 require 'departure/migration'
+require 'departure/rails_adapter'
 
 require 'departure/railtie' if defined?(Rails)
 
 # We need the OS not to buffer the IO to see pt-osc's output while migrating
 $stdout.sync = true
 
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Migration.class_eval do
-    include Departure::Migration
-  end
-end
+Departure::RailsAdapter.for_current.register_integrations
 
 module Departure
   class << self

data/lib/lhm/column_with_sql.rb

@@ -6,13 +6,6 @@ module Lhm
   class ColumnWithSql
     extend Forwardable
 
-    # Returns the column's class to be used
-    #
-    # @return [Constant]
-    def self.column_factory
-      ::ActiveRecord::ConnectionAdapters::DepartureAdapter::Column
-    end
-
     # Constructor
     #
     # @param name [String, Symbol]
@@ -59,7 +52,7 @@ module Lhm
         limit: cast_type.limit
       )
       mysql_metadata = ActiveRecord::ConnectionAdapters::MySQL::TypeMetadata.new(metadata)
-      @column ||= self.class.column_factory.new(
+      @column ||= Departure::RailsAdapter.for_current.sql_column.new(
         name,
         default_value,
         mysql_metadata,

data/test_database.rb

@@ -1,5 +1,6 @@
 require 'active_record'
 require 'active_record/connection_adapters/mysql2_adapter'
+require 'departure'
 
 # Setups the test database with the schema_migrations table that ActiveRecord
 # requires for the migrations, plus a table for the Comment model used throught
@@ -70,11 +71,6 @@ class TestDatabase
   end
 
   def conn
-    @conn ||= ActiveRecord::Base.mysql2_connection(
-      host: @config['hostname'],
-      username: @config['username'],
-      password: @config['password'],
-      reconnect: true
-    )
+    ActiveRecord::Base.connection
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: departure
 version: !ruby/object:Gem::Version
-  version: 6.6.0
+  version: 6.8.0
 platform: ruby
 authors:
 - Ilya Zayats
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-02 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -23,52 +23,52 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 7.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 7.3.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 7.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 7.3.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -76,9 +76,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -86,9 +86,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
-    - - "<="
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -186,23 +200,36 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - RELEASING.md
 - Rakefile
 - bin/console
+- bin/rails
 - bin/rspec
 - bin/setup
 - config.yml.erb
 - configuration.rb
 - departure.gemspec
 - docker-compose.yml
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_6_1.gemfile.lock
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_0.gemfile.lock
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_1.gemfile.lock
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_7_2.gemfile.lock
 - lib/active_record/connection_adapters/for_alter.rb
+- lib/active_record/connection_adapters/patch_connection_handling.rb
 - lib/active_record/connection_adapters/percona_adapter.rb
+- lib/active_record/connection_adapters/rails_7_2_departure_adapter.rb
 - lib/departure.rb
 - lib/departure/alter_argument.rb
 - lib/departure/cli_generator.rb
@@ -218,6 +245,8 @@ files:
 - lib/departure/migration.rb
 - lib/departure/null_logger.rb
 - lib/departure/option.rb
+- lib/departure/rails_adapter.rb
+- lib/departure/rails_patches/active_record_migrator_with_advisory_lock_patch.rb
 - lib/departure/railtie.rb
 - lib/departure/runner.rb
 - lib/departure/user_options.rb
@@ -239,14 +268,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: pt-online-schema-change runner for ActiveRecord migrations