strong_migrations 1.4.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7444023bd5f0829a289ebc9d222a28f041a4e3789224438f9fd6bffa01fa6668
-  data.tar.gz: feb5010616cc8ef6cf36088be7a67bb0d74272cde79d0e9a0a442272bfa92d99
+  metadata.gz: 23737504a1d3beb08bf2412b161b8e59a8a620b4f4d993f11fe931e7f1772452
+  data.tar.gz: 993dc5f9d78cba148540a22772c18ed115ea6ae8075dd209cc3a869cc2a647a4
 SHA512:
-  metadata.gz: '0599a3fef628ec724471ef53b7ad7358831e6b638bdd0ca3b7cb79c1b416da6c044793ecca5475f5e602e8a7d1235ced3ff3fda526f31b9c4a56990c8531f9b4'
-  data.tar.gz: 6aac91ecb348c6a04c25511adf7df5d3e97823f6b9acdfbfd86bac50c4f5856f15fdcc271f00d0fc6f1e5d2cfdbaf3da5e056b1476aaf9b224e7df89b9737e01
+  metadata.gz: e906dc1c79d12a72a7d0e6fb4ca87319095d3b0a39f2da1dbd08b453d19e3215892745c86f80bf9ea26bbf07173d87022aab21b424a881f24744b65396fcd9bc
+  data.tar.gz: 56a0dadcb236f09a1a7d5450456ae343ac8cb6662b65f983c28b4268edad6e7cbecfa47c86ebb0d1da72dcc1b305e7196521811a48838c25beb1119846a2b928

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.6.0 (2023-07-22)
+
+- Added check for `change_column_default`
+
+## 1.5.0 (2023-07-02)
+
+- Added check for `add_column` with stored generated columns
+- Fixed `add_reference` with `foreign_key` and `index: false`
+
 ## 1.4.4 (2023-03-08)
 
 - Fixed `add_foreign_key` with `name` and `column` options with `safe_by_default`

data/README.md

@@ -62,6 +62,7 @@ Potentially dangerous operations:
 - [removing a column](#removing-a-column)
 - [adding a column with a default value](#adding-a-column-with-a-default-value)
 - [backfilling data](#backfilling-data)
+- [adding a stored generated column](#adding-a-stored-generated-column)
 - [changing the type of a column](#changing-the-type-of-a-column)
 - [renaming a column](#renaming-a-column)
 - [renaming a table](#renaming-a-table)
@@ -78,6 +79,10 @@ Postgres-specific checks:
 - [adding a json column](#adding-a-json-column)
 - [setting NOT NULL on an existing column](#setting-not-null-on-an-existing-column)
 
+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)
@@ -191,6 +196,24 @@ class BackfillSomeColumn < ActiveRecord::Migration[7.0]
 end
 ```
 
+### Adding a stored generated column
+
+#### Bad
+
+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[7.0]
+  def change
+    add_column :users, :some_column, :virtual, type: :string, as: "...", stored: true
+  end
+end
+```
+
+#### Good
+
+Add a non-generated column and use callbacks or triggers instead (or a virtual generated column with MySQL and MariaDB).
+
 ### Changing the type of a column
 
 #### Bad
@@ -609,6 +632,36 @@ class ValidateSomeColumnNotNull < ActiveRecord::Migration[6.0]
 end
 ```
 
+### 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

data/lib/strong_migrations/checker.rb

@@ -8,6 +8,7 @@ module StrongMigrations
     def initialize(migration)
       @migration = migration
       @new_tables = []
+      @new_columns = []
       @safe = false
       @timeouts_set = false
       @committed = false
@@ -46,6 +47,8 @@ module StrongMigrations
           check_add_reference(method, *args)
         when :change_column
           check_change_column(*args)
+        when :change_column_default
+          check_change_column_default(*args)
         when :change_column_null
           check_change_column_null(*args)
         when :change_table

data/lib/strong_migrations/checks.rb

@@ -32,6 +32,9 @@ module StrongMigrations
       table, column, type = args
       default = options[:default]
 
+      # keep track of new columns of change_column_default check
+      @new_columns << [table.to_s, column.to_s]
+
       # Check key since DEFAULT NULL behaves differently from no default
       #
       # Also, Active Record has special case for uuid columns that allows function default values
@@ -71,6 +74,10 @@ Then add the NOT NULL constraint in separate migrations."
         raise_error :add_column_json,
           command: command_str("add_column", [table, column, :jsonb, options])
       end
+
+      if type.to_s == "virtual" && options[:stored]
+        raise_error :add_column_generated_stored, rewrite_blocks: adapter.rewrite_blocks
+      end
     end
 
     def check_add_exclusion_constraint(*args)
@@ -147,7 +154,7 @@ Then add the NOT NULL constraint in separate migrations."
         if bad_index || options[:foreign_key]
           if index_value.is_a?(Hash)
             options[:index] = options[:index].merge(algorithm: :concurrently)
-          else
+          elsif index_value
             options = options.merge(index: {algorithm: :concurrently})
           end
 
@@ -194,6 +201,18 @@ Then add the foreign key in separate migrations."
       raise_error :change_column, rewrite_blocks: adapter.rewrite_blocks unless safe
     end
 
+    def check_change_column_default(*args)
+      table, column, _default_or_changes = args
+
+      # just check ActiveRecord::Base, even though can override on model
+      partial_inserts = ar_version >= 7 ? ActiveRecord::Base.partial_inserts : ActiveRecord::Base.partial_writes
+
+      if partial_inserts && !new_column?(table, column)
+        raise_error :change_column_default,
+          config: ar_version >= 7 ? "partial_inserts" : "partial_writes"
+      end
+    end
+
     def check_change_column_null(*args)
       table, column, null, default = args
       if !null
@@ -456,5 +475,9 @@ Then add the foreign key in separate migrations."
     def new_table?(table)
       @new_tables.include?(table.to_s)
     end
+
+    def new_column?(table, column)
+      new_table?(table) || @new_columns.include?([table.to_s, column.to_s])
+    end
   end
 end

data/lib/strong_migrations/error_messages.rb

@@ -50,6 +50,9 @@ class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
   end
 end",
 
+    add_column_generated_stored:
+"Adding a stored generated column blocks %{rewrite_blocks} while the entire table is rewritten.",
+
     change_column:
 "Changing the type of an existing column blocks %{rewrite_blocks}
 while the entire table is rewritten. A safer approach is to:
@@ -158,6 +161,13 @@ Otherwise, remove the force option.",
 execute call, so cannot help you here. Please make really sure that what
 you're doing is safe before proceeding, then wrap it in a safety_assured { ... } block.",
 
+    change_column_default:
+"Partial writes are enabled, which can cause incorrect values
+to be inserted when changing the default value of a column.
+Disable partial writes in config/application.rb:
+
+config.active_record.%{config} = false",
+
     change_column_null:
 "Passing a default value to change_column_null runs a single UPDATE query,
 which can cause downtime. Instead, backfill the existing rows in the

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "1.4.4"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Catch unsafe migrations in development