online_migrations 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ddbce66257c9010d8ab7361d8860cd898854207b5a1f4c6aa2b6b797aec2e1
-  data.tar.gz: c21fbb5f535f788e13068e339eebe77f05a378c68c00244c4522a10d50a28a0d
+  metadata.gz: 48361b40b0c34e603f7f18124d458993171da657cf74d0fd58b57529d11fdd6b
+  data.tar.gz: 2036e05bacfbbc000d1a24f1fd1e24406ffdbf89f39f4d125b45795011cb6dec
 SHA512:
-  metadata.gz: a5bbff2a8cca45e5fce79d653db3246bc41a4ab9d314f44131bbf74f2659d610fdaf3e87ac5e22baf7928d0cdb481e19eacaa1ed8945e4ee32f1afac3223273f
-  data.tar.gz: 6e3861f420327e0bccec7ab8e7c0a508e7cf224312c366297834091467d7cdb5e4fac8a305dbb59f7c0650d199d9a17062ab0408fd180b6fbaa05946bfd27545
+  metadata.gz: 774c4870cc1cab99053dea9bddfe4d3e5c37668ba2bb379409beaeb80ca525572a7140877d34005af412d7e4269e2ebc941d1769fb2a6fca1fa7b565207d3afa
+  data.tar.gz: dc57b344bfeb9b2d85ac5e0a56a0cc5dd23ec3081d13d81d6b9293c65ef8f9d5f3ac3b0f3f42b1f84306bc4793ecd95702bb44155fffdc98faaace69ecb3cb60

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## master (unreleased)
 
+## 0.17.0 (2024-04-23)
+
+- Fix background migrations `#progress` possibility to fail with zero division error
+- Add `ensure_background_data_migration_succeeded` and `ensure_background_schema_migration_succeeded` migration helpers
+- Raise in development when background index creation/removal was not enqueued
+- Suggest two migrations for adding foreign keys
+- Reraise errors when running background schema migrations inline
+
+## 0.16.1 (2024-03-29)
+
+- Improve error message when background schema migration name is already taken
+- Fix copying column background migration to work with primary keys added via `initialize_column_type_change`
+
 ## 0.16.0 (2024-03-28)
 
 - Add support for asynchronous creation/removal of indexes

data/README.md

@@ -355,6 +355,8 @@ A safer approach can be accomplished in several steps:
      disable_ddl_transaction!
 
      def up
+       # You can use `backfill_column_for_type_change_in_background` if want to
+       # backfill using background migrations.
        backfill_column_for_type_change :files, :size
      end
 
@@ -860,20 +862,25 @@ end
 
 :white_check_mark: **Good**
 
-Add the foreign key without validating existing rows, and then validate them in a separate transaction.
+Add the foreign key without validating existing rows:
 
 ```ruby
 class AddForeignKeyToProjectsUser < ActiveRecord::Migration[7.1]
-  disable_ddl_transaction!
-
   def change
     add_foreign_key :projects, :users, validate: false
-    validate_foreign_key :projects, :users
   end
 end
 ```
 
-**Note**: If you forget `disable_ddl_transaction!`, the migration will fail.
+Then validate them in a separate migration:
+
+```ruby
+class ValidateForeignKeyOnProjectsUser < ActiveRecord::Migration[7.1]
+  def change
+    validate_foreign_key :projects, :users
+  end
+end
+```
 
 ### Adding an exclusion constraint
 

data/docs/background_data_migrations.md

@@ -80,16 +80,16 @@ You can enqueue your background migration to be run by the scheduler via:
 # db/migrate/xxxxxxxxxxxxxx_enqueue_backfill_project_issues_count.rb
 class EnqueueBackfillProjectIssuesCount < ActiveRecord::Migration[7.1]
   def up
-    enqueue_background_migration("BackfillProjectIssuesCount")
+    enqueue_background_data_migration("BackfillProjectIssuesCount")
   end
 
   def down
-    remove_background_migration("BackfillProjectIssuesCount")
+    remove_background_data_migration("BackfillProjectIssuesCount")
   end
 end
 ```
 
-`enqueue_background_migration` accepts additional configuration options which controls how the background migration is run. Check the [source code](https://github.com/fatkodima/online_migrations/blob/master/lib/online_migrations/background_migrations/migration_helpers.rb) for the list of all available configuration options.
+`enqueue_background_data_migration` accepts additional configuration options which controls how the background migration is run. Check the [source code](https://github.com/fatkodima/online_migrations/blob/master/lib/online_migrations/background_migrations/migration_helpers.rb) for the list of all available configuration options.
 
 ## Custom Background Migration Arguments
 
@@ -112,7 +112,7 @@ And pass them when enqueuing:
 
 ```ruby
 def up
-  enqueue_background_migration("MyMigrationWithArgs", arg1, arg2, ...)
+  enqueue_background_data_migration("MyMigrationWithArgs", arg1, arg2, ...)
 end
 ```
 
@@ -120,7 +120,7 @@ Make sure to also pass the arguments inside the `down` method of the migration:
 
 ```ruby
 def down
-  remove_background_migration("MyMigrationWithArgs", arg1, arg2, ...)
+  remove_background_data_migration("MyMigrationWithArgs", arg1, arg2, ...)
 end
 ```
 
@@ -140,6 +140,10 @@ end
 
 **Note**: These migration helpers should be run inside the migration against the database where background migrations tables are defined.
 
+## Depending on migrated data
+
+You shouldn't depend on the data until the background data migration is finished. If having 100% of the data migrated is a requirement, then the `ensure_background_data_migration_succeeded` helper can be used to guarantee that the migration succeeded and the data fully migrated.
+
 ## Testing
 
 At a minimum, it's recommended that the `#process_batch` method in your background migration is tested. You may also want to test the `#relation` and `#count` methods if they are sufficiently complex.

data/docs/background_schema_migrations.md

@@ -62,6 +62,10 @@ end
 
 `add_index_in_background`/`remove_index_in_background` accept additional configuration options which controls how the background schema migration is run. Check the [source code](https://github.com/fatkodima/online_migrations/blob/master/lib/online_migrations/background_schema_migrations/migration_helpers.rb) for the list of all available configuration options.
 
+## Depending on schema changes
+
+You shouldn't depend on the schema until the background schema migration is finished. If having the schema migrated is a requirement, then the `ensure_background_schema_migration_succeeded` helper can be used to guarantee that the migration succeeded and the schema change applied.
+
 ## Instrumentation
 
 Background schema migrations use the [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) API.

data/lib/generators/online_migrations/background_migration_generator.rb

@@ -11,7 +11,7 @@ module OnlineMigrations
     source_root File.expand_path("templates", __dir__)
     desc "This generator creates a background migration related files."
 
-    def create_background_migration_file
+    def create_background_data_migration_file
       migrations_module_file_path = migrations_module.underscore
 
       template_file = File.join(
@@ -20,7 +20,7 @@ module OnlineMigrations
         class_path,
         "#{file_name}.rb"
       )
-      template("background_migration.rb", template_file)
+      template("background_data_migration.rb", template_file)
     end
 
     def create_migration_file

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

@@ -1,10 +1,10 @@
 class Enqueue<%= class_name %> < <%= migration_parent %>
   def up
-    enqueue_background_migration("<%= class_name %>", ...args)
+    enqueue_background_data_migration("<%= class_name %>", ...args)
   end
 
   def down
     # Make sure to pass the same arguments as in the "up" method, if any.
-    remove_background_migration("<%= class_name %>", ...args)
+    remove_background_data_migration("<%= class_name %>", ...args)
   end
 end

data/lib/online_migrations/background_migrations/copy_column.rb

@@ -25,10 +25,7 @@ module OnlineMigrations
       end
 
       def relation
-        model
-          .unscoped
-          .where(copy_to.index_with(nil))
-          .where.not(copy_from.index_with(nil))
+        model.unscoped
       end
 
       def process_batch(relation)

data/lib/online_migrations/background_migrations/migration.rb

@@ -5,7 +5,7 @@ module OnlineMigrations
     # Class representing background data migration.
     #
     # @note The records of this class should not be created manually, but via
-    #   `enqueue_background_migration` helper inside migrations.
+    #   `enqueue_background_data_migration` helper inside migrations.
     #
     class Migration < ApplicationRecord
       STATUSES = [
@@ -20,6 +20,7 @@ module OnlineMigrations
       self.table_name = :background_migrations
 
       scope :queue_order, -> { order(created_at: :asc) }
+      scope :parents, -> { where(parent_id: nil) }
       scope :runnable, -> { where(composite: false) }
       scope :active, -> { where(status: [statuses[:enqueued], statuses[:running]]) }
       scope :except_succeeded, -> { where.not(status: :succeeded) }
@@ -125,7 +126,7 @@ module OnlineMigrations
 
             progresses.sum.round(2)
           end
-        elsif rows_count
+        elsif rows_count && rows_count > 0
           jobs_rows_count = migration_jobs.succeeded.sum(:batch_size)
           # The last migration job may need to process the amount of rows
           # less than the batch size, so we can get a value > 1.0.
@@ -179,6 +180,20 @@ module OnlineMigrations
         end
       end
 
+      # Returns the time this migration started running.
+      def started_at
+        # To be precise, we should get the minimum of `started_at` amongst the children jobs
+        # (for simple migrations) and amongst the children migrations (for composite migrations).
+        # But we do not have an appropriate index on the jobs table and using this will lead to
+        # N+1 queries if used inside some dashboard, for example.
+        created_at
+      end
+
+      # Returns the time this migration finished running.
+      def finished_at
+        updated_at if completed?
+      end
+
       # @private
       def on_shard(&block)
         abstract_class = Utils.find_connection_class(migration_model)

data/lib/online_migrations/background_migrations/migration_helpers.rb

@@ -11,7 +11,7 @@ module OnlineMigrations
       # @param model_name [String] If Active Record multiple databases feature is used,
       #     the class name of the model to get connection from.
       # @param options [Hash] used to control the behavior of background migration.
-      #     See `#enqueue_background_migration`
+      #     See `#enqueue_background_data_migration`
       #
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
@@ -48,7 +48,7 @@ module OnlineMigrations
 
         model_name = model_name.name if model_name.is_a?(Class)
 
-        enqueue_background_migration(
+        enqueue_background_data_migration(
           "BackfillColumn",
           table_name,
           updates,
@@ -67,7 +67,7 @@ module OnlineMigrations
       #     For example when changing from `text` to `jsonb`. In this case, use the `type_cast_function` option.
       #     You need to make sure there is no bad data and the cast will always succeed
       # @param options [Hash] used to control the behavior of background migration.
-      #     See `#enqueue_background_migration`
+      #     See `#enqueue_background_data_migration`
       #
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
@@ -110,7 +110,7 @@ module OnlineMigrations
         tmp_columns = column_names.map { |column_name| "#{column_name}_for_type_change" }
         model_name = model_name.name if model_name.is_a?(Class)
 
-        enqueue_background_migration(
+        enqueue_background_data_migration(
           "CopyColumn",
           table_name,
           column_names,
@@ -132,7 +132,7 @@ module OnlineMigrations
       #     For example when changing from `text` to `jsonb`. In this case, use the `type_cast_function` option.
       #     You need to make sure there is no bad data and the cast will always succeed
       # @param options [Hash] used to control the behavior of background migration.
-      #     See `#enqueue_background_migration`
+      #     See `#enqueue_background_data_migration`
       #
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
@@ -167,7 +167,7 @@ module OnlineMigrations
 
         model_name = model_name.name if model_name.is_a?(Class)
 
-        enqueue_background_migration(
+        enqueue_background_data_migration(
           "CopyColumn",
           table_name,
           copy_from,
@@ -187,7 +187,7 @@ module OnlineMigrations
       #   - when `true` - will touch `updated_at` and/or `updated_on`
       #   - when `Symbol` or `Array` - will touch specific column(s)
       # @param options [Hash] used to control the behavior of background migration.
-      #     See `#enqueue_background_migration`
+      #     See `#enqueue_background_data_migration`
       #
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
@@ -208,7 +208,7 @@ module OnlineMigrations
       def reset_counters_in_background(model_name, *counters, touch: nil, **options)
         model_name = model_name.name if model_name.is_a?(Class)
 
-        enqueue_background_migration(
+        enqueue_background_data_migration(
           "ResetCounters",
           model_name,
           counters,
@@ -224,7 +224,7 @@ module OnlineMigrations
       # @param model_name [String]
       # @param associations [Array]
       # @param options [Hash] used to control the behavior of background migration.
-      #     See `#enqueue_background_migration`
+      #     See `#enqueue_background_data_migration`
       #
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
@@ -237,7 +237,7 @@ module OnlineMigrations
       def delete_orphaned_records_in_background(model_name, *associations, **options)
         model_name = model_name.name if model_name.is_a?(Class)
 
-        enqueue_background_migration(
+        enqueue_background_data_migration(
           "DeleteOrphanedRecords",
           model_name,
           associations,
@@ -253,7 +253,7 @@ module OnlineMigrations
       # @param record_id [Integer, String] parent record primary key's value
       # @param association [String, Symbol] association name for which records will be removed
       # @param options [Hash] used to control the behavior of background migration.
-      #     See `#enqueue_background_migration`
+      #     See `#enqueue_background_data_migration`
       #
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
@@ -266,7 +266,7 @@ module OnlineMigrations
       def delete_associated_records_in_background(model_name, record_id, association, **options)
         model_name = model_name.name if model_name.is_a?(Class)
 
-        enqueue_background_migration(
+        enqueue_background_data_migration(
           "DeleteAssociatedRecords",
           model_name,
           record_id,
@@ -284,7 +284,7 @@ module OnlineMigrations
       #     Relation-wide available actions: `:delete_all`, `:destroy_all`, and `:update_all`.
       # @param updates [Hash] updates to perform when `action` is set to `:update_all`
       # @param options [Hash] used to control the behavior of background migration.
-      #     See `#enqueue_background_migration`
+      #     See `#enqueue_background_data_migration`
       #
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
@@ -312,7 +312,7 @@ module OnlineMigrations
       def perform_action_on_relation_in_background(model_name, conditions, action, updates: nil, **options)
         model_name = model_name.name if model_name.is_a?(Class)
 
-        enqueue_background_migration(
+        enqueue_background_data_migration(
           "PerformActionOnRelation",
           model_name,
           conditions,
@@ -344,7 +344,7 @@ module OnlineMigrations
       # @return [OnlineMigrations::BackgroundMigrations::Migration]
       #
       # @example
-      #   enqueue_background_migration("BackfillProjectIssuesCount",
+      #   enqueue_background_data_migration("BackfillProjectIssuesCount",
       #       batch_size: 10_000, batch_max_attempts: 10)
       #
       #   # Given the background migration exists:
@@ -369,8 +369,8 @@ module OnlineMigrations
       # @note For convenience, the enqueued background migration is run inline
       #     in development and test environments
       #
-      def enqueue_background_migration(migration_name, *arguments, **options)
-        migration = create_background_migration(migration_name, *arguments, **options)
+      def enqueue_background_data_migration(migration_name, *arguments, **options)
+        migration = create_background_data_migration(migration_name, *arguments, **options)
 
         if Utils.run_background_migrations_inline?
           runner = MigrationRunner.new(migration)
@@ -379,6 +379,7 @@ module OnlineMigrations
 
         migration
       end
+      alias enqueue_background_migration enqueue_background_data_migration
 
       # Removes the background migration for the given class name and arguments, if exists.
       #
@@ -386,15 +387,54 @@ module OnlineMigrations
       # @param arguments [Array] Extra arguments the migration was originally created with
       #
       # @example
-      #   remove_background_migration("BackfillProjectIssuesCount")
+      #   remove_background_data_migration("BackfillProjectIssuesCount")
       #
-      def remove_background_migration(migration_name, *arguments)
+      def remove_background_data_migration(migration_name, *arguments)
         migration_name = migration_name.name if migration_name.is_a?(Class)
         Migration.for_configuration(migration_name, arguments).delete_all
       end
+      alias remove_background_migration remove_background_data_migration
+
+      # Ensures that the background data migration with the provided configuration succeeded.
+      #
+      # If the enqueued migration was not found in development (probably when resetting a dev environment
+      # followed by `db:migrate`), then a log warning is printed.
+      # If enqueued migration was not found in production, then the error is raised.
+      # If enqueued migration was found but is not succeeded, then the error is raised.
+      #
+      # @param migration_name [String, Class] Background migration job class name
+      # @param arguments [Array, nil] Arguments with which background migration was enqueued
+      #
+      # @example Without arguments
+      #   ensure_background_data_migration_succeeded("BackfillProjectIssuesCount")
+      #
+      # @example With arguments
+      #   ensure_background_data_migration_succeeded("CopyColumn", arguments: ["users", "id", "id_for_type_change"])
+      #
+      def ensure_background_data_migration_succeeded(migration_name, arguments: nil)
+        migration_name = migration_name.name if migration_name.is_a?(Class)
+
+        configuration = { migration_name: migration_name }
+
+        if arguments
+          arguments = Array(arguments)
+          migration = Migration.parents.for_configuration(migration_name, arguments).first
+          configuration[:arguments] = arguments.to_json
+        else
+          migration = Migration.parents.for_migration_name(migration_name).first
+        end
+
+        if migration.nil?
+          Utils.raise_in_prod_or_say_in_dev("Could not find background data migration for the given configuration: #{configuration}")
+        elsif !migration.succeeded?
+          raise "Expected background data migration for the given configuration to be marked as 'succeeded', " \
+                "but it is '#{migration.status}': #{configuration}"
+        end
+      end
+      alias ensure_background_migration_succeeded ensure_background_data_migration_succeeded
 
       # @private
-      def create_background_migration(migration_name, *arguments, **options)
+      def create_background_data_migration(migration_name, *arguments, **options)
         options.assert_valid_keys(:batch_column_name, :min_value, :max_value, :batch_size, :sub_batch_size,
             :batch_pause, :sub_batch_pause_ms, :batch_max_attempts)
 

data/lib/online_migrations/background_schema_migrations/migration.rb

@@ -20,6 +20,7 @@ module OnlineMigrations
       self.table_name = :background_schema_migrations
 
       scope :queue_order, -> { order(created_at: :asc) }
+      scope :parents, -> { where(parent_id: nil) }
       scope :runnable, -> { where(composite: false) }
       scope :active, -> { where(status: [statuses[:enqueued], statuses[:running]]) }
       scope :except_succeeded, -> { where.not(status: :succeeded) }
@@ -57,9 +58,18 @@ module OnlineMigrations
       belongs_to :parent, class_name: name, optional: true
       has_many :children, class_name: name, foreign_key: :parent_id
 
-      validates :migration_name, presence: true, uniqueness: { scope: :shard }
       validates :table_name, presence: true, length: { maximum: MAX_IDENTIFIER_LENGTH }
       validates :definition, presence: true
+      validates :migration_name, presence: true, uniqueness: {
+        scope: :shard,
+        message: ->(object, data) do
+          message = "(#{data[:value]}) has already been taken."
+          if object.index_addition?
+            message += " Consider enqueuing index creation with a different index name via a `:name` option."
+          end
+          message
+        end,
+      }
 
       validate :validate_children_statuses, if: -> { composite? && status_changed? }
       validate :validate_connection_class, if: :connection_class_name?
@@ -81,7 +91,14 @@ module OnlineMigrations
           100.0
         elsif composite?
           progresses = children.map(&:progress)
-          (progresses.sum.to_f / progresses.size).round(2)
+          # There should not be composite migrations without children,
+          # but children may be deleted for some reason, so we need to
+          # make a check to avoid 0 division error.
+          if progresses.any?
+            (progresses.sum.to_f / progresses.size).round(2)
+          else
+            0.0
+          end
         else
           0.0
         end
@@ -107,6 +124,10 @@ module OnlineMigrations
         end
       end
 
+      def index_addition?
+        definition.match?(/create (unique )?index/i)
+      end
+
       # @private
       def connection_class
         if connection_class_name && (klass = connection_class_name.safe_constantize)
@@ -130,8 +151,7 @@ module OnlineMigrations
             statement_timeout = self.statement_timeout || OnlineMigrations.config.statement_timeout
 
             with_statement_timeout(connection, statement_timeout) do
-              case definition
-              when /create (unique )?index/i
+              if index_addition?
                 index = connection.indexes(table_name).find { |i| i.name == name }
                 if index
                   # Use index validity from https://github.com/rails/rails/pull/45160

data/lib/online_migrations/background_schema_migrations/migration_helpers.rb

@@ -7,7 +7,7 @@ module OnlineMigrations
         migration_options = options.extract!(:max_attempts, :statement_timeout, :connection_class_name)
 
         if index_exists?(table_name, column_name, **options)
-          Utils.say("Index creation was not enqueued because the index already exists.")
+          Utils.raise_or_say("Index creation was not enqueued because the index already exists.")
           return
         end
 
@@ -27,7 +27,7 @@ module OnlineMigrations
         migration_options = options.extract!(:max_attempts, :statement_timeout, :connection_class_name)
 
         if !index_exists?(table_name, column_name, **options, name: name)
-          Utils.say("Index deletion was not enqueued because the index does not exist.")
+          Utils.raise_or_say("Index deletion was not enqueued because the index does not exist.")
           return
         end
 
@@ -35,6 +35,29 @@ module OnlineMigrations
         enqueue_background_schema_migration(name, table_name, definition: definition, **migration_options)
       end
 
+      # Ensures that the background schema migration with the provided migration name succeeded.
+      #
+      # If the enqueued migration was not found in development (probably when resetting a dev environment
+      # followed by `db:migrate`), then a log warning is printed.
+      # If enqueued migration was not found in production, then the error is raised.
+      # If enqueued migration was found but is not succeeded, then the error is raised.
+      #
+      # @param migration_name [String, Symbol] Background schema migration name
+      #
+      # @example
+      #   ensure_background_schema_migration_succeeded("index_users_on_email")
+      #
+      def ensure_background_schema_migration_succeeded(migration_name)
+        migration = Migration.parents.find_by(migration_name: migration_name)
+
+        if migration.nil?
+          Utils.raise_in_prod_or_say_in_dev("Could not find background schema migration: '#{migration_name}'")
+        elsif !migration.succeeded?
+          raise "Expected background schema migration '#{migration_name}' to be marked as 'succeeded', " \
+                "but it is '#{migration.status}'."
+        end
+      end
+
       def enqueue_background_schema_migration(name, table_name, **options)
         if options[:connection_class_name].nil? && Utils.multiple_databases?
           raise ArgumentError, "You must pass a :connection_class_name when using multiple databases."

data/lib/online_migrations/background_schema_migrations/migration_runner.rb

@@ -76,6 +76,7 @@ module OnlineMigrations
           )
 
           ::OnlineMigrations.config.background_schema_migrations.error_handler.call(e, migration)
+          raise if Utils.run_background_migrations_inline?
         end
 
         def should_throttle?

data/lib/online_migrations/command_recorder.rb

@@ -25,8 +25,8 @@ module OnlineMigrations
       :remove_text_limit_constraint,
       :add_reference_concurrently,
       :change_column_type_in_background,
-      :enqueue_background_migration,
-      :remove_background_migration,
+      :enqueue_background_data_migration,
+      :remove_background_data_migration,
 
       # column type change helpers
       :initialize_column_type_change,

data/lib/online_migrations/error_messages.rb

@@ -203,9 +203,9 @@ which will be passed to `add_column` when creating a new column, so you can over
     disable_ddl_transaction!
 
     def up
-      <%= backfill_code %>
       # You can use `backfill_column_for_type_change_in_background` if want to
       # backfill using background migrations.
+      <%= backfill_code %>
     end
 
     def down
@@ -393,14 +393,17 @@ end",
 A safer approach is to create the new index and then delete the old one.",
 
       add_foreign_key:
-"Adding a foreign key blocks writes on both tables. Add the foreign key without validating existing rows,
-and then validate them in a separate transaction.
+"Adding a foreign key blocks writes on both tables. Instead, add the foreign key without validating existing rows,
+then validate them in a separate migration.
 
 class <%= migration_name %> < <%= migration_parent %>
-  disable_ddl_transaction!
-
   def change
     <%= add_code %>
+  end
+end
+
+class Validate<%= migration_name %> < <%= migration_parent %>
+  def change
     <%= validate_code %>
   end
 end",

data/lib/online_migrations/migration.rb

@@ -12,6 +12,7 @@ module OnlineMigrations
       super
     ensure
       VerboseSqlLogs.disable if verbose_sql_logs?
+      OnlineMigrations.current_migration = nil
     end
 
     # @private

data/lib/online_migrations/utils.rb

@@ -32,6 +32,22 @@ module OnlineMigrations
         end
       end
 
+      def raise_or_say(message)
+        if developer_env?
+          raise message
+        else
+          say(message)
+        end
+      end
+
+      def raise_in_prod_or_say_in_dev(message)
+        if developer_env?
+          say(message)
+        else
+          raise message
+        end
+      end
+
       def warn(message)
         Kernel.warn("[online_migrations] #{message}")
       end

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -40,7 +40,7 @@ files:
 - lib/generators/online_migrations/background_migration_generator.rb
 - lib/generators/online_migrations/install_generator.rb
 - lib/generators/online_migrations/templates/add_sharding_to_online_migrations.rb.tt
-- lib/generators/online_migrations/templates/background_migration.rb.tt
+- lib/generators/online_migrations/templates/background_data_migration.rb.tt
 - lib/generators/online_migrations/templates/create_background_schema_migrations.rb.tt
 - lib/generators/online_migrations/templates/initializer.rb.tt
 - lib/generators/online_migrations/templates/install_migration.rb.tt