strong_migrations 2.5.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 971d5d1eabb91dc04c72cc99a24f8b92f1b0d31d8d28369577f48c283b8d8624
-  data.tar.gz: '08a413578f564ada7f9768aeaf469719ca051e4c37057be6324e593c73fb3144'
+  metadata.gz: 9c7db529b15ac630f2f6c9e284b185ca5affbdb275c2d34d26e508317f6e2fa4
+  data.tar.gz: 8b00a79a0f4cb787d43de827cbafe495c081b5250db4f08d75a893953778d72a
 SHA512:
-  metadata.gz: b8ca27268e166609ec8253ce686c6fe9cbe6d7c4b298f8c80ce7f1690e76a2c997fad2806cce52c9765f6ee92e7e389fdf6c830d3ca8ebb0241574adc02c4b57
-  data.tar.gz: 18731d2b1bdd12698d6b860a470249a24ea12aaa0b5b74b6510d41527ef2126c46b27ef4aa7c7adb1437bd7a006d0bb7c46490d24ec15720009723e5b0d8eca4
+  metadata.gz: 73091c6f13637427c09ed2dc013f804ac1ce91d78844b6dc10b7deb89aeb4d391123c4f16e661b34a1fd9e8013f5c6c50295e2a45824ca042e9418d3c6cd338d
+  data.tar.gz: 96bbd494942e1a9f3a529f2ee7453fb693e9ec61aba22846d6be9c5a986b9213053142f9f06a87dc16dbc9361520ae9ae84e32c72e43654fdd0f2da921590cdb

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.5.2 (2025-12-20)
+
+- Fixed false positive for `add_reference` with `foreign_key: {validate: false}`
+
+## 2.5.1 (2025-10-13)
+
+- Fixed `transaction_timeout` option with DDL transaction
+
 ## 2.5.0 (2025-07-27)
 
 - Added check for `rename_schema`

data/README.md

@@ -43,7 +43,7 @@ end
 
 Deploy the code, then wrap this step in a safety_assured { ... } block.
 
-class RemoveColumn < ActiveRecord::Migration[8.0]
+class RemoveColumn < ActiveRecord::Migration[8.1]
   def change
     safety_assured { remove_column :users, :name }
   end
@@ -82,10 +82,6 @@ Postgres-specific checks:
 - [adding a column with a volatile default value](#adding-a-column-with-a-volatile-default-value)
 - [renaming a schema](#renaming-a-schema)
 
-Config-specific checks:
-
-- [changing the default value of a column](#changing-the-default-value-of-a-column)
-
 Best practices:
 
 - [keeping non-unique indexes to three columns or less](#keeping-non-unique-indexes-to-three-columns-or-less)
@@ -99,7 +95,7 @@ You can also add [custom checks](#custom-checks) or [disable specific checks](#d
 Active Record caches database columns at runtime, so if you drop a column, it can cause exceptions until your app reboots.
 
 ```ruby
-class RemoveSomeColumnFromUsers < ActiveRecord::Migration[8.0]
+class RemoveSomeColumnFromUsers < ActiveRecord::Migration[8.1]
   def change
     remove_column :users, :some_column
   end
@@ -120,7 +116,7 @@ end
 3. Write a migration to remove the column (wrap in `safety_assured` block)
 
   ```ruby
-  class RemoveSomeColumnFromUsers < ActiveRecord::Migration[8.0]
+  class RemoveSomeColumnFromUsers < ActiveRecord::Migration[8.1]
     def change
       safety_assured { remove_column :users, :some_column }
     end
@@ -137,7 +133,7 @@ end
 Changing the type of a column causes the entire table to be rewritten. During this time, reads and writes are blocked in Postgres, and writes are blocked in MySQL and MariaDB.
 
 ```ruby
-class ChangeSomeColumnType < ActiveRecord::Migration[8.0]
+class ChangeSomeColumnType < ActiveRecord::Migration[8.1]
   def change
     change_column :users, :some_column, :new_type
   end
@@ -183,7 +179,7 @@ A safer approach is to:
 Renaming a column that’s in use will cause errors in your application.
 
 ```ruby
-class RenameSomeColumn < ActiveRecord::Migration[8.0]
+class RenameSomeColumn < ActiveRecord::Migration[8.1]
   def change
     rename_column :users, :some_column, :new_name
   end
@@ -208,7 +204,7 @@ A safer approach is to:
 Renaming a table that’s in use will cause errors in your application.
 
 ```ruby
-class RenameUsersToCustomers < ActiveRecord::Migration[8.0]
+class RenameUsersToCustomers < ActiveRecord::Migration[8.1]
   def change
     rename_table :users, :customers
   end
@@ -233,7 +229,7 @@ A safer approach is to:
 The `force` option can drop an existing table.
 
 ```ruby
-class CreateUsers < ActiveRecord::Migration[8.0]
+class CreateUsers < ActiveRecord::Migration[8.1]
   def change
     create_table :users, force: true do |t|
       # ...
@@ -247,7 +243,7 @@ end
 Create tables without the `force` option.
 
 ```ruby
-class CreateUsers < ActiveRecord::Migration[8.0]
+class CreateUsers < ActiveRecord::Migration[8.1]
   def change
     create_table :users do |t|
       # ...
@@ -265,7 +261,7 @@ If you intend to drop an existing table, run `drop_table` first.
 Adding an auto-incrementing column (`serial`/`bigserial` in Postgres and `AUTO_INCREMENT` in MySQL and MariaDB) causes the entire table to be rewritten. During this time, reads and writes are blocked in Postgres, and writes are blocked in MySQL and MariaDB.
 
 ```ruby
-class AddIdToCitiesUsers < ActiveRecord::Migration[8.0]
+class AddIdToCitiesUsers < ActiveRecord::Migration[8.1]
   def change
     add_column :cities_users, :id, :primary_key
   end
@@ -285,7 +281,7 @@ Create a new table and migrate the data with the same steps as [renaming a table
 Adding a stored generated column causes the entire table to be rewritten. During this time, reads and writes are blocked in Postgres, and writes are blocked in MySQL and MariaDB.
 
 ```ruby
-class AddSomeColumnToUsers < ActiveRecord::Migration[8.0]
+class AddSomeColumnToUsers < ActiveRecord::Migration[8.1]
   def change
     add_column :users, :some_column, :virtual, type: :string, as: "...", stored: true
   end
@@ -305,7 +301,7 @@ Add a non-generated column and use callbacks or triggers instead (or a virtual g
 Adding a check constraint blocks reads and writes in Postgres and blocks writes in MySQL and MariaDB while every row is checked.
 
 ```ruby
-class AddCheckConstraint < ActiveRecord::Migration[8.0]
+class AddCheckConstraint < ActiveRecord::Migration[8.1]
   def change
     add_check_constraint :users, "price > 0", name: "price_check"
   end
@@ -317,7 +313,7 @@ end
 Add the check constraint without validating existing rows:
 
 ```ruby
-class AddCheckConstraint < ActiveRecord::Migration[8.0]
+class AddCheckConstraint < ActiveRecord::Migration[8.1]
   def change
     add_check_constraint :users, "price > 0", name: "price_check", validate: false
   end
@@ -327,7 +323,7 @@ end
 Then validate them in a separate migration.
 
 ```ruby
-class ValidateCheckConstraint < ActiveRecord::Migration[8.0]
+class ValidateCheckConstraint < ActiveRecord::Migration[8.1]
   def change
     validate_check_constraint :users, name: "price_check"
   end
@@ -343,7 +339,7 @@ end
 Strong Migrations can’t ensure safety for raw SQL statements. Make really sure that what you’re doing is safe, then use:
 
 ```ruby
-class ExecuteSQL < ActiveRecord::Migration[8.0]
+class ExecuteSQL < ActiveRecord::Migration[8.1]
   def change
     safety_assured { execute "..." }
   end
@@ -359,7 +355,7 @@ Note: Strong Migrations does not detect dangerous backfills.
 Active Record creates a transaction around each migration, and backfilling in the same transaction that alters a table keeps the table locked for the [duration of the backfill](https://wework.github.io/data/2015/11/05/add-columns-with-default-values-to-large-tables-in-rails-postgres/).
 
 ```ruby
-class AddSomeColumnToUsers < ActiveRecord::Migration[8.0]
+class AddSomeColumnToUsers < ActiveRecord::Migration[8.1]
   def change
     add_column :users, :some_column, :text
     User.update_all some_column: "default_value"
@@ -374,7 +370,7 @@ Also, running a single query to update data can cause issues for large tables.
 There are three keys to backfilling safely: batching, throttling, and running it outside a transaction. Use the Rails console or a separate migration with `disable_ddl_transaction!`.
 
 ```ruby
-class BackfillSomeColumn < ActiveRecord::Migration[8.0]
+class BackfillSomeColumn < ActiveRecord::Migration[8.1]
   disable_ddl_transaction!
 
   def up
@@ -397,7 +393,7 @@ Note: If backfilling with a method other than `update_all`, use `User.reset_colu
 In Postgres, adding an index non-concurrently blocks writes.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[8.0]
+class AddSomeIndexToUsers < ActiveRecord::Migration[8.1]
   def change
     add_index :users, :some_column
   end
@@ -409,7 +405,7 @@ end
 Add indexes concurrently.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[8.0]
+class AddSomeIndexToUsers < ActiveRecord::Migration[8.1]
   disable_ddl_transaction!
 
   def change
@@ -435,7 +431,7 @@ rails g index table column
 Rails adds an index non-concurrently to references by default, which blocks writes in Postgres.
 
 ```ruby
-class AddReferenceToUsers < ActiveRecord::Migration[8.0]
+class AddReferenceToUsers < ActiveRecord::Migration[8.1]
   def change
     add_reference :users, :city
   end
@@ -447,7 +443,7 @@ end
 Make sure the index is added concurrently.
 
 ```ruby
-class AddReferenceToUsers < ActiveRecord::Migration[8.0]
+class AddReferenceToUsers < ActiveRecord::Migration[8.1]
   disable_ddl_transaction!
 
   def change
@@ -465,7 +461,7 @@ end
 In Postgres, adding a foreign key blocks writes on both tables.
 
 ```ruby
-class AddForeignKeyOnUsers < ActiveRecord::Migration[8.0]
+class AddForeignKeyOnUsers < ActiveRecord::Migration[8.1]
   def change
     add_foreign_key :users, :orders
   end
@@ -475,7 +471,7 @@ end
 or
 
 ```ruby
-class AddReferenceToUsers < ActiveRecord::Migration[8.0]
+class AddReferenceToUsers < ActiveRecord::Migration[8.1]
   def change
     add_reference :users, :order, foreign_key: true
   end
@@ -487,7 +483,7 @@ end
 Add the foreign key without validating existing rows:
 
 ```ruby
-class AddForeignKeyOnUsers < ActiveRecord::Migration[8.0]
+class AddForeignKeyOnUsers < ActiveRecord::Migration[8.1]
   def change
     add_foreign_key :users, :orders, validate: false
   end
@@ -497,7 +493,7 @@ end
 Then validate them in a separate migration.
 
 ```ruby
-class ValidateForeignKeyOnUsers < ActiveRecord::Migration[8.0]
+class ValidateForeignKeyOnUsers < ActiveRecord::Migration[8.1]
   def change
     validate_foreign_key :users, :orders
   end
@@ -511,7 +507,7 @@ end
 In Postgres, adding a unique constraint creates a unique index, which blocks reads and writes.
 
 ```ruby
-class AddUniqueConstraint < ActiveRecord::Migration[8.0]
+class AddUniqueConstraint < ActiveRecord::Migration[8.1]
   def change
     add_unique_constraint :users, :some_column
   end
@@ -523,7 +519,7 @@ end
 Create a unique index concurrently, then use it for the constraint.
 
 ```ruby
-class AddUniqueConstraint < ActiveRecord::Migration[8.0]
+class AddUniqueConstraint < ActiveRecord::Migration[8.1]
   disable_ddl_transaction!
 
   def up
@@ -544,7 +540,7 @@ end
 In Postgres, adding an exclusion constraint blocks reads and writes while every row is checked.
 
 ```ruby
-class AddExclusionConstraint < ActiveRecord::Migration[8.0]
+class AddExclusionConstraint < ActiveRecord::Migration[8.1]
   def change
     add_exclusion_constraint :users, "number WITH =", using: :gist
   end
@@ -562,7 +558,7 @@ end
 In Postgres, there’s no equality operator for the `json` column type, which can cause errors for existing `SELECT DISTINCT` queries in your application.
 
 ```ruby
-class AddPropertiesToUsers < ActiveRecord::Migration[8.0]
+class AddPropertiesToUsers < ActiveRecord::Migration[8.1]
   def change
     add_column :users, :properties, :json
   end
@@ -574,7 +570,7 @@ end
 Use `jsonb` instead.
 
 ```ruby
-class AddPropertiesToUsers < ActiveRecord::Migration[8.0]
+class AddPropertiesToUsers < ActiveRecord::Migration[8.1]
   def change
     add_column :users, :properties, :jsonb
   end
@@ -590,7 +586,7 @@ end
 In Postgres, setting `NOT NULL` on an existing column blocks reads and writes while every row is checked.
 
 ```ruby
-class SetSomeColumnNotNull < ActiveRecord::Migration[8.0]
+class SetSomeColumnNotNull < ActiveRecord::Migration[8.1]
   def change
     change_column_null :users, :some_column, false
   end
@@ -602,7 +598,7 @@ end
 Instead, add a check constraint.
 
 ```ruby
-class SetSomeColumnNotNull < ActiveRecord::Migration[8.0]
+class SetSomeColumnNotNull < ActiveRecord::Migration[8.1]
   def change
     add_check_constraint :users, "some_column IS NOT NULL", name: "users_some_column_null", validate: false
   end
@@ -612,7 +608,7 @@ end
 Then validate it in a separate migration. Once the check constraint is validated, you can safely set `NOT NULL` on the column and drop the check constraint.
 
 ```ruby
-class ValidateSomeColumnNotNull < ActiveRecord::Migration[8.0]
+class ValidateSomeColumnNotNull < ActiveRecord::Migration[8.1]
   def up
     validate_check_constraint :users, name: "users_some_column_null"
     change_column_null :users, :some_column, false
@@ -633,7 +629,7 @@ end
 Adding a column with a volatile default value to an existing table causes the entire table to be rewritten. During this time, reads and writes are blocked.
 
 ```ruby
-class AddSomeColumnToUsers < ActiveRecord::Migration[8.0]
+class AddSomeColumnToUsers < ActiveRecord::Migration[8.1]
   def change
     add_column :users, :some_column, :uuid, default: "gen_random_uuid()"
   end
@@ -645,7 +641,7 @@ end
 Instead, add the column without a default value, then change the default.
 
 ```ruby
-class AddSomeColumnToUsers < ActiveRecord::Migration[8.0]
+class AddSomeColumnToUsers < ActiveRecord::Migration[8.1]
   def up
     add_column :users, :some_column, :uuid
     change_column_default :users, :some_column, from: nil, to: "gen_random_uuid()"
@@ -684,36 +680,6 @@ A safer approach is to:
 5. Stop writing to the old schema
 6. Drop the old schema
 
-### Changing the default value of a column
-
-#### Bad
-
-Rails < 7 enables partial writes by default, which can cause incorrect values to be inserted when changing the default value of a column.
-
-```ruby
-class ChangeSomeColumnDefault < ActiveRecord::Migration[6.1]
-  def change
-    change_column_default :users, :some_column, from: "old", to: "new"
-  end
-end
-
-User.create!(some_column: "old") # can insert "new"
-```
-
-#### Good
-
-Disable partial writes in `config/application.rb`. For Rails < 7, use:
-
-```ruby
-config.active_record.partial_writes = false
-```
-
-For Rails 7+, use:
-
-```ruby
-config.active_record.partial_inserts = false
-```
-
 ### Keeping non-unique indexes to three columns or less
 
 #### Bad
@@ -721,7 +687,7 @@ config.active_record.partial_inserts = false
 Adding a non-unique index with more than three columns rarely improves performance.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[8.0]
+class AddSomeIndexToUsers < ActiveRecord::Migration[8.1]
   def change
     add_index :users, [:a, :b, :c, :d]
   end
@@ -733,7 +699,7 @@ end
 Instead, start an index with columns that narrow down the results the most.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[8.0]
+class AddSomeIndexToUsers < ActiveRecord::Migration[8.1]
   def change
     add_index :users, [:d, :b]
   end
@@ -747,7 +713,7 @@ For Postgres, be sure to add them concurrently.
 To mark a step in the migration as safe, despite using a method that might otherwise be dangerous, wrap it in a `safety_assured` block.
 
 ```ruby
-class MySafeMigration < ActiveRecord::Migration[8.0]
+class MySafeMigration < ActiveRecord::Migration[8.1]
   def change
     safety_assured { remove_column :users, :some_column }
   end
@@ -967,15 +933,20 @@ StrongMigrations.auto_analyze = true
 
 ## Faster Migrations
 
-Only dump the schema when adding a new migration. If you use Git, add to `config/environments/development.rb`:
+Only dump the schema when adding a new migration. If you use Git, add to the end of your `Rakefile`:
 
 ```rb
-config.active_record.dump_schema_after_migration = `git status db/migrate/ --porcelain`.present?
+task :faster_migrations do
+  ActiveRecord.dump_schema_after_migration = Rails.env.development? &&
+    `git status db/migrate/ --porcelain`.present?
+end
+
+task "db:migrate" => "faster_migrations"
 ```
 
 ## 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/). Add to `config/initializers/strong_migrations.rb`:
+With Active Record < 8.1, 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/). Add to `config/initializers/strong_migrations.rb`:
 
 ```ruby
 StrongMigrations.alphabetize_schema = true

data/lib/strong_migrations/checker.rb

@@ -151,6 +151,16 @@ module StrongMigrations
       StrongMigrations.skipped_databases.map(&:to_s).include?(db_config_name)
     end
 
+    def set_transaction_timeout
+      return if defined?(@transaction_timeout_set)
+
+      if StrongMigrations.transaction_timeout
+        adapter.set_transaction_timeout(StrongMigrations.transaction_timeout)
+      end
+
+      @transaction_timeout_set = true
+    end
+
     private
 
     def check_adapter
@@ -183,9 +193,6 @@ module StrongMigrations
       if StrongMigrations.statement_timeout
         adapter.set_statement_timeout(StrongMigrations.statement_timeout)
       end
-      if StrongMigrations.transaction_timeout
-        adapter.set_transaction_timeout(StrongMigrations.transaction_timeout)
-      end
       if StrongMigrations.lock_timeout
         adapter.set_lock_timeout(StrongMigrations.lock_timeout)
       end

data/lib/strong_migrations/checks.rb

@@ -147,9 +147,13 @@ module StrongMigrations
       if postgresql?
         index_value = options.fetch(:index, true)
         concurrently_set = index_value.is_a?(Hash) && index_value[:algorithm] == :concurrently
-        bad_index = index_value && !concurrently_set
+        index_unsafe = index_value && !concurrently_set
 
-        if bad_index || options[:foreign_key]
+        foreign_key_value = options[:foreign_key]
+        validate_false = foreign_key_value.is_a?(Hash) && foreign_key_value[:validate] == false
+        foreign_key_unsafe = foreign_key_value && !validate_false
+
+        if index_unsafe || foreign_key_unsafe
           if index_value.is_a?(Hash)
             options[:index] = options[:index].merge(algorithm: :concurrently)
           elsif index_value
@@ -161,7 +165,8 @@ module StrongMigrations
             throw :safe
           end
 
-          if options.delete(:foreign_key)
+          if foreign_key_unsafe
+            options.delete(:foreign_key)
             headline = "Adding a foreign key blocks writes on both tables."
             append = "\n\nThen add the foreign key in separate migrations."
           else

data/lib/strong_migrations/migrator.rb

@@ -1,7 +1,8 @@
 module StrongMigrations
   module Migrator
     def ddl_transaction(migration, ...)
-      return super unless StrongMigrations.lock_timeout_retries > 0 && use_transaction?(migration)
+      retries = StrongMigrations.lock_timeout_retries > 0 && use_transaction?(migration)
+      return super unless retries || StrongMigrations.transaction_timeout
 
       # handle MigrationProxy class
       migration = migration.send(:migration) if !migration.is_a?(ActiveRecord::Migration) && migration.respond_to?(:migration, true)
@@ -9,6 +10,9 @@ module StrongMigrations
       checker = migration.send(:strong_migrations_checker)
       return super if checker.skip?
 
+      checker.set_transaction_timeout
+      return super unless retries
+
       # retry migration since the entire transaction needs to be rerun
       checker.retry_lock_timeouts(check_committed: true) do
         # failed transaction reverts timeout, so need to re-apply

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "2.5.0"
+  VERSION = "2.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Andrew Kane