online_migrations 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ecf0ad3b1c2bc1992e9ec205018212b4d3c663f2a3040271a0cce45d4b9f60c
-  data.tar.gz: fcc3a3ac5b96fc3bd893f251949969794ebde738e5f663eb367fd191fa50784d
+  metadata.gz: 493a3f1a84eb30974c533f81ca5baf8b739d69d4ec6e30810d891284791632f1
+  data.tar.gz: 9dae1370ea3073146888d3757314bac6c8e968c5e35a2c2be345f3617f610881
 SHA512:
-  metadata.gz: c5a92bde9892d9f7bf545248d359527c9fac1a41b31e6eabf34f0da0a1342fdfc9e54ccc853aba6e35414d368328979d7b445246f71e72e0ac09cce80ad8a02f
-  data.tar.gz: d244cb531e3e2f58d140e75af1f8fc571a272d9d188d87f0e52d89b7efbc7233eb4c1df7bac63fe32d1e7b79643e1202872b951f1fcfc2b8ca5fa9c3abdc7746
+  metadata.gz: d40cae89f1be37a97567d7bb05d1ded17479ce89b9783ed0c606d6bdfdec2d940d251de4de66557af774fc88e1262ae492539fe3fae5f4cb105d88526e7315d3
+  data.tar.gz: 26316851d405210a67576ea0ae35ba0419574832aacc43a2f0ddd00a8f22223f0d1ed73ff1635f6f9aa4168877c48aebb56d0f93f05472b531d80f3fc19881e9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
 
+## 0.22.0 (2025-01-03)
+
+- Make background data migrations scheduler run a single migration at a time
+
+    This is similar to background schema migrations scheduler's behavior.
+    Running multiple migrations at a time can cause unneeded database load and other bad effects.
+
+- Add `#pausable?`, `#can_be_cancelled?` and `#can_be_paused?` helpers to background migrations
+
 ## 0.21.0 (2024-12-09)
 
 - Fix `add_foreign_key` when referencing same table via different columns

data/lib/online_migrations/background_migrations/migration.rb

@@ -110,6 +110,18 @@ module OnlineMigrations
       end
       alias cancel cancelled!
 
+      def pausable?
+        true
+      end
+
+      def can_be_paused?
+        enqueued? || running?
+      end
+
+      def can_be_cancelled?
+        !succeeded? && !cancelled?
+      end
+
       def last_job
         migration_jobs.order(:max_value).last
       end

data/lib/online_migrations/background_migrations/scheduler.rb

@@ -3,9 +3,10 @@
 module OnlineMigrations
   module BackgroundMigrations
     # Class responsible for scheduling background migrations.
-    # It selects runnable background migrations and runs them one step (one batch) at a time.
+    #
+    # It selects a single runnable background migration and runs it one step (one batch) at a time.
     # A migration is considered runnable if it is not completed and the time interval between
-    #   successive runs has passed.
+    # successive runs has passed.
     #
     # Scheduler should be configured to run periodically, for example, via cron.
     # @example Run via whenever
@@ -22,18 +23,13 @@ module OnlineMigrations
       # Runs Scheduler
       def run
         active_migrations = Migration.runnable.active.queue_order
-        runnable_migrations = active_migrations.select(&:interval_elapsed?)
+        runnable_migration = active_migrations.select(&:interval_elapsed?).first
 
-        runnable_migrations.each do |migration|
-          run_migration_job(migration)
-        end
-      end
-
-      private
-        def run_migration_job(migration)
-          runner = MigrationRunner.new(migration)
+        if runnable_migration
+          runner = MigrationRunner.new(runnable_migration)
           runner.run_migration_job
         end
+      end
     end
   end
 end

data/lib/online_migrations/background_schema_migrations/migration.rb

@@ -94,6 +94,18 @@ module OnlineMigrations
       end
       alias cancel cancelled!
 
+      def pausable?
+        false
+      end
+
+      def can_be_paused?
+        false
+      end
+
+      def can_be_cancelled?
+        !succeeded? && !cancelled?
+      end
+
       # Returns the progress of the background schema migration.
       #
       # @return [Float] value in range from 0.0 to 100.0

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord