online_migrations 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8952366397c54505f364a353dde1d68e988ac4773e9b3663de790a75c8b860f3
-  data.tar.gz: 376dc6e760a2b07d55968a11097f9f81067bc72291718938d1102fafb46a73ea
+  metadata.gz: 296a1517b032cbd6d5fa3948f60f1a4f20c4142c8f4c7676c43998f9e941925d
+  data.tar.gz: f61a7c6728a6ea1e834be61187b61e3ddf004f4314003752ec3ccf9a5b79afd9
 SHA512:
-  metadata.gz: 3e40ed5ab49e5d702c7d7cfebdb4264621375ad9affb67e8c3592814c4a832e75929c4ff718ce90709e64497226df3d9503a42babf56cfaad5ce973026f71d82
-  data.tar.gz: cdcbc9c26ac23fb975f21dd58c9826dab59c9571d074da06211dea2ffae72c3c57372722110ecd729ba649f21db551f58e8ca43689214f1235cd20669f033cf6
+  metadata.gz: fd04da6b57f9862726ee45e6ed13b1032632099a089e26e691717b2e93009269b7f8a8cf3c828501ef97a86d3d13731d4cadb77d0b48f0cf25fea172502780c1
+  data.tar.gz: '089a7f40afc28b9671669764ee98c760e4ee8649aab67a4d814b22ca8f5c52cf76afc8a5c9f95244d8be7b879d2b714fa38f07fff3c741bcc91e450077c96801'

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## 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

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_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/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.1"
+  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.1
+  version: 0.14.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord