gene_pool 1.2.4 → 1.3.0

data/History.md

@@ -1,6 +1,10 @@
 GenePool Changelog
 =====================
 
+1.3.0 / 2012-09-10
+
+  - Allow :timeout option to raise Timeout::Error if waiting for a connection exceeds this value.
+
 1.2.4 / 2012-09-05
 
   - require 'thread' under ruby 1.8 so that mutex is defined (Thanks soupmatt!)

data/README.md

@@ -20,8 +20,10 @@ Generic pooling library for connection pools.
       class MyClient
         # Print a logger warning if it requires more than 0.25 seconds to acquire a connection.
         # Close and reopen the connection if it hasn't been used for 10 seconds.
+        # Raise Timeout::Error if waiting for a connection more than 3 seconds.
         @@gene_pool = GenePool.new(:name         => 'MyClient',
                                    :pool_size    => 10,
+                                   :timeout      => 3,
                                    :warn_timeout => 0.25,
                                    :idle_timeout => 10,
                                    :logger       => Rails.logger,

data/lib/gene_pool.rb

@@ -1,5 +1,5 @@
 require 'logger'
-require 'thread' if RUBY_VERSION < '1.9'
+require 'thread'
 
 # Generic connection pool class
 class GenePool
@@ -9,18 +9,20 @@ class GenePool
   # 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).
-  #   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.
+  #   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]
@@ -31,17 +33,13 @@ class GenePool
       @logger.level = Logger::INFO
     end
 
-    # Mutex for synchronizing pool access
-    @mutex = Mutex.new
-
-    # Condition variable for waiting for an available connection
-    @condition = ConditionVariable.new
-
     @connections = []
     @checked_out = []
     # Map the original connections object_id within the with_connection method to the final connection.
     # This could change if the connection is renew'ed.
     @with_map    = {}
+
+    setup_mutex
   end
 
   def size
@@ -84,7 +82,7 @@ class GenePool
             @logger.debug {"#{@name}: Created connection ##{@connections.size} #{connection}(#{connection.object_id}) for #{name}"}
           else
             @logger.info "#{@name}: Waiting for an available connection, all #{@pool_size} connections are checked out."
-            @condition.wait(@mutex)
+            wait_mutex(start_time)
           end
         end
       end
@@ -231,8 +229,8 @@ class GenePool
 
   def close(timeout=10)
     self.pool_size = 0
-    start = Time.now
-    while (Time.now - start) < timeout
+    start_time = Time.now
+    while (Time.now - start_time) < timeout
       sleep 1
       @mutex.synchronize do
         return if @connections.empty?
@@ -287,4 +285,41 @@ class GenePool
     @connections.delete(connection)
     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 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
+  end
 end

data/test/gene_pool_test.rb

@@ -169,7 +169,7 @@ class GenePoolTest < Test::Unit::TestCase
     should 'handle aborted connection' do
       @gene_pool.with_connection do |conn1|
         @sleep = 2
-        e = assert_raises Timeout::Error do
+        assert_raises Timeout::Error do
           Timeout.timeout(1) do
             @gene_pool.with_connection { |conn2| }
           end
@@ -200,13 +200,10 @@ class GenePoolTest < Test::Unit::TestCase
         assert_equal i, @gene_pool.checked_out.size
         assert_equal conns, @gene_pool.connections
       end
-      begin
+      assert_raises Timeout::Error do
         Timeout.timeout(1) do
           @gene_pool.checkout
         end
-        flunk "connection should have timed out"
-      rescue  Timeout::Error => e
-        #pass "successfully timed out connection"
       end
       (1..pool_size).each do |i|
         @gene_pool.checkin(conns[i-1])
@@ -281,7 +278,7 @@ class GenePoolTest < Test::Unit::TestCase
     end
 
     should 'not auto-retry on timeout' do
-      e = assert_raises Timeout::Error do
+      assert_raises Timeout::Error do
         Timeout.timeout(1) do
           @gene_pool.with_connection_auto_retry do |conn|
             sleep 2
@@ -401,6 +398,44 @@ class GenePoolTest < Test::Unit::TestCase
       assert_same conn, close_conn
       assert_equal 2, foo
     end
+  end
+
+  context 'timeout' do
+    setup do
+      @gene_pool = GenePool.new(:name         => 'TestGenePool',
+                                :pool_size    => 2,
+                                :close_proc   => nil,
+                                :timeout      => 1.0) do
+        Object.new
+      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)
+            end
+          end
+        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
 end

metadata

@@ -1,67 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gene_pool
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.3.0
   prerelease: 
-  version: 1.2.4
 platform: ruby
-authors: 
-  - Brad Pardee
+authors:
+- Brad Pardee
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-06 00:00:00 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies: []
-
 description: Generic pooling library for creating a connection pool
-email: 
-  - bradpardee@gmail.com
+email:
+- bradpardee@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-  - lib/gene_pool.rb
-  - LICENSE.txt
-  - Rakefile
-  - Gemfile
-  - History.md
-  - README.md
-  - test/gene_pool_test.rb
+files:
+- lib/gene_pool.rb
+- LICENSE.txt
+- Rakefile
+- Gemfile
+- History.md
+- README.md
+- test/gene_pool_test.rb
 homepage: http://github.com/bpardee/gene_pool
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 2
-        segments: 
-          - 0
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 102611247716920126
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 2
-        segments: 
-          - 0
-        version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 102611247716920126
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Generic pooling library for creating a connection pool
-test_files: 
-  - test/gene_pool_test.rb
+test_files:
+- test/gene_pool_test.rb