departure 4.0.1 → 6.3.0

data/lib/departure/command.rb

@@ -44,10 +44,10 @@ module Departure
         begin
           loop do
             IO.select([stdout])
-            data = stdout.read_nonblock(8)
+            data = stdout.read_nonblock(8192)
             logger.write_no_newline(data)
           end
-        rescue EOFError
+        rescue EOFError # rubocop:disable Lint/HandleExceptions
           # noop
         ensure
           @status = waith_thr.value
@@ -69,7 +69,7 @@ module Departure
     # @raise [SignalError] if the spawned process received a signal
     # @raise [CommandNotFoundError] if pt-online-schema-change can't be found
     def validate_status!
-      raise SignalError.new(status) if status.signaled?
+      raise SignalError.new(status) if status.signaled? # rubocop:disable Style/RaiseArgs
       raise CommandNotFoundError if status.exitstatus == COMMAND_NOT_FOUND
       raise Error, error_message unless status.success?
     end

data/lib/departure/configuration.rb

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

data/lib/departure/connection_base.rb

@@ -0,0 +1,9 @@
+module Departure
+  class ConnectionBase < ActiveRecord::Base
+    def self.establish_connection(config = nil)
+      super.tap do
+        ActiveRecord::Base.connection_specification_name = connection_specification_name
+      end
+    end
+  end
+end

data/lib/departure/connection_details.rb

@@ -1,7 +1,8 @@
+require 'shellwords'
 module Departure
   # Holds the parameters of the DB connection and formats them to string
   class ConnectionDetails
-
+    DEFAULT_PORT = 3306
     # Constructor
     #
     # @param [Hash] connection parametes as used in #establish_conneciton
@@ -14,7 +15,7 @@ module Departure
     #
     # @return [String]
     def to_s
-      @to_s ||= "-h #{host} -u #{user} #{password_argument}"
+      @to_s ||= "#{host_argument} -P #{port} -u #{user} #{password_argument}"
     end
 
     # TODO: Doesn't the abstract adapter already handle this somehow?
@@ -33,12 +34,23 @@ module Departure
     # @return [String]
     def password_argument
       if password.present?
-        "-p #{password}"
+        %(--password #{Shellwords.escape(password)} )
       else
         ''
       end
     end
 
+    # Returns the host fragment of the details string, adds ssl options if needed
+    #
+    # @return [String]
+    def host_argument
+      host_string = host
+      if ssl_ca.present?
+        host_string += ";mysql_ssl=1;mysql_ssl_client_ca=#{ssl_ca}"
+      end
+      "-h \"#{host_string}\""
+    end
+
     private
 
     attr_reader :connection_data
@@ -66,5 +78,19 @@ module Departure
     def password
       ENV.fetch('PERCONA_DB_PASSWORD', connection_data[:password])
     end
+
+    # Returns the database's port.
+    #
+    # @return [String]
+    def port
+      connection_data.fetch(:port, DEFAULT_PORT)
+    end
+
+    # Returns the database' SSL CA certificate.
+    #
+    # @return [String]
+    def ssl_ca
+      connection_data.fetch(:sslca, nil)
+    end
   end
 end

data/lib/departure/dsn.rb

@@ -1,9 +1,7 @@
 module Departure
-
   # Represents the 'DSN' argument of Percona's pt-online-schema-change
   # See https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html#dsn-options
   class DSN
-
     # Constructor
     #
     # @param database [String, Symbol]

data/lib/departure/log_sanitizers/password_sanitizer.rb

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

data/lib/departure/logger.rb

@@ -4,7 +4,6 @@ module Departure
   # the from ActiveRecord::Migration because the migration's instance can't be
   # seen from the connection adapter.
   class Logger
-
     def initialize(sanitizers)
       @sanitizers = sanitizers
     end
@@ -15,7 +14,7 @@ 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

data/lib/departure/logger_factory.rb

@@ -1,6 +1,5 @@
 module Departure
   module LoggerFactory
-
     # Returns the appropriate logger instance for the given configuration. Use
     # :verbose option to log to the stdout
     #

data/lib/departure/migration.rb

@@ -0,0 +1,104 @@
+module Departure
+  # Hooks Departure into Rails migrations by replacing the configured database
+  # adapter.
+  #
+  # It also patches ActiveRecord's #migrate method so that it patches LHM
+  # first. This will make migrations written with LHM to go through the
+  # regular Rails Migration DSL.
+  module Migration
+    extend ActiveSupport::Concern
+
+    included do
+      # Holds the name of the adapter that was configured by the app.
+      mattr_accessor :original_adapter
+
+      # Declare on a per-migration class basis whether or not to use Departure.
+      # The default for this attribute is set based on
+      # Departure.configuration.enabled_by_default (default true).
+      class_attribute :uses_departure
+      self.uses_departure = true
+
+      alias_method :active_record_migrate, :migrate
+      remove_method :migrate
+    end
+
+    module ClassMethods
+      # Declare `uses_departure!` in the class body of your migration to enable
+      # Departure for that migration only when
+      # Departure.configuration.enabled_by_default is false.
+      def uses_departure!
+        self.uses_departure = true
+      end
+
+      # Declare `disable_departure!` in the class body of your migration to
+      # disable Departure for that migration only (when
+      # Departure.configuration.enabled_by_default is true, the default).
+      def disable_departure!
+        self.uses_departure = false
+      end
+    end
+
+    # Replaces the current connection adapter with the PerconaAdapter and
+    # patches LHM, then it continues with the regular migration process.
+    #
+    # @param direction [Symbol] :up or :down
+    def departure_migrate(direction)
+      reconnect_with_percona
+      include_foreigner if defined?(Foreigner)
+
+      ::Lhm.migration = self
+      active_record_migrate(direction)
+    end
+
+    # 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)
+      end
+    end
+
+    # Includes the Foreigner's Mysql2Adapter implemention in
+    # DepartureAdapter to support foreign keys
+    def include_foreigner
+      Foreigner::Adapter.safe_include(
+        :DepartureAdapter,
+        Foreigner::ConnectionAdapters::Mysql2Adapter
+      )
+    end
+
+    # 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'))
+    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::ConnectionBase.establish_connection(connection_config.merge(adapter: original_adapter))
+    end
+
+    private
+
+    # 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]
+      end
+    end
+
+    private def configuration_hash
+      if ActiveRecord::VERSION::STRING >= '6.1'
+        ActiveRecord::Base.connection_db_config.configuration_hash
+      else
+        ActiveRecord::Base.connection_config
+      end
+    end
+  end
+end

data/lib/departure/option.rb

@@ -24,10 +24,10 @@ module Departure
     #
     # @param [Option]
     # @return [Boolean]
-    def ==(another_option)
-      name == another_option.name
+    def ==(other)
+      name == other.name
     end
-    alias :eql? :==
+    alias eql? ==
 
     # Returns the option's hash
     #
@@ -65,7 +65,7 @@ module Departure
     def value_as_string
       if value.nil?
         ''
-      elsif value.include?("=")
+      elsif value.include?('=')
         " #{value}"
       else
         "=#{value}"

data/lib/departure/railtie.rb

@@ -6,23 +6,16 @@ module Departure
   class Railtie < Rails::Railtie
     railtie_name :departure
 
-    # It drops all previous database connections and reconnects using this
-    # PerconaAdapter. By doing this, all later ActiveRecord methods called in
-    # the migration will use this adapter instead of Mysql2Adapter.
-    #
-    # It also patches ActiveRecord's #migrate method so that it patches LHM
-    # first. This will make migrations written with LHM to go through the
-    # regular Rails Migration DSL.
-    initializer 'departure.configure_rails_initialization' do
-      ActiveSupport.on_load(:active_record) do
-        Departure.load
-      end
-    end
-
     initializer 'departure.configure' do |app|
       Departure.configure do |config|
         config.tmp_path = app.paths['tmp'].first
       end
     end
+
+    config.after_initialize do
+      Departure.configure do |dc|
+        ActiveRecord::Migration.uses_departure = dc.enabled_by_default
+      end
+    end
   end
 end

data/lib/departure/runner.rb

@@ -1,11 +1,9 @@
 require 'open3'
 
 module Departure
-
   # It executes pt-online-schema-change commands in a new process and gets its
   # output and status
   class Runner
-
     # Constructor
     #
     # @param logger [#say, #write]

data/lib/departure/version.rb

@@ -1,3 +1,3 @@
 module Departure
-  VERSION = '4.0.1'.freeze
+  VERSION = '6.3.0'.freeze
 end

data/lib/lhm.rb

@@ -4,14 +4,13 @@ require 'lhm/adapter'
 # while providing a different behaviour. We delegate all LHM's methods to
 # ActiveRecord so that you don't need to modify your old LHM migrations
 module Lhm
-
   # Yields an adapter instance so that Lhm migration Dsl methods get
   # delegated to ActiveRecord::Migration ones instead
   #
   # @param table_name [String]
   # @param _options [Hash]
   # @param block [Block]
-  def self.change_table(table_name, _options = {}, &block)
+  def self.change_table(table_name, _options = {}, &block) # rubocop:disable Lint/UnusedMethodArgument
     yield Adapter.new(@migration, table_name)
   end
 
@@ -22,4 +21,3 @@ module Lhm
     @migration = migration
   end
 end
-

data/lib/lhm/adapter.rb

@@ -2,12 +2,10 @@ require 'lhm/column_with_sql'
 require 'lhm/column_with_type'
 
 module Lhm
-
   # Translates Lhm DSL to ActiveRecord's one, so Lhm migrations will now go
   # through Percona as well, without any modification on the migration's
   # code
   class Adapter
-
     # Constructor
     #
     # @param migration [ActiveRecord::Migtration]
@@ -79,7 +77,7 @@ module Lhm
     # @param index_name [String]
     def add_unique_index(columns, index_name = nil)
       options = { unique: true }
-      options.merge!(name: index_name) if index_name
+      options.merge!(name: index_name) if index_name # rubocop:disable Performance/RedundantMerge
 
       migration.add_index(table_name, columns, options)
     end

data/lib/lhm/column_with_sql.rb

@@ -1,7 +1,6 @@
 require 'forwardable'
 
 module Lhm
-
   # Abstracts the details of a table column definition when specified with a MySQL
   # column definition string
   class ColumnWithSql
@@ -53,12 +52,17 @@ module Lhm
     #
     # @return [column_factory]
     def column
-      cast_type = ActiveRecord::Base.connection.lookup_cast_type(definition)
+      cast_type = ActiveRecord::Base.connection.send(:lookup_cast_type, definition)
+      metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(
+        type: cast_type.type,
+        sql_type: definition,
+        limit: cast_type.limit
+      )
+      mysql_metadata = ActiveRecord::ConnectionAdapters::MySQL::TypeMetadata.new(metadata)
       @column ||= self.class.column_factory.new(
         name,
         default_value,
-        cast_type,
-        definition,
+        mysql_metadata,
         null_value
       )
     end

data/lib/lhm/column_with_type.rb

@@ -1,12 +1,10 @@
 module Lhm
-
   # Abstracts the details of a table column definition when specified with a type
   # as a symbol. This is the regular ActiveRecord's #add_column syntax:
   #
   #   add_column :tablenames, :field, :string
   #
   class ColumnWithType
-
     # Constructor
     #
     # @param name [String, Symbol]

data/test_database.rb

@@ -1,9 +1,11 @@
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+
 # Setups the test database with the schema_migrations table that ActiveRecord
 # requires for the migrations, plus a table for the Comment model used throught
 # the tests.
 #
 class TestDatabase
-
   # Constructor
   #
   # @param config [Hash]
@@ -19,7 +21,7 @@ class TestDatabase
     drop_and_create_schema_migrations_table
   end
 
-  # Creates the #{database} database and the comments table in it.
+  # Creates the #{@database} database and the comments table in it.
   # Before, it drops both if they already exist
   def setup_test_database
     drop_and_create_test_database
@@ -29,7 +31,13 @@ class TestDatabase
   # Creates the ActiveRecord's schema_migrations table required for
   # migrations to work. Before, it drops the table if it already exists
   def drop_and_create_schema_migrations_table
-    %x(#{mysql_command} "USE #{database}; DROP TABLE IF EXISTS schema_migrations; CREATE TABLE schema_migrations ( version varchar(255) COLLATE utf8_unicode_ci NOT NULL, UNIQUE KEY unique_schema_migrations (version)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci")
+    sql = [
+      "USE #{@database}",
+      'DROP TABLE IF EXISTS schema_migrations',
+      'CREATE TABLE schema_migrations ( version varchar(255) COLLATE utf8_unicode_ci NOT NULL, UNIQUE KEY unique_schema_migrations (version)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci'
+    ]
+
+    run_commands(sql)
   end
 
   private
@@ -37,16 +45,36 @@ class TestDatabase
   attr_reader :config, :database
 
   def drop_and_create_test_database
-    %x(#{mysql_command} "DROP DATABASE IF EXISTS #{database}; CREATE DATABASE #{database} DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci;")
+    sql = [
+      "DROP DATABASE IF EXISTS #{@database}",
+      "CREATE DATABASE #{@database} DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci"
+    ]
+
+    run_commands(sql)
   end
 
   def drop_and_create_comments_table
-    %x(#{mysql_command} "USE #{database}; DROP TABLE IF EXISTS comments; CREATE TABLE comments ( id int(12) NOT NULL AUTO_INCREMENT, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;")
+    sql = [
+      "USE #{@database}",
+      'DROP TABLE IF EXISTS comments',
+      'CREATE TABLE comments ( id bigint(20) NOT NULL AUTO_INCREMENT, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci'
+    ]
+
+    run_commands(sql)
+  end
+
+  def run_commands(sql)
+    conn.execute('START TRANSACTION')
+    sql.each { |str| conn.execute(str) }
+    conn.execute('COMMIT')
   end
 
-  # Returns the command to run the mysql client. It uses the crendentials from
-  # the provided config
-  def mysql_command
-    "mysql --user=#{config['username']} --password=#{config['password']} -e"
+  def conn
+    @conn ||= ActiveRecord::Base.mysql2_connection(
+      host: @config['hostname'],
+      username: @config['username'],
+      password: @config['password'],
+      reconnect: true
+    )
   end
 end