strong_migrations 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140b74a0133d3db034a54fc178e4f95e53fbdec0c569dc2ade222efc96b83a6b
-  data.tar.gz: f4aadca5f15f85849b975630bdb937e3eef00498c0e806f6ca7cd8112d859fd4
+  metadata.gz: c2afb67b7b25f7608d3d77d266703a23b5585fcfe006d8442a3da42547979f8d
+  data.tar.gz: 502347f1d82a120f93694bdffb3cc9d434573bb2e6c14f75f61c5dc1b43c723d
 SHA512:
-  metadata.gz: 2f79d4dbd4342e45af9799f4d303c8ad8af68e8aa24fc5e86667547ec2a4c8ce95e123a6b3f0eb1851573d7a1bebd89a6795f4afffd4a319a0a9f0d73293f3ee
-  data.tar.gz: a784f11afffd45d827d7135d1f8fb822979ba851f6d8b54e09025ff9144f32f5091dce8e080901bac51237be74894571c6d007eddf373e3007de4886f5391b54
+  metadata.gz: bb821b724c1d55150415e117c1509f407edadcb209312ee869b230563b59e55e64072371631b9a75f59e84bbc7af0bdde05e5e5e872ad0dc738917d28ea5c49f
+  data.tar.gz: eb503dd38ecc6ad8877e4a2c506b6503f5a00ac661f8adbc4962d6802009c278091d4a7236dff4c83d64885405d468a9275fd4601e869d3dffac709c3c39cc13

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.6.7 (2020-05-13)
+
+- Improved comments in initializer
+- Fixed string timeouts for Postgres
+
 ## 0.6.6 (2020-05-08)
 
 - Added warnings for missing and long lock timeouts

data/README.md

@@ -21,6 +21,7 @@ gem 'strong_migrations'
 And run:
 
 ```sh
+bundle install
 rails generate strong_migrations:install
 ```
 
@@ -40,8 +41,7 @@ Potentially dangerous operations:
 
 Postgres-specific checks:
 
-- [adding an index non-concurrently](#adding-an-index)
-- [removing an index non-concurrently](#removing-an-index)
+- [adding an index non-concurrently](#adding-an-index-non-concurrently)
 - [adding a reference](#adding-a-reference)
 - [adding a foreign key](#adding-a-foreign-key)
 - [adding a json column](#adding-a-json-column)
@@ -257,6 +257,8 @@ class CreateUsers < ActiveRecord::Migration[6.0]
 end
 ```
 
+If you intend to drop an existing table, run `drop_table` first.
+
 ### Using change_column_null with a default value
 
 #### Bad
@@ -297,7 +299,7 @@ class ExecuteSQL < ActiveRecord::Migration[6.0]
 end
 ```
 
-### Adding an index
+### Adding an index non-concurrently
 
 #### Bad
 
@@ -333,36 +335,6 @@ With [gindex](https://github.com/ankane/gindex), you can generate an index migra
 rails g index table column
 ```
 
-### Removing an index
-
-Note: This check is [opt-in](#opt-in-checks).
-
-#### Bad
-
-In Postgres, removing an index non-concurrently locks the table for a brief period.
-
-```ruby
-class RemoveSomeIndexFromUsers < ActiveRecord::Migration[6.0]
-  def change
-    remove_index :users, :some_column
-  end
-end
-```
-
-#### Good
-
-Remove indexes concurrently.
-
-```ruby
-class RemoveSomeIndexFromUsers < ActiveRecord::Migration[6.0]
-  disable_ddl_transaction!
-
-  def change
-    remove_index :users, column: :some_column, algorithm: :concurrently
-  end
-end
-```
-
 ### Adding a reference
 
 #### Bad
@@ -591,16 +563,12 @@ Note: Since `remove_column` always requires a `safety_assured` block, it’s not
 
 ## Opt-in Checks
 
-Some operations rarely cause issues in practice, but can be checked if desired. Enable checks with:
+### Removing an index non-concurrently
 
-```ruby
-StrongMigrations.enable_check(:remove_index)
-```
-
-To start a check only after a specific migration, use:
+Postgres supports removing indexes concurrently, but removing them non-concurrently shouldn’t be an issue for most applications. You can enable this check with:
 
 ```ruby
-StrongMigrations.enable_check(:remove_index, start_after: 20170101000000)
+StrongMigrations.enable_check(:remove_index)
 ```
 
 ## Disable Checks

data/lib/generators/strong_migrations/templates/initializer.rb.tt

@@ -1,12 +1,13 @@
 # Mark existing migrations as safe
 StrongMigrations.start_after = <%= start_after %>
 
-# Set timeouts
+# Set timeouts for migrations
 # If you use PgBouncer in transaction mode, delete these lines and set timeouts on the database user
 StrongMigrations.lock_timeout = 10.seconds
 StrongMigrations.statement_timeout = 1.hour
 
-# Analyze tables automatically (to update planner statistics) after an index is added
+# Analyze tables after indexes are added
+# Outdated statistics can sometimes hurt performance
 StrongMigrations.auto_analyze = true
 
 # Add custom checks

data/lib/strong_migrations.rb

@@ -5,7 +5,6 @@ require "active_support"
 require "strong_migrations/checker"
 require "strong_migrations/database_tasks"
 require "strong_migrations/migration"
-require "strong_migrations/migration_helpers"
 require "strong_migrations/version"
 
 # integrations
@@ -18,7 +17,7 @@ module StrongMigrations
   class << self
     attr_accessor :auto_analyze, :start_after, :checks, :error_messages,
       :target_postgresql_version, :target_mysql_version, :target_mariadb_version,
-      :enabled_checks, :lock_timeout, :statement_timeout, :helpers
+      :enabled_checks, :lock_timeout, :statement_timeout
     attr_writer :lock_timeout_limit
   end
   self.auto_analyze = false
@@ -182,19 +181,6 @@ class Validate%{migration_name} < ActiveRecord::Migration%{migration_suffix}
   end
 end",
 
-    change_column_null_postgresql_helper:
-"Setting NOT NULL on a column requires an AccessExclusiveLock,
-which is expensive on large tables. Instead, we can use a constraint and
-validate it in a separate step with a more agreeable RowShareLock.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def change
-    %{command}
-  end
-end",
-
     change_column_null_mysql:
 "Setting NOT NULL on an existing column is not safe with your database engine.",
 
@@ -213,23 +199,9 @@ class Validate%{migration_name} < ActiveRecord::Migration%{migration_suffix}
   def change
     %{validate_foreign_key_code}
   end
-end",
-
-    add_foreign_key_helper:
-"New foreign keys are validated by default. This acquires an AccessExclusiveLock,
-which is expensive on large tables. Instead, we can validate it in a separate step
-with a more agreeable RowShareLock.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def change
-    %{command}
-  end
-end",
+end"
   }
   self.enabled_checks = (error_messages.keys - [:remove_index]).map { |k| [k, {}] }.to_h
-  self.helpers = false
 
   # private
   def self.developer_env?
@@ -263,13 +235,6 @@ end",
       false
     end
   end
-
-  # def self.enable_helpers
-  #   unless helpers
-  #     ActiveRecord::Migration.include(StrongMigrations::MigrationHelpers)
-  #     self.helpers = true
-  #   end
-  # end
 end
 
 ActiveSupport.on_load(:active_record) do

data/lib/strong_migrations/checker.rb

@@ -196,17 +196,12 @@ Then add the foreign key in separate migrations."
           table, column, null, default = args
           if !null
             if postgresql?
-              if helpers?
-                raise_error :change_column_null_postgresql_helper,
-                  command: command_str(:add_null_constraint_safely, [table, column])
-              else
-                # match https://github.com/nullobject/rein
-                constraint_name = "#{table}_#{column}_null"
+              # match https://github.com/nullobject/rein
+              constraint_name = "#{table}_#{column}_null"
 
-                raise_error :change_column_null_postgresql,
-                  add_constraint_code: constraint_str("ALTER TABLE %s ADD CONSTRAINT %s CHECK (%s IS NOT NULL) NOT VALID", [table, constraint_name, column]),
-                  validate_constraint_code: constraint_str("ALTER TABLE %s VALIDATE CONSTRAINT %s", [table, constraint_name])
-              end
+              raise_error :change_column_null_postgresql,
+                add_constraint_code: constraint_str("ALTER TABLE %s ADD CONSTRAINT %s CHECK (%s IS NOT NULL) NOT VALID", [table, constraint_name, column]),
+                validate_constraint_code: constraint_str("ALTER TABLE %s VALIDATE CONSTRAINT %s", [table, constraint_name])
             elsif mysql? || mariadb?
               raise_error :change_column_null_mysql
             elsif !default.nil?
@@ -222,10 +217,7 @@ Then add the foreign key in separate migrations."
           validate = options.fetch(:validate, true) || ActiveRecord::VERSION::STRING < "5.2"
 
           if postgresql? && validate
-            if helpers?
-              raise_error :add_foreign_key_helper,
-                command: command_str(:add_foreign_key_safely, [from_table, to_table, options])
-            elsif ActiveRecord::VERSION::STRING < "5.2"
+            if ActiveRecord::VERSION::STRING < "5.2"
               # fk name logic from rails
               primary_key = options[:primary_key] || "id"
               column = options[:column] || "#{to_table.to_s.singularize}_id"
@@ -250,8 +242,10 @@ Then add the foreign key in separate migrations."
 
       result = yield
 
+      # outdated statistics + a new index can hurt performance of existing queries
       if StrongMigrations.auto_analyze && direction == :up && method == :add_index
         if postgresql?
+          # TODO remove verbose in 0.7.0
           connection.execute "ANALYZE VERBOSE #{connection.quote_table_name(args[0].to_s)}"
         elsif mariadb? || mysql?
           connection.execute "ANALYZE TABLE #{connection.quote_table_name(args[0].to_s)}"
@@ -267,7 +261,7 @@ Then add the foreign key in separate migrations."
         if StrongMigrations.statement_timeout
           statement =
             if postgresql?
-              "SET statement_timeout TO #{connection.quote(StrongMigrations.statement_timeout.to_i * 1000)}"
+              "SET statement_timeout TO #{connection.quote(postgresql_timeout(StrongMigrations.statement_timeout))}"
             elsif mysql?
               "SET max_execution_time = #{connection.quote(StrongMigrations.statement_timeout.to_i * 1000)}"
             elsif mariadb?
@@ -282,7 +276,7 @@ Then add the foreign key in separate migrations."
         if StrongMigrations.lock_timeout
           statement =
             if postgresql?
-              "SET lock_timeout TO #{connection.quote(StrongMigrations.lock_timeout.to_i * 1000)}"
+              "SET lock_timeout TO #{connection.quote(postgresql_timeout(StrongMigrations.lock_timeout))}"
             elsif mysql? || mariadb?
               "SET lock_wait_timeout = #{connection.quote(StrongMigrations.lock_timeout)}"
             else
@@ -369,22 +363,24 @@ Then add the foreign key in separate migrations."
           lock_timeout = connection.select_all("SHOW lock_timeout").first["lock_timeout"]
           lock_timeout_sec = timeout_to_sec(lock_timeout)
           if lock_timeout_sec == 0
-            warn "[strong_migrations] WARNING: No lock timeout set. This is dangerous."
+            warn "[strong_migrations] DANGER: No lock timeout set"
           elsif lock_timeout_sec > limit
-            warn "[strong_migrations] WARNING: Lock timeout is longer than #{limit} seconds: #{lock_timeout}. This is dangerous."
+            warn "[strong_migrations] DANGER: Lock timeout is longer than #{limit} seconds: #{lock_timeout}"
           end
         elsif mysql? || mariadb?
           lock_timeout = connection.select_all("SHOW VARIABLES LIKE 'lock_wait_timeout'").first["Value"]
           if lock_timeout.to_i > limit
-            warn "[strong_migrations] WARNING: Lock timeout is longer than #{limit} seconds: #{lock_timeout}. This is dangerous."
+            warn "[strong_migrations] DANGER: Lock timeout is longer than #{limit} seconds: #{lock_timeout}"
           end
         end
         @lock_timeout_checked = true
       end
     end
 
+    # units: https://www.postgresql.org/docs/current/config-setting.html
     def timeout_to_sec(timeout)
       suffixes = {
+        "us" => 0.001,
         "ms" => 1,
         "s" => 1000,
         "min" => 1000 * 60,
@@ -401,8 +397,12 @@ Then add the foreign key in separate migrations."
       timeout_ms / 1000.0
     end
 
-    def helpers?
-      StrongMigrations.helpers
+    def postgresql_timeout(timeout)
+      if timeout.is_a?(String)
+        timeout
+      else
+        timeout.to_i * 1000
+      end
     end
 
     def raise_error(message_key, header: nil, append: nil, **vars)

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "0.6.6"
+  VERSION = "0.6.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.7
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -115,7 +115,6 @@ files:
 - lib/strong_migrations/checker.rb
 - lib/strong_migrations/database_tasks.rb
 - lib/strong_migrations/migration.rb
-- lib/strong_migrations/migration_helpers.rb
 - lib/strong_migrations/railtie.rb
 - lib/strong_migrations/version.rb
 - lib/tasks/strong_migrations.rake

data/lib/strong_migrations/migration_helpers.rb

@@ -1,117 +0,0 @@
-module StrongMigrations
-  module MigrationHelpers
-    def add_foreign_key_safely(from_table, to_table, **options)
-      ensure_postgresql(__method__)
-      ensure_not_in_transaction(__method__)
-
-      reversible do |dir|
-        dir.up do
-          if ActiveRecord::VERSION::STRING >= "5.2"
-            add_foreign_key(from_table, to_table, options.merge(validate: false))
-            validate_foreign_key(from_table, to_table)
-          else
-            options = connection.foreign_key_options(from_table, to_table, options)
-            fk_name, column, primary_key = options.values_at(:name, :column, :primary_key)
-            primary_key ||= "id"
-
-            statement = ["ALTER TABLE %s ADD CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s (%s)"]
-            statement << on_delete_update_statement(:delete, options[:on_delete]) if options[:on_delete]
-            statement << on_delete_update_statement(:update, options[:on_update]) if options[:on_update]
-            statement << "NOT VALID"
-
-            safety_assured do
-              execute quote_identifiers(statement.join(" "), [from_table, fk_name, column, to_table, primary_key])
-              execute quote_identifiers("ALTER TABLE %s VALIDATE CONSTRAINT %s", [from_table, fk_name])
-            end
-          end
-        end
-
-        dir.down do
-          remove_foreign_key(from_table, to_table)
-        end
-      end
-    end
-
-    def add_null_constraint_safely(table_name, column_name, name: nil)
-      ensure_postgresql(__method__)
-      ensure_not_in_transaction(__method__)
-
-      reversible do |dir|
-        dir.up do
-          name ||= null_constraint_name(table_name, column_name)
-
-          safety_assured do
-            execute quote_identifiers("ALTER TABLE %s ADD CONSTRAINT %s CHECK (%s IS NOT NULL) NOT VALID", [table_name, name, column_name])
-            execute quote_identifiers("ALTER TABLE %s VALIDATE CONSTRAINT %s", [table_name, name])
-          end
-        end
-
-        dir.down do
-          remove_null_constraint_safely(table_name, column_name)
-        end
-      end
-    end
-
-    # removing constraints is safe, but this method is safe to reverse as well
-    def remove_null_constraint_safely(table_name, column_name, name: nil)
-      # could also ensure in transaction so it can be reversed
-      # but that's more of a concern for a reversible migrations check
-      ensure_postgresql(__method__)
-
-      reversible do |dir|
-        dir.up do
-          name ||= null_constraint_name(table_name, column_name)
-
-          safety_assured do
-            execute quote_identifiers("ALTER TABLE %s DROP CONSTRAINT %s", [table_name, name])
-          end
-        end
-
-        dir.down do
-          add_null_constraint_safely(table_name, column_name)
-        end
-      end
-    end
-
-    private
-
-    def ensure_postgresql(method_name)
-      raise StrongMigrations::Error, "`#{method_name}` is intended for Postgres only" unless postgresql?
-    end
-
-    def postgresql?
-      %w(PostgreSQL PostGIS).include?(connection.adapter_name)
-    end
-
-    def ensure_not_in_transaction(method_name)
-      if connection.transaction_open?
-        raise StrongMigrations::Error, "Cannot run `#{method_name}` inside a transaction. Use `disable_ddl_transaction` to disable the transaction."
-      end
-    end
-
-    # match https://github.com/nullobject/rein
-    def null_constraint_name(table_name, column_name)
-      "#{table_name}_#{column_name}_null"
-    end
-
-    def on_delete_update_statement(delete_or_update, action)
-      on = delete_or_update.to_s.upcase
-
-      case action
-      when :nullify
-        "ON #{on} SET NULL"
-      when :cascade
-        "ON #{on} CASCADE"
-      when :restrict
-        "ON #{on} RESTRICT"
-      else
-        # same error message as Active Record
-        raise "'#{action}' is not supported for :on_update or :on_delete.\nSupported values are: :nullify, :cascade, :restrict"
-      end
-    end
-
-    def quote_identifiers(statement, identifiers)
-      statement % identifiers.map { |v| connection.quote_table_name(v) }
-    end
-  end
-end