pgtk 0.16.3 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f86b9a969a2e41e480e4596035128c5ac1f260eeaa4dfb0625a88316d5c34f5d
-  data.tar.gz: d6b9dfe1dd5717f2884ba63d72b87696ddc0331983527dbb530f74a469961af6
+  metadata.gz: 72b30fd73fd65ec23cd7853399d575b696aef7db096b76e53d3448b881cbcf6c
+  data.tar.gz: 02f7a7c50eea3ce4b20862b6fcbb762e89de2259722dc034dd10c3a712345386
 SHA512:
-  metadata.gz: 7f7433c8b02fae500929e2e62929469eae1511d958fb85d8d7a6ca56fe9010467bac3759b6f77155ec4e4d86f92b532e8f7c5bf57c83f4c6a7ce99caebc63b9d
-  data.tar.gz: ef3a0849da8ac6678a4957868618b6c6350c86fc255285e49efd6ed3cc8dbc5503765a54abed9387d60a90e0d1c1571dd5f35e4f2daad4e8c9b5ada8e141b1d5
+  metadata.gz: 30707ad9cf31b00a9fca53e8c83e1197d2e6f7c3bce07856fc0f93efa5240091f31e82f99cf91940c3466e499e4cf10f46b3bf16a4476a48256ab7b120fb3f84
+  data.tar.gz: 0adf7b70d2921a681af1f65cd6fbc77025a96a53d678ca25f50d1c7a6c7d6173240fcd8f4475eb16383dc4d5d92868420035d64744b5660a230cca57f304b54b

data/.github/workflows/copyrights.yml

@@ -12,4 +12,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.8
+      - uses: yegor256/copyrights-action@0.0.10

data/.github/workflows/markdown-lint.yml

@@ -20,4 +20,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: articulate/actions-markdownlint@v1
+      - uses: DavidAnson/markdownlint-cli2-action@v20.0.0

data/Gemfile.lock

@@ -25,8 +25,8 @@ GEM
     elapsed (0.0.1)
       loog (> 0)
       tago (> 0)
-    joined (0.2.0)
-    json (2.12.0)
+    joined (0.3.0)
+    json (2.12.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -57,14 +57,14 @@ GEM
       loog (> 0)
       tago (> 0)
     racc (1.8.1)
-    rack (3.1.14)
+    rack (3.1.15)
     rainbow (3.1.1)
     rake (13.2.1)
     random-port (0.7.5)
       tago (> 0)
     regexp_parser (2.10.0)
     rexml (3.4.1)
-    rubocop (1.75.6)
+    rubocop (1.75.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)

data/README.md

@@ -44,14 +44,19 @@ Then, add this to your
 ```ruby
 require 'pgtk/pgsql_task'
 Pgtk::PgsqlTask.new :pgsql do |t|
-  t.dir = 'target/pgsql' # Temp directory with PostgreSQL files
-  t.fresh_start = true # To delete the directory on every start
+  # Temp directory with PostgreSQL files:
+  t.dir = 'target/pgsql'
+  # To delete the directory on every start;
+  t.fresh_start = true
   t.user = 'test'
   t.password = 'test'
   t.dbname = 'test'
-  t.yaml = 'target/pgsql-config.yml' # YAML file to be created with connection details
-  t.contexts = '!test' # list of contexts or empty if all
-  t.config = { # list of PostgreSQL configuration options
+  # YAML file to be created with connection details:
+  t.yaml = 'target/pgsql-config.yml'
+  # List of contexts or empty if all:
+  t.contexts = '!test'
+  # List of PostgreSQL configuration options:
+  t.config = {
     log_min_messages: 'ERROR',
     log_filename: 'target/pg.log'
   }
@@ -66,11 +71,16 @@ are used inside):
 ```ruby
 require 'pgtk/liquibase_task'
 Pgtk::LiquibaseTask.new liquibase: :pgsql do |t|
-  t.master = 'liquibase/master.xml' # Master XML file path
-  t.yaml = ['target/pgsql-config.yml', 'config.yml'] # YAML files with connection details
-  t.quiet = false # TRUE by default
-  t.postgresql_version = '42.7.0' # overwriting default version
-  t.liquibase_version = '3.2.2' # overwriting default version
+  # Master XML file path:
+  t.master = 'liquibase/master.xml'
+  # YAML files connection details:
+  t.yaml = ['target/pgsql-config.yml', 'config.yml']
+  # Reduce the amount of log messages (TRUE by default):
+  t.quiet = false
+  # Overwriting default version of PostgreSQL server:
+  t.postgresql_version = '42.7.0'
+  # Overwriting default version of Liquibase:
+  t.liquibase_version = '3.2.2'
 end
 ```
 

data/lib/pgtk/impatient.rb

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2019-2025 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
+require 'securerandom'
 require 'tago'
 require 'timeout'
 require_relative '../pgtk'
@@ -59,9 +60,11 @@ class Pgtk::Impatient
   #
   # @param [Pgtk::Pool] pool The pool to decorate
   # @param [Integer] timeout Timeout in seconds for each SQL query
-  def initialize(pool, timeout = 1)
+  # @param [Array<Regex>] off List of regex to exclude queries from checking
+  def initialize(pool, timeout, *off)
     @pool = pool
     @timeout = timeout
+    @off = off
   end
 
   # Get the version of PostgreSQL server.
@@ -78,16 +81,19 @@ class Pgtk::Impatient
   # @return [Array] Result rows
   # @raise [Timeout::Error] If the query takes too long
   def exec(sql, *args)
+    return @pool.exec(sql, *args) if @off.any? { |re| re.match?(sql) }
     start = Time.now
+    token = SecureRandom.uuid
     begin
-      Timeout.timeout(@timeout) do
+      Timeout.timeout(@timeout, Timeout::Error, token) do
         @pool.exec(sql, *args)
       end
-    rescue Timeout::Error
+    rescue Timeout::Error => e
+      raise e unless e.message == token
       raise TooSlow, [
         'SQL query',
-        ("with #{args.count} arguments" unless args.empty?),
-        'stopped after',
+        ("with #{args.count} argument#{'s' if args.count > 1}" unless args.empty?),
+        'was terminated after',
         start.ago,
         'of waiting'
       ].compact.join(' ')

data/lib/pgtk/version.rb

@@ -11,5 +11,5 @@ require_relative '../pgtk'
 # License:: MIT
 module Pgtk
   # Current version of the library.
-  VERSION = '0.16.3'
+  VERSION = '0.17.1'
 end

data/resources/pom.xml

@@ -11,7 +11,7 @@
   <packaging>pom</packaging>
   <properties>
     <postgresql.version>42.7.5</postgresql.version>
-    <liquibase.version>4.31.1</liquibase.version>
+    <liquibase.version>4.32.0</liquibase.version>
   </properties>
   <dependencies>
     <dependency>

data/test/test_impatient.rb

@@ -20,7 +20,7 @@ require_relative '../lib/pgtk/impatient'
 class TestImpatient < Pgtk::Test
   def test_takes_version
     fake_pool do |pool|
-      v = Pgtk::Impatient.new(pool).version
+      v = Pgtk::Impatient.new(pool, 1).version
       refute_nil(v)
     end
   end
@@ -28,16 +28,36 @@ class TestImpatient < Pgtk::Test
   def test_interrupts
     fake_pool do |pool|
       assert_raises(Pgtk::Impatient::TooSlow) do
-        Pgtk::Impatient.new(pool, 0.1).exec(
-          'SELECT COUNT(*) FROM generate_series(1, 10000000) AS a'
+        Pgtk::Impatient.new(pool, 0.01).exec(
+          'SELECT COUNT(*) FROM generate_series(1, 1000000) AS a'
         )
       end
     end
   end
 
+  def test_skips_by_regex
+    fake_pool do |pool|
+      Pgtk::Impatient.new(pool, 0.01, /^SELECT.*$/).exec(
+        'SELECT COUNT(*) FROM generate_series(1, 1000000) AS a'
+      )
+    end
+  end
+
+  def test_doesnt_shadow_larger_timeout
+    fake_pool do |pool|
+      assert_raises(Timeout::Error) do
+        Timeout.timeout(0.1) do
+          Pgtk::Impatient.new(pool, 999).exec(
+            'SELECT COUNT(*) FROM generate_series(1, 100000000) AS a'
+          )
+        end
+      end
+    end
+  end
+
   def test_doesnt_interrupt
     fake_pool do |pool|
-      id = Pgtk::Impatient.new(pool).exec(
+      id = Pgtk::Impatient.new(pool, 1).exec(
         'INSERT INTO book (title) VALUES ($1) RETURNING id',
         ['1984']
       ).first['id'].to_i
@@ -47,7 +67,7 @@ class TestImpatient < Pgtk::Test
 
   def test_doesnt_interrupt_in_transaction
     fake_pool do |pool|
-      Pgtk::Impatient.new(pool).transaction do |t|
+      Pgtk::Impatient.new(pool, 1).transaction do |t|
         id = t.exec(
           'INSERT INTO book (title) VALUES ($1) RETURNING id',
           ['1984']

data/test/test_pool.rb

@@ -38,6 +38,35 @@ class TestPool < Pgtk::Test
     end
   end
 
+  def test_logs_pgsql_errors_to_logger
+    buf = Loog::Buffer.new
+    fake_pool(log: buf) do |pool|
+      pool.exec(
+        "
+        CREATE FUNCTION intentional_failure() RETURNS trigger AS
+        'BEGIN
+          IF NEW.title = ''War and War'' THEN
+            RAISE EXCEPTION ''The title of the book is bad'';
+          END IF;
+          RETURN NEW;
+        END' LANGUAGE PLPGSQL
+        "
+      )
+      pool.exec(
+        "
+        CREATE TRIGGER check_book_title
+        BEFORE INSERT ON book
+        FOR EACH ROW EXECUTE PROCEDURE intentional_failure();
+        "
+      )
+      assert_raises(PG::RaiseException) do
+        pool.exec('INSERT INTO book (title) VALUES ($1)', ['War and War'])
+      end
+      assert_includes(buf.to_s, 'The title of the book is bad')
+      assert_includes(buf.to_s, 'function intentional_failure() line 3')
+    end
+  end
+
   def test_queries_with_block
     fake_pool do |pool|
       pool.exec('INSERT INTO book (title) VALUES ($1)', ['1984'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgtk
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.17.1
 platform: ruby
 authors:
 - Yegor Bugayenko