departure 6.8.0 → 8.0.0

data/lib/active_record/connection_adapters/rails_8_1_departure_adapter.rb

@@ -0,0 +1,83 @@
+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 'forwardable'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Rails81DepartureAdapter < 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
+          Rails81DepartureAdapter
+        end
+      end
+
+      # https://github.com/departurerb/departure/commit/f178ca26cd3befa1c68301d3b57810f8cdcff9eb
+      # For `DROP FOREIGN KEY constraint_name` with pt-online-schema-change requires specifying `_constraint_name`
+      # rather than the real constraint_name due to to a limitation in MySQL
+      # pt-online-schema-change adds a leading underscore to foreign key constraint names when creating the new table.
+      # https://www.percona.com/blog/2017/03/21/dropping-foreign-key-constraint-using-pt-online-schema-change-2/
+      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)
+
+      ADAPTER_NAME = 'Percona'.freeze
+
+      def self.new_client(config)
+        original_client = super
+
+        Departure::DbClient.new(config, original_client)
+      end
+
+      # add_index is modified from the underlying mysql adapter implementation to ensure we add ALTER TABLE to it
+      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_index is modified from the underlying mysql adapter implementation to ensure we add ALTER TABLE to it
+      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
+
+      private
+
+      attr_reader :mysql_adapter
+
+      # rubocop:disable Metrics/ParameterLists
+      def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false)
+        return raw_connection.send_to_pt_online_schema_change(sql) if raw_connection.alter_statement?(sql)
+
+        super
+      end
+      # rubocop:enable Metrics/ParameterLists
+    end
+  end
+end

data/lib/departure/db_client.rb

@@ -0,0 +1,52 @@
+require 'open3'
+
+require 'forwardable'
+
+module Departure
+  # It executes pt-online-schema-change commands in a new process and gets its
+  # output and status
+  class DbClient
+    delegate_missing_to :database_client
+
+    attr_reader :database_client
+
+    def initialize(config, database_client)
+      @config = config
+      @database_client = database_client
+
+      connection_details = Departure::ConnectionDetails.new(config)
+      verbose = ActiveRecord::Migration.verbose
+      sanitizers = [Departure::LogSanitizers::PasswordSanitizer.new(connection_details)]
+      @logger = Departure::LoggerFactory.build(sanitizers: sanitizers, verbose: verbose)
+      @cli_generator = Departure::CliGenerator.new(connection_details)
+    end
+
+    # Intercepts raw query calls to pass ALTER TABLE statements to pt-online-schema-change
+    # otherwise sends to the database adapter
+    # eg: goes to pt-online-schema-change
+    #   query("ALTER TABLE `comments` ADD INDEX `index_comments_on_some_id_field` (`some_id_field`))
+    # eg: sends to database adapter
+    #   query("COMMIT") - query("SELECT * from 'comments'")
+    def query(raw_sql_string)
+      if alter_statement?(raw_sql_string)
+        send_to_pt_online_schema_change(raw_sql_string)
+      else
+        database_client.query(raw_sql_string)
+      end
+    end
+
+    # Runs raw_sql_string through pt-online-schema-change command line tool
+    def send_to_pt_online_schema_change(raw_sql_string)
+      command_line = @cli_generator.parse_statement(raw_sql_string)
+
+      Command.new(command_line,
+                  Departure.configuration.error_log_path,
+                  @logger,
+                  Departure.configuration.redirect_stderr).run
+    end
+
+    def alter_statement?(raw_sql_string)
+      raw_sql_string =~ /\Aalter table/i
+    end
+  end
+end

data/lib/departure/migration.rb

@@ -94,11 +94,7 @@ module Departure
     end
 
     private def configuration_hash
-      if ActiveRecord::VERSION::STRING >= '6.1'
-        ActiveRecord::Base.connection_db_config.configuration_hash
-      else
-        ActiveRecord::Base.connection_config
-      end
+      ActiveRecord::Base.connection_db_config.configuration_hash
     end
   end
 end

data/lib/departure/rails_adapter.rb

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 module Departure
   class RailsAdapter
-    extend Forwardable
+    extend ::Forwardable
+
+    class UnsupportedRailsVersionError < StandardError; end
+    class MustImplementError < StandardError; end
 
     class << self
+      def version_matches?(version_string, compatibility_string = current_version::STRING)
+        requirement = Gem::Requirement.new(compatibility_string)
+        requirement.satisfied_by?(Gem::Version.new(version_string))
+      end
+
       def current_version
         ActiveRecord::VERSION
       end
@@ -14,10 +24,14 @@ module Departure
       end
 
       def for(ar_version)
-        if ar_version::MAJOR >= 7 && ar_version::MINOR >= 2
+        if ar_version::MAJOR == 8 && ar_version::MINOR.positive?
+          V8_1_Adapter
+        elsif ar_version::MAJOR == 8
+          V8_0_Adapter
+        elsif ar_version::MAJOR >= 7 && ar_version::MINOR >= 2
           V7_2_Adapter
         else
-          BaseAdapter
+          raise UnsupportedRailsVersionError, "Unsupported Rails version: #{ar_version}"
         end
       end
     end
@@ -25,59 +39,92 @@ module Departure
     class BaseAdapter
       class << self
         def register_integrations
-          require 'active_record/connection_adapters/percona_adapter'
+          raise MustImplementError, 'adapter must implement register_integrations'
+        end
+
+        # ActiveRecord::ConnectionAdapters::Mysql2Adapter
+        def create_connection_adapter(**_config)
+          raise MustImplementError, 'adapter must implement create_connection_adapter'
+        end
+
+        # https://github.com/rails/rails/commit/9ad36e067222478090b36a985090475bb03e398c#diff-de807ece2205a84c0e3de66b0e5ab831325d567893b8b88ce0d6e9d498f923d1
+        # Rails Column arity changed to require cast_type in position 2 which required us introducing this indirection
+        def new_sql_column(name:,
+                           default_value:,
+                           mysql_metadata:,
+                           null_value:,
+                           **_kwargs)
+          sql_column.new(name, default_value, mysql_metadata, null_value)
+        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
 
-            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
+
+          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
 
-              ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
+        def sql_column
+          ::ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter::Column
+        end
+      end
+    end
+
+    class V8_0_Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
+      class << self
+        def register_integrations
+          require 'active_record/connection_adapters/rails_8_0_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::Rails80DepartureAdapter',
+                                                    'active_record/connection_adapters/rails_8_0_departure_adapter'
         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
-          )
+          ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter.new(config)
         end
 
         def sql_column
-          ::ActiveRecord::ConnectionAdapters::DepartureAdapter::Column
+          ::ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter::Column
         end
       end
     end
 
-    class V7_2_Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
+    class V8_1_Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
       class << self
         def register_integrations
-          require 'active_record/connection_adapters/rails_7_2_departure_adapter'
+          require 'active_record/connection_adapters/rails_8_1_departure_adapter'
           require 'departure/rails_patches/active_record_migrator_with_advisory_lock_patch'
 
           ActiveSupport.on_load(:active_record) do
@@ -89,16 +136,29 @@ module Departure
           end
 
           ActiveRecord::ConnectionAdapters.register 'percona',
-                                                    'ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter',
-                                                    'active_record/connection_adapters/rails_7_2_departure_adapter'
+                                                    'ActiveRecord::ConnectionAdapters::Rails81DepartureAdapter',
+                                                    'active_record/connection_adapters/rails_8_1_departure_adapter'
         end
 
         def create_connection_adapter(**config)
-          ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter.new(config)
+          ActiveRecord::ConnectionAdapters::Rails81DepartureAdapter.new(config)
+        end
+
+        # rubocop:disable Metrics/ParameterLists
+        # https://github.com/rails/rails/commit/9ad36e067222478090b36a985090475bb03e398c#diff-de807ece2205a84c0e3de66b0e5ab831325d567893b8b88ce0d6e9d498f923d1
+        # Rails Column arity changed to require cast_type in position 2 which required us introducing this indirection
+        def new_sql_column(name:,
+                           cast_type:,
+                           default_value:,
+                           mysql_metadata:,
+                           null_value:,
+                           **_kwargs)
+          # rubocop:enable Metrics/ParameterLists
+          sql_column.new(name, cast_type, default_value, mysql_metadata, null_value)
         end
 
         def sql_column
-          ::ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter::Column
+          ::ActiveRecord::ConnectionAdapters::MySQL::Column
         end
       end
     end

data/lib/departure/rails_patches/active_record_migrator_with_advisory_lock_patch.rb

@@ -11,13 +11,13 @@ module Departure
         @__original_connection = connection
 
         got_lock = @__original_connection.get_advisory_lock(lock_id)
-        raise ConcurrentMigrationError unless got_lock
+        raise ActiveRecord::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
+          raise ActiveRecord::ConcurrentMigrationError, RELEASE_LOCK_FAILED_MESSAGE
         end
       end
     end

data/lib/departure/runner.rb

@@ -1,10 +1,15 @@
 require 'open3'
+require 'forwardable'
+
+# Runner is deprecated and used in rails 8.0 and below
+# We will slowly reduce the responsibility of departure to be delegating
+# all calls to underlying adapters/connections
 
 module Departure
   # It executes pt-online-schema-change commands in a new process and gets its
   # output and status
   class Runner
-    extend Forwardable
+    extend ::Forwardable
 
     def_delegators :raw_connection, :execute, :escape, :close, :affected_rows
 
@@ -22,6 +27,14 @@ module Departure
       @redirect_stderr = config&.redirect_stderr
     end
 
+    def query_options
+      raw_connection.query_options
+    end
+
+    def abandon_results!
+      raw_connection.abandon_results!
+    end
+
     def database_adapter
       @mysql_adapter
     end

data/lib/departure/version.rb

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

data/lib/departure.rb

@@ -5,6 +5,7 @@ require 'active_record/connection_adapters/for_alter'
 
 require 'departure/version'
 require 'departure/log_sanitizers/password_sanitizer'
+require 'departure/db_client'
 require 'departure/runner'
 require 'departure/cli_generator'
 require 'departure/logger'

data/lib/lhm/column_with_sql.rb

@@ -52,11 +52,12 @@ module Lhm
         limit: cast_type.limit
       )
       mysql_metadata = ActiveRecord::ConnectionAdapters::MySQL::TypeMetadata.new(metadata)
-      @column ||= Departure::RailsAdapter.for_current.sql_column.new(
-        name,
-        default_value,
-        mysql_metadata,
-        null_value
+      @column ||= Departure::RailsAdapter.for_current.new_sql_column(
+        name:,
+        cast_type:,
+        default_value:,
+        mysql_metadata:,
+        null_value:
       )
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: departure
 version: !ruby/object:Gem::Version
-  version: 6.8.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Ilya Zayats
@@ -12,10 +12,9 @@ authors:
 - Adrian Serafin
 - Kirk Haines
 - Guillermo Iguaran
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -23,52 +22,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.3.0
+        version: 7.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.3.0
+        version: 7.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.3.0
+        version: 7.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.3.0
+        version: 7.2.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -95,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -218,18 +193,17 @@ files:
 - 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
+- gemfiles/rails_8_0.gemfile
+- gemfiles/rails_8_0.gemfile.lock
+- gemfiles/rails_8_1.gemfile
+- gemfiles/rails_8_1.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/active_record/connection_adapters/rails_8_0_departure_adapter.rb
+- lib/active_record/connection_adapters/rails_8_1_departure_adapter.rb
 - lib/departure.rb
 - lib/departure/alter_argument.rb
 - lib/departure/cli_generator.rb
@@ -237,6 +211,7 @@ files:
 - lib/departure/configuration.rb
 - lib/departure/connection_base.rb
 - lib/departure/connection_details.rb
+- lib/departure/db_client.rb
 - lib/departure/dsn.rb
 - lib/departure/errors.rb
 - lib/departure/log_sanitizers/password_sanitizer.rb
@@ -260,7 +235,6 @@ homepage: https://github.com/departurerb/departure
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -268,15 +242,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: pt-online-schema-change runner for ActiveRecord migrations
 test_files: []

data/gemfiles/rails_6_1.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source 'https://rubygems.org'
-
-gem 'codeclimate-test-reporter', '~> 1.0.3', group: :test, require: nil
-gem 'rails', '6.1.7.6'
-gem 'rubocop', '~> 1.60.2', require: false
-gem 'rubocop-performance', '~> 1.20.2', require: false
-
-gemspec path: '../'