strong_migrations 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e155e036c26788c7c9fa7f513131422b784b895fe1cbfdfc8052ad1f5233cd6c
-  data.tar.gz: 5fe21cada2e29c433313c686332d96c67e2c55d057fd6c68839fe1993307c0f8
+  metadata.gz: 3538811c535186c2757c2e92a56ec753c77842a99728a727aabe323dd8852182
+  data.tar.gz: 6d33a69582e57e3035d7ef540894ce0020957aef8d4e081e693552615ac9af8b
 SHA512:
-  metadata.gz: 7f40abaf84f10ce6ce7255d083b3ec0940c2f7380705857767b0cde56b23802dcf844c27251c634006559dfb4489b799ab3758bf9928b6cb57b6bceb1bf051ec
-  data.tar.gz: c283b8b93715a4aabd2c0e8dc15b022e45ebfbe3bb52fccc037b9c95d3b2279d6002b78354cab8600cf2972f96a6966af0fd80aa9b58cde53343b5035d8bc59c
+  metadata.gz: 50a4b8ea0d0677bc0d5a3fa740f9f2e8b00acee0e673abaf7197c0c89540165ecb0cad913ed4244b61e3ac23342d4c44b8209991dea3841ee6dd7d7fbef827e3
+  data.tar.gz: fd6d44273d6365ca9e33a246e072a24da93191bfc73b5d425df22c0b3b6523ce218d6aa6360dd6a8fcbcf88b5a06bf41c7221ccdceb69f26b734510cd38876f7

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.3.0 (2025-04-03)
+
+- Added check for `change_column` for columns with check constraints with Postgres
+
+## 2.2.1 (2025-03-21)
+
+- Added support for `change_column_null` with default value with `safe_by_default` option
+- Improved backfill instructions
+- Fixed `safe_by_default` applying to migrations before `start_after`
+
 ## 2.2.0 (2025-02-01)
 
 - Fixed constraint name for long table and column names with `change_column_null`

data/README.md

@@ -377,8 +377,8 @@ class BackfillSomeColumn < ActiveRecord::Migration[8.0]
   disable_ddl_transaction!
 
   def up
-    User.unscoped.in_batches do |relation|
-      relation.update_all some_column: "default_value"
+    User.unscoped.in_batches(of: 10000) do |relation|
+      relation.where(some_column: nil).update_all some_column: "default_value"
       sleep(0.01) # throttle
     end
   end

data/lib/strong_migrations/adapters/postgresql_adapter.rb

@@ -177,6 +177,11 @@ module StrongMigrations
         63
       end
 
+      def constraints(table, column)
+        # TODO improve column check
+        connection.check_constraints(table).select { |c| /\b#{Regexp.escape(column.to_s)}\b/.match?(c.expression) }
+      end
+
       private
 
       def set_timeout(setting, timeout)

data/lib/strong_migrations/checks.rb

@@ -210,6 +210,32 @@ module StrongMigrations
       end
 
       raise_error :change_column, rewrite_blocks: adapter.rewrite_blocks unless safe
+
+      # constraints must be rechecked
+      # Postgres recommends dropping constraints before and adding them back
+      # https://www.postgresql.org/docs/current/ddl-alter.html#DDL-ALTER-COLUMN-TYPE
+      if postgresql?
+        constraints = adapter.constraints(table, column)
+        if constraints.any?
+          change_commands = []
+          constraints.each do |c|
+            change_commands << command_str(:remove_check_constraint, [table, c.expression, {name: c.name}])
+          end
+          change_commands << command_str(:change_column, args + [options])
+          constraints.each do |c|
+            change_commands << command_str(:add_check_constraint, [table, c.expression, {name: c.name, validate: false}])
+          end
+
+          validate_commands = []
+          constraints.each do |c|
+            validate_commands << command_str(:validate_check_constraint, [table, {name: c.name}])
+          end
+
+          raise_error :change_column_constraint,
+            change_column_code: change_commands.join("\n    "),
+            validate_constraint_code: validate_commands.join("\n    ")
+        end
+      end
     end
 
     def check_change_column_default(*args)
@@ -251,7 +277,7 @@ module StrongMigrations
             remove_args = [table, {name: constraint_name}]
 
             if StrongMigrations.safe_by_default
-              safe_change_column_null(add_args, validate_args, change_args, remove_args, default, constraints)
+              safe_change_column_null(add_args, validate_args, change_args, remove_args, table, column, default, constraints)
               throw :safe
             end
 
@@ -444,9 +470,9 @@ module StrongMigrations
       if function
         # update_all(column: Arel.sql(default)) also works in newer versions of Active Record
         update_expr = "#{quote_column_if_needed(column)} = #{default}"
-        "#{model}.unscoped.in_batches do |relation| \n      relation.where(#{column}: nil).update_all(#{update_expr.inspect})\n      sleep(0.01)\n    end"
+        "#{model}.unscoped.in_batches(of: 10000) do |relation| \n      relation.where(#{column}: nil).update_all(#{update_expr.inspect})\n      sleep(0.01)\n    end"
       else
-        "#{model}.unscoped.in_batches do |relation| \n      relation.update_all #{column}: #{default.inspect}\n      sleep(0.01)\n    end"
+        "#{model}.unscoped.in_batches(of: 10000) do |relation| \n      relation.where(#{column}: nil).update_all #{column}: #{default.inspect}\n      sleep(0.01)\n    end"
       end
     end
 

data/lib/strong_migrations/error_messages.rb

@@ -60,6 +60,22 @@ while the entire table is rewritten. A safer approach is to:
     change_column_with_not_null:
 "Changing the type is safe, but setting NOT NULL is not.",
 
+    change_column_constraint: "Changing the type of a column that has check constraints blocks reads and writes
+while every row is checked. Drop the check constraints on the column before
+changing the type and add them back afterwards.
+
+class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
+  def change
+    %{change_column_code}
+  end
+end
+
+class Validate%{migration_name} < ActiveRecord::Migration%{migration_suffix}
+  def change
+    %{validate_constraint_code}
+  end
+end",
+
     remove_column: "Active Record caches attributes, which causes problems
 when removing columns. Be sure to ignore the column%{column_suffix}:
 

data/lib/strong_migrations/safe_methods.rb

@@ -1,7 +1,7 @@
 module StrongMigrations
   module SafeMethods
     def safe_by_default_method?(method)
-      StrongMigrations.safe_by_default && [:add_index, :add_belongs_to, :add_reference, :remove_index, :add_foreign_key, :add_check_constraint, :change_column_null].include?(method)
+      StrongMigrations.safe_by_default && !version_safe? && [:add_index, :add_belongs_to, :add_reference, :remove_index, :add_foreign_key, :add_check_constraint, :change_column_null].include?(method)
     end
 
     def safe_add_index(*args, **options)
@@ -76,11 +76,38 @@ module StrongMigrations
       end
     end
 
-    def safe_change_column_null(add_args, validate_args, change_args, remove_args, default, constraints)
+    def safe_change_column_null(add_args, validate_args, change_args, remove_args, table, column, default, constraints)
       @migration.reversible do |dir|
         dir.up do
           unless default.nil?
-            raise Error, "default value not supported yet with safe_by_default"
+            # TODO search for parent model if needed
+            if connection.pool != ActiveRecord::Base.connection_pool
+              raise_error :change_column_null,
+                code: backfill_code(table, column, default)
+            end
+
+            model =
+              Class.new(ActiveRecord::Base) do
+                self.table_name = table
+
+                def self.to_s
+                  "Backfill"
+                end
+              end
+
+            update_sql =
+              model.connection_pool.with_connection do |c|
+                quoted_column = c.quote_column_name(column)
+                quoted_default = c.quote_default_expression(default, c.send(:column_for, table, column))
+                "#{quoted_column} = #{quoted_default}"
+              end
+
+            @migration.say("Backfilling default")
+            disable_transaction
+            model.unscoped.in_batches(of: 10000) do |relation|
+              relation.where(column => nil).update_all(update_sql)
+              sleep(0.01)
+            end
           end
 
           add_options = add_args.extract_options!

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -9,7 +9,7 @@ authors:
 - David Waller
 bindir: bin
 cert_chain: []
-date: 2025-02-01 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord