online_migrations 0.19.6 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8711d56259535675633074868019a5c4b3de068bb30d783c9ae16dc906afb1
-  data.tar.gz: 3b417e176d143092d69e4551c1f96a32e1a2acf1d74d268fc33f9b5a598be553
+  metadata.gz: 2fd0059b044a120c61044268bfc32c3622163ae1871f85655ae51fe3cfb99c60
+  data.tar.gz: 1e1842002d3d229014011ee2a6af8eb122eaa7a6822912bec2d276f67e6555b4
 SHA512:
-  metadata.gz: ad26fd5662f2636479b697933042b8d7e60b4ee42f136ddeb8cff8256c65a4491b8017d09d2da849faf65cb6f8d4ecc95595816b7669c8364e9f31bbe75232c4
-  data.tar.gz: 21fec027462ff6f96baaf0fc65d186fc68fefbb50fd3de6af8f561aae691e6f9909d70d7053557d39f0a56ea498841816c2853cce0b1acef161411b2d968b196
+  metadata.gz: 590aa0a0d36f94316cf02c0b3c8ec2dcf7be08e17cd687eb889d6fb9d8a4cfc892424cffb49c1988691720a7cbede5d58f1a2e712a0ddd8ab8545ce6df6395ed
+  data.tar.gz: a981da87aae5a6e0a5872be04ec9839285fa6b53693c73a4f8ceac354d30f5623d7aef473a8d5c07992e14654083253d3603881f031877692c6718c8f5588407

data/CHANGELOG.md

@@ -1,8 +1,18 @@
 ## master (unreleased)
 
+## 0.20.1 (2024-11-05)
+
+- Fix background data migrations to work with `includes`/`eager_load` on relation
+- Fix problem with running migrations for `activerecord` 8.0.0.rc2
+
+## 0.20.0 (2024-10-21)
+
+- Enhance columns removal check to check indexes `where` and `include` options
+- Do not wait before running retried background migrations
+
 ## 0.19.6 (2024-09-26)
 
-- Fix `add_refernce_concurrently` when adding non polymorphic references
+- Fix `add_reference_concurrently` when adding non polymorphic references
 - Fix progress for background migrations with small number of records
 
 ## 0.19.5 (2024-09-20)

data/docs/configuring.md

@@ -51,7 +51,7 @@ config.check_down = true
 You can customize specific error messages:
 
 ```ruby
-config.error_messages[:add_column_default] = "Your custom instructions"
+config.error_messages[:add_column_with_default] = "Your custom instructions"
 ```
 
 Check the [source code](https://github.com/fatkodima/online_migrations/blob/master/lib/online_migrations/error_messages.rb) for the list of keys.

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

@@ -4,18 +4,25 @@ module <%= migrations_module %>
 <% module_namespacing do -%>
   class <%= class_name %> < OnlineMigrations::BackgroundMigration
     def relation
-      # ActiveRecord::Relation to be iterated over
+      # return ActiveRecord::Relation to be iterated over
     end
 
     def process_batch(relation)
+      # 'relation' is an ActiveRecord::Relation instance containing a batch to process.
+      #
       # The work to be done in a single iteration of the background migration.
       # This should be idempotent, as the same batch may be processed more
       # than once if the background migration is interrupted and resumed.
     end
 
+    # Optional.
     def count
-      # Optionally, define the number of rows that will be iterated over.
+      # Define the number of rows that will be iterated over.
       # This is used to track the background migration's progress.
+      # Usually this is configured to be 'relation.count'.
+      #
+      # If the query to calculate the count is heavy, it is recommended to use
+      # some approximate hardcode number or skip defining this method entirely.
     end
   end
 <% end -%>

data/lib/online_migrations/background_migrations/migration_job.rb

@@ -17,7 +17,7 @@ module OnlineMigrations
       scope :completed, -> { where(status: [:failed, :succeeded]) }
       scope :stuck, -> do
         timeout = OnlineMigrations.config.background_migrations.stuck_jobs_timeout
-        active.where("updated_at <= ?", timeout.seconds.ago)
+        running.where("updated_at <= ?", timeout.seconds.ago)
       end
 
       scope :retriable, -> do

data/lib/online_migrations/background_migrations/migration_runner.rb

@@ -115,7 +115,7 @@ module OnlineMigrations
           if min_value && max_value
             create_migration_job!(min_value, max_value)
           else
-            migration.migration_jobs.retriable.first
+            migration.migration_jobs.enqueued.first || migration.migration_jobs.retriable.first
           end
         end
 

data/lib/online_migrations/background_schema_migrations/migration.rb

@@ -123,7 +123,7 @@ module OnlineMigrations
         return false if composite?
 
         stuck_timeout = (statement_timeout || 1.day) + 10.minutes
-        (enqueued? || running?) && updated_at <= stuck_timeout.seconds.ago
+        running? && updated_at <= stuck_timeout.seconds.ago
       end
 
       # Mark this migration as ready to be processed again.
@@ -134,7 +134,7 @@ module OnlineMigrations
         if composite? && failed?
           children.failed.each(&:retry)
           update!(
-            status: self.class.statuses[:running],
+            status: self.class.statuses[:enqueued],
             finished_at: nil
           )
           true

data/lib/online_migrations/batch_iterator.rb

@@ -19,7 +19,8 @@ module OnlineMigrations
       end
 
       relation = apply_limits(self.relation, column, start, finish, order)
-      base_relation = relation.reselect(column).reorder(column => order)
+      unscopes = Utils.ar_version < 7.1 ? [:includes] : [:includes, :preload, :eager_load]
+      base_relation = relation.unscope(*unscopes).reselect(column).reorder(column => order)
 
       start_id = start || begin
         start_row = base_relation.uncached { base_relation.first }

data/lib/online_migrations/change_column_type_helpers.rb

@@ -118,7 +118,7 @@ module OnlineMigrations
           type_cast_functions[column_name] = type_cast_function if type_cast_function
           tmp_column_name = conversions[column_name]
 
-          if raw_connection.server_version >= 11_00_00
+          if database_version >= 11_00_00
             if primary_key(table_name) == column_name.to_s && old_col.type == :integer
               # For PG < 11 and Primary Key conversions, setting a column as the PK
               # converts even check constraints to NOT NULL column constraints
@@ -497,7 +497,7 @@ module OnlineMigrations
       def __set_not_null(table_name, column_name)
         # For PG >= 12 we can "promote" CHECK constraint to NOT NULL constraint:
         # https://github.com/postgres/postgres/commit/bbb96c3704c041d139181c6601e5bc770e045d26
-        if raw_connection.server_version >= 12_00_00
+        if database_version >= 12_00_00
           execute(<<~SQL)
             ALTER TABLE #{quote_table_name(table_name)}
             ALTER #{quote_column_name(column_name)}

data/lib/online_migrations/command_checker.rb

@@ -453,13 +453,7 @@ module OnlineMigrations
 
         if !new_table?(table_name)
           indexes = connection.indexes(table_name).select do |index|
-            case index.columns
-            when String
-              # Expression index
-              columns.any? { |column| index.columns.include?(column) }
-            else
-              (index.columns & columns).any?
-            end
+            columns.any? { |column| index_include_column?(index, column) }
           end
 
           raise_error :remove_column,
@@ -892,6 +886,14 @@ module OnlineMigrations
           postgresql_version < Gem::Version.new("14.4")
       end
 
+      def index_include_column?(index, column)
+        # Expression index
+        (index.columns.is_a?(String) && index.columns.include?(column)) ||
+          index.columns.include?(column) ||
+          (Utils.ar_version >= 7.1 && index.include && index.include.include?(column)) ||
+          (index.where && index.where.include?(column))
+      end
+
       def run_custom_checks(method, args)
         OnlineMigrations.config.checks.each do |options, check|
           if !options[:start_after] || version > options[:start_after]

data/lib/online_migrations/database_tasks.rb

@@ -3,7 +3,7 @@
 module OnlineMigrations
   # @private
   module DatabaseTasks
-    def migrate(*)
+    def migrate(*, **)
       super
     rescue => e
       if e.cause.is_a?(OnlineMigrations::Error)

data/lib/online_migrations/error_messages.rb

@@ -279,8 +279,8 @@ end",
 
       remove_column:
 "<% if !small_table && indexes.any? %>
-Removing a column will automatically remove all of the indexes that involved the removed column.
-But the indexes would be removed non-concurrently, so you need to safely remove the indexes first:
+Removing a column will automatically remove all the indexes that include this column.
+Indexes will be removed non-concurrently, so you need to safely remove them first:
 
 class <%= migration_name %>RemoveIndexes < <%= migration_parent %>
   disable_ddl_transaction!

data/lib/online_migrations/schema_statements.rb

@@ -439,7 +439,7 @@ module OnlineMigrations
     def add_column_with_default(table_name, column_name, type, **options)
       default = options.fetch(:default)
 
-      if raw_connection.server_version >= 11_00_00 && !Utils.volatile_default?(self, type, default)
+      if database_version >= 11_00_00 && !Utils.volatile_default?(self, type, default)
         add_column(table_name, column_name, type, **options)
       else
         __ensure_not_in_transaction!
@@ -465,7 +465,7 @@ module OnlineMigrations
           add_not_null_constraint(table_name, column_name, validate: false)
           validate_not_null_constraint(table_name, column_name)
 
-          if raw_connection.server_version >= 12_00_00
+          if database_version >= 12_00_00
             # In PostgreSQL 12+ it is safe to "promote" a CHECK constraint to `NOT NULL` for the column
             change_column_null(table_name, column_name, false)
             remove_not_null_constraint(table_name, column_name)

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.19.6
+  version: 0.20.1
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord