online_migrations 0.33.1 → 0.33.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ea2552d8a879bacf5a5f8360a13aeafa9b36bec50943b359eb2d0501532ceb0
-  data.tar.gz: 251b3bee148c70f37d86892ce985a93ee664a2623111de38b9fcff47b6be4baa
+  metadata.gz: 54cc719e4b9c6d22226c4393fa81362cec973f1f368553c2797bc5a7e0b3720b
+  data.tar.gz: f8dba7a97c0e4bbb744d552f783ad9407aa65aec16d1020933becaf83a9779a4
 SHA512:
-  metadata.gz: 295c89b41757157ce16b7b2585d3516cd2900b1ba0291523c2e689991002669e08ba3928fc23b1047a92dbd0f225436f0b2f8ed9c7b6803fee8a4e56c4ef4239
-  data.tar.gz: 16c0ada6d9a4e07271eae3a1a509f23a4756a5af3eebf172ca4971680b1c799f148c2f7bbeeffdcfce2e600cf24095e1663f03d6de00dd692af803ccdad22f62
+  metadata.gz: bd3a4195693d1f48a585c96ec66a0ae5775f585a2ce66c2e226a1148847cc63292e64a9704268a7a40e84a094c50e6a1990b91009fc22527db4ba004ef8aae95
+  data.tar.gz: 8f8cf24be5a12a4e68dadaeae47373a05ed2426bcc61f7bbe325e3e714c884ee353c48afd7696b7da3bd0393a2c88e11993afa081b99a63bedf839fb88e8eec4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master (unreleased)
 
+## 0.33.2 (2026-03-16)
+
+- Fix message for adding to `ignored_columns` when renaming a column
+- Schedule background data migration jobs only after committing the database transaction
+
 ## 0.33.1 (2026-02-05)
 
 - Allow "running" to "enqueued" state transition for stuck background data migrations
@@ -94,7 +99,7 @@
 - Drop support for Ruby < 3.1 and Rails < 7.1
 - Add check for `change_column` for columns with check constraints
 
-- Allow to require safety reason explanation when calling `safery_assured`
+- Allow to require safety reason explanation when calling `safety_assured`
 
   ```ruby
   # config/initializers/online_migrations.rb

data/README.md

@@ -441,8 +441,9 @@ It will use a combination of a VIEW and column aliasing to work with both column
    ```
 
 4. Replace usages of the old column with a new column in the codebase
-5. If you enabled Active Record `enumerate_columns_in_select_statements` setting in your application
-   (is disabled by default in Active Record >= 7), then you need to ignore old column:
+5. If the model has `ignored_columns` set, or you enabled Active Record
+   `enumerate_columns_in_select_statements` setting (is disabled by default in Active Record >= 7),
+   then you need to ignore the old column:
 
    ```ruby
    class User < ApplicationRecord

data/docs/configuring.md

@@ -40,7 +40,7 @@ Check the [source code](https://github.com/fatkodima/online_migrations/blob/mast
 
 ## Requiring safety_assured reason
 
-To require safety reason explanation when calling `safery_assured` (disabled by default):
+To require safety reason explanation when calling `safety_assured` (disabled by default):
 
 ```ruby
 config.require_safety_assured_reason = true

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

@@ -1,4 +1,4 @@
-class BackgroundDataMigrationsChangeStatusDefault < <%= migration_parent %>
+class BackgroundMigrationsChangeStatusDefault < <%= migration_parent %>
   def change
     safety_assured do
       change_column_default :background_data_migrations, :status, from: "enqueued", to: "pending"

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

@@ -12,7 +12,7 @@ OnlineMigrations.configure do |config|
   # Set the version of the production database so the right checks are run in development.
   # config.target_version = 17
 
-  # Configure whether to require safety reason explanation when calling #safery_assured.
+  # Configure whether to require safety reason explanation when calling #safety_assured.
   config.require_safety_assured_reason = false
 
   # Configure whether to perform checks when migrating down.

data/lib/online_migrations/background_data_migrations/scheduler.rb

@@ -33,6 +33,8 @@ module OnlineMigrations
         relation = Migration.queue_order
         relation = relation.where(shard: shard) if shard
 
+        migrations_to_enqueue = []
+
         with_lock do
           stuck_migrations, active_migrations = relation.running.partition(&:stuck?)
           runnable_migrations = relation.pending + stuck_migrations
@@ -40,13 +42,18 @@ module OnlineMigrations
           # Ensure no more than 'concurrency' migrations are running at the same time.
           remaining_to_enqueue = concurrency - active_migrations.count
           if remaining_to_enqueue > 0
-            migrations_to_enqueue = runnable_migrations.take(remaining_to_enqueue)
-            migrations_to_enqueue.each do |migration|
-              enqueue_migration(migration)
+            runnable_migrations.take(remaining_to_enqueue).each do |migration|
+              migration.update!(status: :enqueued)
+
+              migrations_to_enqueue << migration
             end
           end
         end
 
+        migrations_to_enqueue.each do |migration|
+          enqueue_migration(migration)
+        end
+
         true
       end
 
@@ -67,7 +74,6 @@ module OnlineMigrations
         def enqueue_migration(migration)
           job = OnlineMigrations.config.background_data_migrations.job
           job_class = job.constantize
-          migration.update!(status: :enqueued)
 
           jid = job_class.perform_async(migration.id)
           if jid

data/lib/online_migrations/background_schema_migrations/migration.rb

@@ -151,28 +151,28 @@ module OnlineMigrations
       # @private
       def run
         on_shard_if_present do
-          connection = connection_class.connection
-
-          connection.with_lock_retries do
-            statement_timeout = self.statement_timeout || OnlineMigrations.config.statement_timeout
-
-            with_statement_timeout(connection, statement_timeout) do
-              if index_addition?
-                index = connection.indexes(table_name).find { |i| name.match?(/\b#{i.name}\b/) }
-                if index
-                  if index.valid?
-                    return
-                  else
-                    connection.remove_index(table_name, name: index.name, algorithm: :concurrently)
+          with_connection do |connection|
+            connection.with_lock_retries do
+              statement_timeout = self.statement_timeout || OnlineMigrations.config.statement_timeout
+
+              with_statement_timeout(connection, statement_timeout) do
+                if index_addition?
+                  index = connection.indexes(table_name).find { |i| name.match?(/\b#{i.name}\b/) }
+                  if index
+                    if index.valid?
+                      return
+                    else
+                      connection.remove_index(table_name, name: index.name, algorithm: :concurrently)
+                    end
                   end
                 end
-              end
 
-              connection.execute(definition)
+                connection.execute(definition)
 
-              # Outdated statistics + a new index can hurt performance of existing queries.
-              if OnlineMigrations.config.auto_analyze
-                connection.execute("ANALYZE #{table_name}")
+                # Outdated statistics + a new index can hurt performance of existing queries.
+                if OnlineMigrations.config.auto_analyze
+                  connection.execute("ANALYZE #{table_name}")
+                end
               end
             end
           end
@@ -206,6 +206,16 @@ module OnlineMigrations
           indexes_in_progress.include?(name)
         end
 
+        # Extension point, do not remove this method.
+        def with_connection(&block)
+          if Utils.ar_version >= 7.2
+            # https://github.com/rails/rails/pull/51083
+            connection_class.with_connection(&block)
+          else
+            yield connection_class.connection
+          end
+        end
+
         def with_statement_timeout(connection, timeout)
           return yield if timeout.nil?
 

data/lib/online_migrations/config.rb

@@ -73,7 +73,7 @@ module OnlineMigrations
       end
     end
 
-    # Whether to require safety reason explanation when calling #safery_assured
+    # Whether to require safety reason explanation when calling #safety_assured
     #
     # Disabled by default
     # @return [Boolean]

data/lib/online_migrations/error_messages.rb

@@ -148,14 +148,14 @@ It will use a combination of a VIEW and column aliasing to work with both column
   end
 
 4. Replace usages of the old column with a new column in the codebase
-<% if ActiveRecord::Base.enumerate_columns_in_select_statements %>
-5. Ignore old column
+5. If the model has `ignored_columns` set, or you enabled
+  `enumerate_columns_in_select_statements`, ignore the old column:
 
   self.ignored_columns += [:<%= column_name %>]
 
 6. Deploy
 7. Remove the column rename config from step 1
-8. Remove the column ignore from step 5
+8. Remove the column ignore from step 5, if added
 9. Remove the VIEW created in step 3 and finally rename the column:
 
   class Finalize<%= migration_name %> < <%= migration_parent %>
@@ -165,19 +165,7 @@ It will use a combination of a VIEW and column aliasing to work with both column
   end
 
 10. Deploy
-<% else %>
-5. Deploy
-6. Remove the column rename config from step 1
-7. Remove the VIEW created in step 3 and finally rename the column:
-
-  class Finalize<%= migration_name %> < <%= migration_parent %>
-    def change
-      finalize_column_rename :<%= table_name %>, :<%= column_name %>, :<%= new_column %>
-    end
-  end
-
-8. Deploy
-<% end %>",
+",
 
       change_column_with_not_null:
 "Changing the type is safe, but setting NOT NULL is not.",

data/lib/online_migrations/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.33.1
+  version: 0.33.2
 platform: ruby
 authors:
 - fatkodima