Trilogy adapter support in Rails 8.1

.github/workflows/test.yml

@@ -3,7 +3,7 @@ name: Test
 on: [push, pull_request]
 
 jobs:
-  test:
+  test_mysql:
     strategy:
       fail-fast: false
       matrix:
@@ -36,6 +36,43 @@ jobs:
         run: sudo systemctl start mysql.service
       - run: bin/setup
       - run: bundle exec rake
+
+  test_trilogy:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.2
+          - 3.3
+          - 3.4
+        gemfile:
+          - gemfiles/rails_8_1.gemfile
+    env:
+      DB_ADAPTER: "trilogy"
+      PERCONA_DB_USER: root
+      PERCONA_DB_PASSWORD: root
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: "Add Percona GPG key"
+        run: sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 9334A25F8507EFA5
+      - name: "Add Percona APT repository"
+        run: echo "deb http://repo.percona.com/apt `lsb_release -cs` main" | sudo tee -a /etc/apt/sources.list
+      - run: sudo apt-get update -qq
+      - run: sudo apt-get install percona-toolkit
+      - name: Start MySQL server
+        run: sudo systemctl start mysql.service
+      - name: Configure MySQL for Trilogy
+        run: |
+          sudo mysql -u root -proot -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'root'; FLUSH PRIVILEGES;"
+      - run: bin/setup
+      - run: bundle exec rake
+
   lint:
     strategy:
       fail-fast: false

.rubocop.yml

@@ -28,6 +28,8 @@ Layout/LineLength:
   Exclude:
     - 'departure.gemspec'
     - 'test_database.rb'
+    - 'spec/*'
+    - 'spec/**/*'
 
 Metrics/MethodLength:
   Max: 30

Appraisals

@@ -10,4 +10,5 @@ end
 
 appraise 'rails-8-1' do
   gem 'rails', '8.1.1'
+  gem 'trilogy'
 end

README.md

@@ -151,9 +151,16 @@ It's strongly recommended to name it after this gems name, such as
 
 All configuration options are configurable from the `Departure.configure` block example below
 
-|Option|Default|What it Controls|
-|---|---|---|
-|disable_rails_advisory_lock_patch|false|When truthy, disables a patch in at least rails 7.1 and 7.2 where rails throws ConcurrentMigrationErrors due to the inability to release the advisory lock in migrations|
+| Option                            | Default | What it Controls                                                                                                                                                          |
+|-----------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| disable_rails_advisory_lock_patch | false   | When truthy, disables a patch in at least rails 7.1 and 7.2 where rails throws ConcurrentMigrationErrors due to the inability to release the advisory lock in migrations  |
+
+### Trilogy Adapter Support
+
+Starting in Rails 8.1 we add support for the use of the trilogy database adapter gem.  Logic for selecting an adapter follows this logic
+
+1. If the database configuration specifies 'trilogy' use the trilogy adapter
+2. Default to mysql2
 
 ### Disable on per-migration basis
 
@@ -226,7 +233,7 @@ adapters.
       %% Core Departure Components
       subgraph "Departure System"
           RailsAdapter["RailsAdapter<br/>(Version Detection)"]
-          DepartureAdapter["Rails81DepartureAdapter<br/>(Connection Adapter)"]
+          DepartureAdapter["Rails81MysqlAdapter<br/>(Connection Adapter)"]
           Runner["Runner<br/>(Query Interceptor)"]
           Command["Command<br/>(Process Executor)"]
           CliGenerator["CliGenerator<br/>(Command Builder)"]

gemfiles/rails_7_2.gemfile

@@ -1,16 +1,16 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "base64"
-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 "bigdecimal"
-gem "rails", "7.2.2.1"
+gem 'base64'
+gem 'bigdecimal'
+gem 'codeclimate-test-reporter', '~> 1.0.3', group: :test, require: nil
+gem 'lhm'
+gem 'logger'
+gem 'mutex_m', require: false
+gem 'rails', '7.2.2.1'
+gem 'rubocop', '~> 1.74.0', require: false
+gem 'rubocop-performance', '~> 1.20.2', require: false
+gem 'zeitwerk', '< 2.7.0'
 
-gemspec path: "../"
+gemspec path: '../'

gemfiles/rails_8_0.gemfile

@@ -1,16 +1,16 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "base64"
-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 "bigdecimal"
-gem "rails", "8.0.2.1"
+gem 'base64'
+gem 'bigdecimal'
+gem 'codeclimate-test-reporter', '~> 1.0.3', group: :test, require: nil
+gem 'lhm'
+gem 'logger'
+gem 'mutex_m', require: false
+gem 'rails', '8.0.2.1'
+gem 'rubocop', '~> 1.74.0', require: false
+gem 'rubocop-performance', '~> 1.20.2', require: false
+gem 'zeitwerk', '< 2.7.0'
 
-gemspec path: "../"
+gemspec path: '../'

gemfiles/rails_8_1.gemfile

@@ -1,15 +1,16 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "base64"
-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 'base64'
+gem 'codeclimate-test-reporter', '~> 1.0.3', group: :test, require: nil
+gem 'lhm'
+gem 'logger'
+gem 'mutex_m', require: false
+gem 'rails', '8.1.1'
+gem 'rubocop', '~> 1.74.0', require: false
+gem 'rubocop-performance', '~> 1.20.2', require: false
+gem 'trilogy'
+gem 'zeitwerk', '< 2.7.0'
 
-gemspec path: "../"
+gemspec path: '../'

gemfiles/rails_8_1.gemfile.lock

@@ -270,6 +270,7 @@ GEM
     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)
@@ -310,6 +311,7 @@ DEPENDENCIES
   rspec-its (~> 1.2)
   rubocop (~> 1.74.0)
   rubocop-performance (~> 1.20.2)
+  trilogy
   zeitwerk (< 2.7.0)
 
 BUNDLED WITH

lib/active_record/connection_adapters/rails_8_1_departure_adapter.rb → lib/active_record/connection_adapters/rails_8_1_mysql2_adapter.rb

@@ -6,12 +6,12 @@
 
 module ActiveRecord
   module ConnectionAdapters
-    class Rails81DepartureAdapter < ActiveRecord::ConnectionAdapters::Mysql2Adapter
+    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
-          Rails81DepartureAdapter
+          Rails81Mysql2Adapter
         end
       end
 
@@ -33,8 +33,6 @@ def visit_DropForeignKey(name) # rubocop:disable Naming/MethodName
         end
       end
 
-      extend Forwardable
-
       include ForAlterStatements unless method_defined?(:change_column_for_alter)
 
       ADAPTER_NAME = 'Percona'.freeze

lib/active_record/connection_adapters/rails_8_1_trilogy_adapter.rb

@@ -0,0 +1,77 @@
+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 'forwardable'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Rails81TrilogyAdapter < ActiveRecord::ConnectionAdapters::TrilogyAdapter
+      class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
+        def adapter
+          Rails81TrilogyAdapter
+        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
+
+      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
+
+      # 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

lib/departure.rb

@@ -23,8 +23,6 @@
 # We need the OS not to buffer the IO to see pt-osc's output while migrating
 $stdout.sync = true
 
-Departure::RailsAdapter.for_current.register_integrations
-
 module Departure
   class << self
     attr_accessor :configuration

lib/departure/configuration.rb

@@ -1,14 +1,15 @@
 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, :db_adapter_name
 
     def initialize
       @tmp_path = '.'.freeze
       @error_log_filename = 'departure_error.log'.freeze
       @global_percona_args = nil
       @enabled_by_default = true
       @redirect_stderr = true
+      @db_adapter_name = nil
     end
 
     def error_log_path