online_migrations 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcbf178b59ac7d856b8b3b44640aa30bd5bb0bc61c334d90925562da1ca23782
-  data.tar.gz: 3034174c45f26e4e70a338faa8074bcb4c926160202f6dd85dc43d6ffc5b7101
+  metadata.gz: babb68ddc337cbc52cb3a10d842dfb427031544fa8b32716b9b0166996f45252
+  data.tar.gz: '08e334985d6ecbe603831ad44a9b535d3e39ee1b7f17bb576fc035b9de11c84c'
 SHA512:
-  metadata.gz: 228cbf5deacedaf2017b86a7c6f005c89d454be0fdfe05358d1c33414fa1349cac46fa602901bdb9cf16f2b9bc8f73b6f7e8a935ff754a623182083032d649a4
-  data.tar.gz: 3b05af5c90a084eb64ef0f711e0d9ecb88a0e28d73ae3aa3720bbea525454a63061525aa56c56d251fc8044c6741f9cc94258f6eaf2b1cbd4325c01be86390e7
+  metadata.gz: ca383bfa73dd712076f3ac5ade02767955a7da7ec99306258d70a61b32331226fc22f4a84fea3f37423e7ebce2e805b514077bd13fcee1fcb09ae3ac637ac53f
+  data.tar.gz: 470a1d00e16f00b70a248c0ea2e0a3acfcb3e05b165fe5d12fa966c3f03d2a40c953fe4dd9265d210c330fca0b2536143716a47adfb9f1a8749d3348183e4959

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## master (unreleased)
 
+## 0.29.0 (2025-07-10)
+
+- Add `iteration_pause` column to background data migrations
+
+    Note: Run `bin/rails generate online_migrations:upgrade` if using background data migrations.
+    Make sure all data migrations finished before applying this migration or change its timestamp
+    to be older than all pending db migrations which will enqueue data migrations.
+
 ## 0.28.0 (2025-06-26)
 
 - Support renaming columns and tables for tables within custom schemas

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

@@ -0,0 +1,7 @@
+class BackgroundDataMigrationsAddIterationPause < <%= migration_parent %>
+  def change
+    safety_assured("Table is small") do
+      add_column :background_data_migrations, :iteration_pause, :float, default: 0.0, null: false
+    end
+  end
+end

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

@@ -13,6 +13,7 @@ class InstallOnlineMigrations < <%= migration_parent %>
       t.bigint :tick_count, default: 0, null: false
       t.float :time_running, default: 0.0, null: false
       t.integer :max_attempts, null: false
+      t.float :iteration_pause, default: 0.0, null: false
       t.string :error_class
       t.string :error_message
       t.string :backtrace, array: true

data/lib/generators/online_migrations/upgrade_generator.rb

@@ -19,33 +19,34 @@ module OnlineMigrations
     private
       def migrations_to_apply
         connection = BackgroundDataMigrations::Migration.connection
-        data_table = "background_migrations"
-        schema_table = "background_schema_migrations"
-        columns = connection.columns(data_table).map(&:name)
 
         migrations = []
-        if connection.table_exists?(data_table) && !columns.include?("shard")
+        if connection.table_exists?(:background_migrations) && !connection.column_exists?(:background_migrations, :shard)
           migrations << "add_sharding_to_online_migrations"
         end
 
-        if !connection.table_exists?(schema_table)
+        if !connection.table_exists?(:background_schema_migrations)
           migrations << "create_background_schema_migrations"
         end
 
-        indexes = connection.indexes(schema_table)
+        indexes = connection.indexes(:background_schema_migrations)
         unique_index = indexes.find { |i| i.unique && i.columns.sort == ["connection_class_name", "migration_name", "shard"] }
         if !unique_index
           migrations << "background_schema_migrations_change_unique_index"
         end
 
-        if connection.table_exists?(data_table) && !connection.column_exists?(data_table, :started_at)
+        if connection.table_exists?(:background_migrations) && !connection.column_exists?(:background_migrations, :started_at)
           migrations << "add_timestamps_to_background_migrations"
         end
 
-        if connection.table_exists?(data_table)
+        if connection.table_exists?(:background_migrations)
           migrations << "change_background_data_migrations"
         end
 
+        if !connection.column_exists?(:background_data_migrations, :iteration_pause)
+          migrations << "background_data_migrations_add_iteration_pause"
+        end
+
         migrations
       end
 

data/lib/online_migrations/background_data_migrations/migration.rb

@@ -250,7 +250,7 @@ module OnlineMigrations
       def progress
         if succeeded?
           100.0
-        elsif enqueued? || tick_total == 0
+        elsif tick_total == 0
           0.0
         elsif tick_total
           ([tick_count.to_f / tick_total, 1.0].min * 100)
@@ -297,6 +297,8 @@ module OnlineMigrations
           self.tick_total ||= on_shard_if_present do
             data_migration.count
           end
+
+          self.iteration_pause ||= config.iteration_pause
         end
 
         def instrument_status_change

data/lib/online_migrations/background_data_migrations/migration_helpers.rb

@@ -369,7 +369,7 @@ module OnlineMigrations
       #     in development and test environments
       #
       def enqueue_background_data_migration(migration_name, *arguments, **options)
-        options.assert_valid_keys(:max_attempts, :connection_class_name)
+        options.assert_valid_keys(:max_attempts, :iteration_pause, :connection_class_name)
 
         migration_name = migration_name.name if migration_name.is_a?(Class)
         options[:connection_class_name] ||= compute_connection_class_name(migration_name, arguments)
@@ -387,7 +387,7 @@ module OnlineMigrations
           migration = Migration.where(migration_name: migration_name, shard: shard).where("arguments = ?", arguments.to_json).first
           migration ||= Migration.create!(**options, migration_name: migration_name, arguments: arguments, shard: shard)
 
-          if Utils.run_background_migrations_inline?
+          if Utils.run_background_migrations_inline? && !migration.succeeded?
             job = OnlineMigrations.config.background_data_migrations.job
             job.constantize.perform_inline(migration.id)
           end

data/lib/online_migrations/background_data_migrations/migration_job.rb

@@ -128,7 +128,8 @@ module OnlineMigrations
           @data_migration.around_process do
             @migration.data_migration.process(item)
 
-            pause = OnlineMigrations.config.background_data_migrations.iteration_pause
+            # Migration is refreshed regularly by ticker.
+            pause = @migration.iteration_pause
             sleep(pause) if pause > 0
           end
           @ticker.tick

data/lib/online_migrations/background_schema_migrations/migration_helpers.rb

@@ -112,6 +112,9 @@ module OnlineMigrations
                                .find_or_create_by!(migration_name: migration_name, shard: shard, connection_class_name: connection_class_name)
 
           if Utils.run_background_migrations_inline?
+            # Run migration again in development.
+            migration.update_column(:status, :enqueued) if !migration.enqueued?
+
             runner = MigrationRunner.new(migration)
             runner.run
           end

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-26 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -42,6 +42,7 @@ files:
 - lib/generators/online_migrations/install_generator.rb
 - 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_schema_migrations_change_unique_index.rb.tt
 - lib/generators/online_migrations/templates/change_background_data_migrations.rb.tt
 - lib/generators/online_migrations/templates/create_background_schema_migrations.rb.tt