online_migrations 0.19.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57661cb5e096da3eaed31d4dbe5cda862f9f75271b59c28045412642acaf786b
-  data.tar.gz: 50ed46eaa89a4ee95ecd8b249b0fce616047006c91339dbc1069e572a96f0454
+  metadata.gz: 259343358d51032a296c3745f92aa0e7ab5fc8f2d5dc6cd124873876e523d525
+  data.tar.gz: d07240d06faac048145ae8f54da1a947d197f9ff40bb2adf276625eb76bcafb5
 SHA512:
-  metadata.gz: be91a43493896dbf0787cf9045c0ac187920a55946b98b0c653b8a50604031aee1bba3b59591fd4c22f7996af05254c71001e098289ded180eec9cdd8ae47d43
-  data.tar.gz: 840c35a008b4b949d1d686222d0722f98aa579fb31ccb14ffe3f6bd80147100bbcb323a9bdba657f230efbd3b2a97f799385e21f43218d8dbf19ab9a484d1147
+  metadata.gz: c67adbf061095fdcbb5fcaa5305f671d81cf434dc182bfe9e43d66dae41f87d24cf5a79bb4aca160a955c74dff20de5e217b20731fe022df1dece6246e0239c0
+  data.tar.gz: 705397632e3afe3628776e854f74ff0ee70ada9d73d0d9e84c113289623d6240fc79b7823ca0dc05d3dab8dfd90c421c667b60ee394dbfb03c49afabd31ddc95

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master (unreleased)
 
+## 0.19.1 (2024-05-24)
+
+- Fix `add_index_in_background` to be idempotent
+
 ## 0.19.0 (2024-05-21)
 
 - Add ability to cancel background migrations

data/lib/online_migrations/background_schema_migrations/migration_helpers.rb

@@ -6,14 +6,24 @@ module OnlineMigrations
       def add_index_in_background(table_name, column_name, **options)
         migration_options = options.extract!(:max_attempts, :statement_timeout, :connection_class_name)
 
+        options[:algorithm] = :concurrently
+        index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options)
+
+        # Need to check this first, because `index_exists?` does not check for `:where`s.
+        if index_name_exists?(table_name, index.name)
+          Utils.raise_or_say(<<~MSG)
+            Index creation was not enqueued because the index with name '#{index.name}' already exists.
+            This can be due to an aborted migration or you need to explicitly provide another name
+            via `:name` option.
+          MSG
+          return
+        end
+
         if index_exists?(table_name, column_name, **options)
           Utils.raise_or_say("Index creation was not enqueued because the index already exists.")
           return
         end
 
-        options[:algorithm] = :concurrently
-        index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options)
-
         create_index = ActiveRecord::ConnectionAdapters::CreateIndexDefinition.new(index, algorithm, if_not_exists)
         schema_creation = ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaCreation.new(self)
         definition = schema_creation.accept(create_index)
@@ -77,22 +87,21 @@ module OnlineMigrations
       # @private
       def create_background_schema_migration(migration_name, table_name, **options)
         options.assert_valid_keys(:definition, :max_attempts, :statement_timeout, :connection_class_name)
-        migration = Migration.new(migration_name: migration_name, table_name: table_name, **options)
-
-        shards = Utils.shard_names(migration.connection_class)
-        if shards.size > 1
-          migration.children = shards.map do |shard|
-            child = migration.dup
-            child.shard = shard
-            child
-          end
 
-          migration.composite = true
-        end
+        Migration.find_or_create_by!(migration_name: migration_name, shard: nil) do |migration|
+          migration.assign_attributes(**options, table_name: table_name)
 
-        # This will save all the records using a transaction.
-        migration.save!
-        migration
+          shards = Utils.shard_names(migration.connection_class)
+          if shards.size > 1
+            migration.children = shards.map do |shard|
+              child = migration.dup
+              child.shard = shard
+              child
+            end
+
+            migration.composite = true
+          end
+        end
       end
     end
   end

data/lib/online_migrations/background_schema_migrations/migration_runner.rb

@@ -11,7 +11,7 @@ module OnlineMigrations
       end
 
       def run
-        return if migration.cancelled?
+        return if migration.cancelled? || migration.succeeded?
 
         mark_as_running if migration.enqueued? || migration.failed?
 

data/lib/online_migrations/version.rb

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

metadata

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