departure 8.0.0 → 8.2.0

data/gemfiles/rails_8_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    departure (8.0.0)
+    departure (8.2.0)
       activerecord (>= 7.2.0)
       mysql2 (>= 0.4.0, < 0.6.0)
       railties (>= 7.2.0)
@@ -167,7 +167,7 @@ GEM
     pp (0.6.3)
       prettyprint
     prettyprint (0.2.0)
-    prism (1.6.0)
+    prism (1.9.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -240,7 +240,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
-    rubocop (1.74.0)
+    rubocop (1.84.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -248,15 +248,16 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.47.1)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     simplecov (0.13.0)
@@ -264,9 +265,25 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    standard (1.54.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.84.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    standardrb (1.0.1)
+      standard
     stringio (3.1.7)
     thor (1.4.0)
     timeout (0.4.4)
+    trilogy (2.12.6)
+      bigdecimal
     tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -306,8 +323,8 @@ DEPENDENCIES
   rake (>= 10.0)
   rspec (~> 3.4, >= 3.4.0)
   rspec-its (~> 1.2)
-  rubocop (~> 1.74.0)
-  rubocop-performance (~> 1.20.2)
+  standardrb
+  trilogy
   zeitwerk (< 2.7.0)
 
 BUNDLED WITH

data/gemfiles/rails_8_1.gemfile

@@ -7,9 +7,9 @@ gem "codeclimate-test-reporter", "~> 1.0.3", group: :test, require: nil
 gem "lhm"
 gem "logger"
 gem "mutex_m", require: false
-gem "rubocop", "~> 1.74.0", require: false
-gem "rubocop-performance", "~> 1.20.2", require: false
-gem "zeitwerk", "< 2.7.0"
 gem "rails", "8.1.1"
+gem "standardrb", require: false
+gem "trilogy"
+gem "zeitwerk", "< 2.7.0"
 
 gemspec path: "../"

data/gemfiles/rails_8_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    departure (8.0.0)
+    departure (8.2.0)
       activerecord (>= 7.2.0)
       mysql2 (>= 0.4.0, < 0.6.0)
       railties (>= 7.2.0)
@@ -169,7 +169,7 @@ GEM
     pp (0.6.3)
       prettyprint
     prettyprint (0.2.0)
-    prism (1.6.0)
+    prism (1.9.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -243,7 +243,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
-    rubocop (1.74.0)
+    rubocop (1.84.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -251,15 +251,16 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.47.1)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     simplecov (0.13.0)
@@ -267,9 +268,24 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    standard (1.54.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.84.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    standardrb (1.0.1)
+      standard
     stringio (3.1.7)
     thor (1.4.0)
     timeout (0.4.4)
+    trilogy (2.9.0)
     tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -308,8 +324,8 @@ DEPENDENCIES
   rake (>= 10.0)
   rspec (~> 3.4, >= 3.4.0)
   rspec-its (~> 1.2)
-  rubocop (~> 1.74.0)
-  rubocop-performance (~> 1.20.2)
+  standardrb
+  trilogy
   zeitwerk (< 2.7.0)
 
 BUNDLED WITH

data/lib/active_record/connection_adapters/departure_adapter_behavior.rb

@@ -0,0 +1,88 @@
+module ActiveRecord
+  module ConnectionAdapters
+    # Behavior shared between the per-Rails-version Departure adapters.
+    # Adapters compose the pieces they need:
+    #
+    # - SchemaStatements: ALTER TABLE-friendly schema statements, so every DDL
+    #   change goes through a statement pt-online-schema-change understands.
+    # - DbClientConnection: wraps the raw database client in a
+    #   Departure::DbClient, which routes ALTER TABLE statements to
+    #   pt-online-schema-change.
+    # - PerformQuery: intercepts ALTER TABLE statements through the
+    #   perform_query hook available on Rails >= 8.0.
+    # - Rails8: the composition used by Rails >= 8.0 adapters.
+    module DepartureAdapterBehavior
+      module SchemaStatements
+        class SchemaCreation < ActiveRecord::ConnectionAdapters::MySQL::SchemaCreation
+          def visit_DropForeignKey(name) # standard:disable Naming/MethodName
+            fk_name =
+              if name =~ /^__(.+)/
+                Regexp.last_match(1)
+              else
+                "_#{name}"
+              end
+
+            "DROP FOREIGN KEY #{fk_name}"
+          end
+        end
+
+        def self.included(adapter_class)
+          adapter_class.const_set(:SchemaCreation, SchemaCreation)
+          adapter_class.include ForAlterStatements unless adapter_class.method_defined?(:change_column_for_alter)
+        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
+          self.class::SchemaCreation.new(self)
+        end
+      end
+
+      # Meant to be used with `extend`, so new_client can call super up to the
+      # underlying adapter's implementation.
+      module DbClientConnection
+        def new_client(config)
+          original_client = super
+
+          Departure::DbClient.new(config, original_client)
+        end
+      end
+
+      module PerformQuery
+        private
+
+        # 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
+
+      module Rails8
+        def self.included(adapter_class)
+          adapter_class.include SchemaStatements
+          adapter_class.extend DbClientConnection
+          adapter_class.include PerformQuery
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/for_alter.rb

@@ -1,12 +1,6 @@
-require 'active_record/connection_adapters/mysql/schema_statements'
+require "active_record/connection_adapters/mysql/schema_statements"
 
 module ForAlterStatements
-  class << self
-    def included(_)
-      STDERR.puts 'Including for_alter statements'
-    end
-  end
-
   def bulk_change_table(table_name, operations) #:nodoc:
     sqls = operations.flat_map do |command, args|
       table = args.shift
@@ -16,7 +10,7 @@ module ForAlterStatements
 
       raise "Unknown method called : #{method}(#{arguments.inspect})" unless respond_to?(method, true)
       public_send(method, table, *arguments)
-    end.join(', ')
+    end.join(", ")
 
     execute("ALTER TABLE #{quote_table_name(table_name)} #{sqls}")
   end
@@ -37,7 +31,7 @@ module ForAlterStatements
   end
 
   def rename_column_for_alter(table_name, column_name, new_column_name)
-    column  = column_for(table_name, column_name)
+    column = column_for(table_name, column_name)
     options = {
       default: column.default,
       null: column.null,
@@ -45,7 +39,7 @@ module ForAlterStatements
     }
 
     columns_sql = "SHOW COLUMNS FROM #{quote_table_name(table_name)} LIKE #{quote(column_name)}"
-    current_type = exec_query(columns_sql, 'SCHEMA').first['Type']
+    current_type = exec_query(columns_sql, "SCHEMA").first["Type"]
     td = create_table_definition(table_name)
     cd = td.new_column_definition(new_column_name, current_type, **options)
     schema_creation.accept(ActiveRecord::ConnectionAdapters::ChangeColumnDefinition.new(cd, column.name))

data/lib/active_record/connection_adapters/patch_connection_handling.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require 'active_record/connection_handling'
+require "active_record/connection_handling"
 
 module ActiveRecord
   module ConnectionHandling
     # Establishes a connection to the database that's used by all Active
     # Record objects.
     def percona_connection(config)
-      if config[:username].nil?
-        config = config.dup if config.frozen?
-        config[:username] = 'root'
-      end
+      config = config.dup
+      original_adapter = config.delete(:departure_original_adapter)
+      config[:username] ||= "root"
 
-      Departure::RailsAdapter.for_current.create_connection_adapter(**config)
+      Departure::RailsAdapter
+        .for_current(db_connection_adapter: original_adapter)
+        .create_connection_adapter(**config)
     end
   end
 end

data/lib/active_record/connection_adapters/rails_7_2_departure_adapter.rb

@@ -1,10 +1,11 @@
-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'
+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"
+require "active_record/connection_adapters/departure_adapter_behavior"
 
 module ActiveRecord
   module ConnectionAdapters
@@ -17,24 +18,11 @@ module ActiveRecord
         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)
+      include DepartureAdapterBehavior::SchemaStatements
 
-      ADAPTER_NAME = 'Percona'.freeze
+      ADAPTER_NAME = "Percona".freeze
 
       def self.new_client(config)
         connection_details = Departure::ConnectionDetails.new(config)
@@ -45,7 +33,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,
@@ -60,7 +48,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
@@ -79,18 +67,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/Metrics/ParameterLists
+      def exec_insert(sql, name, binds, pky = nil, sequence_name = nil, returning: nil) # standard:disable Lint/UnusedMethodArgument
         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.
@@ -114,35 +102,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)
@@ -153,7 +112,7 @@ module ActiveRecord
         get_full_version
       end
 
-      def get_full_version # rubocop:disable Style/AccessorMethodName
+      def get_full_version # standard:disable Naming/AccessorMethodName
         return @get_full_version if defined? @get_full_version
 
         with_raw_connection do |conn|

data/lib/active_record/connection_adapters/rails_7_2_trilogy_adapter.rb

@@ -0,0 +1,53 @@
+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 Rails72TrilogyAdapter < ActiveRecord::ConnectionAdapters::TrilogyAdapter
+      class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
+        def adapter
+          Rails72TrilogyAdapter
+        end
+      end
+
+      ADAPTER_NAME = "Percona".freeze
+
+      include DepartureAdapterBehavior::SchemaStatements
+      extend DepartureAdapterBehavior::DbClientConnection
+
+      def new_column(...)
+        Column.new(...)
+      end
+
+      private
+
+      # Rails 7.2 has no perform_query hook, so the interception happens here:
+      # the DbClient wrapper routes ALTER TABLE statements to
+      # pt-online-schema-change, which yields a Process::Status instead of a
+      # Trilogy::Result.
+      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)
+            while conn.more_results_exist?
+              conn.next_result
+            end
+            verified!
+            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?(:count)
+              notification_payload[:row_count] = result.count
+            end
+            result
+          end
+        end
+      end
+    end
+  end
+end