online_migrations 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ceda570f99a1712496ac5c9549859c7dc2cad7e3cc4ab59c97a22ba17f3bfd0
-  data.tar.gz: dfc5a83147a92bf5e04a532210e72b6f32f561f032b2a1b746ff142bf4e16635
+  metadata.gz: a5db4da5657a6887113af46baa5c5ec9a6906ba4f8e3d33afc3d81f378f9b5ae
+  data.tar.gz: 0acf2706e6b453055d41f338908323a0672066b6e742724b8a6d588e969ca05f
 SHA512:
-  metadata.gz: 0ff6cce820134ef6b893f9405b71a0d8f8cd42dd79616123aaa492983671ebcff98dbff21477afa78b29342d40098822da4b8de0306489faf956b21ee44e2113
-  data.tar.gz: 42dcf132290c9affe812ef7489397d4c05d48f33069f3ee09710fced6aaf8ac928fee63c1498333657a824f98885e3af5e706e4dcc4a089b9cd62284ad0223d1
+  metadata.gz: 4a1b97dceb858d5c6ebd6ddccab4ea0b3ed8d257074f1e7f6562f101b3ae002ac19576053a44fe765624350c40d6e269d753fd24be5b5419474036a308b5cce5
+  data.tar.gz: 9b6a3ece26c9e3e679c5d8d0f827eda7aa10b591242440a18d2a0fb18aa8f16b16935db6654859aab9b6f5008160e117c2eb32e98571261127d1a6ac1e936f2c

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## master (unreleased)
 
+## 0.12.0 (2024-01-18)
+
+- Require passing model name for background migration helpers when using multiple databases
+- Add `statement_timeout` configuration option
+
+- Make `lock_timeout` argument optional for `config.lock_retrier`
+
+    This way, a default lock timeout value will be used (configured in `database.yml` or for the database user).
+
+- Fix a bug that can lead to unfinished children of a sharded background migration
+
+## 0.11.1 (2024-01-11)
+
+- Fix calculation of batch ranges for sharded background migrations
+
 ## 0.11.0 (2024-01-09)
 
 - Support sharding for background migrations

data/docs/configuring.md

@@ -59,22 +59,33 @@ Check the [source code](https://github.com/fatkodima/online_migrations/blob/mast
 ## Migration Timeouts
 
 It’s extremely important to set a short lock timeout for migrations. This way, if a migration can't acquire a lock in a timely manner, other statements won't be stuck behind it.
+We also recommend setting a long statement timeout so migrations can run for a while.
 
-Add timeouts to `config/database.yml`:
+You can configure a statement timeout for migrations via:
 
-```yml
-production:
-  connect_timeout: 5
-  variables:
-    lock_timeout: 10s
-    statement_timeout: 15s
+```ruby
+config.statement_timeout = 1.hour
 ```
 
+and a lock timeout for migrations can be configured via the `lock_retrier`.
+
 Or set the timeouts directly on the database user that runs migrations:
 
 ```sql
 ALTER ROLE myuser SET lock_timeout = '10s';
-ALTER ROLE myuser SET statement_timeout = '15s';
+ALTER ROLE myuser SET statement_timeout = '1h';
+```
+
+## App Timeouts
+
+We recommend adding timeouts to `config/database.yml` to prevent connections from hanging and individual queries from taking up too many resources in controllers, jobs, the Rails console, and other places.
+
+```yml
+production:
+  connect_timeout: 5
+  variables:
+    lock_timeout: 10s
+    statement_timeout: 15s
 ```
 
 ## Lock Timeout Retries
@@ -86,7 +97,7 @@ config.lock_retrier = OnlineMigrations::ExponentialLockRetrier.new(
   attempts: 30,                # attempt 30 retries
   base_delay: 0.01.seconds,    # starting with delay of 10ms between each unsuccessful try, increasing exponentially
   max_delay: 1.minute,         # maximum delay is 1 minute
-  lock_timeout: 0.2.seconds    # and 200ms set as lock timeout for each try
+  lock_timeout: 0.2.seconds    # and 200ms set as lock timeout for each try. Remove this line to use a default lock timeout.
 )
 ```
 
@@ -192,7 +203,7 @@ To enable verbose sql logs:
 config.verbose_sql_logs = true
 ```
 
-This feature is enabled by default in a production Rails environment. You can override this setting via `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.
+This feature is enabled by default in a staging and production Rails environments. You can override this setting via `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.
 
 ## Analyze Tables
 

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

@@ -4,6 +4,9 @@ OnlineMigrations.configure do |config|
   # Configure the migration version starting after which checks are performed.
   # config.start_after = <%= start_after %>
 
+  # Configure statement timeout used for migrations.
+  config.statement_timeout = 1.hour
+
   # Set the version of the production database so the right checks are run in development.
   # config.target_version = 10
 
@@ -48,7 +51,7 @@ OnlineMigrations.configure do |config|
   # a better grasp of what is going on for high-level statements like add_column_with_default.
   #
   # Note: It can be overridden by `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.
-  config.verbose_sql_logs = defined?(Rails) && Rails.env.production?
+  config.verbose_sql_logs = defined?(Rails.env) && (Rails.env.production? || Rails.env.staging?)
 
   # Lock retries.
   # Configure your custom lock retrier (see LockRetrier).
@@ -57,7 +60,7 @@ OnlineMigrations.configure do |config|
     attempts: 30,                # attempt 30 retries
     base_delay: 0.01.seconds,    # starting with delay of 10ms between each unsuccessful try, increasing exponentially
     max_delay: 1.minute,         # up to the maximum delay of 1 minute
-    lock_timeout: 0.2.seconds    # and 200ms set as lock timeout for each try
+    lock_timeout: 0.2.seconds    # and 200ms set as lock timeout for each try. Remove this line to use a default lock timeout.
   )
 
   # Configure tables that are in the process of being renamed.
@@ -75,6 +78,10 @@ OnlineMigrations.configure do |config|
   # end
 
   # ==> Background migrations configuration
+
+  # The module in which background migrations will be placed.
+  # config.background_migrations.migrations_module = "OnlineMigrations::BackgroundMigrations"
+
   # The number of rows to process in a single background migration run.
   # config.background_migrations.batch_size = 20_000
 

data/lib/online_migrations/background_migrations/config.rb

@@ -4,7 +4,7 @@ module OnlineMigrations
   module BackgroundMigrations
     # Class representing configuration options for background migrations.
     class Config
-      # The module to namespace background migrations in
+      # The module in which background migrations will be placed
       # @return [String] defaults to "OnlineMigrations::BackgroundMigrations"
       attr_accessor :migrations_module
 

data/lib/online_migrations/background_migrations/migration.rb

@@ -2,6 +2,11 @@
 
 module OnlineMigrations
   module BackgroundMigrations
+    # Class representing background data migration.
+    #
+    # @note The records of this class should not be created manually, but via
+    #   `enqueue_background_migration` helper inside migrations.
+    #
     class Migration < ApplicationRecord
       STATUSES = [
         :enqueued,    # The migration has been enqueued by the user.
@@ -26,8 +31,8 @@ module OnlineMigrations
       enum status: STATUSES.index_with(&:to_s)
 
       belongs_to :parent, class_name: name, optional: true
-      has_many :children, class_name: name, foreign_key: :parent_id
-      has_many :migration_jobs
+      has_many :children, class_name: name, foreign_key: :parent_id, dependent: :delete_all
+      has_many :migration_jobs, dependent: :delete_all
 
       validates :migration_name, :batch_column_name, presence: true
 
@@ -47,7 +52,6 @@ module OnlineMigrations
       validates_with MigrationStatusValidator, on: :update
 
       before_validation :set_defaults
-      before_create :create_child_migrations, if: :composite?
       before_update :copy_attributes_to_children, if: :composite?
 
       # @private
@@ -57,6 +61,7 @@ module OnlineMigrations
       end
 
       def migration_name=(class_name)
+        class_name = class_name.name if class_name.is_a?(Class)
         write_attribute(:migration_name, self.class.normalize_migration_name(class_name))
       end
 
@@ -102,9 +107,15 @@ module OnlineMigrations
         if succeeded?
           100.0
         elsif composite?
-          progresses = children.map(&:progress).compact
-          if progresses.any?
-            (progresses.sum / progresses.size).round(2)
+          rows_counts = children.to_a.pluck(:rows_count)
+          if rows_counts.none?(nil)
+            total_rows_count = rows_counts.sum
+
+            progresses = children.map do |child|
+              child.progress * child.rows_count / total_rows_count # weighted progress
+            end
+
+            progresses.sum.round(2)
           end
         elsif rows_count
           jobs_rows_count = migration_jobs.succeeded.sum(:batch_size)
@@ -181,15 +192,17 @@ module OnlineMigrations
         iterator = BatchIterator.new(migration_relation)
         batch_range = nil
 
-        # rubocop:disable Lint/UnreachableLoop
-        iterator.each_batch(of: batch_size, column: batch_column_name, start: next_min_value) do |relation|
-          min = relation.arel_table[batch_column_name].minimum
-          max = relation.arel_table[batch_column_name].maximum
-          batch_range = relation.pick(min, max)
+        on_shard do
+          # rubocop:disable Lint/UnreachableLoop
+          iterator.each_batch(of: batch_size, column: batch_column_name, start: next_min_value) do |relation|
+            min = relation.arel_table[batch_column_name].minimum
+            max = relation.arel_table[batch_column_name].maximum
+            batch_range = relation.pick(min, max)
 
-          break
+            break
+          end
+          # rubocop:enable Lint/UnreachableLoop
         end
-        # rubocop:enable Lint/UnreachableLoop
 
         return if batch_range.nil?
 
@@ -201,10 +214,6 @@ module OnlineMigrations
         [min_value, max_value]
       end
 
-      protected
-        attr_accessor :child
-        alias child? child
-
       private
         def validate_batch_column_values
           if max_value.to_i < min_value.to_i
@@ -234,11 +243,6 @@ module OnlineMigrations
 
         def set_defaults
           if migration_relation.is_a?(ActiveRecord::Relation)
-            if !child?
-              shards = Utils.shard_names(migration_model)
-              self.composite = shards.size > 1
-            end
-
             self.batch_column_name ||= migration_relation.primary_key
 
             if composite?
@@ -268,25 +272,13 @@ module OnlineMigrations
           self.batch_max_attempts   ||= config.batch_max_attempts
         end
 
-        def create_child_migrations
-          shards = Utils.shard_names(migration_model)
-
-          children = shards.map do |shard|
-            child = Migration.new(migration_name: migration_name, arguments: arguments, shard: shard)
-            child.child = true
-            child
-          end
-
-          self.children = children
-        end
-
         def copy_attributes_to_children
           attributes = [:batch_size, :sub_batch_size, :batch_pause, :sub_batch_pause_ms, :batch_max_attempts]
           updates = {}
           attributes.each do |attribute|
             updates[attribute] = read_attribute(attribute) if attribute_changed?(attribute)
           end
-          children.update_all(updates) if updates.any?
+          children.active.update_all(updates) if updates.any?
         end
 
         def next_min_value

data/lib/online_migrations/background_migrations/migration_helpers.rb

@@ -42,6 +42,10 @@ module OnlineMigrations
       # @see #backfill_column_in_background
       #
       def backfill_columns_in_background(table_name, updates, model_name: nil, **options)
+        if model_name.nil? && Utils.multiple_databases?
+          raise ArgumentError, "You must pass a :model_name when using multiple databases."
+        end
+
         model_name = model_name.name if model_name.is_a?(Class)
 
         enqueue_background_migration(
@@ -99,6 +103,10 @@ module OnlineMigrations
       #
       def backfill_columns_for_type_change_in_background(table_name, *column_names, model_name: nil,
                                                          type_cast_functions: {}, **options)
+        if model_name.nil? && Utils.multiple_databases?
+          raise ArgumentError, "You must pass a :model_name when using multiple databases."
+        end
+
         tmp_columns = column_names.map { |column_name| "#{column_name}_for_type_change" }
         model_name = model_name.name if model_name.is_a?(Class)
 
@@ -153,6 +161,10 @@ module OnlineMigrations
       # @see #copy_column_in_background
       #
       def copy_columns_in_background(table_name, copy_from, copy_to, model_name: nil, type_cast_functions: {}, **options)
+        if model_name.nil? && Utils.multiple_databases?
+          raise ArgumentError, "You must pass a :model_name when using multiple databases."
+        end
+
         model_name = model_name.name if model_name.is_a?(Class)
 
         enqueue_background_migration(
@@ -358,23 +370,41 @@ module OnlineMigrations
       #     in development and test environments
       #
       def enqueue_background_migration(migration_name, *arguments, **options)
+        migration = create_background_migration(migration_name, *arguments, **options)
+
+        # For convenience in dev/test environments
+        if Utils.developer_env?
+          runner = MigrationRunner.new(migration)
+          runner.run_all_migration_jobs
+        end
+
+        migration
+      end
+
+      # @private
+      def create_background_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)
 
-        migration_name = migration_name.name if migration_name.is_a?(Class)
-
-        migration = Migration.create!(
+        migration = Migration.new(
           migration_name: migration_name,
           arguments: arguments,
           **options
         )
 
-        # For convenience in dev/test environments
-        if Utils.developer_env?
-          runner = MigrationRunner.new(migration)
-          runner.run_all_migration_jobs
+        shards = Utils.shard_names(migration.migration_model)
+        if shards.size > 1
+          migration.children = shards.map do |shard|
+            child = migration.dup
+            child.shard = shard
+            child
+          end
+
+          migration.composite = true
         end
 
+        # This will save all the records using a transaction.
+        migration.save!
         migration
       end
     end

data/lib/online_migrations/background_migrations/migration_runner.rb

@@ -14,10 +14,7 @@ module OnlineMigrations
       def run_migration_job
         raise "Should not be called on a composite (with sharding) migration" if migration.composite?
 
-        if migration.enqueued?
-          migration.running!
-          migration.parent.running! if migration.parent && migration.parent.enqueued?
-        end
+        mark_as_running if migration.enqueued?
         migration_payload = notifications_payload(migration)
 
         if !migration.migration_jobs.exists?
@@ -57,7 +54,7 @@ module OnlineMigrations
         raise "This method is not intended for use in production environments" if !Utils.developer_env?
         return if migration.completed?
 
-        migration.running!
+        mark_as_running
 
         if migration.composite?
           migration.children.each do |child_migration|
@@ -96,6 +93,13 @@ module OnlineMigrations
       end
 
       private
+        def mark_as_running
+          Migration.transaction do
+            migration.running!
+            migration.parent.running! if migration.parent && migration.parent.enqueued?
+          end
+        end
+
         def should_throttle?
           ::OnlineMigrations.config.background_migrations.throttler.call
         end

data/lib/online_migrations/command_checker.rb

@@ -31,6 +31,7 @@ module OnlineMigrations
 
     def check(command, *args, &block)
       check_database_version
+      set_statement_timeout
       check_lock_timeout
 
       if !safe?
@@ -98,6 +99,16 @@ module OnlineMigrations
         @database_version_checked = true
       end
 
+      def set_statement_timeout
+        if !@statement_timeout_set
+          if (statement_timeout = OnlineMigrations.config.statement_timeout)
+            # TODO: inline this method call after deprecated `disable_statement_timeout` method removal.
+            connection.__set_statement_timeout(statement_timeout)
+          end
+          @statement_timeout_set = true
+        end
+      end
+
       def check_lock_timeout
         limit = OnlineMigrations.config.lock_timeout_limit
 

data/lib/online_migrations/config.rb

@@ -35,6 +35,12 @@ module OnlineMigrations
       end
     end
 
+    # Statement timeout used for migrations (in seconds)
+    #
+    # @return [Numeric]
+    #
+    attr_accessor :statement_timeout
+
     # Set the database version against which the checks will be performed
     #
     # If your development database version is different from production, you can specify
@@ -158,7 +164,7 @@ module OnlineMigrations
     # migration failure in production. This is also useful in development to get
     # a better grasp of what is going on for high-level statements like add_column_with_default.
     #
-    # This feature is enabled by default in a production Rails environment.
+    # This feature is enabled by default in a staging and production Rails environments.
     # @return [Boolean]
     #
     # @note: It can be overridden by `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.

data/lib/online_migrations/lock_retrier.rb

@@ -60,9 +60,7 @@ module OnlineMigrations
     #
     # @param _attempt [Integer] attempt number
     #
-    def lock_timeout(_attempt)
-      raise NotImplementedError
-    end
+    def lock_timeout(_attempt); end
 
     # Returns sleep time after unsuccessful lock attempt (in seconds)
     #
@@ -143,9 +141,9 @@ module OnlineMigrations
     #
     # @param attempts [Integer] Maximum number of attempts
     # @param delay [Numeric] Sleep time after unsuccessful lock attempt (in seconds)
-    # @param lock_timeout [Numeric] Database lock timeout value (in seconds)
+    # @param lock_timeout [Numeric, nil] Database lock timeout value (in seconds)
     #
-    def initialize(attempts:, delay:, lock_timeout:)
+    def initialize(attempts:, delay:, lock_timeout: nil)
       super()
       @attempts = attempts
       @delay = delay
@@ -196,7 +194,7 @@ module OnlineMigrations
     # @param max_delay [Numeric] Maximum sleep time after unsuccessful lock attempt (in seconds)
     # @param lock_timeout [Numeric] Database lock timeout value (in seconds)
     #
-    def initialize(attempts:, base_delay:, max_delay:, lock_timeout:)
+    def initialize(attempts:, base_delay:, max_delay:, lock_timeout: nil)
       super()
       @attempts = attempts
       @base_delay = base_delay

data/lib/online_migrations/schema_statements.rb

@@ -680,7 +680,7 @@ module OnlineMigrations
     #
     # @see https://edgeapi.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-add_index
     #
-    def add_index(table_name, column_name, options = {})
+    def add_index(table_name, column_name, **options)
       algorithm = options[:algorithm]
 
       __ensure_not_in_transaction! if algorithm == :concurrently
@@ -694,8 +694,7 @@ module OnlineMigrations
         schema = __schema_for_table(table_name)
 
         if __index_valid?(index_name, schema: schema)
-          Utils.say("Index was not created because it already exists (this may be due to an aborted migration " \
-                    "or similar): table_name: #{table_name}, column_name: #{column_name}")
+          Utils.say("Index was not created because it already exists.")
           return
         else
           Utils.say("Recreating invalid index: table_name: #{table_name}, column_name: #{column_name}")
@@ -703,11 +702,22 @@ module OnlineMigrations
         end
       end
 
-      disable_statement_timeout do
+      if OnlineMigrations.config.statement_timeout
         # "CREATE INDEX CONCURRENTLY" requires a "SHARE UPDATE EXCLUSIVE" lock.
         # It only conflicts with constraint validations, creating/removing indexes,
         # and some other "ALTER TABLE"s.
         super(table_name, column_name, **options.merge(name: index_name))
+      else
+        OnlineMigrations.deprecator.warn(<<~MSG)
+          Running `add_index` without a statement timeout is deprecated.
+          Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
+          or the default database statement timeout will be used.
+          Example, `config.statement_timeout = 1.hour`.
+        MSG
+
+        disable_statement_timeout do
+          super(table_name, column_name, **options.merge(name: index_name))
+        end
       end
     end
 
@@ -716,23 +726,32 @@ module OnlineMigrations
     # @see https://edgeapi.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-remove_index
     #
     def remove_index(table_name, column_name = nil, **options)
-      algorithm = options[:algorithm]
+      if column_name.blank? && options[:column].blank? && options[:name].blank?
+        raise ArgumentError, "No name or columns specified"
+      end
 
-      __ensure_not_in_transaction! if algorithm == :concurrently
+      __ensure_not_in_transaction! if options[:algorithm] == :concurrently
 
-      column_names = index_column_names(column_name || options[:column])
-
-      if index_exists?(table_name, column_names, **options)
-        disable_statement_timeout do
+      if index_exists?(table_name, column_name, **options)
+        if OnlineMigrations.config.statement_timeout
           # "DROP INDEX CONCURRENTLY" requires a "SHARE UPDATE EXCLUSIVE" lock.
           # It only conflicts with constraint validations, other creating/removing indexes,
           # and some "ALTER TABLE"s.
+          super(table_name, column_name, **options)
+        else
+          OnlineMigrations.deprecator.warn(<<~MSG)
+            Running `remove_index` without a statement timeout is deprecated.
+            Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
+            or the default database statement timeout will be used.
+            Example, `config.statement_timeout = 1.hour`.
+          MSG
 
-          super(table_name, **options.merge(column: column_names))
+          disable_statement_timeout do
+            super(table_name, column_name, **options)
+          end
         end
       else
-        Utils.say("Index was not removed because it does not exist (this may be due to an aborted migration " \
-                  "or similar): table_name: #{table_name}, column_name: #{column_names}")
+        Utils.say("Index was not removed because it does not exist.")
       end
     end
 
@@ -778,11 +797,22 @@ module OnlineMigrations
       # Skip costly operation if already validated.
       return if foreign_key.validated?
 
-      disable_statement_timeout do
+      if OnlineMigrations.config.statement_timeout
         # "VALIDATE CONSTRAINT" requires a "SHARE UPDATE EXCLUSIVE" lock.
         # It only conflicts with other validations, creating/removing indexes,
         # and some other "ALTER TABLE"s.
         super
+      else
+        OnlineMigrations.deprecator.warn(<<~MSG)
+          Running `validate_foreign_key` without a statement timeout is deprecated.
+          Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
+          or the default database statement timeout will be used.
+          Example, `config.statement_timeout = 1.hour`.
+        MSG
+
+        disable_statement_timeout do
+          super
+        end
       end
     end
 
@@ -811,11 +841,22 @@ module OnlineMigrations
       # Skip costly operation if already validated.
       return if check_constraint.validated?
 
-      disable_statement_timeout do
+      if OnlineMigrations.config.statement_timeout
         # "VALIDATE CONSTRAINT" requires a "SHARE UPDATE EXCLUSIVE" lock.
         # It only conflicts with other validations, creating/removing indexes,
         # and some other "ALTER TABLE"s.
         super
+      else
+        OnlineMigrations.deprecator.warn(<<~MSG)
+          Running `validate_check_constraint` without a statement timeout is deprecated.
+          Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
+          or the default database statement timeout will be used.
+          Example, `config.statement_timeout = 1.hour`.
+        MSG
+
+        disable_statement_timeout do
+          super
+        end
       end
     end
 
@@ -855,28 +896,26 @@ module OnlineMigrations
       end
     end
 
-    # Disables statement timeout while executing &block
-    #
-    # Long-running migrations may take more than the timeout allowed by the database.
-    # Disable the session's statement timeout to ensure migrations don't get killed prematurely.
-    #
-    # Statement timeouts are already disabled in `add_index`, `remove_index`,
-    # `validate_foreign_key`, and `validate_check_constraint` helpers.
-    #
-    # @return [void]
-    #
-    # @example
-    #   disable_statement_timeout do
-    #     add_index(:users, :email, unique: true, algorithm: :concurrently)
-    #   end
-    #
+    # @private
     def disable_statement_timeout
-      prev_value = select_value("SHOW statement_timeout")
-      execute("SET statement_timeout TO 0")
+      OnlineMigrations.deprecator.warn(<<~MSG)
+        `disable_statement_timeout` is deprecated and will be removed. Configure an explicit
+        statement timeout in the initializer file via `config.statement_timeout` or the default
+        database statement timeout will be used. Example, `config.statement_timeout = 1.hour`.
+      MSG
 
+      prev_value = select_value("SHOW statement_timeout")
+      __set_statement_timeout(0)
       yield
     ensure
-      execute("SET statement_timeout TO #{quote(prev_value)}")
+      __set_statement_timeout(prev_value)
+    end
+
+    # @private
+    def __set_statement_timeout(timeout)
+      # use ceil to prevent no timeout for values under 1 ms
+      timeout = (timeout.to_f * 1000).ceil if !timeout.is_a?(String)
+      execute("SET statement_timeout TO #{quote(timeout)}")
     end
 
     # @private

data/lib/online_migrations/utils.rb

@@ -10,8 +10,17 @@ module OnlineMigrations
         ActiveRecord.version.to_s.to_f
       end
 
+      def env
+        if defined?(Rails.env)
+          Rails.env
+        else
+          # default to production for safety
+          ENV["RACK_ENV"] || "production"
+        end
+      end
+
       def developer_env?
-        defined?(Rails.env) && (Rails.env.development? || Rails.env.test?)
+        env == "development" || env == "test"
       end
 
       def say(message)
@@ -137,6 +146,11 @@ module OnlineMigrations
           return pool_manager.shard_names.uniq if pool_manager
         end
       end
+
+      def multiple_databases?
+        db_config = ActiveRecord::Base.configurations.configs_for(env_name: env)
+        db_config.reject(&:replica?).size > 1
+      end
     end
   end
 end

data/lib/online_migrations/version.rb

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

data/lib/online_migrations.rb

@@ -1,7 +1,19 @@
 # frozen_string_literal: true
 
 require "active_record"
+
 require "online_migrations/version"
+require "online_migrations/utils"
+require "online_migrations/change_column_type_helpers"
+require "online_migrations/background_migrations/migration_helpers"
+require "online_migrations/schema_statements"
+require "online_migrations/migration"
+require "online_migrations/migrator"
+require "online_migrations/schema_dumper"
+require "online_migrations/database_tasks"
+require "online_migrations/command_recorder"
+require "online_migrations/error_messages"
+require "online_migrations/config"
 
 module OnlineMigrations
   class Error < StandardError; end
@@ -9,15 +21,8 @@ module OnlineMigrations
 
   extend ActiveSupport::Autoload
 
-  autoload :Utils
-  autoload :ErrorMessages
-  autoload :Config
   autoload :BatchIterator
   autoload :VerboseSqlLogs
-  autoload :Migration
-  autoload :Migrator
-  autoload :SchemaDumper
-  autoload :DatabaseTasks
   autoload :ForeignKeysCollector
   autoload :IndexDefinition
   autoload :IndexesCollector
@@ -36,10 +41,7 @@ module OnlineMigrations
     autoload :NullLockRetrier
   end
 
-  autoload :CommandRecorder
   autoload :CopyTrigger
-  autoload :ChangeColumnTypeHelpers
-  autoload :SchemaStatements
 
   module BackgroundMigrations
     extend ActiveSupport::Autoload
@@ -59,7 +61,6 @@ module OnlineMigrations
     autoload :Migration
     autoload :MigrationJobRunner
     autoload :MigrationRunner
-    autoload :MigrationHelpers
     autoload :Scheduler
   end
 
@@ -80,6 +81,15 @@ module OnlineMigrations
       BackgroundMigrations::Scheduler.run
     end
 
+    def deprecator
+      @deprecator ||=
+        if Utils.ar_version >= 7.1
+          ActiveSupport::Deprecation.new(nil, "online_migrations")
+        else
+          ActiveSupport::Deprecation
+        end
+    end
+
     # @private
     def load
       require "active_record/connection_adapters/postgresql_adapter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Catch unsafe PostgreSQL migrations in development and run them easier in