strong_migrations 1.2.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c0ea5c8cf3e904b89b8c4ab2f28ff60031515e40edf5b0c617ca4b8f8249650
-  data.tar.gz: 5cb0fd63058bf618595cd929ef90de3cf90f02963f0adca21182c578f41c3320
+  metadata.gz: 227ddfd8f939d855d93232f5d30d02a0c219f46c6393d98e2be5d8756c445e33
+  data.tar.gz: bde562f14e23d1fc7a1209e075efffad03454594b842bcde3c7b1ec6fa3046b4
 SHA512:
-  metadata.gz: 50db9d240d49b60b75d97c76765b8f5e3b252c2cc826bd5e50e9b57311082dfea2c9cc5790fd905a2eac45a3eb6afb2784c7ed7962dcaf0172157548e1c8d233
-  data.tar.gz: 2f2e5311cad061b712ee9dfb69a41b5e81f31be8db257bd095cbd8124bc461551afebb305d95b0bb090d6f7ef85c61618d61e64e9b73f266338a0aa7f5101b53
+  metadata.gz: 972103d956c2a8cdff88e478401f18459eabe93d7260107b5c19908cc76bef9451b19e99852511d8a8675639b076107d79d26a6046308d4627afc88f580afc76
+  data.tar.gz: 3bf1e422cf0d5cd4297bf63a6121570e5afa9acddccf42c4fa7a21eac40fa0cc6d5fca04e2227a45132d7efde0b7f702bb90f3be916097079f9b569cdd04ba50

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.3.2 (2022-10-09)
+
+- Improved error message for `add_column` with `default: nil` with Postgres 10
+
+## 1.3.1 (2022-09-21)
+
+- Fixed check for `add_column` with `default: nil` with Postgres 10
+
+## 1.3.0 (2022-08-30)
+
+- Added check for `add_column` with `uuid` type and volatile default value
+
 ## 1.2.0 (2022-06-10)
 
 - Added check for index corruption with Postgres 14.0 to 14.3

data/README.md

@@ -135,7 +135,7 @@ class AddSomeColumnToUsers < ActiveRecord::Migration[7.0]
 end
 ```
 
-In Postgres 11+, MySQL 8.0.12+, and MariaDB 10.3.2+, this no longer requires a table rewrite and is safe.
+In Postgres 11+, MySQL 8.0.12+, and MariaDB 10.3.2+, this no longer requires a table rewrite and is safe (except for volatile functions like `gen_random_uuid()`).
 
 #### Good
 
@@ -681,7 +681,7 @@ Disable specific checks with:
 StrongMigrations.disable_check(:add_index)
 ```
 
-Check the [source code](https://github.com/ankane/strong_migrations/blob/master/lib/strong_migrations.rb) for the list of keys.
+Check the [source code](https://github.com/ankane/strong_migrations/blob/master/lib/strong_migrations/error_messages.rb) for the list of keys.
 
 ## Down Migrations / Rollbacks
 

data/lib/strong_migrations/adapters/postgresql_adapter.rb

@@ -14,11 +14,7 @@ module StrongMigrations
           target_version(StrongMigrations.target_postgresql_version) do
             version = select_all("SHOW server_version_num").first["server_version_num"].to_i
             # major and minor version
-            if version >= 100000
-              "#{version / 10000}.#{(version % 10000)}"
-            else
-              "#{version / 10000}.#{(version % 10000) / 100}"
-            end
+            "#{version / 10000}.#{(version % 10000)}"
           end
         end
       end
@@ -76,7 +72,7 @@ module StrongMigrations
           # but there doesn't seem to be a way to set/modify it
           # https://wiki.postgresql.org/wiki/What%27s_new_in_PostgreSQL_9.2#Reduce_ALTER_TABLE_rewrites
         when "numeric", "decimal"
-          # numeric and decimal are equivalent and can be used interchangably
+          # numeric and decimal are equivalent and can be used interchangeably
           safe = ["numeric", "decimal"].include?(existing_type) &&
             (
               (
@@ -166,6 +162,13 @@ module StrongMigrations
           !StrongMigrations.developer_env?
       end
 
+      # default to true if unsure
+      def default_volatile?(default)
+        name = default.to_s.delete_suffix("()")
+        rows = select_all("SELECT provolatile FROM pg_proc WHERE proname = #{connection.quote(name)}").to_a
+        rows.empty? || rows.any? { |r| r["provolatile"] == "v" }
+      end
+
       private
 
       def set_timeout(setting, timeout)

data/lib/strong_migrations/checks.rb

@@ -32,7 +32,11 @@ module StrongMigrations
       table, column, type = args
       default = options[:default]
 
-      if !default.nil? && !adapter.add_column_default_safe?
+      # Check key since DEFAULT NULL behaves differently from no default
+      #
+      # Also, Active Record has special case for uuid columns that allows function default values
+      # https://github.com/rails/rails/blob/v7.0.3.1/activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb#L92-L93
+      if options.key?(:default) && (!adapter.add_column_default_safe? || (volatile = (postgresql? && type.to_s == "uuid" && default.to_s.include?("()") && adapter.default_volatile?(default))))
         if options[:null] == false
           options = options.except(:null)
           append = "
@@ -40,13 +44,21 @@ module StrongMigrations
 Then add the NOT NULL constraint in separate migrations."
         end
 
-        raise_error :add_column_default,
-          add_command: command_str("add_column", [table, column, type, options.except(:default)]),
-          change_command: command_str("change_column_default", [table, column, default]),
-          remove_command: command_str("remove_column", [table, column]),
-          code: backfill_code(table, column, default),
-          append: append,
-          rewrite_blocks: adapter.rewrite_blocks
+        if default.nil?
+          raise_error :add_column_default_null,
+            command: command_str("add_column", [table, column, type, options.except(:default)]),
+            append: append,
+            rewrite_blocks: adapter.rewrite_blocks
+        else
+          raise_error :add_column_default,
+            add_command: command_str("add_column", [table, column, type, options.except(:default)]),
+            change_command: command_str("change_column_default", [table, column, default]),
+            remove_command: command_str("remove_column", [table, column]),
+            code: backfill_code(table, column, default, volatile),
+            append: append,
+            rewrite_blocks: adapter.rewrite_blocks,
+            default_type: (volatile ? "volatile" : "non-null")
+        end
       elsif default.is_a?(Proc) && postgresql?
         # adding a column with a VOLATILE default is not safe
         # https://www.postgresql.org/docs/current/sql-altertable.html#SQL-ALTERTABLE-NOTES
@@ -219,16 +231,22 @@ Then add the foreign key in separate migrations."
 
             add_constraint_code =
               if constraint_methods
-                # only quote when needed
-                expr_column = column.to_s =~ /\A[a-z0-9_]+\z/ ? column : connection.quote_column_name(column)
-                command_str(:add_check_constraint, [table, "#{expr_column} IS NOT NULL", {name: constraint_name, validate: false}])
+                command_str(:add_check_constraint, [table, "#{quote_column_if_needed(column)} IS NOT NULL", {name: constraint_name, validate: false}])
               else
                 safety_assured_str(add_code)
               end
 
+            validate_constraint_code =
+              if safe_with_check_constraint
+                down_code = "#{add_constraint_code}\n    #{command_str(:change_column_null, [table, column, true])}"
+                "def up\n    #{validate_constraint_code}\n  end\n\n  def down\n    #{down_code}\n  end"
+              else
+                "def change\n    #{validate_constraint_code}\n  end"
+              end
+
             raise_error :change_column_null_postgresql,
               add_constraint_code: add_constraint_code,
-              validate_constraint_code: "def change\n    #{validate_constraint_code}\n  end"
+              validate_constraint_code: validate_constraint_code
           end
         elsif mysql? || mariadb?
           unless adapter.strict_mode?
@@ -409,9 +427,21 @@ Then add the foreign key in separate migrations."
       "#{command} #{str_args.join(", ")}"
     end
 
-    def backfill_code(table, column, default)
+    def backfill_code(table, column, default, function = false)
       model = table.to_s.classify
-      "#{model}.unscoped.in_batches do |relation| \n      relation.update_all #{column}: #{default.inspect}\n      sleep(0.01)\n    end"
+      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"
+      else
+        "#{model}.unscoped.in_batches do |relation| \n      relation.update_all #{column}: #{default.inspect}\n      sleep(0.01)\n    end"
+      end
+    end
+
+    # only quote when needed
+    # important! only use for display purposes
+    def quote_column_if_needed(column)
+      column.to_s =~ /\A[a-z0-9_]+\z/ ? column : connection.quote_column_name(column)
     end
 
     def new_table?(table)

data/lib/strong_migrations/error_messages.rb

@@ -1,7 +1,7 @@
 module StrongMigrations
   self.error_messages = {
     add_column_default:
-"Adding a column with a non-null default blocks %{rewrite_blocks} while the entire table is rewritten.
+"Adding a column with a %{default_type} default blocks %{rewrite_blocks} while the entire table is rewritten.
 Instead, add the column without a default value, then change the default.
 
 class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
@@ -25,6 +25,16 @@ class Backfill%{migration_name} < ActiveRecord::Migration%{migration_suffix}
   end
 end",
 
+    add_column_default_null:
+"Adding a column with a null default blocks %{rewrite_blocks} while the entire table is rewritten.
+Instead, add the column without a default value.
+
+class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
+  def change
+    %{command}
+  end
+end",
+
     add_column_default_callable:
 "Strong Migrations does not support inspecting callable default values.
 Please make really sure you're not calling a VOLATILE function,

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "1.2.0"
+  VERSION = "1.3.2"
 end

data/lib/tasks/strong_migrations.rake

@@ -1,5 +1,5 @@
 namespace :strong_migrations do
-  # https://www.pgrs.net/2008/03/13/alphabetize-schema-rb-columns/
+  # https://www.pgrs.net/2008/03/12/alphabetize-schema-rb-columns/
   task :alphabetize_columns do
     $stderr.puts "Dumping schema"
     ActiveRecord::Base.logger.level = Logger::INFO

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord