online_migrations 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a84bdeb495a3d25432c6ae97d4c46777517ae3bbcf01359020d400ad8f16f30
-  data.tar.gz: 935d3b38b096fcdb222a89065d7c10023a8b85a6009065d73a1df9bb92c2b0f8
+  metadata.gz: 6740adaa6d20273e8d148e8e0788a6e27c6c6701187fe60e006ff3ba8e2129d2
+  data.tar.gz: 445a3ef72888dd358cc5d917ca31de7499df3368797c9c73324704e0e2d8307a
 SHA512:
-  metadata.gz: f2c578a25081bb86cafc2851cb818c40e819363d40bdac2a6f4cde634f71a8dc3a90909e4dbf10bf0fb6df61e1d979f4d581982650eec3834715baa8e5888832
-  data.tar.gz: 01377b6bcdbe0b601a45b53a52a99746e443d60c5ca513e2312322c81718e4a995fde32ee78a45554fe155878391f6a885fdef50bdea4d4619a4e10799bab295
+  metadata.gz: 338cf3a26b64efb827b5691addc67987048e0522f467d89c5ff4a18494f6b0e3cbeb93513e419a01b04be643d9f7e7a36c1aaf1b0a9d7f5c8158ecff1eb315e7
+  data.tar.gz: 4a6b9282a87124e037b3f101a5856d4a8756e86f9fb5b8bf3a4e42e7e2790e0edbd78b7263b8e9c653bedc25700d8a3fb8ade671e2f99e1e74dbfd49780c20eb

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
 
+## 0.36.0 (2026-07-20)
+
+- Serialize to JSON `cursor` value for background data migrations
+
+    Note: Run `bin/rails generate online_migrations:upgrade` if using background migrations.
+
+- Do not consider running background migrations as stuck
+- Do not automatically retry stuck background migrations
+
 ## 0.35.0 (2026-07-01)
 
 - Drop support for Ruby < 3.3

data/README.md

@@ -342,6 +342,8 @@ during writes works automatically). For most column type changes, this does not
 
    ```ruby
    class CleanupChangeFilesSizeType < ActiveRecord::Migration[8.0]
+     disable_ddl_transaction!
+
      def up
        cleanup_column_type_change :files, :size
      end

data/lib/generators/online_migrations/templates/background_data_migrations_convert_cursor.rb.tt

@@ -0,0 +1,9 @@
+class BackgroundDataMigrationsConvertCursor < <%= migration_parent %>
+  def change
+    up_only do
+      OnlineMigrations::DataMigrations::Migration.find_each do |migration|
+        OnlineMigrations::DataMigrations::Migration.where(id: migration.id).update_all(cursor: migration.cursor)
+      end
+    end
+  end
+end

data/lib/generators/online_migrations/upgrade_generator.rb

@@ -57,6 +57,8 @@ module OnlineMigrations
           migrations << "background_migrations_change_status_default"
         end
 
+        migrations << "background_data_migrations_convert_cursor"
+
         migrations
       end
 

data/lib/online_migrations/background_data_migrations/migration.rb

@@ -52,6 +52,8 @@ module OnlineMigrations
 
       enum :status, STATUSES.index_with(&:to_s)
 
+      serialize :cursor, coder: JSON
+
       validates :migration_name, presence: true
       validates :arguments, uniqueness: { scope: [:migration_name, :shard] }
 
@@ -66,6 +68,13 @@ module OnlineMigrations
         migration_name.sub(/^(::)?#{namespace}::/, "")
       end
 
+      # TODO: delete in some future version
+      def cursor
+        self[:cursor]
+      rescue JSON::ParserError
+        cursor_before_type_cast
+      end
+
       def migration_name=(class_name)
         class_name = class_name.name if class_name.is_a?(Class)
         write_attribute(:migration_name, self.class.normalize_migration_name(class_name))
@@ -111,13 +120,13 @@ module OnlineMigrations
       end
 
       # Returns whether a migration is stuck, which is defined as having a status of
-      # running, cancelling or pausing, and not having been updated in the last 5 minutes.
+      # cancelling or pausing, and not having been updated in the last 5 minutes.
       #
       # @return [Boolean] whether the migration is stuck.
       #
       def stuck?
         stuck_timeout = OnlineMigrations.config.background_data_migrations.stuck_timeout
-        (running? || cancelling? || pausing?) && updated_at <= stuck_timeout.ago
+        (cancelling? || pausing?) && updated_at <= stuck_timeout.ago
       end
 
       # @private

data/lib/online_migrations/background_data_migrations/migration_job.rb

@@ -72,6 +72,7 @@ module OnlineMigrations
         # Job was manually cancelled.
         @migration.cancel if cancelled?
 
+        @migration.update!(jid: nil)
         @migration.complete
       end
 

data/lib/online_migrations/background_data_migrations/migration_status_validator.rb

@@ -13,14 +13,12 @@ module OnlineMigrations
         # enqueued -> failed occurs when the migration job fails to be enqueued, or
         #   if the migration is deleted before is starts running.
         "enqueued" => ["running", "paused", "cancelled", "failed"],
-        # running -> enqueued occurs when the migration is stuck and rescheduled by the scheduler.
         # running -> succeeded occurs when the migration completes successfully.
         # running -> pausing occurs when a user pauses the migration as it's performing.
         # running -> cancelling occurs when a user cancels the migration as it's performing.
         # running -> errored occurs when the migration raised an error during the last run.
         # running -> failed occurs when the migration raises an error when running and retry attempts exceeded.
         "running" => [
-          "enqueued",
           "succeeded",
           "pausing",
           "cancelling",

data/lib/online_migrations/background_data_migrations/scheduler.rb

@@ -36,11 +36,10 @@ module OnlineMigrations
         migrations_to_enqueue = []
 
         with_lock do
-          stuck_migrations, active_migrations = relation.running.partition(&:stuck?)
-          runnable_migrations = migrations_with_existing_classes(relation.pending) + stuck_migrations
+          runnable_migrations = migrations_with_existing_classes(relation.pending)
 
           # Ensure no more than 'concurrency' migrations are running at the same time.
-          remaining_to_enqueue = concurrency - active_migrations.count
+          remaining_to_enqueue = concurrency - relation.running.count
           if remaining_to_enqueue > 0
             runnable_migrations.take(remaining_to_enqueue).each do |migration|
               migration.update!(status: :enqueued)

data/lib/online_migrations/background_schema_migrations/migration.rb

@@ -23,6 +23,7 @@ module OnlineMigrations
       MAX_IDENTIFIER_LENGTH = 63
 
       self.table_name = :background_schema_migrations
+      self.ignored_columns += ["parent_id", "composite"]
 
       scope :queue_order, -> { order(created_at: :asc) }
       scope :active, -> { where(status: [:pending, :running, :errored]) }
@@ -80,15 +81,10 @@ module OnlineMigrations
       def progress
       end
 
-      # Whether the migration is considered stuck (is running for some configured time).
+      # Whether the migration is considered stuck.
       #
       def stuck?
-        if index_addition?
-          running? && !index_build_in_progress?
-        else
-          stuck_timeout = (statement_timeout || 1.day) + 10.minutes
-          running? && updated_at <= stuck_timeout.seconds.ago
-        end
+        index_addition? && running? && !index_build_in_progress?
       end
 
       # Mark this migration as ready to be processed again.

data/lib/online_migrations/background_schema_migrations/migration_runner.rb

@@ -44,9 +44,8 @@ module OnlineMigrations
         # Background schema migrations could take a while to run. It is possible, that the process
         # never reaches this (or the rescue below) line of code. E.g., when it is force quitted
         # (SIGKILL etc.) and so the migration will end up in the "running" state and the query is
-        # still executing (or already finished) in the database. This migration can either be safely
-        # manually retried or will be picked up in the future by scheduler when it decides that
-        # this migration is stuck.
+        # still executing (or already finished) in the database. This migration can be safely
+        # manually retried.
 
         migration.update!(status: :succeeded, finished_at: Time.current)
 

data/lib/online_migrations/background_schema_migrations/scheduler.rb

@@ -35,8 +35,8 @@ module OnlineMigrations
 
       private
         def find_migration(**options)
-          stuck_migrations, active_migrations = Migration.running.partition(&:stuck?)
-          runnable_migrations = (Migration.pending + Migration.errored + stuck_migrations).sort_by(&:created_at)
+          active_migrations = Migration.running.to_a
+          runnable_migrations = (Migration.pending + Migration.errored).sort_by(&:created_at)
 
           if options.key?(:shard)
             runnable_migrations = runnable_migrations.select { |migration| migration.shard.to_s == options[:shard].to_s }

data/lib/online_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OnlineMigrations
-  VERSION = "0.35.0"
+  VERSION = "0.36.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - fatkodima
@@ -41,6 +41,7 @@ files:
 - lib/generators/online_migrations/templates/add_sharding_to_online_migrations.rb.tt
 - lib/generators/online_migrations/templates/add_timestamps_to_background_migrations.rb.tt
 - lib/generators/online_migrations/templates/background_data_migrations_add_iteration_pause.rb.tt
+- lib/generators/online_migrations/templates/background_data_migrations_convert_cursor.rb.tt
 - lib/generators/online_migrations/templates/background_data_migrations_remove_iteration_pause_default.rb.tt
 - lib/generators/online_migrations/templates/background_migrations_change_status_default.rb.tt
 - lib/generators/online_migrations/templates/background_schema_migrations_change_unique_index.rb.tt