online_migrations 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34bd3f3fc2c18bc49962183603c7f2c85e167d978eafd3fb840b639fa98de60d
-  data.tar.gz: 0ae0b82440ea7dcec1183c987395742fab0c93618b384f770d7acd3fecd41cdf
+  metadata.gz: 296a1517b032cbd6d5fa3948f60f1a4f20c4142c8f4c7676c43998f9e941925d
+  data.tar.gz: f61a7c6728a6ea1e834be61187b61e3ddf004f4314003752ec3ccf9a5b79afd9
 SHA512:
-  metadata.gz: 321b877ffe09ccf2edb94b43d1060f5ebc8d83c1c058a41dc1d248f4d52c161b5a4576186363349c6c027d20890375728590271d24bdb75647d0556a57202aa9
-  data.tar.gz: d6a25cf51e31b772e4556b18de85ed88c5019b0469a8d6299e955063042c2e939f4f3f228e05ce4fdc8a4060b2ee2f4160a1e5d477a8769439b103f03b103fb8
+  metadata.gz: fd04da6b57f9862726ee45e6ed13b1032632099a089e26e691717b2e93009269b7f8a8cf3c828501ef97a86d3d13731d4cadb77d0b48f0cf25fea172502780c1
+  data.tar.gz: '089a7f40afc28b9671669764ee98c760e4ee8649aab67a4d814b22ca8f5c52cf76afc8a5c9f95244d8be7b879d2b714fa38f07fff3c741bcc91e450077c96801'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## master (unreleased)
 
+## 0.14.0 (2024-02-01)
+
+- Add ability to configure whether background migrations should be run inline
+
+    The previous behavior of running inline in development and test environments is preserved, unless overriden.
+
+    ```ruby
+    config.run_background_migrations_inline = -> { Rails.env.local? }
+    ```
+
+## 0.13.1 (2024-01-23)
+
+- Fix calculation of batch ranges for background migration created with explicit ranges
+
 ## 0.13.0 (2024-01-22)
 
 - Add ability to configure the path where generated background migrations will be placed

data/docs/configuring.md

@@ -214,6 +214,17 @@ Add to an initializer file:
 config.auto_analyze = true
 ```
 
+### Running background migrations inline
+
+`config.run_background_migrations_inline` can be configured with a proc to decide whether background migrations should be run inline. For convenience defaults to true for development and test environments.
+
+```ruby
+# config/initializers/online_migrations.rb
+config.run_background_migrations_inline = -> { Rails.env.local? }
+```
+
+Set to `nil` to avoid running background migrations inline.
+
 ## Schema Sanity
 
 Columns can flip order in `db/schema.rb` when you have multiple developers. One way to prevent this is to [alphabetize them](https://www.pgrs.net/2008/03/12/alphabetize-schema-rb-columns/).

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

@@ -77,6 +77,10 @@ OnlineMigrations.configure do |config|
   #   end
   # end
 
+  # Decide whether background migrations should be run inline.
+  # Convenient for development and test environments.
+  config.run_background_migrations_inline = -> { Rails.env.local? }
+
   # ==> Background migrations configuration
 
   # The path where generated background migrations will be placed.

data/lib/online_migrations/background_migrations/migration.rb

@@ -197,10 +197,7 @@ module OnlineMigrations
 
         on_shard do
           # rubocop:disable Lint/UnreachableLoop
-          iterator.each_batch(of: batch_size, column: batch_column_name, start: next_min_value) do |relation, min_value, max_value|
-            if max_value.nil?
-              max_value = relation.pick(relation.arel_table[batch_column_name].maximum)
-            end
+          iterator.each_batch(of: batch_size, column: batch_column_name, start: next_min_value, finish: max_value) do |_relation, min_value, max_value|
             batch_range = [min_value, max_value]
 
             break

data/lib/online_migrations/background_migrations/migration_helpers.rb

@@ -372,8 +372,8 @@ module OnlineMigrations
       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?
+        run_inline = OnlineMigrations.config.run_background_migrations_inline
+        if run_inline && run_inline.call
           runner = MigrationRunner.new(migration)
           runner.run_all_migration_jobs
         end

data/lib/online_migrations/batch_iterator.rb

@@ -69,7 +69,7 @@ module OnlineMigrations
         # efficient UPDATE queries, hence we get rid of it.
         batch_relation = batch_relation.except(:order)
 
-        last_id = (last_row && last_row[column]) || start_id
+        last_id = (last_row && last_row[column]) || finish
 
         # Retaining the results in the query cache would undermine the point of batching.
         batch_relation.uncached { yield batch_relation, start_id, last_id }

data/lib/online_migrations/config.rb

@@ -171,6 +171,16 @@ module OnlineMigrations
     #
     attr_accessor :verbose_sql_logs
 
+    # The proc which decides whether background migrations should be run inline.
+    # For convenience defaults to true for development and test environments.
+    #
+    # @example
+    #   OnlineMigrations.config.run_background_migrations_inline = -> { Rails.env.local? }
+    #
+    # @return [Proc]
+    #
+    attr_accessor :run_background_migrations_inline
+
     # Configuration object to configure background migrations
     #
     # @return [BackgroundMigrationsConfig]
@@ -202,6 +212,7 @@ module OnlineMigrations
       @alphabetize_schema = false
       @enabled_checks = @error_messages.keys.index_with({})
       @verbose_sql_logs = defined?(Rails.env) && (Rails.env.production? || Rails.env.staging?)
+      @run_background_migrations_inline = -> { Utils.developer_env? }
     end
 
     def lock_retrier=(value)

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-22 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord