strong_migrations 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a22e260ec0e3e09954c65535725a3ddc4439b9cf94182a21cf5963e12d8485fe
-  data.tar.gz: 865633da561d77e615df16a9a00f8524a95bf73edc5590e3932855aaf544d4f7
+  metadata.gz: 4da88a3161110bc4e7fd6cc989ea51e0db2e32681c8026db11ac74c763f253b3
+  data.tar.gz: 583cd8b1e9665842ff6017c6d7242dcbfd9583157327b33ec023d5357c4e799f
 SHA512:
-  metadata.gz: f9b4df7a67aae2c8e1f7c58327b0e7e298261a33d9810dff4b5634bee3e000f1b26e64ad7b3997c8fc6c1cfef3a5cbeabe35ecbe508ed902679e3c9a720ecfb8
-  data.tar.gz: f4a7ecb6e64c40d1be1025a978387b94b9c2e47897cc25568c32dc32043292bc8fe14c9e6471108a4d84a1b1704459707f4fcf8a25227b7a86d8bcf2237dc19d
+  metadata.gz: 68356a9f5966f33a2a43f35a5f74ce21943798e4d85eb1c52710808dbac0efab6659d67a22d89aa4360cfc4f87e0dce6312e16f3a71dc0a739e87bb335d42f84
+  data.tar.gz: 67038470a20b75fd3dfb8642fea4775aedb08bff959255a44aa92271e2214300e9140f3d7cce21eae83e81ea314739c06999ce8d46a72f76f75f675e6c8914fb

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 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
+
+## 1.1.0 (2022-06-08)
+
+- Added check for `force` option with `create_join_table`
+- Improved errors for extra arguments
+- Fixed ignoring extra arguments with `safe_by_default`
+- Fixed missing options with `remove_index` and `safe_by_default`
+
 ## 1.0.0 (2022-03-21)
 
 New safe operations with MySQL and MariaDB

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

@@ -13,13 +13,8 @@ module StrongMigrations
         @version ||= begin
           target_version(StrongMigrations.target_postgresql_version) do
             version = select_all("SHOW server_version_num").first["server_version_num"].to_i
-            if version >= 100000
-              # major version for 10+
-              "#{version / 10000}"
-            else
-              # major and minor version for < 10
-              "#{version / 10000}.#{(version % 10000) / 100}"
-            end
+            # major and minor version
+            "#{version / 10000}.#{(version % 10000)}"
           end
         end
       end
@@ -77,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) &&
             (
               (
@@ -160,6 +155,20 @@ module StrongMigrations
         select_all(query.squish).any?
       end
 
+      # only check in non-developer environments (where actual server version is used)
+      def index_corruption?
+        server_version >= Gem::Version.new("14.0") &&
+          server_version < Gem::Version.new("14.4") &&
+          !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/checker.rb

@@ -33,29 +33,31 @@ module StrongMigrations
         # see checks.rb for methods
         case method
         when :add_check_constraint
-          check_add_check_constraint(args)
+          check_add_check_constraint(*args)
         when :add_column
-          check_add_column(args)
+          check_add_column(*args)
         when :add_foreign_key
-          check_add_foreign_key(args)
+          check_add_foreign_key(*args)
         when :add_index
-          check_add_index(args)
+          check_add_index(*args)
         when :add_reference, :add_belongs_to
-          check_add_reference(method, args)
+          check_add_reference(method, *args)
         when :change_column
-          check_change_column(args)
+          check_change_column(*args)
         when :change_column_null
-          check_change_column_null(args)
+          check_change_column_null(*args)
         when :change_table
           check_change_table
+        when :create_join_table
+          check_create_join_table(*args)
         when :create_table
-          check_create_table(args)
+          check_create_table(*args)
         when :execute
           check_execute
         when :remove_column, :remove_columns, :remove_timestamps, :remove_reference, :remove_belongs_to
-          check_remove_column(method, args)
+          check_remove_column(method, *args)
         when :remove_index
-          check_remove_index(args)
+          check_remove_index(*args)
         when :rename_column
           check_rename_column
         when :rename_table

data/lib/strong_migrations/checks.rb

@@ -3,9 +3,9 @@ module StrongMigrations
   module Checks
     private
 
-    def check_add_check_constraint(args)
-      table, expression, options = args
-      options ||= {}
+    def check_add_check_constraint(*args)
+      options = args.extract_options!
+      table, expression = args
 
       if !new_table?(table)
         if postgresql? && options[:validate] != false
@@ -14,7 +14,7 @@ module StrongMigrations
           validate_options = {name: name}
 
           if StrongMigrations.safe_by_default
-            safe_add_check_constraint(table, expression, add_options, validate_options)
+            safe_add_check_constraint(*args, add_options, validate_options)
             throw :safe
           end
 
@@ -27,12 +27,14 @@ module StrongMigrations
       end
     end
 
-    def check_add_column(args)
-      table, column, type, options = args
-      options ||= {}
+    def check_add_column(*args)
+      options = args.extract_options!
+      table, column, type = args
       default = options[:default]
 
-      if !default.nil? && !adapter.add_column_default_safe?
+      # 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 !default.nil? && (!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 = "
@@ -44,9 +46,10 @@ Then add the NOT NULL constraint in separate migrations."
           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),
+          code: backfill_code(table, column, default, volatile),
           append: append,
-          rewrite_blocks: adapter.rewrite_blocks
+          rewrite_blocks: adapter.rewrite_blocks,
+          default_type: (volatile ? "volatile" : "non-null")
       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
@@ -73,14 +76,14 @@ Then add the NOT NULL constraint in separate migrations."
     #
     # note: adding foreign_keys with create_table is fine
     # since the table is always guaranteed to be empty
-    def check_add_foreign_key(args)
-      from_table, to_table, options = args
-      options ||= {}
+    def check_add_foreign_key(*args)
+      options = args.extract_options!
+      from_table, to_table = args
 
       validate = options.fetch(:validate, true)
       if postgresql? && validate
         if StrongMigrations.safe_by_default
-          safe_add_foreign_key(from_table, to_table, options)
+          safe_add_foreign_key(*args, **options)
           throw :safe
         end
 
@@ -90,19 +93,24 @@ Then add the NOT NULL constraint in separate migrations."
       end
     end
 
-    def check_add_index(args)
-      table, columns, options = args
-      options ||= {}
+    def check_add_index(*args)
+      options = args.extract_options!
+      table, columns = args
 
       if columns.is_a?(Array) && columns.size > 3 && !options[:unique]
         raise_error :add_index_columns, header: "Best practice"
       end
 
+      # safe_by_default goes through this path as well
+      if postgresql? && options[:algorithm] == :concurrently && adapter.index_corruption?
+        raise_error :add_index_corruption
+      end
+
       # safe to add non-concurrently to new tables (even after inserting data)
       # since the table won't be in use by the application
       if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
         if StrongMigrations.safe_by_default
-          safe_add_index(table, columns, options)
+          safe_add_index(*args, **options)
           throw :safe
         end
 
@@ -110,9 +118,9 @@ Then add the NOT NULL constraint in separate migrations."
       end
     end
 
-    def check_add_reference(method, args)
-      table, reference, options = args
-      options ||= {}
+    def check_add_reference(method, *args)
+      options = args.extract_options!
+      table, reference = args
 
       if postgresql?
         index_value = options.fetch(:index, true)
@@ -127,7 +135,7 @@ Then add the NOT NULL constraint in separate migrations."
           end
 
           if StrongMigrations.safe_by_default
-            safe_add_reference(table, reference, options)
+            safe_add_reference(*args, **options)
             throw :safe
           end
 
@@ -148,9 +156,9 @@ Then add the foreign key in separate migrations."
       end
     end
 
-    def check_change_column(args)
-      table, column, type, options = args
-      options ||= {}
+    def check_change_column(*args)
+      options = args.extract_options!
+      table, column, type = args
 
       safe = false
       existing_column = connection.columns(table).find { |c| c.name.to_s == column.to_s }
@@ -168,7 +176,7 @@ Then add the foreign key in separate migrations."
       raise_error :change_column, rewrite_blocks: adapter.rewrite_blocks unless safe
     end
 
-    def check_change_column_null(args)
+    def check_change_column_null(*args)
       table, column, null, default = args
       if !null
         if postgresql?
@@ -221,9 +229,17 @@ Then add the foreign key in separate migrations."
                 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?
@@ -242,13 +258,21 @@ Then add the foreign key in separate migrations."
       raise_error :change_table, header: "Possibly dangerous operation"
     end
 
-    def check_create_table(args)
-      table, options = args
-      options ||= {}
+    def check_create_join_table(*args)
+      options = args.extract_options!
 
       raise_error :create_table if options[:force]
 
-      # keep track of new tables of add_index check
+      # TODO keep track of new table of add_index check
+    end
+
+    def check_create_table(*args)
+      options = args.extract_options!
+      table, _ = args
+
+      raise_error :create_table if options[:force]
+
+      # keep track of new table of add_index check
       @new_tables << table.to_s
     end
 
@@ -256,7 +280,7 @@ Then add the foreign key in separate migrations."
       raise_error :execute, header: "Possibly dangerous operation"
     end
 
-    def check_remove_column(method, args)
+    def check_remove_column(method, *args)
       columns =
         case method
         when :remove_timestamps
@@ -288,20 +312,26 @@ Then add the foreign key in separate migrations."
         column_suffix: columns.size > 1 ? "s" : ""
     end
 
-    def check_remove_index(args)
-      table, options = args
-      unless options.is_a?(Hash)
-        options = {column: options}
-      end
-      options ||= {}
+    def check_remove_index(*args)
+      options = args.extract_options!
+      table, _ = args
 
       if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
+        # avoid suggesting extra (invalid) args
+        args = args[0..1] unless StrongMigrations.safe_by_default
+
+        # Active Record < 6.1 only supports two arguments (including options)
+        if args.size == 2 && ar_version < 6.1
+          # arg takes precedence over option
+          options[:column] = args.pop
+        end
+
         if StrongMigrations.safe_by_default
-          safe_remove_index(table, options)
+          safe_remove_index(*args, **options)
           throw :safe
         end
 
-        raise_error :remove_index, command: command_str("remove_index", [table, options.merge(algorithm: :concurrently)])
+        raise_error :remove_index, command: command_str("remove_index", args + [options.merge(algorithm: :concurrently)])
       end
     end
 
@@ -390,9 +420,14 @@ 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
+        "#{model}.unscoped.in_batches do |relation| \n      relation.where(#{column}: nil).update_all(\"#{column} = #{default}\")\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
 
     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}
@@ -128,6 +128,11 @@ end",
 "Adding a non-unique index with more than three columns rarely improves performance.
 Instead, start an index with columns that narrow down the results the most.",
 
+    add_index_corruption:
+"Adding an index concurrently can cause silent data corruption in Postgres 14.0 to 14.3.
+Upgrade Postgres before adding new indexes, or wrap this step in a safety_assured { ... } block
+to accept the risk.",
+
     change_table:
 "Strong Migrations does not support inspecting what happens inside a
 change_table block, so cannot help you here. Please make really sure that what

data/lib/strong_migrations/safe_methods.rb

@@ -5,22 +5,22 @@ module StrongMigrations
     end
 
     # TODO check if invalid index with expected name exists and remove if needed
-    def safe_add_index(table, columns, options)
+    def safe_add_index(*args, **options)
       disable_transaction
-      @migration.add_index(table, columns, **options.merge(algorithm: :concurrently))
+      @migration.add_index(*args, **options.merge(algorithm: :concurrently))
     end
 
-    def safe_remove_index(table, options)
+    def safe_remove_index(*args, **options)
       disable_transaction
-      @migration.remove_index(table, **options.merge(algorithm: :concurrently))
+      @migration.remove_index(*args, **options.merge(algorithm: :concurrently))
     end
 
-    def safe_add_reference(table, reference, options)
+    def safe_add_reference(table, reference, *args, **options)
       @migration.reversible do |dir|
         dir.up do
           disable_transaction
           foreign_key = options.delete(:foreign_key)
-          @migration.add_reference(table, reference, **options)
+          @migration.add_reference(table, reference, *args, **options)
           if foreign_key
             # same as Active Record
             name =
@@ -43,10 +43,10 @@ module StrongMigrations
       end
     end
 
-    def safe_add_foreign_key(from_table, to_table, options)
+    def safe_add_foreign_key(from_table, to_table, *args, **options)
       @migration.reversible do |dir|
         dir.up do
-          @migration.add_foreign_key(from_table, to_table, **options.merge(validate: false))
+          @migration.add_foreign_key(from_table, to_table, *args, **options.merge(validate: false))
           disable_transaction
           @migration.validate_foreign_key(from_table, to_table)
         end
@@ -56,10 +56,10 @@ module StrongMigrations
       end
     end
 
-    def safe_add_check_constraint(table, expression, add_options, validate_options)
+    def safe_add_check_constraint(table, expression, *args, add_options, validate_options)
       @migration.reversible do |dir|
         dir.up do
-          @migration.add_check_constraint(table, expression, **add_options)
+          @migration.add_check_constraint(table, expression, *args, **add_options)
           disable_transaction
           @migration.validate_check_constraint(table, **validate_options)
         end

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "1.0.0"
+  VERSION = "1.3.0"
 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.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord