departure 6.8.0 → 8.0.0

data/gemfiles/rails_8_1.gemfile.lock

@@ -0,0 +1,316 @@
+PATH
+  remote: ..
+  specs:
+    departure (8.0.0)
+      activerecord (>= 7.2.0)
+      mysql2 (>= 0.4.0, < 0.6.0)
+      railties (>= 7.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    action_text-trix (2.1.15)
+      railties
+    actioncable (8.1.1)
+      actionpack (= 8.1.1)
+      activesupport (= 8.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.1.1)
+      actionpack (= 8.1.1)
+      activejob (= 8.1.1)
+      activerecord (= 8.1.1)
+      activestorage (= 8.1.1)
+      activesupport (= 8.1.1)
+      mail (>= 2.8.0)
+    actionmailer (8.1.1)
+      actionpack (= 8.1.1)
+      actionview (= 8.1.1)
+      activejob (= 8.1.1)
+      activesupport (= 8.1.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.1.1)
+      actionview (= 8.1.1)
+      activesupport (= 8.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.1.1)
+      action_text-trix (~> 2.1.15)
+      actionpack (= 8.1.1)
+      activerecord (= 8.1.1)
+      activestorage (= 8.1.1)
+      activesupport (= 8.1.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.1.1)
+      activesupport (= 8.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.1.1)
+      activesupport (= 8.1.1)
+      globalid (>= 0.3.6)
+    activemodel (8.1.1)
+      activesupport (= 8.1.1)
+    activerecord (8.1.1)
+      activemodel (= 8.1.1)
+      activesupport (= 8.1.1)
+      timeout (>= 0.4.0)
+    activestorage (8.1.1)
+      actionpack (= 8.1.1)
+      activejob (= 8.1.1)
+      activerecord (= 8.1.1)
+      activesupport (= 8.1.1)
+      marcel (~> 1.0)
+    activesupport (8.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    builder (3.3.0)
+    byebug (12.0.0)
+    climate_control (0.0.4)
+      activesupport (>= 3.0)
+    codeclimate-test-reporter (1.0.9)
+      simplecov (<= 0.13)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    crass (1.0.6)
+    date (3.5.0)
+    diff-lcs (1.6.2)
+    docile (1.1.5)
+    drb (2.2.3)
+    erb (5.1.3)
+    erubi (1.13.1)
+    globalid (1.3.0)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.3)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.15.2)
+    language_server-protocol (3.17.0.5)
+    lhm (2.2.0)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.9.0)
+      logger
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.1.0)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.26.0)
+    mutex_m (0.3.0)
+    mysql2 (0.5.7)
+      bigdecimal
+    net-imap (0.5.12)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.5)
+    nokogiri (1.18.10-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.6.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.11.0)
+      byebug (~> 12.0)
+      pry (>= 0.13, < 0.16)
+    psych (5.2.6)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.2.4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.1.1)
+      actioncable (= 8.1.1)
+      actionmailbox (= 8.1.1)
+      actionmailer (= 8.1.1)
+      actionpack (= 8.1.1)
+      actiontext (= 8.1.1)
+      actionview (= 8.1.1)
+      activejob (= 8.1.1)
+      activemodel (= 8.1.1)
+      activerecord (= 8.1.1)
+      activestorage (= 8.1.1)
+      activesupport (= 8.1.1)
+      bundler (>= 1.15.0)
+      railties (= 8.1.1)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.1.1)
+      actionpack (= 8.1.1)
+      activesupport (= 8.1.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    rdoc (6.15.1)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.11.3)
+    reline (0.6.2)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-its (1.3.1)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.74.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.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)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    stringio (3.1.7)
+    thor (1.4.0)
+    timeout (0.4.4)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.1.1)
+    useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  appraisal (~> 2.5.0)
+  base64
+  climate_control (~> 0.0.3)
+  codeclimate-test-reporter (~> 1.0.3)
+  departure!
+  lhm
+  logger
+  mutex_m
+  pry-byebug
+  rails (= 8.1.1)
+  rake (>= 10.0)
+  rspec (~> 3.4, >= 3.4.0)
+  rspec-its (~> 1.2)
+  rubocop (~> 1.74.0)
+  rubocop-performance (~> 1.20.2)
+  zeitwerk (< 2.7.0)
+
+BUNDLED WITH
+   2.6.6

data/lib/active_record/connection_adapters/for_alter.rb

@@ -52,27 +52,14 @@ module ForAlterStatements
   end
 
   def add_index_for_alter(table_name, column_name, options = {})
-    if ActiveRecord::VERSION::STRING >= '6.1'
-      index_definition, = add_index_options(table_name, column_name, **options)
+    index_definition, = add_index_options(table_name, column_name, **options)
 
-      "ADD #{schema_creation.accept(index_definition)}"
-    else
-      index_name, index_type, index_columns, _,
-        index_algorithm, index_using = add_index_options(table_name, column_name, **options)
-      index_algorithm[0, 0] = ', ' if index_algorithm.present?
-
-      "ADD #{index_type} INDEX #{quote_column_name(index_name)} #{index_using} (#{index_columns})#{index_algorithm}"
-    end
+    "ADD #{schema_creation.accept(index_definition)}"
   end
 
   def remove_index_for_alter(table_name, column_name = nil, **options)
-    index_name =
-      if ActiveRecord::VERSION::STRING >= '6.1'
-        index_name_for_remove(table_name, column_name, options)
-      else
-        options = [column_name, options] if column_name
-        index_name_for_remove(table_name, options)
-      end
+    index_name = index_name_for_remove(table_name, column_name, options)
+
     "DROP INDEX #{quote_column_name(index_name)}"
   end
 

data/lib/active_record/connection_adapters/rails_8_0_departure_adapter.rb

@@ -0,0 +1,297 @@
+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/mysql2/database_statements'
+require 'active_record/connection_adapters/patch_connection_handling'
+require 'active_support/core_ext/string/filters'
+require 'departure'
+require 'forwardable'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Rails80DepartureAdapter < AbstractMysqlAdapter
+      include ActiveRecord::ConnectionAdapters::Mysql2::DatabaseStatements
+      TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) } if defined?(initialize_type_map)
+
+      class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
+        def adapter
+          Rails80DepartureAdapter
+        end
+      end
+
+      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)
+        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/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 Naming/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
+
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/ParameterLists
+      def raw_execute(sql, name = nil, binds = [], prepare: false, async: false, allow_retry: false,
+                      materialize_transactions: true, batch: false)
+        type_casted_binds = type_casted_binds(binds)
+        log(sql, name, binds, type_casted_binds, async: async) do |notification_payload|
+          with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
+            perform_query(conn, sql, binds, type_casted_binds, prepare: prepare,
+                                                               notification_payload: notification_payload, batch: batch)
+          end
+        end
+      end
+
+      def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false)
+        reset_multi_statement = if batch && !multi_statements_enabled?
+                                  raw_connection.set_server_option(::Mysql2::Client::OPTION_MULTI_STATEMENTS_ON)
+                                  true
+                                end
+
+        # Make sure we carry over any changes to ActiveRecord.default_timezone that have been
+        # made since we established the connection
+        raw_connection.query_options[:database_timezone] = default_timezone
+
+        result = nil
+        if binds.nil? || binds.empty?
+          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+            result = raw_connection.query(sql)
+            # Ref: https://github.com/brianmario/mysql2/pull/1383
+            # As of mysql2 0.5.6 `#affected_rows` might raise Mysql2::Error if a prepared statement
+            # from that same connection was GCed while `#query` released the GVL.
+            # By avoiding to call `#affected_rows` when we have a result, we reduce the likeliness
+            # of hitting the bug.
+
+            # THIS IS THE CORE CHANGES 1 related to size
+            # We will sometimes have a process exit code instead of a result from executing
+            @affected_rows_before_warnings = if result.is_a? Process::Status
+                                               result.try(:size) || 0
+                                             else
+                                               result.try(:size) || raw_connection.affected_rows
+                                             end
+          end
+        elsif prepare
+
+          stmt = @statements[sql] ||= raw_connection.prepare(sql)
+          begin
+            ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+              result = stmt.execute(*type_casted_binds)
+              @affected_rows_before_warnings = stmt.affected_rows
+            end
+          rescue ::Mysql2::Error
+            @statements.delete(sql)
+            raise
+          end
+        else
+          stmt = raw_connection.prepare(sql)
+
+          begin
+            ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+              result = stmt.execute(*type_casted_binds)
+              @affected_rows_before_warnings = stmt.affected_rows
+            end
+
+            # Ref: https://github.com/brianmario/mysql2/pull/1383
+            # by eagerly closing uncached prepared statements, we also reduce the chances of
+            # that bug happening. It can still happen if `#execute` is used as we have no callback
+            # to eagerly close the statement.
+            if result
+              result.instance_variable_set(:@_ar_stmt_to_close, stmt)
+            else
+              stmt.close
+            end
+          rescue ::Mysql2::Error
+            stmt.close
+            raise
+          end
+        end
+
+        notification_payload[:affected_rows] = @affected_rows_before_warnings
+
+        # THIS IS THE CORE CHANGES 2 related to size
+        notification_payload[:row_count] = result.try(:size) || 0
+
+        if result.is_a? Process::Status
+          notification_payload[:exit_code] = result.exitstatus
+          notification_payload[:exit_pid] = result.pid
+        end
+
+        raw_connection.abandon_results!
+
+        verified!
+        handle_warnings(sql)
+        result
+      ensure
+        if reset_multi_statement && active?
+          raw_connection.set_server_option(::Mysql2::Client::OPTION_MULTI_STATEMENTS_OFF)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/ParameterLists
+
+      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