online_migrations 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7125a034a085c11fff526219d8f2483dfea610b100486766145b7caf85e07700
-  data.tar.gz: 609636661c23e939a1766a14097fca30bc01b21666cfcb5e207bc20dfde4923c
+  metadata.gz: bcbf178b59ac7d856b8b3b44640aa30bd5bb0bc61c334d90925562da1ca23782
+  data.tar.gz: 3034174c45f26e4e70a338faa8074bcb4c926160202f6dd85dc43d6ffc5b7101
 SHA512:
-  metadata.gz: 22866111b2a0ba3392d930c60548234f72c1f9dd27309a5b0c5ebff0b06232e5a59d2a6353db51d4c760abdafd90091a8ddf873808fb6cb53bbb755ebc7daf80
-  data.tar.gz: 16643b7af80d9d20e482a5be141e0ecd4733503ff9a80effcd03516af60270227c1c7d604b4b342c70a553e6fe729b83b9b8eb609f87cf9f5c6bde7e3177eb36
+  metadata.gz: 228cbf5deacedaf2017b86a7c6f005c89d454be0fdfe05358d1c33414fa1349cac46fa602901bdb9cf16f2b9bc8f73b6f7e8a935ff754a623182083032d649a4
+  data.tar.gz: 3b05af5c90a084eb64ef0f711e0d9ecb88a0e28d73ae3aa3720bbea525454a63061525aa56c56d251fc8044c6741f9cc94258f6eaf2b1cbd4325c01be86390e7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
 
+## 0.28.0 (2025-06-26)
+
+- Support renaming columns and tables for tables within custom schemas
+- Include operation name into the background schema migrations names
+
+## 0.27.1 (2025-05-08)
+
+- Fix background data migrations to enumerate using the correct shard
+
 ## 0.27.0 (2025-05-01)
 
 - **WARNING**: This release has breaking changes! See `docs/0.27-upgrade.md` for release notes

data/docs/0.27-upgrade.md

@@ -9,7 +9,7 @@ To upgrade:
 * Upgrade gem to v0.27: `gem 'online_migrations', '~> 0.27.0'`
 * Upgrade the gem's initializer in `config/online_migrations.rb` by referring to the [newest contents](https://github.com/fatkodima/online_migrations/blob/master/lib/generators/online_migrations/templates/initializer.rb.tt)
 
-If you don't use any of the [background data migrations](docs/background_data_migrations.md) or [background schema migrations](docs/background_schema_migrations.md), then this is probably all you need.
+If you don't use any of the [background data migrations](background_data_migrations.md) or [background schema migrations](background_schema_migrations.md), then this is probably all you need.
 
 If you use background data migrations:
 
@@ -21,4 +21,4 @@ If you use background data migrations:
   $ bin/rails db:migrate
   ```
 
-Look at [background data migrations guide](docs/background_data_migrations.md) to find the API changes and new features.
+Look at [background data migrations guide](background_data_migrations.md) to find the API changes and new features.

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

@@ -110,6 +110,9 @@ OnlineMigrations.configure do |config|
   # The number of seconds that must pass before the cancelling or pausing data migration is considered stuck.
   config.background_data_migrations.stuck_timeout = 5.minutes
 
+  # The pause interval between each data migration's `process` method execution (in seconds).
+  config.background_data_migrations.iteration_pause = Rails.env.production? ? 0.02 : 0
+
   # The callback to perform when an error occurs during the data migration.
   # config.background_data_migrations.error_handler = ->(error, errored_migration) do
   #   Bugsnag.notify(error) do |notification|

data/lib/online_migrations/background_data_migrations/migration_job.rb

@@ -45,10 +45,6 @@ module OnlineMigrations
         @migration.start
       end
 
-      def around_iteration(&block)
-        @migration.on_shard_if_present(&block)
-      end
-
       def on_resume
         @data_migration.after_resume
       end
@@ -140,6 +136,12 @@ module OnlineMigrations
       end
 
       private
+        # It would be better for sidekiq to have a callback like `around_perform`,
+        # but currently this is the way to make job iteration shard aware.
+        def iterate_with_enumerator(enumerator, arguments)
+          @migration.on_shard_if_present { super }
+        end
+
         THROTTLE_CHECK_INTERVAL = 5 # seconds
         private_constant :THROTTLE_CHECK_INTERVAL
 

data/lib/online_migrations/background_schema_migrations/migration_helpers.rb

@@ -28,7 +28,7 @@ module OnlineMigrations
         schema_creation = ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaCreation.new(self)
         definition = schema_creation.accept(create_index)
 
-        enqueue_background_schema_migration(index.name, table_name, definition: definition, **migration_options)
+        enqueue_background_schema_migration("Add index #{index.name}", table_name, definition: definition, **migration_options)
       end
 
       def remove_index_in_background(table_name, column_name = nil, name:, **options)
@@ -42,7 +42,7 @@ module OnlineMigrations
         end
 
         definition = "DROP INDEX CONCURRENTLY IF EXISTS #{quote_column_name(name)}"
-        enqueue_background_schema_migration(name, table_name, definition: definition, **migration_options)
+        enqueue_background_schema_migration("Remove index #{name}", table_name, definition: definition, **migration_options)
       end
 
       def validate_foreign_key_in_background(from_table, to_table = nil, **options)
@@ -62,7 +62,7 @@ module OnlineMigrations
           ALTER TABLE #{quote_table_name(table_name)}
           VALIDATE CONSTRAINT #{quote_table_name(constraint_name)}
         SQL
-        enqueue_background_schema_migration(constraint_name, table_name, definition: definition, **options)
+        enqueue_background_schema_migration("Validate #{constraint_name}", table_name, definition: definition, **options)
       end
 
       # Ensures that the background schema migration with the provided migration name succeeded.
@@ -78,7 +78,7 @@ module OnlineMigrations
       #   ensure_background_schema_migration_succeeded("index_users_on_email")
       #
       def ensure_background_schema_migration_succeeded(migration_name)
-        migrations = Migration.where(migration_name: migration_name).to_a
+        migrations = Migration.where("migration_name ILIKE ?", "%#{migration_name}%").to_a
 
         if migrations.empty?
           Utils.raise_in_prod_or_say_in_dev("Could not find background schema migration(s): '#{migration_name}'.")
@@ -97,12 +97,13 @@ module OnlineMigrations
         if connection_class_name
           klass = connection_class_name.constantize
           connection_class = Utils.find_connection_class(klass)
-          # Normalize to the real connection class name.
-          connection_class_name = connection_class.name
         else
           connection_class = ActiveRecord::Base
         end
 
+        # Normalize to the real connection class name.
+        connection_class_name = connection_class.name
+
         shards = Utils.shard_names(connection_class)
         shards = [nil] if shards.size == 1
 

data/lib/online_migrations/change_column_type_helpers.rb

@@ -152,7 +152,11 @@ module OnlineMigrations
     #   revert_initialize_column_type_change(:files, :size)
     #
     def revert_initialize_column_type_change(table_name, column_name, _new_type = nil, **_options)
-      cleanup_column_type_change(table_name, column_name)
+      tmp_column_name = __change_type_column(column_name)
+      transaction do
+        __remove_copy_triggers(table_name, column_name, tmp_column_name)
+        remove_column(table_name, tmp_column_name)
+      end
     end
 
     # Same as `revert_initialize_column_type_change` but for multiple columns.
@@ -160,7 +164,12 @@ module OnlineMigrations
     #
     def revert_initialize_columns_type_change(table_name, columns_and_types, **_options)
       column_names = columns_and_types.map(&:first)
-      cleanup_columns_type_change(table_name, *column_names)
+      tmp_column_names = column_names.map { |column_name| __change_type_column(column_name) }
+
+      transaction do
+        __remove_copy_triggers(table_name, column_names, tmp_column_names)
+        remove_columns(table_name, *tmp_column_names)
+      end
     end
 
     # Backfills data from the old column to the new column.
@@ -347,6 +356,7 @@ module OnlineMigrations
     #   the original column type to be able to revert.
     #
     def cleanup_column_type_change(table_name, column_name)
+      __ensure_not_in_transaction!
       cleanup_columns_type_change(table_name, column_name)
     end
 
@@ -354,6 +364,8 @@ module OnlineMigrations
     # @see #cleanup_column_type_change
     #
     def cleanup_columns_type_change(table_name, *column_names)
+      __ensure_not_in_transaction!
+
       tmp_column_names = column_names.map { |column_name| __change_type_column(column_name) }
 
       # Safely remove existing indexes and foreign keys first, if any.

data/lib/online_migrations/error_messages.rb

@@ -230,6 +230,8 @@ during writes works automatically). For most column type changes, this does not
 7. Finally, if everything works as expected, remove copy trigger and old column:
 
   class Cleanup<%= migration_name %> < <%= migration_parent %>
+    disable_ddl_transaction!
+
     def up
       <%= cleanup_code %>
     end

data/lib/online_migrations/schema_cache.rb

@@ -52,15 +52,14 @@ module OnlineMigrations
     private
       def renamed_table?(connection, table_name)
         table_renames = OnlineMigrations.config.table_renames
-        if table_renames.key?(table_name)
-          views = connection.views
-          table_renames[table_name] if views.include?(table_name)
+        if table_renames.key?(table_name) && connection.view_exists?(table_name)
+          table_renames[table_name]
         end
       end
 
       def renamed_column?(connection, table_name)
         column_renames = OnlineMigrations.config.column_renames
-        column_renames.key?(table_name) && connection.views.include?(table_name)
+        column_renames.key?(table_name) && connection.view_exists?(table_name)
       end
 
       def column_rename_table(table_name)
@@ -131,14 +130,21 @@ module OnlineMigrations
       def renamed_table?(pool, table_name)
         table_renames = OnlineMigrations.config.table_renames
         if table_renames.key?(table_name)
-          views = pool.with_connection(&:views)
-          table_renames[table_name] if views.include?(table_name)
+          view_exists = pool.with_connection do |connection|
+            connection.view_exists?(table_name)
+          end
+
+          table_renames[table_name] if view_exists
         end
       end
 
       def renamed_column?(pool, table_name)
         column_renames = OnlineMigrations.config.column_renames
-        column_renames.key?(table_name) && pool.with_connection(&:views).include?(table_name)
+        return false if !column_renames.key?(table_name)
+
+        pool.with_connection do |connection|
+          connection.view_exists?(table_name)
+        end
       end
 
       def column_rename_table(table_name)

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-01 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord