online_migrations 0.19.1 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259343358d51032a296c3745f92aa0e7ab5fc8f2d5dc6cd124873876e523d525
-  data.tar.gz: d07240d06faac048145ae8f54da1a947d197f9ff40bb2adf276625eb76bcafb5
+  metadata.gz: 4d8223e51d4016b3752a738ecbc04cc200c94ee44dd3d91a1be2aefbc74060a9
+  data.tar.gz: bbaa8a04c4b730ac33e1503c59782658f6810f9782b4f882ab2b19bd0e0402d2
 SHA512:
-  metadata.gz: c67adbf061095fdcbb5fcaa5305f671d81cf434dc182bfe9e43d66dae41f87d24cf5a79bb4aca160a955c74dff20de5e217b20731fe022df1dece6246e0239c0
-  data.tar.gz: 705397632e3afe3628776e854f74ff0ee70ada9d73d0d9e84c113289623d6240fc79b7823ca0dc05d3dab8dfd90c421c667b60ee394dbfb03c49afabd31ddc95
+  metadata.gz: 878031d1e81e5a069500e4c9c8f0d2bb9b9b60320e07ce101a7ae8680556a6a8114de4d0f6bf092340ec3651f9bbbb74fdc6e6453db39be3c22f6846b5a2ad94
+  data.tar.gz: 143a618f2d46a8a452c9f32ca87f44e47dffe5268bae00dcff008f54865cf272e20bb6aa4af7243cf642a195e64e9aed8269660f1658ebb3440bff12eeed37df

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
 
+## 0.19.3 (2024-08-09)
+
+- Fix idempotency for `add_index`/`remove_index` for expression indexes
+
+## 0.19.2 (2024-07-09)
+
+- Fix `add_reference_concurrently` to be idempotent when adding a foreign key
+- Fix `enqueue_background_data_migration` to be idempotent
+
 ## 0.19.1 (2024-05-24)
 
 - Fix `add_index_in_background` to be idempotent

data/README.md

@@ -169,7 +169,7 @@ Config-specific checks:
 
 - [changing the default value of a column](#changing-the-default-value-of-a-column)
 
-You can also add [custom checks](#custom-checks) or [disable specific checks](#disable-checks).
+You can also add [custom checks](docs/configuring.md#custom-checks) or [disable specific checks](docs/configuring.md#disable-checks).
 
 ### Removing a column
 
@@ -544,7 +544,7 @@ The technique is built on top of database views, using the following steps:
 2. Create a VIEW using the old table name by pointing to the new table name
 3. Add a workaround for Active Record's schema cache
 
-For the previous example, to rename `name` column to `first_name` of the `users` table, we can run:
+For the previous example, to rename `clients` table to `users`, we can run:
 
 ```sql
 BEGIN;

data/lib/online_migrations/background_migrations/migration_helpers.rb

@@ -440,26 +440,22 @@ module OnlineMigrations
 
         migration_name = migration_name.name if migration_name.is_a?(Class)
 
-        migration = Migration.new(
-          migration_name: migration_name,
-          arguments: arguments,
-          **options
-        )
-
-        shards = Utils.shard_names(migration.migration_model)
-        if shards.size > 1
-          migration.children = shards.map do |shard|
-            child = migration.dup
-            child.shard = shard
-            child
+        # Can't use `find_or_create_by` or hash syntax here, because it does not correctly work with json `arguments`.
+        existing_migration = Migration.find_by("migration_name = ? AND arguments = ? AND shard IS NULL", migration_name, arguments.to_json)
+        return existing_migration if existing_migration
+
+        Migration.create!(**options, migration_name: migration_name, arguments: arguments, shard: nil) do |migration|
+          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
-
-          migration.composite = true
         end
-
-        # This will save all the records using a transaction.
-        migration.save!
-        migration
       end
     end
   end

data/lib/online_migrations/background_migrations/migration_runner.rb

@@ -13,7 +13,7 @@ module OnlineMigrations
       # Runs one background migration job.
       def run_migration_job
         raise "Should not be called on a composite (with sharding) migration" if migration.composite?
-        return if migration.cancelled?
+        return if migration.cancelled? || migration.succeeded?
 
         mark_as_running if migration.enqueued?
         migration_payload = notifications_payload(migration)

data/lib/online_migrations/schema_statements.rb

@@ -684,9 +684,17 @@ module OnlineMigrations
     def add_index(table_name, column_name, **options)
       __ensure_not_in_transaction! if options[:algorithm] == :concurrently
 
-      # Rewrite this with `IndexDefinition#defined_for?` when Active Record >= 7.1 is supported.
-      # See https://github.com/rails/rails/pull/45160.
-      index = indexes(table_name).find { |i| __index_defined_for?(i, column_name, **options) }
+      index =
+        if column_name.is_a?(String) && column_name.match?(/\W/)
+          # Use only name to check if index exists, because it does not work for complex expressions.
+          index_name = (options[:name] || index_name(table_name, column_name)).to_s
+          indexes(table_name).find { |i| i.name == index_name }
+        else
+          # Rewrite this with `IndexDefinition#defined_for?` when Active Record >= 7.1 is supported.
+          # See https://github.com/rails/rails/pull/45160.
+          indexes(table_name).find { |i| __index_defined_for?(i, column_name, **options) }
+        end
+
       if index
         schema = __schema_for_table(table_name)
 
@@ -729,12 +737,22 @@ module OnlineMigrations
 
       __ensure_not_in_transaction! if options[:algorithm] == :concurrently
 
-      if index_exists?(table_name, column_name, **options)
+      column = column_name || options[:column]
+      index_exists =
+        if column.is_a?(String) && column.match?(/\W/)
+          # Use only name to check if index exists, because it does not work for complex expressions.
+          index_name = options[:name] || index_name(table_name, column)
+          index_name_exists?(table_name, index_name)
+        else
+          index_exists?(table_name, column_name, **options)
+        end
+
+      if index_exists
         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)
+          super
         else
           OnlineMigrations.deprecator.warn(<<~MSG)
             Running `remove_index` without a statement timeout is deprecated.
@@ -744,7 +762,7 @@ module OnlineMigrations
           MSG
 
           disable_statement_timeout do
-            super(table_name, column_name, **options)
+            super
           end
         end
       else
@@ -773,7 +791,8 @@ module OnlineMigrations
     # @see https://edgeapi.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-add_foreign_key
     #
     def add_foreign_key(from_table, to_table, **options)
-      if foreign_key_exists?(from_table, to_table, **options)
+      # Do not consider validation for idempotency.
+      if foreign_key_exists?(from_table, to_table, **options.except(:validate))
         message = +"Foreign key was not created because it already exists " \
                    "(this can be due to an aborted migration or similar): from_table: #{from_table}, to_table: #{to_table}"
         message << ", #{options.inspect}" if options.any?

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.19.3
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord