strong_migrations 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bad0ba9c075a7c3eae98fc8835b9e56863b3573a381371d3b1affde769da0ad6
-  data.tar.gz: 7d67dbdaf674414b43781dd45b60f1f0d11a6d811ffe9ce8235ffed2889d8383
+  metadata.gz: 140b74a0133d3db034a54fc178e4f95e53fbdec0c569dc2ade222efc96b83a6b
+  data.tar.gz: f4aadca5f15f85849b975630bdb937e3eef00498c0e806f6ca7cd8112d859fd4
 SHA512:
-  metadata.gz: dc889f4d62bba08ae0d628e629dc37d7ecd53300ae92691118ca3db0707a416e7f043bbde41f2a0311acb9bd0f0b973175413f17a7c8aed2e134a6f29fc59b61
-  data.tar.gz: b08c078f6591b4458fadf64c9d1b8e04c3323c8dc9036e88e4e5a7ddc4f8a38bfa39d8e3e0cce2dcda7b9b9fce2d9676140d0cf89b2d668f6e5f2389e825b225
+  metadata.gz: 2f79d4dbd4342e45af9799f4d303c8ad8af68e8aa24fc5e86667547ec2a4c8ce95e123a6b3f0eb1851573d7a1bebd89a6795f4afffd4a319a0a9f0d73293f3ee
+  data.tar.gz: a784f11afffd45d827d7135d1f8fb822979ba851f6d8b54e09025ff9144f32f5091dce8e080901bac51237be74894571c6d007eddf373e3007de4886f5391b54

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.6.6 (2020-05-08)
+
+- Added warnings for missing and long lock timeouts
+- Added install generator
+
 ## 0.6.5 (2020-05-06)
 
 - Fixed deprecation warnings with Ruby 2.7

data/README.md

@@ -18,7 +18,11 @@ Add this line to your application’s Gemfile:
 gem 'strong_migrations'
 ```
 
-We highly recommend [setting timeouts](#timeouts). You can [mark existing migrations as safe](#existing-migrations) as well.
+And run:
+
+```sh
+rails generate strong_migrations:install
+```
 
 ## Checks
 
@@ -621,20 +625,20 @@ Check the [source code](https://github.com/ankane/strong_migrations/blob/master/
 
 ## Timeouts
 
-It’s a good idea to set a long statement timeout and a short lock timeout for migrations. This way, migrations can run for a while, and if a migration can’t acquire a lock in a timely manner, other statements won’t be stuck behind it.
+It’s extremely important to set a short lock timeout for migrations. This way, if a migration can’t acquire a lock in a timely manner, other statements won’t be stuck behind it. We also recommend setting a long statement timeout so migrations can run for a while.
 
 Create `config/initializers/strong_migrations.rb` with:
 
 ```ruby
-StrongMigrations.statement_timeout = 1.hour
 StrongMigrations.lock_timeout = 10.seconds
+StrongMigrations.statement_timeout = 1.hour
 ```
 
 Or set the timeouts directly on the database user that runs migrations. For Postgres, use:
 
 ```sql
-ALTER ROLE myuser SET statement_timeout = '1h';
 ALTER ROLE myuser SET lock_timeout = '10s';
+ALTER ROLE myuser SET statement_timeout = '1h';
 ```
 
 Note: If you use PgBouncer in transaction mode, you must set timeouts on the database user.
@@ -651,7 +655,7 @@ Use the version from your latest migration.
 
 ## Target Version
 
-If your development database version is different from production, you can specify the production version so the right checks are run in development.
+If your development database version is different from production, you can specify the production version so the right checks run in development.
 
 ```ruby
 StrongMigrations.target_postgresql_version = "10"

data/lib/generators/strong_migrations/install_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators"
+
+module StrongMigrations
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def create_initializer
+        template "initializer.rb", "config/initializers/strong_migrations.rb"
+      end
+
+      def start_after
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# Mark existing migrations as safe
+StrongMigrations.start_after = <%= start_after %>
+
+# Set timeouts
+# 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
+StrongMigrations.auto_analyze = true
+
+# Add custom checks
+# StrongMigrations.add_check do |method, args|
+#   if method == :add_index && args[0].to_s == "users"
+#     stop! "No more indexes on the users table"
+#   end
+# end

data/lib/strong_migrations.rb

@@ -19,6 +19,7 @@ module StrongMigrations
     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
+    attr_writer :lock_timeout_limit
   end
   self.auto_analyze = false
   self.start_after = 0
@@ -230,6 +231,18 @@ end",
   self.enabled_checks = (error_messages.keys - [:remove_index]).map { |k| [k, {}] }.to_h
   self.helpers = false
 
+  # private
+  def self.developer_env?
+    defined?(Rails) && (Rails.env.development? || Rails.env.test?)
+  end
+
+  def self.lock_timeout_limit
+    unless defined?(@lock_timeout_limit)
+      @lock_timeout_limit = developer_env? ? false : 10
+    end
+    @lock_timeout_limit
+  end
+
   def self.add_check(&block)
     checks << block
   end

data/lib/strong_migrations/checker.rb

@@ -7,6 +7,7 @@ module StrongMigrations
       @new_tables = []
       @safe = false
       @timeouts_set = false
+      @lock_timeout_checked = false
     end
 
     def safety_assured
@@ -21,6 +22,7 @@ module StrongMigrations
 
     def perform(method, *args)
       set_timeouts
+      check_lock_timeout
 
       unless safe?
         case method
@@ -259,6 +261,7 @@ Then add the foreign key in separate migrations."
       result
     end
 
+    # TODO allow string timeouts in 0.7.0
     def set_timeouts
       if !@timeouts_set
         if StrongMigrations.statement_timeout
@@ -350,7 +353,7 @@ Then add the foreign key in separate migrations."
 
     def target_version(target_version)
       version =
-        if target_version && defined?(Rails) && (Rails.env.development? || Rails.env.test?)
+        if target_version && StrongMigrations.developer_env?
           target_version.to_s
         else
           yield
@@ -358,6 +361,46 @@ Then add the foreign key in separate migrations."
       Gem::Version.new(version)
     end
 
+    def check_lock_timeout
+      limit = StrongMigrations.lock_timeout_limit
+
+      if limit && !@lock_timeout_checked
+        if postgresql?
+          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."
+          elsif lock_timeout_sec > limit
+            warn "[strong_migrations] WARNING: Lock timeout is longer than #{limit} seconds: #{lock_timeout}. This is dangerous."
+          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."
+          end
+        end
+        @lock_timeout_checked = true
+      end
+    end
+
+    def timeout_to_sec(timeout)
+      suffixes = {
+        "ms" => 1,
+        "s" => 1000,
+        "min" => 1000 * 60,
+        "h" => 1000 * 60 * 60,
+        "d" => 1000 * 60 * 60 * 24
+      }
+      timeout_ms = timeout.to_i
+      suffixes.each do |k, v|
+        if timeout.end_with?(k)
+          timeout_ms *= v
+          break
+        end
+      end
+      timeout_ms / 1000.0
+    end
+
     def helpers?
       StrongMigrations.helpers
     end

data/lib/strong_migrations/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,8 @@ files:
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
+- lib/generators/strong_migrations/install_generator.rb
+- lib/generators/strong_migrations/templates/initializer.rb.tt
 - lib/strong_migrations.rb
 - lib/strong_migrations/alphabetize_columns.rb
 - lib/strong_migrations/checker.rb