pgtk 0.32.4 → 0.32.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72cdeed11d9faa8c9097c01256603b2ce77a507b936c983ab623b9e1d6e7d364
-  data.tar.gz: ab60b5670e87009e1eb47983bd8d729eb403d78a9c6a20c82ea14d70d4a7d18f
+  metadata.gz: bff4002fc7f88a973b99757aa0b8be3b82b6631b87f94c8ade93b30983b21761
+  data.tar.gz: 707d5ec1bf05047d60a0f25103b7210751c4731f79caa8b08c3021e7e3810e6c
 SHA512:
-  metadata.gz: 691ea0c8b5ca6002b72ab4b66487b3dbf489feaedbc8e80cc772fe69cfc1ad966fa836e13298b561cadb38c75290ed8a533a389751a7d6b0454da23b87afcb74
-  data.tar.gz: 8a04b05ad839b935ac3f8e5362bb957eb64e8e70e1b963c5713a7c7755f8184e6c1e8c806a4d03467bba80e3ce5af0cf9c1a1a50c4d73f11e79d46dc9569fc2f
+  metadata.gz: 210230feda441fdee55cb3c3b6ccf1e2335efcdef77e95996afe89d3a4caf4f21bd8aa4fb9fd19f9b636d1336cc821345aa7454ec474d1693dff21990f2a1b40
+  data.tar.gz: ab98c8f9cf29405c495bd4808855e1107889ccdc2ee9011f4abe431b561f05d033564dc587f5a3084f64f0842e935d4bee6b9c8265cc729fe762a0f99bab4eb9

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     pgtk (0.0.0)
-      backtrace (~> 0.4)
+      cgi (~> 0.0)
       concurrent-ruby (~> 1.3)
       donce (~> 0.0)
       ellipsized (~> 0.3)
@@ -22,7 +22,8 @@ GEM
     ast (2.4.3)
     backtrace (0.4.1)
     builder (3.3.0)
-    concurrent-ruby (1.3.6)
+    cgi (0.5.1)
+    concurrent-ruby (1.3.7)
     differ (0.1.2)
     docile (1.4.1)
     donce (0.7.0)
@@ -35,7 +36,7 @@ GEM
       tago (~> 0.1)
     ellipsized (0.3.0)
     joined (0.4.0)
-    json (2.19.5)
+    json (2.19.9)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -52,24 +53,24 @@ GEM
       minitest (>= 5.0, < 7)
       ruby-progressbar
     minitest-stub-const (0.6)
-    nokogiri (1.19.3-aarch64-linux-gnu)
+    nokogiri (1.19.4-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.19.3-aarch64-linux-musl)
+    nokogiri (1.19.4-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.19.3-arm-linux-gnu)
+    nokogiri (1.19.4-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.19.3-arm-linux-musl)
+    nokogiri (1.19.4-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.19.3-arm64-darwin)
+    nokogiri (1.19.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.3-x86_64-darwin)
+    nokogiri (1.19.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.3-x86_64-linux-gnu)
+    nokogiri (1.19.4-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.19.3-x86_64-linux-musl)
+    nokogiri (1.19.4-x86_64-linux-musl)
       racc (~> 1.4)
     os (1.1.4)
-    parallel (2.0.1)
+    parallel (2.1.0)
     parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
@@ -81,7 +82,7 @@ GEM
     pg (1.6.3-x86_64-linux)
     pg (1.6.3-x86_64-linux-musl)
     prism (1.9.0)
-    qbash (0.8.3)
+    qbash (0.8.4)
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
@@ -94,7 +95,7 @@ GEM
       tago (~> 0.0)
     regexp_parser (2.12.0)
     rexml (3.4.4)
-    rubocop (1.86.2)
+    rubocop (1.87.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -108,7 +109,7 @@ GEM
     rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
-    rubocop-elegant (0.0.20)
+    rubocop-elegant (0.6.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.75)
     rubocop-minitest (0.39.1)
@@ -147,7 +148,7 @@ GEM
       nokogiri (~> 1.8)
       rainbow (~> 3.0)
       slop (~> 4.4)
-    yard (0.9.43)
+    yard (0.9.44)
 
 PLATFORMS
   aarch64-linux

data/lib/pgtk/impatient/too_slow.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../../pgtk'
+
+class Pgtk::Impatient; end
+
+# Raised by Pgtk::Impatient#exec when the query takes longer than the
+# configured timeout. The deadline is enforced server-side via
+# +SET LOCAL statement_timeout+, so the underlying +PG::QueryCanceled+
+# is translated into this error for the caller.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
+# License:: MIT
+class Pgtk::Impatient::TooSlow < StandardError; end

data/lib/pgtk/impatient.rb

@@ -58,18 +58,17 @@ require_relative '../pgtk'
 # Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
 # License:: MIT
 class Pgtk::Impatient
-  # If timed out
-  class TooSlow < StandardError; end
-
   # Constructor.
   #
   # @param [Pgtk::Pool] pool The pool to decorate
   # @param [Integer] timeout Timeout in seconds for each SQL query
   # @param [Array<Regex>] off List of regex to exclude queries from checking
-  def initialize(pool, timeout, *off)
+  # @param [Integer] default Fallback timeout in seconds for excluded queries (0 = no timeout)
+  def initialize(pool, timeout, *off, default: 300)
     @pool = pool
     @timeout = timeout
     @off = off
+    @default = default
   end
 
   # Start a new connection pool with the given arguments.
@@ -89,7 +88,7 @@ class Pgtk::Impatient
     [
       @pool.dump,
       '',
-      "Pgtk::Impatient (timeout=#{@timeout}s):",
+      "Pgtk::Impatient (timeout=#{@timeout}s, default=#{@default}s):",
       @off.map { |re| "  #{re}" }
     ].join("\n")
   end
@@ -109,7 +108,13 @@ class Pgtk::Impatient
   # @raise [TooSlow] If the query takes too long
   def exec(query, *args)
     sql = query.is_a?(Array) ? query.join(' ') : query
-    return @pool.exec(sql, *args) if @off.any? { |re| re.match?(sql) }
+    if @off.any? { |re| re.match?(sql) }
+      ms = Integer(@default * 1000)
+      return @pool.transaction do |t|
+        t.exec("SET LOCAL statement_timeout = #{ms}") unless ms.zero?
+        t.exec(sql, *args)
+      end
+    end
     start = Time.now
     ms = [Integer(@timeout * 1000), 1].max
     begin
@@ -118,14 +123,16 @@ class Pgtk::Impatient
         t.exec(sql, *args)
       end
     rescue PG::QueryCanceled
-      raise(TooSlow, [
-        'SQL query',
-        ("with #{args.count} argument#{'s' if args.count > 1}" unless args.empty?),
-        'was terminated after',
-        start.ago,
-        'of waiting:',
-        sql.ellipsized(50).inspect
-      ].compact.join(' '))
+      raise(
+        TooSlow, [
+          'SQL query',
+          ("with #{args.count} argument#{'s' if args.count > 1}" unless args.empty?),
+          'was terminated after',
+          start.ago,
+          'of waiting:',
+          sql.ellipsized(50).inspect
+        ].compact.join(' ')
+      )
     end
   end
 
@@ -146,3 +153,5 @@ class Pgtk::Impatient
     end
   end
 end
+
+require_relative 'impatient/too_slow'

data/lib/pgtk/liquibase_task.rb

@@ -127,14 +127,15 @@ class Pgtk::LiquibaseTask < Rake::TaskLib
     password = yml['pgsql']['password']
     host = yml.dig('pgsql', 'host')
     Dir.chdir(File.dirname(@schema)) do
-      out =
+      File.write(
+        @schema,
         if (local && @docker != :always) || @docker == :never
           pgdump(yml, host, password)
         else
           host = donce_host if OS.mac? && ['localhost', '127.0.0.1'].include?(host)
           dockerdump(yml, host, password)
         end
-      File.write(@schema, out)
+      )
     end
   end
 

data/lib/pgtk/liquicheck_task/must_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../../pgtk'
+
+class Pgtk::LiquicheckTask; end
+
+# Internal error raised by Pgtk::LiquicheckTask validation helpers and
+# captured per-file by the +on+ helper to accumulate readable diagnostics.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
+# License:: MIT
+class Pgtk::LiquicheckTask::MustError < StandardError
+end

data/lib/pgtk/liquicheck_task.rb

@@ -110,8 +110,6 @@ class Pgtk::LiquicheckTask < Rake::TaskLib
   def confirm(prop, regex, msg)
     raise(MustError, msg) unless prop.match?(regex)
   end
-
-  class MustError < StandardError
-  end
-  private_constant :MustError
 end
+
+require_relative 'liquicheck_task/must_error'

data/lib/pgtk/pgsql_task.rb

@@ -51,18 +51,18 @@ class Pgtk::PgsqlTask < Rake::TaskLib
 
   def run
     local = detect(:local)
-    docker = detect(:docker)
-    preflight(local, docker)
+    preflight(local, detect(:docker))
     home = File.expand_path(@dir)
     FileUtils.rm_rf(home) if @fresh
     raise(ArgumentError, "Directory/file #{home} is present, use fresh=true") if File.exist?(home)
-    stdout = @quiet ? nil : $stdout
     port = acquire
-    place = launch(local, home, stdout, port)
-    save(port)
-    return if @quiet
-    puts("PostgreSQL has been started #{place}, port #{port}")
-    puts("YAML config saved to #{@yaml}")
+    launch(local, home, @quiet ? nil : $stdout, port).then do |place|
+      save(port)
+      unless @quiet
+        puts("PostgreSQL has been started #{place}, port #{port}")
+        puts("YAML config saved to #{@yaml}")
+      end
+    end
   end
 
   def preflight(local, docker)
@@ -87,11 +87,9 @@ class Pgtk::PgsqlTask < Rake::TaskLib
 
   def launch(local, home, stdout, port)
     if (local && @docker != :always) || @docker == :never
-      pid = localize(home, stdout, port)
-      "in process ##{pid}"
+      "in process ##{localize(home, stdout, port)}"
     else
-      container = dockerize(home, stdout, port)
-      "in container #{container}"
+      "in container #{dockerize(home, stdout, port)}"
     end
   end
 
@@ -122,21 +120,23 @@ class Pgtk::PgsqlTask < Rake::TaskLib
 
   def dockerize(home, stdout, port)
     FileUtils.mkdir_p(home)
-    out =
-      qbash(
-        'docker',
-        'run',
-        "--publish #{Shellwords.escape("#{port}:5432")}",
-        "-e POSTGRES_USER=#{Shellwords.escape(@user)}",
-        "-e POSTGRES_PASSWORD=#{Shellwords.escape(@password)}",
-        "-e POSTGRES_DB=#{Shellwords.escape(@dbname)}",
-        '--detach',
-        '--rm',
-        'postgres:18.1',
-        @config.map { |k, v| "-c #{Shellwords.escape("#{k}=#{v}")}" },
-        stdout:
-      )
-    container = out.scan(/[a-f0-9]+\Z/).first
+    container = qbash(
+      'docker',
+      'run',
+      "--publish #{Shellwords.escape("#{port}:5432")}",
+      "-e POSTGRES_USER=#{Shellwords.escape(@user)}",
+      "-e POSTGRES_PASSWORD=#{Shellwords.escape(@password)}",
+      "-e POSTGRES_DB=#{Shellwords.escape(@dbname)}",
+      '--detach',
+      '--rm',
+      '--health-cmd', 'pg_isready',
+      '--health-interval', '1s',
+      '--health-timeout', '2s',
+      '--health-retries', '10',
+      'postgres:18.1',
+      @config.map { |k, v| "-c #{Shellwords.escape("#{k}=#{v}")}" },
+      stdout:
+    ).scan(/[a-f0-9]+\Z/).first
     File.write(File.join(home, 'docker-container'), container)
     at_exit do
       if qbash(
@@ -152,6 +152,15 @@ class Pgtk::PgsqlTask < Rake::TaskLib
     rescue WaitUtil::TimeoutError => e
       raise(IOError, "Failed to start PostgreSQL Docker container #{container.inspect}: #{e.message}")
     end
+    (30 * 2).times do
+      status = qbash(
+        "docker inspect --format='{{.State.Health.Status}}' #{Shellwords.escape(container)}",
+        accept: nil, both: true
+      )[0]&.strip
+      break if status == 'healthy'
+      raise(IOError, "PostgreSQL container #{container.inspect} is #{status}") if status == 'unhealthy'
+      sleep(0.5)
+    end
     container
   end
 
@@ -185,13 +194,17 @@ class Pgtk::PgsqlTask < Rake::TaskLib
       puts("PostgreSQL killed in PID #{pid}") unless @quiet
     end
     begin
-      WaitUtil.wait_for_service('PG in local', 'localhost', port, timeout_sec: 10, delay_sec: 0.1)
+      WaitUtil.wait_for_service('PG in local', 'localhost', port, timeout_sec: 10, delay_sec: 0.2)
     rescue WaitUtil::TimeoutError => e
       puts("+ #{cmd}")
       puts("stdout:\n#{File.read(File.join(home, 'stdout.txt'))}")
       puts("stderr:\n#{File.read(File.join(home, 'stderr.txt'))}")
       raise(IOError, "Failed to start PostgreSQL database server on port #{port}: #{e.message}")
     end
+    (10 * 2).times do
+      break if qbash("pg_isready -h localhost -p #{port}", accept: nil, both: true)[1].zero?
+      sleep(0.5)
+    end
     qbash(
       'createdb',
       '--host', 'localhost',

data/lib/pgtk/pool/busy.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../../pgtk'
+
+class Pgtk::Pool; end
+
+# Raised when no connection becomes available from the pool within
+# the configured timeout. Indicates that all connections are currently
+# taken by other threads and none was returned in time.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
+# License:: MIT
+class Pgtk::Pool::Busy < StandardError; end

data/lib/pgtk/pool/iterable_queue.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../../pgtk'
+require_relative 'busy'
+
+class Pgtk::Pool; end
+
+# Thread-safe queue implementation that supports iteration.
+# Unlike Ruby's Queue class, this implementation allows safe iteration
+# over all elements while maintaining thread safety for concurrent access.
+#
+# This class is used internally by Pool to store database connections
+# and provide the ability to iterate over them for inspection purposes.
+#
+# The queue is bounded by size. When an item is taken out, it remains in
+# the internal array but is marked as "taken". When returned, it's placed
+# back in its original slot and marked as available.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
+# License:: MIT
+class Pgtk::Pool::IterableQueue
+  def initialize(size, timeout)
+    @size = size
+    @timeout = timeout
+    @items = []
+    @taken = []
+    @free = []
+    @mutex = Mutex.new
+    @condition = ConditionVariable.new
+  end
+
+  def push(item)
+    @mutex.synchronize do
+      if @items.size < @size
+        @items << item
+        @taken << false
+        @free << (@items.size - 1)
+      else
+        index = @items.index(item)
+        if index.nil?
+          index = @taken.index(true)
+          raise(StandardError, 'No taken slot found') if index.nil?
+          @items[index] = item
+        end
+        @taken[index] = false
+        @free << index
+      end
+      @condition.signal
+    end
+  end
+
+  def pop
+    @mutex.synchronize do
+      deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + @timeout
+      while @free.empty?
+        remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        if remaining <= 0
+          raise(Pgtk::Pool::Busy, "No free connection appeared in the pool after #{@timeout}s of waiting")
+        end
+        @condition.wait(@mutex, remaining)
+      end
+      index = @free.shift
+      @taken[index] = true
+      @items[index]
+    end
+  end
+
+  def size
+    @mutex.synchronize do
+      @items.size
+    end
+  end
+
+  def map(&)
+    @mutex.synchronize do
+      @items.map(&)
+    end
+  end
+end

data/lib/pgtk/pool/txn.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'tago'
+require_relative '../../pgtk'
+
+class Pgtk::Pool; end
+
+# A temporary class to execute a single SQL request.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
+# License:: MIT
+class Pgtk::Pool::Txn
+  def initialize(conn, log)
+    @conn = conn
+    @log = log
+  end
+
+  # Exec a single parameterized command.
+  # @param [String] query The SQL query with params inside (possibly)
+  # @param [Array] args List of arguments
+  # @param [Integer] result Should be 0 for text results, 1 for binary
+  # @yield [Hash] Rows
+  def exec(query, args = [], result = 0)
+    start = Time.now
+    sql = query.is_a?(Array) ? query.join(' ') : query
+    @conn.instance_variable_set(:@pgtk_last_query, sql)
+    @conn.instance_variable_set(:@pgtk_started_at, start)
+    begin
+      out =
+        if args.empty?
+          @conn.exec(sql) do |res|
+            if block_given?
+              yield(res)
+            else
+              res.each.to_a
+            end
+          end
+        else
+          @conn.exec_params(sql, args, result) do |res|
+            if block_given?
+              yield(res)
+            else
+              res.each.to_a
+            end
+          end
+        end
+    rescue StandardError => e
+      @log.error("#{sql} -> #{e.message}")
+      raise(e)
+    end
+    if (Time.now - start) < 1
+      @log.debug("#{sql} >> #{start.ago} / #{@conn.object_id}")
+    else
+      @log.info("#{sql} >> #{start.ago}")
+    end
+    out
+  end
+end