online_migrations 0.13.1 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8952366397c54505f364a353dde1d68e988ac4773e9b3663de790a75c8b860f3
-  data.tar.gz: 376dc6e760a2b07d55968a11097f9f81067bc72291718938d1102fafb46a73ea
+  metadata.gz: 330d5ed7f11aae3b85e7fb5aab5a1ea66d809da704cf193420b6d4206f72d82b
+  data.tar.gz: 36d47a6f2a1cae3de33331a4ec9e6b21fc7b3b8b09a7d5e9c34d1be6c92e5d35
 SHA512:
-  metadata.gz: 3e40ed5ab49e5d702c7d7cfebdb4264621375ad9affb67e8c3592814c4a832e75929c4ff718ce90709e64497226df3d9503a42babf56cfaad5ce973026f71d82
-  data.tar.gz: cdcbc9c26ac23fb975f21dd58c9826dab59c9571d074da06211dea2ffae72c3c57372722110ecd729ba649f21db551f58e8ca43689214f1235cd20669f033cf6
+  metadata.gz: e07937136867b4b6bc2d0dfb2e5ccb8471faf6ce0339a247bc0c63d591cc163e084da731e86fc01ba839c7744a51e9c63e99ce632452e471f9eed98a95b9dd02
+  data.tar.gz: f1a33636d5fbd01f25a0cee32af0d74e377c804eaef0feee2c778c5318a93bbe8942dc03e8ea2bad0a610d0046a8d4e42b505d0991c7d215cc9842a24d5e5065

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## master (unreleased)
 
+## 0.14.1 (2024-02-21)
+
+- Fix `MigrationRunner` to consider `run_background_migrations_inline` proc
+
+## 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/README.md

@@ -206,7 +206,7 @@ end
    end
    ```
 
-4. Remove column ignoring from `User` model
+4. Remove column ignoring from step 1
 5. Deploy
 
 ### Adding a column with a default value

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

@@ -30,7 +30,12 @@ module OnlineMigrations
 
       alias_attribute :name, :migration_name
 
-      enum status: STATUSES.index_with(&:to_s)
+      # Avoid deprecation warnings.
+      if Utils.ar_version >= 7
+        enum :status, STATUSES.index_with(&:to_s)
+      else
+        enum status: STATUSES.index_with(&:to_s)
+      end
 
       belongs_to :parent, class_name: name, optional: true
       has_many :children, class_name: name, foreign_key: :parent_id, dependent: :delete_all

data/lib/online_migrations/background_migrations/migration_helpers.rb

@@ -307,7 +307,7 @@ module OnlineMigrations
       #     perform_action_on_relation_in_background("User", { invite_token: nil }, :generate_invite_token)
       #
       # @note This method is better suited for large tables (10/100s of millions of records).
-      #     For smaller tables it is probably better and easier to directly delete associated records.
+      #     For smaller tables it is probably better and easier to directly perform the action on associated records.
       #
       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)
@@ -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/background_migrations/migration_job.rb

@@ -37,7 +37,12 @@ module OnlineMigrations
       scope :except_succeeded, -> { where.not(status: :succeeded) }
       scope :attempts_exceeded, -> { where("attempts >= max_attempts") }
 
-      enum status: STATUSES.index_with(&:to_s)
+      # Avoid deprecation warnings.
+      if Utils.ar_version >= 7
+        enum :status, STATUSES.index_with(&:to_s)
+      else
+        enum status: STATUSES.index_with(&:to_s)
+      end
 
       delegate :migration_class, :migration_object, :migration_relation, :batch_column_name,
         :arguments, :batch_pause, to: :migration

data/lib/online_migrations/background_migrations/migration_runner.rb

@@ -51,7 +51,11 @@ module OnlineMigrations
       # @note This method should not be used in production environments
       #
       def run_all_migration_jobs
-        raise "This method is not intended for use in production environments" if !Utils.developer_env?
+        run_inline = OnlineMigrations.config.run_background_migrations_inline
+        if run_inline && !run_inline.call
+          raise "This method is not intended for use in production environments"
+        end
+
         return if migration.completed?
 
         mark_as_running

data/lib/online_migrations/command_checker.rb

@@ -100,7 +100,7 @@ module OnlineMigrations
       end
 
       def set_statement_timeout
-        if !@statement_timeout_set
+        if !defined?(@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)

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/database_tasks.rb

@@ -5,7 +5,7 @@ module OnlineMigrations
   module DatabaseTasks
     def migrate(*)
       super
-    rescue => e # rubocop:disable Style/RescueStandardError
+    rescue => e
       if e.cause.is_a?(OnlineMigrations::Error)
         # strip cause
         def e.cause

data/lib/online_migrations/error_messages.rb

@@ -295,7 +295,7 @@ end
 Active Record caches database columns at runtime, so if you drop a column, it can cause exceptions until your app reboots.
 A safer approach is to:
 
-1. Ignore the column(s):
+1. Ignore the column:
 
   class <%= model %> < ApplicationRecord
     self.ignored_columns = <%= columns %>
@@ -310,7 +310,7 @@ A safer approach is to:
     end
   end
 
-4. Remove columns ignoring
+4. Remove column ignoring from step 1
 5. Deploy
 <% end %>",
 

data/lib/online_migrations/schema_cache.rb

@@ -78,7 +78,7 @@ module OnlineMigrations
   end
 
   # @private
-  module SchemaCache7
+  module SchemaCache71
     # Active Record >= 7.1 changed signature of the methods,
     # see https://github.com/rails/rails/pull/48716.
     def primary_keys(connection, table_name)
@@ -154,4 +154,82 @@ module OnlineMigrations
         columns << new_column.freeze
       end
   end
+
+  # @private
+  module SchemaCache72
+    # Active Record >= 7.2 changed signature of the methods,
+    # see https://github.com/rails/rails/pull/48716.
+    def primary_keys(pool, table_name)
+      if (renamed_table = renamed_table?(pool, table_name))
+        super(pool, renamed_table)
+      elsif renamed_column?(pool, table_name)
+        super(pool, column_rename_table(table_name))
+      else
+        super
+      end
+    end
+
+    def columns(pool, table_name)
+      if (renamed_table = renamed_table?(pool, table_name))
+        super(pool, renamed_table)
+      elsif renamed_column?(pool, table_name)
+        columns = super(pool, column_rename_table(table_name))
+        OnlineMigrations.config.column_renames[table_name].each do |old_column_name, new_column_name|
+          duplicate_column(old_column_name, new_column_name, columns)
+        end
+        columns
+      else
+        super.reject { |column| column.name.end_with?("_for_type_change") }
+      end
+    end
+
+    def indexes(pool, table_name)
+      if (renamed_table = renamed_table?(pool, table_name))
+        super(pool, renamed_table)
+      elsif renamed_column?(pool, table_name)
+        super(pool, column_rename_table(table_name))
+      else
+        super
+      end
+    end
+
+    def clear_data_source_cache!(pool, name)
+      if (renamed_table = renamed_table?(pool, name))
+        super(pool, renamed_table)
+      end
+
+      if renamed_column?(pool, name)
+        super(pool, column_rename_table(name))
+      end
+
+      super
+    end
+
+    private
+      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)
+        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)
+      end
+
+      def column_rename_table(table_name)
+        "#{table_name}_column_rename"
+      end
+
+      def duplicate_column(old_column_name, new_column_name, columns)
+        old_column = columns.find { |column| column.name == old_column_name }
+        new_column = old_column.dup
+        # Active Record defines only reader for :name
+        new_column.instance_variable_set(:@name, new_column_name)
+        # Correspond to the Active Record freezing of each column
+        columns << new_column.freeze
+      end
+  end
 end

data/lib/online_migrations/version.rb

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

data/lib/online_migrations.rb

@@ -7,6 +7,7 @@ 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/schema_cache"
 require "online_migrations/migration"
 require "online_migrations/migrator"
 require "online_migrations/schema_dumper"
@@ -29,11 +30,6 @@ module OnlineMigrations
   autoload :CommandChecker
   autoload :BackgroundMigration
 
-  autoload_at "online_migrations/schema_cache" do
-    autoload :SchemaCache
-    autoload :SchemaCache7
-  end
-
   autoload_at "online_migrations/lock_retrier" do
     autoload :LockRetrier
     autoload :ConstantLockRetrier
@@ -102,8 +98,10 @@ module OnlineMigrations
       ActiveRecord::Tasks::DatabaseTasks.singleton_class.prepend(OnlineMigrations::DatabaseTasks)
       ActiveRecord::Migration::CommandRecorder.include(OnlineMigrations::CommandRecorder)
 
-      if OnlineMigrations::Utils.ar_version >= 7.1
-        ActiveRecord::ConnectionAdapters::SchemaCache.prepend(OnlineMigrations::SchemaCache7)
+      if OnlineMigrations::Utils.ar_version >= 7.2
+        ActiveRecord::ConnectionAdapters::SchemaCache.prepend(OnlineMigrations::SchemaCache72)
+      elsif OnlineMigrations::Utils.ar_version >= 7.1
+        ActiveRecord::ConnectionAdapters::SchemaCache.prepend(OnlineMigrations::SchemaCache71)
       else
         ActiveRecord::ConnectionAdapters::SchemaCache.prepend(OnlineMigrations::SchemaCache)
       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.1
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord