pgtk 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 902941bbf98d37acfad72c9615282264148e6ad6ce1183f2fcd085d3a0cf288e
-  data.tar.gz: 00a5488c8dd99f98df1ebce8cef20207514964a1628df8489bd320d0c199ca77
+  metadata.gz: 57546e93aaf2c029a795f61302d943e4f64e7d1e03b77d339636bdfb73d271d5
+  data.tar.gz: 467c0493e69e8402b83ea6b537ac69760d5e712ac088b856307d2418449878f9
 SHA512:
-  metadata.gz: 47d6993b709ebce71a8cd1525f94230b8c554a8c2edd871ca67627ce6e6724d46ea3530827fa3cb653ae54b56cf4299cb4291197d3f870e602942ffc0b7b6134
-  data.tar.gz: cbe8bf7eebf1c038d71079845355d805bc647be88e62523db89180ce9f39e4299a779f104ee648a1f4399f18f90a0e4f3aab371f277df964dec843299b5b733d
+  metadata.gz: 83b61249a1888eed186c7faa7814c9a07f28fa9268d8d7fad1dfc0b9d7f4b304d4c835116fce6e32b6e651d7a2fc12731417c52922daae8ad9759419b32d2344
+  data.tar.gz: 5107f90f035a11e3ab17c8718f759c6869ea24d3c195dafb1845d546587244ad1e6f82dca7da5b505055cefdafa97f7b0e6390f17374e2458f773e54f7f9dd75

data/Gemfile

@@ -16,6 +16,7 @@ gem 'rubocop-performance', '~>1.25', require: false
 gem 'rubocop-rake', '~>0.7', require: false
 gem 'simplecov', '~>0.22', require: false
 gem 'simplecov-cobertura', '~>3.0'
+gem 'threads', '~>0.4'
 gem 'timeout', '~>0.4'
 gem 'xcop', '~>0.8', require: false
 gem 'yard', '~>0.9', require: false

data/Gemfile.lock

@@ -102,6 +102,9 @@ GEM
     simplecov_json_formatter (0.1.4)
     slop (4.10.1)
     tago (0.3.0)
+    threads (0.4.1)
+      backtrace (~> 0)
+      concurrent-ruby (~> 1.0)
     timeout (0.4.4)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
@@ -132,6 +135,7 @@ DEPENDENCIES
   rubocop-rake (~> 0.7)
   simplecov (~> 0.22)
   simplecov-cobertura (~> 3.0)
+  threads (~> 0.4)
   timeout (~> 0.4)
   xcop (~> 0.8)
   yard (~> 0.9)

data/README.md

@@ -115,8 +115,8 @@ From inside your app you may find this class useful:
 
 ```ruby
 require 'pgtk/pool'
-pgsql = Pgtk::Pool.new(Pgtk::Wire::Yaml.new('config.yml'))
-pgsql.start!(5) # Start it with five simultaneous connections
+pgsql = Pgtk::Pool.new(Pgtk::Wire::Yaml.new('config.yml'), max: 5)
+pgsql.start! # Start it with five simultaneous connections
 ```
 
 You can also let it pick the connection parameters from the environment

data/lib/pgtk/impatient.rb

@@ -19,8 +19,8 @@ require_relative '../pgtk'
 # Basic usage:
 #
 #   # Create and configure a regular pool
-#   pool = Pgtk::Pool.new(wire)
-#   pool.start!(4)
+#   pool = Pgtk::Pool.new(wire, max: 4)
+#   pool.start!
 #
 #   # Wrap the pool in an impatient decorator with a 2-second timeout
 #   impatient = Pgtk::Impatient.new(pool, 2)
@@ -69,8 +69,8 @@ class Pgtk::Impatient
   end
 
   # Start a new connection pool with the given arguments.
-  def start!(*)
-    @pool.start!(*)
+  def start!
+    @pool.start!
   end
 
   # Get the version of PostgreSQL server.

data/lib/pgtk/pool.rb

@@ -29,8 +29,8 @@ require_relative 'wire'
 #   )
 #
 #   # Create and start a connection pool with 4 connections
-#   pool = Pgtk::Pool.new(wire)
-#   pool.start!(4)
+#   pool = Pgtk::Pool.new(wire, max: 4)
+#   pool.start!
 #
 #   # Execute a simple query
 #   pool.exec('SELECT * FROM users')
@@ -51,11 +51,14 @@ class Pgtk::Pool
   # Constructor.
   #
   # @param [Pgtk::Wire] wire The wire
+  # @param [Integer] max Total amount of PostgreSQL connections in the pool
   # @param [Object] log The log
-  def initialize(wire, log: Loog::NULL)
+  def initialize(wire, max: 8, log: Loog::NULL)
     @wire = wire
+    @max = max
     @log = log
-    @pool = IterableQueue.new
+    @pool = IterableQueue.new(max)
+    @started = false
   end
 
   # Get the version of PostgreSQL server.
@@ -74,7 +77,42 @@ class Pgtk::Pool
       "  PgSQL version: #{version}",
       "  #{@pool.size} connections:",
       @pool.map do |c|
-        "    ##{c.backend_pid} #{c.pipeline_status} #{c.status} #{c.transaction_status}"
+        [
+          '    ',
+          "##{c.backend_pid}",
+          case c.pipeline_status
+          when PG::Constants::PQ_PIPELINE_ON
+            'ON'
+          when PG::Constants::PQ_PIPELINE_OFF
+            'OFF'
+          when PG::Constants::PQ_PIPELINE_ABORTED
+            'ABORTED'
+          else
+            "pipeline_status=#{c.pipeline_status}"
+          end,
+          case c.status
+          when PG::Constants::CONNECTION_OK
+            'OK'
+          when PG::Constants::CONNECTION_BAD
+            'BAD'
+          else
+            "status=#{c.status}"
+          end,
+          case c.transaction_status
+          when PG::Constants::PQTRANS_IDLE
+            'IDLE'
+          when PG::Constants::PQTRANS_ACTIVE
+            'ACTIVE'
+          when PG::Constants::PQTRANS_INTRANS
+            'INTRANS'
+          when PG::Constants::PQTRANS_INERROR
+            'INERROR'
+          when PG::Constants::PQTRANS_UNKNOWN
+            'UNKNOWN'
+          else
+            "transaction_status=#{c.transaction_status}"
+          end
+        ].join(' ')
       end
     ].flatten.join("\n")
   end
@@ -85,13 +123,13 @@ class Pgtk::Pool
   # keep in mind that not all servers will allow you to have many connections
   # open at the same time. For example, Heroku free PostgreSQL database
   # allows only one connection open.
-  #
-  # @param [Integer] max Total amount of PostgreSQL connections in the pool
-  def start!(max = 8)
-    max.times do
+  def start!
+    return if @started
+    @max.times do
       @pool << @wire.connection
     end
-    @log.debug("PostgreSQL pool started with #{max} connections")
+    @started = true
+    @log.debug("PostgreSQL pool started with #{@max} connections")
   end
 
   # Make a query and return the result as an array of hashes. For example,
@@ -184,24 +222,43 @@ class Pgtk::Pool
   #
   # 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.
   class IterableQueue
-    def initialize
+    def initialize(size)
+      @size = size
       @items = []
+      @taken = []
       @mutex = Mutex.new
       @condition = ConditionVariable.new
     end
 
     def <<(item)
       @mutex.synchronize do
-        @items << item
+        if @items.size < @size
+          @items << item
+          @taken << false
+        else
+          index = @items.index(item)
+          if index.nil?
+            index = @taken.index(true)
+            raise 'No taken slot found' if index.nil?
+            @items[index] = item
+          end
+          @taken[index] = false
+        end
         @condition.signal
       end
     end
 
     def pop
       @mutex.synchronize do
-        @condition.wait(@mutex) while @items.empty?
-        @items.shift
+        @condition.wait(@mutex) while @taken.all? || @items.empty?
+        index = @taken.index(false)
+        @taken[index] = true
+        @items[index]
       end
     end
 

data/lib/pgtk/retry.rb

@@ -16,8 +16,8 @@ require_relative '../pgtk'
 # Basic usage:
 #
 #   # Create and configure a regular pool
-#   pool = Pgtk::Pool.new(wire)
-#   pool.start!(4)
+#   pool = Pgtk::Pool.new(wire, max: 4)
+#   pool.start!
 #
 #   # Wrap the pool in a retry decorator with 3 attempts
 #   retry_pool = Pgtk::Retry.new(pool, attempts: 3)
@@ -58,8 +58,8 @@ class Pgtk::Retry
   end
 
   # Start a new connection pool with the given arguments.
-  def start!(*)
-    @pool.start!(*)
+  def start!
+    @pool.start!
   end
 
   # Get the version of PostgreSQL server.

data/lib/pgtk/spy.rb

@@ -19,8 +19,8 @@ require_relative 'wire'
 # Basic usage:
 #
 #   # Create and configure a regular pool
-#   pool = Pgtk::Pool.new(wire)
-#   pool.start!(4)
+#   pool = Pgtk::Pool.new(wire, max: 4)
+#   pool.start!
 #
 #   # Wrap the pool in a spy that tracks all executed queries
 #   queries = []
@@ -57,8 +57,8 @@ class Pgtk::Spy
   end
 
   # Start a new connection pool with the given arguments.
-  def start!(*)
-    @pool.start!(*)
+  def start!
+    @pool.start!
   end
 
   # Get the version of PostgreSQL server.

data/lib/pgtk/stash.rb

@@ -60,12 +60,13 @@ class Pgtk::Stash
     @max_queue_length = max_queue_length
     @threads = threads
     @loog = loog
+    @tpool = Concurrent::FixedThreadPool.new(@threads)
   end
 
   # Start a new connection pool with the given arguments.
-  def start!(*)
+  def start!
     launch!
-    @pool.start!(*)
+    @pool.start!
   end
 
   # Get the PostgreSQL server version.
@@ -90,9 +91,12 @@ class Pgtk::Stash
       '',
       "Pgtk::Stash (refill_interval=#{@refill_interval}s, max_queue_length=#{@max_queue_length}, threads=#{@threads}):",
       "  #{'not ' if @launched.false?}launched",
-      "  #{@stash[:tables].count} tables in cache",
-      "  #{@stash[:queries].count} queries in cache:",
-      qq.sort_by { -_1[2] }.take(64).map { |a| "    #{a[1]}/#{a[2]}p/#{a[3]}s: #{a[0]}" }
+      "  #{@tpool.queue_length} task(s) in the thread pool",
+      "  #{@stash[:tables].count} table(s) in cache",
+      "  #{qq.sum { |a| a[3] }} stale quer(ies) in cache:",
+      qq.select { |a| a[3].positive? }.sort_by { -_1[2] }.take(16).map { |a| "    #{a[1]}/#{a[2]}p/#{a[3]}s: #{a[0]}" },
+      "  #{qq.count { |a| a[3].zero? }} other quer(ies) in cache:",
+      qq.select { |a| a[3].zero? }.sort_by { -_1[2] }.take(8).map { |a| "    #{a[1]}/#{a[2]}p/#{a[3]}s: #{a[0]}" }
     ].join("\n")
   end
 
@@ -132,7 +136,7 @@ class Pgtk::Stash
               @stash[:tables][t].append(pure).uniq!
             end
             @stash[:queries][pure] ||= {}
-            @stash[:queries][pure][key] = { ret:, params:, result: }
+            @stash[:queries][pure][key] = { ret:, params:, result:, used: Time.now }
           end
         end
       end
@@ -140,6 +144,7 @@ class Pgtk::Stash
         @entrance.with_write_lock do
           @stash[:queries][pure][key][:popularity] ||= 0
           @stash[:queries][pure][key][:popularity] += 1
+          @stash[:queries][pure][key][:used] = Time.now
         end
       end
     end
@@ -171,34 +176,31 @@ class Pgtk::Stash
 
   def launch!
     raise 'Cannot launch multiple times on same cache data' unless @launched.make_true
-    Concurrent::FixedThreadPool.new(@threads).then do |tpool|
-      Concurrent::TimerTask.execute(execution_interval: 60 * 60, executor: tpool) do
-        @entrance.with_write_lock do
-          @stash[:queries].each_key do |q|
-            @stash[:queries][q].each_key do |k|
-              @stash[:queries][q][k][:popularity] = 0
-            end
-          end
+    retire = 60 * 60
+    Concurrent::TimerTask.execute(execution_interval: retire, executor: @tpool) do
+      @entrance.with_write_lock do
+        @stash[:queries].each_key do |q|
+          @stash[:queries][q].delete_if { |_, h| h[:used] < Time.now - retire }
         end
       end
-      Concurrent::TimerTask.execute(execution_interval: @refill_interval, executor: tpool) do
-        @stash[:queries]
-          .map { |k, v| [k, v.values.sum { |vv| vv[:popularity] }, v.values.any? { |vv| vv[:stale] }] }
-          .select { _1[2] }
-          .sort_by { -_1[1] }
-          .each do |a|
-          q = a[0]
-          @stash[:queries][q].each_key do |k|
-            next unless @stash[:queries][q][k][:stale]
-            next if tpool.queue_length >= @max_queue_length
-            tpool.post do
+    end
+    Concurrent::TimerTask.execute(execution_interval: @refill_interval, executor: @tpool) do
+      @stash[:queries]
+        .map { |k, v| [k, v.values.sum { |vv| vv[:popularity] }, v.values.any? { |vv| vv[:stale] }] }
+        .select { _1[2] }
+        .sort_by { -_1[1] }
+        .each do |a|
+        q = a[0]
+        @stash[:queries][q].each_key do |k|
+          next unless @stash[:queries][q][k][:stale]
+          next if @tpool.queue_length >= @max_queue_length
+          @tpool.post do
+            h = @stash[:queries][q][k]
+            ret = @pool.exec(q, h[:params], h[:result])
+            @entrance.with_write_lock do
               h = @stash[:queries][q][k]
-              ret = @pool.exec(q, h[:params], h[:result])
-              @entrance.with_write_lock do
-                h = @stash[:queries][q][k]
-                h[:stale] = false
-                h[:ret] = ret
-              end
+              h[:stale] = false
+              h[:ret] = ret
             end
           end
         end

data/lib/pgtk/version.rb

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

metadata

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