feat: add a test

Author: Baptiste Perbos

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

@@ -79,10 +79,7 @@ def log_blocking_queries
       if queries.empty?
         SafePgMigrations.say 'Could not find any blocking query.', true
       else
-        SafePgMigrations.say(
-          "Statement was being blocked by the following #{'query'.pluralize(queries.size)}:", true
-        )
-        SafePgMigrations.say '', 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 '\
@@ -97,16 +94,20 @@ def log_blocking_queries
 
     def output_blocking_queries(queries)
       if SafePgMigrations.config.blocking_activity_logger_verbose
+        SafePgMigrations.say(
+          "Statement was being blocked by the following #{'query'.pluralize(queries.size)}:", true
+        )
+        SafePgMigrations.say '', true
         queries.each do |query, start_time|
           SafePgMigrations.say "#{format_start_time start_time}:  #{query}", true
         end
       else
         queries.each do |start_time, locktype, mode, pid, transactionid|
           SafePgMigrations.say format_start_time(start_time), true
-          SafePgMigrations.say "lock type: #{locktype || 'null'}"
-          SafePgMigrations.say "lock mode: #{mode || 'null'}"
-          SafePgMigrations.say "lock pid: #{pid || 'null'}"
-          SafePgMigrations.say "lock transactionid: #{transactionid || 'null'}"
+          SafePgMigrations.say "lock type: #{locktype || 'null'}", true
+          SafePgMigrations.say "lock mode: #{mode || 'null'}", true
+          SafePgMigrations.say "lock pid: #{pid || 'null'}", true
+          SafePgMigrations.say "lock transactionid: #{transactionid || 'null'}", true
         end
       end
     end

test/safe_pg_migrations_test.rb

@@ -49,33 +49,22 @@ def change
     refute @connection.table_exists?(:users)
   end
 
-  def test_statement_retry
-    @connection.create_table(:users)
-    @migration =
-      Class.new(ActiveRecord::Migration::Current) do
-        def up
-          # Simulate a blocking transaction from another connection.
-          thread_lock = Concurrent::CountDownLatch.new
-          thread =
-            Thread.new do
-              ActiveRecord::Base.connection.execute('BEGIN; SELECT 1 FROM users')
-              thread_lock.count_down
-              sleep 1
-              ActiveRecord::Base.connection.commit_db_transaction
-            end
-
-          thread_lock.wait # Wait for the above transaction to start.
-
-          add_column :users, :email, :string
+  def test_blocking_activity_logger_filtered
+    SafePgMigrations.config.blocking_activity_logger_verbose = false
 
-          thread.join
-        end
-      end.new
-
-    SafePgMigrations.config.retry_delay = 1.second
-    SafePgMigrations.config.safe_timeout = 0.5.second
-    SafePgMigrations.config.blocking_activity_logger_margin = 0.1.seconds
+    @connection.create_table(:users)
+    @migration = simulate_blocking_transaction_from_another_connection
+
+    calls = record_calls(@migration, :write) { run_migration }.join
+    assert_includes calls, 'lock type: relation'
+    assert_includes calls, 'lock mode: AccessExclusiveLock'
+    assert_includes calls, 'lock pid:'
+    assert_includes calls, 'lock transactionid: null'
+    refute_includes calls, 'Statement was being blocked by the following query'
+  end
 
+  def test_statement_retry
+    @migration = simulate_blocking_transaction_from_another_connection
     calls = record_calls(@migration, :write) { run_migration }.map(&:first)
     assert @connection.column_exists?(:users, :email, :string)
     assert_equal [
@@ -597,4 +586,33 @@ def up
       assert_match("SET lock_timeout TO '70s'", logs[4])
     end
   end
+
+  private
+  
+  def simulate_blocking_transaction_from_another_connection
+    SafePgMigrations.config.retry_delay = 1.second
+    SafePgMigrations.config.safe_timeout = 0.5.second
+    SafePgMigrations.config.blocking_activity_logger_margin = 0.1.seconds
+
+    @connection.create_table(:users)
+    
+    Class.new(ActiveRecord::Migration::Current) do
+      def up
+        thread_lock = Concurrent::CountDownLatch.new
+        thread =
+          Thread.new do
+            ActiveRecord::Base.connection.execute('BEGIN; SELECT 1 FROM users')
+            thread_lock.count_down
+            sleep 1
+            ActiveRecord::Base.connection.commit_db_transaction
+          end
+
+        thread_lock.wait # Wait for the above transaction to start.
+
+        add_column :users, :email, :string
+
+        thread.join
+      end
+    end.new
+  end
 end