safe-pg-migrations 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d981ad3d9694961fa982676398e257817a2f20fb5ef28111c664da67d8caef19
-  data.tar.gz: 7792a0f882fe9c594a1a0309bba12f03c2d0d18d5a0ef68fe49e1681da486ba6
+  metadata.gz: 8b01cc2376f8bcfa1908bdc642a51bd444420540eef7aa01dc403f13ea0b19c8
+  data.tar.gz: 0c09d3bc52ce84542fd50b119cef667714a6058d5fcf59f1be83af72318b3862
 SHA512:
-  metadata.gz: a3d03df54c2a401ea4d7d178d66c8fc49c605cebc1e15f87a69e262df2bfc6433ef7ab86ae21e3ce88b52224a0c9fd14c3cf5f923e109ef06da2d55072fc7d3e
-  data.tar.gz: b28101c7aedcdfb6fc3680ce9c5b14b459ed90fecf21aaf598942f6c91ebd757f1ed608f71c00e622ec9b24cf1f719a6450ae3ef28abd4f07476fd02f7c54242
+  metadata.gz: f7a822bbb6cc2e924c8da76ca1501cec16588b4972e850fd07e7fbc120e159dfef715a8293c3399454aa9072e2cc6c2da8927e6dc84f15c72670bb16182fe53c
+  data.tar.gz: 4821e1fb76ce6e868a2032eb0e53aceea8f745f31fce521333949c20143150bd03950187d7286d63d1d9c7269b6015f8b9be8e38833d3e6df659f2f8e5940902

data/README.md

@@ -208,6 +208,8 @@ 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.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 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

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

@@ -6,6 +6,7 @@ module SafePgMigrations
   class Configuration
     attr_accessor :safe_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
@@ -13,6 +14,7 @@ module SafePgMigrations
     def initialize
       self.safe_timeout = 5.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

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

@@ -2,27 +2,18 @@
 
 module SafePgMigrations
   module BlockingActivityLogger
-    SELECT_BLOCKING_QUERIES_SQL = <<~SQL.squish
-      SELECT blocking_activity.query, blocked_activity.xact_start as start
-      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
@@ -34,6 +25,32 @@ module SafePgMigrations
 
     private
 
+    def select_blocking_queries_sql
+      columns = SafePgMigrations.config.blocking_activity_logger_verbose ? VERBOSE_COLUMNS : FILTERED_COLUMNS
+
+      <<~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
       delay_before_logging =
         SafePgMigrations.config.safe_timeout - SafePgMigrations.config.blocking_activity_logger_margin
@@ -41,7 +58,7 @@ module SafePgMigrations
       blocking_queries_retriever_thread =
         Thread.new do
           sleep delay_before_logging
-          SafePgMigrations.alternate_connection.query(SELECT_BLOCKING_QUERIES_SQL % raw_connection.backend_pid)
+          SafePgMigrations.alternate_connection.query(select_blocking_queries_sql % raw_connection.backend_pid)
         end
 
       yield
@@ -66,7 +83,7 @@ module SafePgMigrations
           "Statement was being blocked by the following #{'query'.pluralize(queries.size)}:", true
         )
         SafePgMigrations.say '', true
-        queries.each { |query, start_time| SafePgMigrations.say "#{format_start_time start_time}:  #{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',
@@ -78,6 +95,22 @@ 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"

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

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: safe-pg-migrations
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Matthieu Prat
 - Romain Choquet
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -174,7 +174,7 @@ homepage: https://github.com/doctolib/safe-pg-migrations
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -189,9 +189,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
+rubyforge_project: 
 rubygems_version: 2.7.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Make your PG migrations safe.
 test_files: []