safe-pg-migrations 1.0.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d3e47cc5a8440b59b3e25dc7a5e99a9212c4709c
-  data.tar.gz: 7347fdd053c1edd34b3ec58d9021b126ec794eb3
+SHA256:
+  metadata.gz: 8b01cc2376f8bcfa1908bdc642a51bd444420540eef7aa01dc403f13ea0b19c8
+  data.tar.gz: 0c09d3bc52ce84542fd50b119cef667714a6058d5fcf59f1be83af72318b3862
 SHA512:
-  metadata.gz: 74058e22a0e55ae44e29b8e74096bf0b4bf6b7c83a7fafce8c6aa3595c50bafec2d93c6ce502d304f89b44e236a3f3770fac91ff7e9bb449a3289cca0a06ab89
-  data.tar.gz: 7a38389555cb2cd8c0271882389aed8e27b1d22ef7cb16976c729041ef315803ad7de0a71400f478d50c7c741e1b10a5a37109940de5a5e7a8809800eecdff25
+  metadata.gz: f7a822bbb6cc2e924c8da76ca1501cec16588b4972e850fd07e7fbc120e159dfef715a8293c3399454aa9072e2cc6c2da8927e6dc84f15c72670bb16182fe53c
+  data.tar.gz: 4821e1fb76ce6e868a2032eb0e53aceea8f745f31fce521333949c20143150bd03950187d7286d63d1d9c7269b6015f8b9be8e38833d3e6df659f2f8e5940902

data/README.md

@@ -1,10 +1,10 @@
-# safe-pg-migrations [![Build Status](https://travis-ci.org/doctolib/safe-pg-migrations.svg?branch=master)](https://travis-ci.org/doctolib/safe-pg-migrations)
+# safe-pg-migrations
 
 ActiveRecord migrations for Postgres made safe.
 
 ## Requirements
 
-- Ruby 2.3+
+- Ruby 2.5+
 - Rails 5.2+
 - PostgreSQL 9.3+
 
@@ -16,6 +16,8 @@ Just drop this line in your Gemfile:
 gem 'safe-pg-migrations'
 ```
 
+**Note: Do not run migrations via PgBouncer connection if it is configured to use transactional or statement pooling modes. You must run migrations via a direct Postgres connection, or configure PgBouncer to use session pooling mode.**
+
 ## Example
 
 Consider the following migration:
@@ -61,25 +63,27 @@ Under the hood, **Safe PG Migrations** patches `ActiveRecord::Migration` and ext
 
 ## Motivation
 
-Writing a safe migration can be daunting. Numerous articles have been written on the topic and a few gems are trying to address the problem. Even for someone who has a pretty good command of Postgres, remembering all the subtleties of explicit locking is not a piece of cake.
+Writing a safe migration can be daunting. Numerous articles, [including ours](https://medium.com/doctolib/stop-worrying-about-postgresql-locks-in-your-rails-migrations-3426027e9cc9), have been written on the topic and a few gems are trying to address the problem. Even for someone who has a pretty good command of Postgres, remembering all the subtleties of explicit locking is not a piece of cake.
 
 Active Record means developers don't have to be proficient in SQL to interact with a database. In the same way, **Safe PG Migrations** was created so that developers don't have to understand the ins and outs of Postgres to write a safe migration.
 
 ## Feature set
 
-### Lock timeout
+<details><summary>Lock timeout</summary>
 
 Most DDL operations (e.g. adding a column, removing a column or adding a default value to a column) take an `ACCESS EXCLUSIVE` lock on the table they are altering. While these operations wait to acquire their lock, other statements are blocked. Before running a migration, **Safe PG Migrations** sets a short lock timeout (default to 5 seconds) so that statements are not blocked for too long.
 
 See [PostgreSQL Alter Table and Long Transactions](http://www.joshuakehn.com/2017/9/9/postgresql-alter-table-and-long-transactions.html) and [Migrations and Long Transactions](https://www.fin.com/post/2018/1/migrations-and-long-transactions) for detailed explanations of the matter.
+</details>
 
-### Statement timeout
+<details><summary>Statement timeout</summary>
 
 Adding a foreign key or a not-null constraint can take a lot of time on a large table. The problem is that those operations take `ACCESS EXCLUSIVE` locks. We clearly don't want them to hold these locks for too long. Thus, **Safe PG Migrations** runs them with a short statement timeout (default to 5 seconds).
 
 See [Zero-downtime Postgres migrations - the hard parts](https://gocardless.com/blog/zero-downtime-postgres-migrations-the-hard-parts/) for a detailed explanation on the subject.
+</details>
 
-### Prevent wrapping migrations in transaction
+<details><summary>Prevent wrapping migrations in transaction</summary>
 
 When **Safe PG Migrations** is used, migrations are not wrapped in a transaction. This is for several reasons:
 
@@ -89,10 +93,22 @@ When **Safe PG Migrations** is used, migrations are not wrapped in a transaction
 
 Note that if a migration fails, it won't be rollbacked. This can result in migrations being partially applied. In that case, they need to be manually reverted.
 
-### Safe `add_column`
+</details>
+
+<details>
+<summary>Safe <code>add_column</code></summary>
+
+**Safe PG Migrations** gracefully handle the upgrade to PG11 by **not** backfilling default value for existing rows, as the [database engine is now natively handling it](https://www.postgresql.org/docs/11/ddl-alter.html#DDL-ALTER-ADDING-A-COLUMN).
+
+Beware though, when adding a volatile default value: 
+```ruby
+add_column :users, :created_at, default: 'clock_timestamp()'
+```
+PG will still needs to update every row of the table, and will most likely statement timeout for big table. In this case, your best bet is to add the column without default, set the default, and backfill existing rows.
 
-#### Pre Postgres 11 behavior
+<blockquote>
 
+**Note: Pre-postgre 11**
 Adding a column with a default value and a not-null constraint is [dangerous](https://wework.github.io/data/2015/11/05/add-columns-with-default-values-to-large-tables-in-rails-postgres/).
 
 **Safe PG Migrations** makes it safe by:
@@ -104,17 +120,11 @@ Adding a column with a default value and a not-null constraint is [dangerous](ht
 
 Note: the addition of the not null constraint may timeout. In that case, you may want to add the not-null constraint as initially not valid and validate it in a separate statement. See [Adding a not-null constraint on Postgres with minimal locking](https://medium.com/doctolib-engineering/adding-a-not-null-constraint-on-pg-faster-with-minimal-locking-38b2c00c4d1c).
 
-#### Postgres 11 behavior
+</blockquote>    
 
-**Safe PG Migrations** gracefully handle the upgrade to PG11 by **not** backfilling default value for existing rows, as the [database engine is now natively handling it](https://www.postgresql.org/docs/11/ddl-alter.html#DDL-ALTER-ADDING-A-COLUMN).
+</details>
 
-Beware though, when adding a volatile default value: 
-```ruby
-add_column :users, :created_at, default: 'clock_timestamp()'
-```
-PG will still needs to update every row of the table, and will most likely statement timeout for big table. In this case, your best bet is to add the column without default, set the default, and backfill existing rows.
-
-### Concurrent indexes
+<details><summary id="safe_add_remove_index">Safe <code>add_index</code> and <code>remove_index</code></summary>
 
 Creating an index requires a `SHARE` lock on the target table which blocks all write on the table while the index is created (which can take some time on a large table). This is usually not practical in a live environment. Thus, **Safe PG Migrations** ensures indexes are created concurrently.
 
@@ -125,16 +135,30 @@ If you still get lock timeout while adding / removing indexes, it might be for o
 - Long-running queries are active on the table. To create / remove an index, PG needs to wait for the queries that are actually running to finish before starting the index creation / removal. The blocking activity logger might help you to pinpoint the culprit queries.
 - A vacuum / autovacuum is running on the table, holding a ShareUpdateExclusiveLock, you are most likely out of luck for the current migration, but you may try to [optimize your autovacuums settings](https://www.percona.com/blog/2018/08/10/tuning-autovacuum-in-postgresql-and-autovacuum-internals/).
 
+</details>
+
+<details><summary id="safe_add_foreign_key">safe <code>add_foreign_key</code> (and <code>add_reference</code>)</summary>
 
-### Retry after lock timeout
+Adding a foreign key requires a `SHARE ROW EXCLUSIVE` lock, which **prevent writing in the tables** while the migration is running.
+
+Adding the constraint itself is rather fast, the major part of the time is spent on validating this constraint. Thus safe-pg-migrations ensures that adding a foreign key holds blocking locks for the least amount of time by splitting the foreign key creation in two steps: 
+
+1. adding the constraint *without validation*, will not validate existing rows;
+2. validating the constraint, will validate existing rows in the table, without blocking read or write on the table
+
+</details>
+
+<details><summary>Retry after lock timeout</summary>
 
 When a statement fails with a lock timeout, **Safe PG Migrations** retries it (5 times max) [list of retryable statments](https://github.com/doctolib/safe-pg-migrations/blob/66933256252b6bbf12e404b829a361dbba30e684/lib/safe-pg-migrations/plugins/statement_retrier.rb#L5)
+</details>
 
-### Blocking activity logging
+<details><summary>Blocking activity logging</summary>
 
 If a statement fails with a lock timeout, **Safe PG Migrations** will try to tell you what was the blocking statement.
+</details>
 
-### Verbose SQL logging
+<details><summary>Verbose SQL logging</summary>
 
 For any operation, **Safe PG Migrations** can output the performed SQL queries. This feature is enabled by default in a production Rails environment. If you want to explicit enable it, for example in your development environment you can use:
 ```bash
@@ -151,7 +175,7 @@ add_index :users, :age
    -> 0.0175s
 == 20191215132355 SampleIndex: migrated (0.0200s) =============================
 ```
-**Sage PG Migrations** will output the following logs:
+**Safe PG Migrations** will output the following logs:
 ```ruby
 add_index :users, :age
 
@@ -175,6 +199,8 @@ So you can actually check that the `CREATE INDEX` statement will be performed co
 
 *Nb: The `SHOW` statements are used by **Safe PG Migrations** to query settings for their original values in order to restore them after the work is done*
 
+</details>
+
 ## Configuration
 
 **Safe PG Migrations** can be customized, here is an example of a Rails initializer (the values are the default ones):
@@ -182,9 +208,9 @@ So you can actually check that the `CREATE INDEX` statement will be performed co
 ```ruby
 SafePgMigrations.config.safe_timeout = 5.seconds # Lock and statement timeout used for all DDL operations except from CREATE / DROP INDEX
 
-SafePgMigrations.config.index_lock_timeout = 30.seconds # Lock timeout used for CREATE / DROP INDEX
+SafePgMigrations.config.blocking_activity_logger_verbose = true # Outputs the raw blocking queries on timeout. When false, outputs information about the lock instead
 
-SafePgMigrations.config.blocking_activity_logger_margin = 1.second # Delay to output blocking queries before timeout. Must be smaller than safe_timeout and index_lock_timeout
+SafePgMigrations.config.blocking_activity_logger_margin = 1.second # Delay to output blocking queries before timeout. Must be shorter than safe_timeout
 
 SafePgMigrations.config.batch_size = 1000 # Size of the batches used for backfilling when adding a column with a default value pre-PG11
 
@@ -230,3 +256,4 @@ Interesting reads:
 - [Rails migrations with no downtime](https://pedro.herokuapp.com/past/2011/7/13/rails_migrations_with_no_downtime/)
 - [Safe Operations For High Volume PostgreSQL](https://www.braintreepayments.com/blog/safe-operations-for-high-volume-postgresql/)
 - [Rails Migrations with Zero Downtime](https://blog.codeship.com/rails-migrations-zero-downtime/)
+- [Stop worrying about PostgreSQL locks in your Rails migrations](https://medium.com/doctolib/stop-worrying-about-postgresql-locks-in-your-rails-migrations-3426027e9cc9)

data/lib/safe-pg-migrations/base.rb

@@ -6,6 +6,7 @@ require 'safe-pg-migrations/plugins/blocking_activity_logger'
 require 'safe-pg-migrations/plugins/statement_insurer'
 require 'safe-pg-migrations/plugins/statement_retrier'
 require 'safe-pg-migrations/plugins/idem_potent_statements'
+require 'safe-pg-migrations/plugins/useless_statements_logger'
 
 module SafePgMigrations
   # Order matters: the bottom-most plugin will have precedence
@@ -14,6 +15,7 @@ module SafePgMigrations
     IdemPotentStatements,
     StatementRetrier,
     StatementInsurer,
+    UselessStatementsLogger,
   ].freeze
 
   class << self
@@ -78,6 +80,7 @@ module SafePgMigrations
     end
 
     def disable_ddl_transaction
+      UselessStatementsLogger.warn_useless '`disable_ddl_transaction`' if super
       true
     end
 

data/lib/safe-pg-migrations/configuration.rb

@@ -5,16 +5,16 @@ require 'active_support/core_ext/numeric/time'
 module SafePgMigrations
   class Configuration
     attr_accessor :safe_timeout
-    attr_accessor :index_lock_timeout
     attr_accessor :blocking_activity_logger_margin
+    attr_accessor :blocking_activity_logger_verbose
     attr_accessor :batch_size
     attr_accessor :retry_delay
     attr_accessor :max_tries
 
     def initialize
       self.safe_timeout = 5.seconds
-      self.index_lock_timeout = 30.seconds
       self.blocking_activity_logger_margin = 1.second
+      self.blocking_activity_logger_verbose = true
       self.batch_size = 1000
       self.retry_delay = 1.minute
       self.max_tries = 5
@@ -24,10 +24,6 @@ module SafePgMigrations
       pg_duration(safe_timeout)
     end
 
-    def pg_index_lock_timeout
-      pg_duration(index_lock_timeout)
-    end
-
     def pg_duration(duration)
       value, unit = duration.integer? ? [duration, 's'] : [(duration * 1000).to_i, 'ms']
       "#{value}#{unit}"

data/lib/safe-pg-migrations/plugins/blocking_activity_logger.rb

@@ -2,55 +2,63 @@
 
 module SafePgMigrations
   module BlockingActivityLogger
-    SELECT_BLOCKING_QUERIES_SQL = <<~SQL.squish
-      SELECT blocking_activity.query
-      FROM pg_catalog.pg_locks           blocked_locks
-      JOIN pg_catalog.pg_stat_activity   blocked_activity
-        ON blocked_activity.pid = blocked_locks.pid
-      JOIN pg_catalog.pg_locks           blocking_locks
-        ON blocking_locks.locktype = blocked_locks.locktype
-        AND blocking_locks.DATABASE      IS NOT DISTINCT FROM blocked_locks.DATABASE
-        AND blocking_locks.relation      IS NOT DISTINCT FROM blocked_locks.relation
-        AND blocking_locks.page          IS NOT DISTINCT FROM blocked_locks.page
-        AND blocking_locks.tuple         IS NOT DISTINCT FROM blocked_locks.tuple
-        AND blocking_locks.virtualxid    IS NOT DISTINCT FROM blocked_locks.virtualxid
-        AND blocking_locks.transactionid IS NOT DISTINCT FROM blocked_locks.transactionid
-        AND blocking_locks.classid       IS NOT DISTINCT FROM blocked_locks.classid
-        AND blocking_locks.objid         IS NOT DISTINCT FROM blocked_locks.objid
-        AND blocking_locks.objsubid      IS NOT DISTINCT FROM blocked_locks.objsubid
-        AND blocking_locks.pid != blocked_locks.pid
-      JOIN pg_catalog.pg_stat_activity   blocking_activity
-        ON blocking_activity.pid = blocking_locks.pid
-      WHERE blocked_locks.pid = %d
-    SQL
+    FILTERED_COLUMNS = %w[
+      blocked_activity.xact_start
+      blocked_locks.locktype
+      blocked_locks.mode
+      blocking_activity.pid
+      blocked_locks.transactionid
+    ].freeze
+
+    VERBOSE_COLUMNS = %w[
+      blocking_activity.query
+      blocked_activity.xact_start
+    ].freeze
 
     %i[
-      add_column remove_column add_foreign_key remove_foreign_key change_column_default
-      change_column_null create_table add_index remove_index
+      add_column remove_column add_foreign_key remove_foreign_key change_column_default change_column_null create_table
     ].each do |method|
       define_method method do |*args, &block|
-        log_blocking_queries(method) { super(*args, &block) }
+        log_blocking_queries { super(*args, &block) }
       end
     end
 
     private
 
-    def delay_before_logging(method)
-      timeout_delay =
-        if %i[add_index remove_index].include?(method)
-          SafePgMigrations.config.index_lock_timeout
-        else
-          SafePgMigrations.config.safe_timeout
-        end
+    def select_blocking_queries_sql
+      columns = SafePgMigrations.config.blocking_activity_logger_verbose ? VERBOSE_COLUMNS : FILTERED_COLUMNS
 
-      timeout_delay - SafePgMigrations.config.blocking_activity_logger_margin
+      <<~SQL.squish
+        SELECT #{columns.join(', ')}
+        FROM pg_catalog.pg_locks           blocked_locks
+        JOIN pg_catalog.pg_stat_activity   blocked_activity
+          ON blocked_activity.pid = blocked_locks.pid
+        JOIN pg_catalog.pg_locks           blocking_locks
+          ON blocking_locks.locktype = blocked_locks.locktype
+          AND blocking_locks.DATABASE      IS NOT DISTINCT FROM blocked_locks.DATABASE
+          AND blocking_locks.relation      IS NOT DISTINCT FROM blocked_locks.relation
+          AND blocking_locks.page          IS NOT DISTINCT FROM blocked_locks.page
+          AND blocking_locks.tuple         IS NOT DISTINCT FROM blocked_locks.tuple
+          AND blocking_locks.virtualxid    IS NOT DISTINCT FROM blocked_locks.virtualxid
+          AND blocking_locks.transactionid IS NOT DISTINCT FROM blocked_locks.transactionid
+          AND blocking_locks.classid       IS NOT DISTINCT FROM blocked_locks.classid
+          AND blocking_locks.objid         IS NOT DISTINCT FROM blocked_locks.objid
+          AND blocking_locks.objsubid      IS NOT DISTINCT FROM blocked_locks.objsubid
+          AND blocking_locks.pid != blocked_locks.pid
+        JOIN pg_catalog.pg_stat_activity   blocking_activity
+          ON blocking_activity.pid = blocking_locks.pid
+        WHERE blocked_locks.pid = %d
+      SQL
     end
 
-    def log_blocking_queries(method)
+    def log_blocking_queries
+      delay_before_logging =
+        SafePgMigrations.config.safe_timeout - SafePgMigrations.config.blocking_activity_logger_margin
+
       blocking_queries_retriever_thread =
         Thread.new do
-          sleep delay_before_logging(method)
-          SafePgMigrations.alternate_connection.query_values(SELECT_BLOCKING_QUERIES_SQL % raw_connection.backend_pid)
+          sleep delay_before_logging
+          SafePgMigrations.alternate_connection.query(select_blocking_queries_sql % raw_connection.backend_pid)
         end
 
       yield
@@ -75,7 +83,7 @@ module SafePgMigrations
           "Statement was being blocked by the following #{'query'.pluralize(queries.size)}:", true
         )
         SafePgMigrations.say '', true
-        queries.each { |query| SafePgMigrations.say "  #{query}", true }
+        output_blocking_queries(queries)
         SafePgMigrations.say(
           'Beware, some of those queries might run in a transaction. In this case the locking query might be '\
           'located elsewhere in the transaction',
@@ -86,5 +94,26 @@ module SafePgMigrations
 
       raise
     end
+
+    def output_blocking_queries(queries)
+      if SafePgMigrations.config.blocking_activity_logger_verbose
+        queries.each { |query, start_time| SafePgMigrations.say "#{format_start_time start_time}:  #{query}", true }
+      else
+        queries.each do |start_time, locktype, mode, pid, transactionid|
+          SafePgMigrations.say(
+            "#{format_start_time(start_time)}: lock type: #{locktype || 'null'}, " \
+              "lock mode: #{mode || 'null'}, " \
+              "lock pid: #{pid || 'null'}, " \
+              "lock transactionid: #{transactionid || 'null'}",
+            true
+          )
+        end
+      end
+    end
+
+    def format_start_time(start_time, reference_time = Time.now)
+      duration = (reference_time - start_time).round
+      "transaction started #{duration} #{'second'.pluralize(duration)} ago"
+    end
   end
 end

data/lib/safe-pg-migrations/plugins/idem_potent_statements.rb

@@ -12,6 +12,12 @@ module SafePgMigrations
       super
     end
 
+    def add_column(table_name, column_name, type, options = {})
+      return super unless column_exists?(table_name, column_name)
+
+      SafePgMigrations.say("/!\\ Column '#{column_name}' already exists in '#{table_name}'. Skipping statement.", true)
+    end
+
     def remove_column(table_name, column_name, type = nil, options = {})
       return super if column_exists?(table_name, column_name)
 
@@ -26,6 +32,32 @@ module SafePgMigrations
       SafePgMigrations.say("/!\\ Index '#{index_name}' not found on table '#{table_name}'. Skipping statement.", true)
     end
 
+    def add_foreign_key(from_table, to_table, **options)
+      options_or_to_table = options.slice(:name, :column).presence || to_table
+      return super unless foreign_key_exists?(from_table, options_or_to_table)
+
+      SafePgMigrations.say(
+        "/!\\ Foreign key '#{from_table}' -> '#{to_table}' already exists. Skipping statement.",
+        true
+      )
+    end
+
+    def create_table(table_name, comment: nil, **options)
+      return super if options[:force] || !table_exists?(table_name)
+
+      SafePgMigrations.say "/!\\ Table '#{table_name}' already exists.", true
+
+      td = create_table_definition(table_name, **options)
+
+      yield td if block_given?
+
+      SafePgMigrations.say(td.indexes.empty? ? '-- Skipping statement' : '-- Creating indexes', true)
+
+      td.indexes.each do |column_name, index_options|
+        add_index(table_name, column_name, index_options)
+      end
+    end
+
     private
 
     def index_valid?(index_name)

data/lib/safe-pg-migrations/plugins/statement_insurer.rb

@@ -4,25 +4,25 @@ module SafePgMigrations
   module StatementInsurer
     PG_11_VERSION_NUM = 110_000
 
-    %i[change_column_null add_foreign_key create_table].each do |method|
+    %i[change_column_null change_column].each do |method|
       define_method method do |*args, &block|
         with_setting(:statement_timeout, SafePgMigrations.config.pg_safe_timeout) { super(*args, &block) }
       end
     end
 
     def add_column(table_name, column_name, type, **options)
-      need_default_value_backfill = SafePgMigrations.pg_version_num < PG_11_VERSION_NUM
+      return super if SafePgMigrations.pg_version_num >= PG_11_VERSION_NUM
 
-      default = options.delete(:default) if need_default_value_backfill
+      default = options.delete(:default)
       null = options.delete(:null)
 
       if !default.nil? || null == false
-        SafePgMigrations.say_method_call(:add_column, table_name, column_name, type, **options)
+        SafePgMigrations.say_method_call(:add_column, table_name, column_name, type, options)
       end
 
       super
 
-      if need_default_value_backfill && !default.nil?
+      unless default.nil?
         SafePgMigrations.say_method_call(:change_column_default, table_name, column_name, default)
         change_column_default(table_name, column_name, default)
 
@@ -36,19 +36,46 @@ module SafePgMigrations
       end
     end
 
+    def add_foreign_key(from_table, to_table, **options)
+      validate_present = options.key? :validate
+      options[:validate] = false unless validate_present
+
+      with_setting(:statement_timeout, SafePgMigrations.config.pg_safe_timeout) { super }
+
+      options_or_to_table = options.slice(:name, :column).presence || to_table
+      without_statement_timeout { validate_foreign_key from_table, options_or_to_table } unless validate_present
+    end
+
+    def create_table(*)
+      with_setting(:statement_timeout, SafePgMigrations.config.pg_safe_timeout) do
+        super do |td|
+          yield td if block_given?
+          td.indexes.map! do |key, index_options|
+            index_options[:algorithm] ||= :default
+            [key, index_options]
+          end
+        end
+      end
+    end
+
     def add_index(table_name, column_name, **options)
-      options[:algorithm] = :concurrently
-      SafePgMigrations.say_method_call(:add_index, table_name, column_name, **options)
+      if options[:algorithm] == :default
+        options.delete :algorithm
+      else
+        options[:algorithm] = :concurrently
+      end
 
-      with_index_timeouts { super }
+      SafePgMigrations.say_method_call(:add_index, table_name, column_name, options)
+
+      without_timeout { super }
     end
 
     def remove_index(table_name, options = {})
       options = { column: options } unless options.is_a?(Hash)
       options[:algorithm] = :concurrently
-      SafePgMigrations.say_method_call(:remove_index, table_name, **options)
+      SafePgMigrations.say_method_call(:remove_index, table_name, options)
 
-      with_index_timeouts { super }
+      without_timeout { super }
     end
 
     def backfill_column_default(table_name, column_name)
@@ -89,12 +116,12 @@ module SafePgMigrations
       with_setting(:statement_timeout, 0) { yield }
     end
 
-    def with_index_timeouts
-      without_statement_timeout do
-        with_setting(:lock_timeout, SafePgMigrations.config.pg_index_lock_timeout) do
-          yield
-        end
-      end
+    def without_lock_timeout
+      with_setting(:lock_timeout, 0) { yield }
+    end
+
+    def without_timeout
+      without_statement_timeout { without_lock_timeout { yield } }
     end
   end
 end

data/lib/safe-pg-migrations/plugins/statement_retrier.rb

@@ -3,8 +3,7 @@
 module SafePgMigrations
   module StatementRetrier
     RETRIABLE_SCHEMA_STATEMENTS = %i[
-      add_column add_foreign_key remove_foreign_key change_column_default
-      change_column_null add_index remove_index remove_column
+      add_column add_foreign_key remove_foreign_key change_column_default change_column_null remove_column
     ].freeze
 
     RETRIABLE_SCHEMA_STATEMENTS.each do |method|

data/lib/safe-pg-migrations/plugins/useless_statements_logger.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SafePgMigrations
+  module UselessStatementsLogger
+    def self.warn_useless(action, link = nil, *args)
+      SafePgMigrations.say "/!\\ No need to explicitly use #{action}, safe-pg-migrations does it for you", *args
+      SafePgMigrations.say "\t see #{link} for more details", *args if link
+    end
+
+    def add_index(*, **options)
+      warn_for_index(**options)
+      super
+    end
+
+    def remove_index(table_name, options = {})
+      warn_for_index(options) if options.is_a? Hash
+      super
+    end
+
+    def add_foreign_key(*, **options)
+      if options[:validate] == false
+        UselessStatementsLogger.warn_useless '`validate: :false`', 'https://github.com/doctolib/safe-pg-migrations#safe_add_foreign_key'
+      end
+      super
+    end
+
+    def warn_for_index(**options)
+      return unless options[:algorithm] == :concurrently
+
+      UselessStatementsLogger.warn_useless '`algorithm: :concurrently`', 'https://github.com/doctolib/safe-pg-migrations#safe_add_remove_index'
+    end
+  end
+end

data/lib/safe-pg-migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafePgMigrations
-  VERSION = '1.0.0'
+  VERSION = '1.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe-pg-migrations
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.3
 platform: ruby
 authors:
 - Matthieu Prat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -166,6 +166,7 @@ files:
 - lib/safe-pg-migrations/plugins/idem_potent_statements.rb
 - lib/safe-pg-migrations/plugins/statement_insurer.rb
 - lib/safe-pg-migrations/plugins/statement_retrier.rb
+- lib/safe-pg-migrations/plugins/useless_statements_logger.rb
 - lib/safe-pg-migrations/plugins/verbose_sql_logger.rb
 - lib/safe-pg-migrations/railtie.rb
 - lib/safe-pg-migrations/version.rb
@@ -181,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -189,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Make your PG migrations safe.