gene_pool 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4185e45cfcd0aaf6dd261f72d1d794df72952a59
-  data.tar.gz: a755af2d8bd162c60ed34219739206af138e69e5
+  metadata.gz: bc1bdaf7ba625db87160e8afdf2ed0dc1769c036
+  data.tar.gz: af8f23899faaea5e5c681807ffaab6ea29651a3b
 SHA512:
-  metadata.gz: b9107ae8d748c69c188ac978bf1cdba31e57af797555e76d1ddcf70a0bdf5d4f641dffcb9364f23f1b4be449b3db09575260a0b1b47737c930d584edf5176a67
-  data.tar.gz: 2ca1941b0689ccd6bba3be10f1410e30e23e26cdcb58c53d65182674604069572426fef646c5b55b4765e6067564073d111d265fbb9fd0fd9e013806696fa3df
+  metadata.gz: 4a861f3844f435b77944cb4699335066278facec8c71bfa581c16bd480ffcd9d34192bbbce6fe6095de474779a66bc59838a5f2a10d62aae54cd1b53418f8220
+  data.tar.gz: 012a79fb29dc53ebf5ae09a94913e45df5ee1fd810c797671f9a090bb7cd50928b38c06e620d3eb56c61cf4b2481f9d18576ebe88e7f5d683c593ffb3e0c8fca

data/Gemfile

@@ -11,5 +11,6 @@ group :development do
 end
 
 group :test do
+  gem 'minitest', "~> 4.0"
   gem 'shoulda'
 end

data/History.md

@@ -1,6 +1,12 @@
 GenePool Changelog
 =====================
 
+1.4.0 / 2014-04-18
+
+  - Use Monitor instead of Mutex for locking to prevent recursive lock issues.
+  - Fix tests where Timeout.timeout without passing exception in raises unrescueable Timeout::Error in ruby 2.1 so cleanup does not occur.
+  - Allow option timeout_class which will get raised instead of Timeout::Error
+
 1.3.2 / 2014-01-06
 
   - Fix bug where connections that failed renew and were nil were attempting to be released.  (Which would generally swallow the originating exception).

data/lib/gene_pool.rb

@@ -1,32 +1,35 @@
 require 'logger'
 require 'thread'
+require 'monitor'
 
 # Generic connection pool class
 class GenePool
 
-  attr_accessor :name, :pool_size, :warn_timeout, :logger
+  attr_accessor :name, :pool_size, :warn_timeout, :logger, :timeout_class
 
   # Creates a gene_pool.  The passed block will be used to initialize a single instance of
   # the item being pooled (i.e., socket connection or whatever)
   # options -
-  #   name         - The name used in logging messages.
-  #   pool_size    - The maximum number of instances that will be created (Defaults to 1).
-  #   timeout      - Will raise a Timeout exception if waiting on a connection for this many seconds.
-  #   warn_timeout - Displays an error message if a checkout takes longer that the given time (used to give hints to increase the pool size).
-  #   idle_timeout - If set, the connection will be renewed if it hasn't been used in this amount of time (seconds).
-  #   logger       - The logger used for log messages, defaults to STDERR.
-  #   close_proc   - The process or method used to close a pooled instance when it is removed.
+  #   name          - The name used in logging messages.
+  #   pool_size     - The maximum number of instances that will be created (Defaults to 1).
+  #   timeout       - Will raise a Timeout exception if waiting on a connection for this many seconds.
+  #   timeout_class - Exception class to raise if timeout error, defaults to Timeout::Error
+  #   warn_timeout  - Displays an error message if a checkout takes longer that the given time (used to give hints to increase the pool size).
+  #   idle_timeout  - If set, the connection will be renewed if it hasn't been used in this amount of time (seconds).
+  #   logger        - The logger used for log messages, defaults to STDERR.
+  #   close_proc    - The process or method used to close a pooled instance when it is removed.
   #     Defaults to :close.  Set to nil for no-op or a symbol for a method or a proc that takes an argument for the instance.
   def initialize(options={}, &connect_block)
     @connect_block = connect_block
 
-    @name         = options[:name]         || 'GenePool'
-    @pool_size    = options[:pool_size]    || 1
-    @timeout      = options[:timeout]
-    @warn_timeout = options[:warn_timeout] || 5.0
-    @idle_timeout = options[:idle_timeout]
-    @logger       = options[:logger]
-    @close_proc   = options[:close_proc]   || (!options.has_key?(:close_proc) && :close)
+    @name          = options[:name]          || 'GenePool'
+    @pool_size     = options[:pool_size]     || 1
+    @timeout       = options[:timeout]
+    @timeout_class = options[:timeout_class] || Timeout::Error
+    @warn_timeout  = options[:warn_timeout]  || 5.0
+    @idle_timeout  = options[:idle_timeout]
+    @logger        = options[:logger]
+    @close_proc    = options[:close_proc]    || (!options.has_key?(:close_proc) && :close)
 
     unless @logger
       @logger = Logger.new(STDERR)
@@ -160,7 +163,7 @@ class GenePool
       begin
         yield connection
       rescue Exception => e
-        if e.kind_of?(Timeout::Error) || e.message =~ /expired/
+        if e.kind_of?(Timeout::Error) || e.kind_of?(@timeout_class) || e.message =~ /expired/
           remove(connection)
           raise
         end
@@ -286,40 +289,20 @@ class GenePool
     close_connection(connection)
   end
 
-  if RUBY_VERSION < '1.9'
-    require 'monitor'
-    def setup_mutex
-      @connections.extend(MonitorMixin)
-      # Mutex for synchronizing pool access
-      @mutex = @connections
-      # Condition variable for waiting for an available connection
-      @condition = @mutex.new_cond
-    end
-
-    def wait_mutex(start_time)
-      return @condition.wait unless @timeout
-      delta = @timeout - (Time.now - start_time)
-      raise Timeout::Error if delta <= 0.0
-      @condition.wait(delta)
-      delta = @timeout - (Time.now - start_time)
-      raise Timeout::Error if delta <= 0.0
-    end
-
-  else # RUBY_VERSION >= '1.9'
-    def setup_mutex
-      # Mutex for synchronizing pool access
-      @mutex = Mutex.new
-      # Condition variable for waiting for an available connection
-      @condition = ConditionVariable.new
-    end
+  def setup_mutex
+    @connections.extend(MonitorMixin)
+    # Mutex for synchronizing pool access
+    @mutex = @connections
+    # Condition variable for waiting for an available connection
+    @condition = @mutex.new_cond
+  end
 
-    def wait_mutex(start_time)
-      return @condition.wait(@mutex) unless @timeout
-      delta = @timeout - (Time.now - start_time)
-      raise Timeout::Error if delta <= 0.0
-      @condition.wait(@mutex, delta)
-      delta = @timeout - (Time.now - start_time)
-      raise Timeout::Error if delta <= 0.0
-    end
+  def wait_mutex(start_time)
+    return @condition.wait unless @timeout
+    delta = @timeout - (Time.now - start_time)
+    raise @timeout_class if delta <= 0.0
+    @condition.wait(delta)
+    delta = @timeout - (Time.now - start_time)
+    raise @timeout_class if delta <= 0.0
   end
 end

data/test/gene_pool_test.rb

@@ -11,6 +11,8 @@ class GenePool
   attr_reader :connections, :checked_out, :with_map
 end
 
+class MyTimeoutError < RuntimeError; end
+
 class DummyConnection
   attr_reader :count
   def initialize(count, sleep_time=nil)
@@ -173,8 +175,8 @@ class GenePoolTest < Test::Unit::TestCase
     should 'handle aborted connection' do
       @gene_pool.with_connection do |conn1|
         @sleep = 2
-        assert_raises Timeout::Error do
-          Timeout.timeout(1) do
+        assert_raises RuntimeError do
+          Timeout.timeout(1, RuntimeError) do
             @gene_pool.with_connection { |conn2| }
           end
         end
@@ -204,8 +206,8 @@ class GenePoolTest < Test::Unit::TestCase
         assert_equal i, @gene_pool.checked_out.size
         assert_equal conns, @gene_pool.connections
       end
-      assert_raises Timeout::Error do
-        Timeout.timeout(1) do
+      assert_raises RuntimeError do
+        Timeout.timeout(1, RuntimeError) do
           @gene_pool.checkout
         end
       end
@@ -282,8 +284,8 @@ class GenePoolTest < Test::Unit::TestCase
     end
 
     should 'not auto-retry on timeout' do
-      assert_raises Timeout::Error do
-        Timeout.timeout(1) do
+      assert_raises RuntimeError do
+        Timeout.timeout(1, RuntimeError) do
           @gene_pool.with_connection_auto_retry do |conn|
             sleep 2
             assert false, true
@@ -405,39 +407,46 @@ class GenePoolTest < Test::Unit::TestCase
 
   context 'timeout' do
     setup do
-      @gene_pool = GenePool.new(:name         => 'TestGenePool',
-                                :pool_size    => 2,
-                                :close_proc   => nil,
-                                :timeout      => 1.0) do
-        Object.new
+      @timeout_classes = [nil, MyTimeoutError]
+      @gene_pools = @timeout_classes.map do |timeout_class|
+        GenePool.new(:name          => 'TestGenePool',
+                     :pool_size     => 2,
+                     :close_proc    => nil,
+                     :timeout       => 1.0,
+                     :timeout_class => timeout_class) do
+          Object.new
+        end
       end
     end
 
     should 'timeout when the timeout period has expired' do
-      pool_size = @gene_pool.pool_size
-      # Do it with new connections and old connections
-      (1..2).each do |n|
-        (1..pool_size).each do |i|
-          Thread.new do
-            @gene_pool.with_connection do |c|
-              sleep(2)
+      @gene_pools.each_with_index do |gene_pool, class_index|
+        pool_size = gene_pool.pool_size
+        # Do it with new connections and old connections
+        (1..2).each do |n|
+          (1..pool_size).each do |i|
+            Thread.new do
+              gene_pool.with_connection do |c|
+                sleep(2)
+              end
             end
           end
+          # Let the threads get the connections
+          sleep(0.1)
+          start_time = Time.now
+          timeout_class = @timeout_classes[class_index] || Timeout::Error
+          assert_raises timeout_class do
+            gene_pool.with_connection { |c| }
+            puts "No timeout after #{Time.now - start_time} seconds"
+          end
+          puts "#{Time.now-start_time} should be around 1.0"
+          assert_equal pool_size, gene_pool.connections.size
+          assert_equal pool_size, gene_pool.checked_out.size
+          # Let the threads complete so we can do it again
+          sleep 2
+          assert_equal pool_size, gene_pool.connections.size
+          assert_equal 0,         gene_pool.checked_out.size
         end
-        # Let the threads get the connections
-        sleep(0.1)
-        start_time = Time.now
-        assert_raises Timeout::Error do
-          @gene_pool.with_connection { |c| }
-          puts "No timeout after #{Time.now - start_time} seconds"
-        end
-        puts "#{Time.now-start_time} should be around 1.0"
-        assert_equal pool_size, @gene_pool.connections.size
-        assert_equal pool_size, @gene_pool.checked_out.size
-        # Let the threads complete so we can do it again
-        sleep 2
-        assert_equal pool_size, @gene_pool.connections.size
-        assert_equal 0,         @gene_pool.checked_out.size
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gene_pool
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Brad Pardee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies: []
 description: Generic pooling library for creating a connection pool
 email:
@@ -27,7 +27,7 @@ files:
 homepage: http://github.com/bpardee/gene_pool
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -42,9 +42,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Generic pooling library for creating a connection pool
 test_files: