vitess-activerecord-migration 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eae6c9228eb8d3d5ebae767cef06ff65c89b073e6598bf690ddbd0907e995a0
-  data.tar.gz: bed613b3ec15ac973a5dabd1957e054d68b5d7adaefb0938af03fba3b7b2be6e
+  metadata.gz: ccf02af6a599148167a09bb0281fcb891663bf455b280c74bcd0f344d15b0008
+  data.tar.gz: 6fbd1977dd22de177572f0de28dbbd80824b445361c62f0d2f1f7741c8b884ba
 SHA512:
-  metadata.gz: bf5fef0a1132c9cc35a7af3314b64da6669653813d90dc50ddb65018ecfa456dc2c25d1b234a8c9a66a7d8f0838b186a0fa281f05249ef58b15e25b084410085
-  data.tar.gz: 213b03855f9303882dd237db331a7b030f1dfe704d18b70895b71b7dffb120165ce012bb932016dc8ce2ce45e9f18d9722ad77b1b65d6c5acd44ae4e0cf1aec5
+  metadata.gz: a02873ccab767abf06dc40277d4f75dd169449d43d1e3b40b08c15ddc099efd89edab6016af640379842c92e1d999e1e112c21a97107eda80b5c0858077f9116
+  data.tar.gz: 42336d57e7c0e870a2dae788ab66ed56858683738df9b76094ce87c8df8b09d8844fc878a9679028a9b1de3cc68dde3b37e890b96a5455ef04d56f06f36c9c02

data/.env

@@ -1,3 +1,3 @@
 RUBY_VERSION=${RUBY_VERSION:-3.2}
 RAILS_VERSION=${RAILS_VERSION:-~> 7.2.0}
-VITESS_VERSION=${VITESS_VERSION:-20.0}
+VITESS_VERSION=${VITESS_VERSION:-21.0}

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-08-30
+
+- **BREAKING**: Drop Rails 6.1 support, require ActiveRecord >= 7.0 (#7)
+- **BREAKING**: Raise errors on failed/cancelled/timed-out migrations (#5)
+
 ## [0.1.0] - 2024-09-02
 
 - Initial release

data/README.md

@@ -1,5 +1,9 @@
 # Vitess::Activerecord::Migration
 
+[![Ruby](https://github.com/yoheimuta/vitess-activerecord-migration/actions/workflows/main.yml/badge.svg)](https://github.com/yoheimuta/vitess-activerecord-migration/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/vitess-activerecord-migration.svg)](https://badge.fury.io/rb/vitess-activerecord-migration)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/yoheimuta/protolint/blob/master/LICENSE)
+
 vitess-activerecord-migration is a gem for integrating Vitess with ActiveRecord migrations.
 
 Vitess::Activerecord::Migration provides tools to integrate Vitess with ActiveRecord migrations, 
@@ -22,7 +26,7 @@ ActiveRecord::Migration.prepend(Vitess::Activerecord::Migration)
 
 The default ddl strategy is `vitess` with no options.
 
-When you want to set the ddl strategy and its options for one shot, you can set them in the migration file.
+When you want to change the ddl strategy and its options for one shot, you can set them in the migration file.
 
 ```ruby
 def default_ddl_strategy
@@ -35,7 +39,7 @@ def change
 end
 ```
 
-When you want to set the default ddl strategy and its options, you can override the following methods.
+When you want to change the default ddl strategy and its options, you can override the following methods.
 
 ```ruby
 # lib/vitess/activerecord/app_migration.rb
@@ -57,6 +61,24 @@ ActiveRecord::Migration.prepend(Vitess::Activerecord::Migration)
 ActiveRecord::Migration.prepend(Vitess::Activerecord::AppMigration)
 ```
 
+When you want to change the log parameters during the migration, you can override the following method.
+
+```ruby
+# lib/vitess/activerecord/app_migration.rb
+module Vitess
+  module Activerecord
+    module AppMigration
+      def migration_log_columns
+        %w[
+          migration_uuid
+          progress
+          eta_seconds
+        ]
+      end
+    end
+  end
+end
+```
 
 ## Development
 

data/lib/vitess/activerecord/migration/version.rb

@@ -3,7 +3,7 @@
 module Vitess
   module Activerecord
     module Migration
-      VERSION = "0.1.0"
+      VERSION = "0.3.0"
     end
   end
 end

data/lib/vitess/activerecord/migration.rb

@@ -7,6 +7,9 @@ module Vitess
   module Activerecord
     module Migration
       class Error < StandardError; end
+      class Failed < Error; end
+      class Cancelled < Error; end
+      class TimedOut < Error; end
 
       # Returns the default DDL strategy.
       # This method is called and set before executing the change, up, or down methods.
@@ -17,13 +20,41 @@ module Vitess
       end
 
       # Returns the timeout seconds for waiting for the completion of the DDL statement.
-      # Even after the timeout, the migration on Vitess will not be stopped, but a warning will be logged.
+      # If the DDL exceeds the timeout:
+      #
+      # * A warning will be logged.
+      # * An error will be raised and halt the Rails migration if `raise_on_timeout` is `true`.
+      # * The Vitess migration will continue.
       #
       # Override this method if you want to change the default timeout.
       def wait_timeout_seconds
         7200 # 120 minutes
       end
 
+      # Returns whether an error will be raised when the DDL statement exceeds wait_timeout_seconds.
+      #
+      # Override this method if you want to change how timeouts are handled.
+      def raise_on_timeout
+        true
+      end
+
+      # Returns the columns of SHOW VITESS_MIGRATIONS to log during the run.
+      #
+      # Override this method if you want to change the default columns.
+      def migration_log_columns
+        %w[
+          migration_uuid
+          migration_statement
+          added_timestamp
+          started_timestamp
+          last_throttled_timestamp
+          last_cutover_attempt_timestamp
+          is_immediate_operation
+          progress
+          eta_seconds
+        ]
+      end
+
       # Override exec_migration to set the default DDL strategy to vitess.
       # This method is called every time a migration is executed.
       # If you want to use a different DDL strategy, call with_ddl_strategy inside the change method or elsewhere.
@@ -97,14 +128,24 @@ module Vitess
         @stopped_uuid ||= []
 
         loop do
+          # A Rails migration will create a separate Vitess migration for each DDL submitted by Rails.
+          # Each Rails migration has a unique version and this is used to group the resulting Vitess migrations using the `migration_context` field.
+          # Vitess records the DDL submitted by Rails in the `migration_statement` column.
+          # If the Rails migration fails and is later retried, Vitess will create additional Vitess migrations with the same `migration_context` from the previous attempt.
+          # Vitess will immediately mark "duplicate" DDLs that were previously successful as complete.
+          # Vitess will retry "duplicate" DDLs that were previously unsuccessful.
+          # The overall Rails migration status is determined by the `migration_status` of the last Vitess migration of each DDL.
+          # For details on Vitess duplicate migration detection, see:
+          # https://vitess.io/docs/22.0/user-guides/schema-changes/advanced-usage/
           migrations = ActiveRecord::Base.connection.select_all("SHOW VITESS_MIGRATIONS LIKE '#{@migration_context}'")
+            .group_by { |migration| migration['migration_statement'] }
+            .map { |_, migrations| migrations.last }
 
           migrations.each do |migration|
             id = migration["id"]
             next if @stopped_uuid.include?(id)
 
-            details = %w[migration_uuid migration_statement added_timestamp started_timestamp is_immediate_operation progress eta_seconds retries]
-            detail_message = details.map { |column| "#{column}: #{migration[column]}" }.join(" | ")
+            detail_message = migration_log_columns.map { |column| "#{column}: #{migration[column]}" }.join(" | ")
             Rails.logger.info("Vitess Migration #{id} checking status, #{detail_message}")
 
             status = migration["migration_status"]
@@ -114,8 +155,10 @@ module Vitess
                 Rails.logger.info("Vitess Migration #{id} completed successfully at #{migration["completed_timestamp"]}")
               when "failed"
                 Rails.logger.error("Vitess Migration #{id} failed: #{migration["message"]} at #{migration["completed_timestamp"]}")
+                raise Failed, "Vitess Migration #{id} failed: #{migration["message"]}"
               when "cancelled"
                 Rails.logger.warn("Vitess Migration #{id} was cancelled at #{migration["cancelled_timestamp"]}")
+                raise Cancelled, "Vitess Migration #{id} was cancelled: #{migration["message"]}"
               end
               @stopped_uuid << id
             else
@@ -130,6 +173,7 @@ module Vitess
 
           if Time.now - start_time > timeout_seconds
             Rails.logger.warn("Vitess Migration did not complete within #{timeout_seconds} seconds. Timing out.")
+            raise TimedOut, "Vitess Migration did not complete within #{timeout_seconds} seconds."
             break
           end
 
@@ -138,6 +182,8 @@ module Vitess
           interval_seconds = [interval_seconds * 2, max_interval_seconds].min
         end
       rescue => e
+        raise e if [Failed, Cancelled].include?(e.class)
+        raise e if e.class == TimedOut && raise_on_timeout
         Rails.logger.error("An error occurred while waiting for Vitess DDL: #{e.message}")
         Rails.logger.error(e.backtrace.join("\n"))
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitess-activerecord-migration
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yohei Yoshimuta
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2025-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '7.0'
 description: Vitess::Activerecord::Migration provides tools to integrate Vitess with
   ActiveRecord migrations, allowing for seamless database schema changes in a Vitess
   environment.
@@ -57,7 +51,6 @@ files:
 - sig/rails_support.rbs
 - sig/vitess/activerecord/migration.rbs
 - tmp/.keep
-- vitess-activerecord-migration.gemspec
 homepage: https://github.com/yoheimuta/vitess-activerecord-migration
 licenses:
 - MIT
@@ -66,7 +59,7 @@ metadata:
   homepage_uri: https://github.com/yoheimuta/vitess-activerecord-migration
   source_code_uri: https://github.com/yoheimuta/vitess-activerecord-migration
   changelog_uri: https://github.com/yoheimuta/vitess-activerecord-migration/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A gem for integrating Vitess with ActiveRecord migrations.
 test_files: []

data/vitess-activerecord-migration.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/vitess/activerecord/migration/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "vitess-activerecord-migration"
-  spec.version = Vitess::Activerecord::Migration::VERSION
-  spec.authors = ["Yohei Yoshimuta"]
-  spec.email = ["yoheimuta@gmail.com"]
-
-  spec.summary = "A gem for integrating Vitess with ActiveRecord migrations."
-  spec.description = "Vitess::Activerecord::Migration provides tools to integrate Vitess with ActiveRecord migrations, allowing for seamless database schema changes in a Vitess environment."
-  spec.homepage = "https://github.com/yoheimuta/vitess-activerecord-migration"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/yoheimuta/vitess-activerecord-migration"
-  spec.metadata["changelog_uri"] = "https://github.com/yoheimuta/vitess-activerecord-migration/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "activerecord", ">= 6", "< 8.1"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end