connection_pool 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d46787d5f1cdf8901aff57ded2eb518418fea245
-  data.tar.gz: 0ffd3058f4269e9155070e901dd4eb29db2e81d7
+  metadata.gz: c0e26a3abd66776ac9ebe51e38226c1efdbee324
+  data.tar.gz: dfba06ec37dc8fc8a9a5b11e79ca09627e6d439c
 SHA512:
-  metadata.gz: 9adff3406500853bcf8fcd480cce510cab1cf03b3d31cf2429648e92973b012000ba9d4a8e252efbce486f38f00b7df86527073d9d3f0212e967d8624675fe03
-  data.tar.gz: 609a9f24d0472bf9df5989e6830118873a9ae779738945e80c7b5e7010aa205b545af949fc4fa2233ccb5bb4379e9b54d2118f42c4900ac81bb262e790b53a53
+  metadata.gz: 462848c7cb5bcd7be90e1b1b7ea8af8db2b785b45918e73be80e9a901fbe4a3de366ca6bd0c57ef609ef1cfaaa4a2eae6e924b5990b1a716b67db4d2451d3ef7
+  data.tar.gz: 177e4e03153eecb3b04b8bf0d4e98d5f5e9f3be2bb2a74a3464a0901cfc7dfe7679c257d4d180a061debc6cf71dd33d32ba4ad85f21cbf989189ef6bd24e4c02

data/.travis.yml

@@ -1,10 +1,14 @@
 ---
+sudo: false
+cache: bundler
 language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - jruby
+  - rbx-2
 notifications:
   email:
-  - drbrain@segment7.net
-rvm:
-- 1.9.3
-- 2.0.0
-- 2.1.0
-script: rake test
+    - drbrain@segment7.net

data/Changes.md

@@ -1,3 +1,11 @@
+2.1.1
+------
+
+- Work around a subtle race condition with code which uses `Timeout.timeout` and
+  checks out a connection within the timeout block.  This might cause
+  connections to get into a bad state and raise very odd errors. [tamird, #67]
+
+
 2.1.0
 ------
 

data/README.md

@@ -1,5 +1,6 @@
 connection\_pool
 =================
+[![Build Status](https://travis-ci.org/mperham/connection_pool.svg)](https://travis-ci.org/mperham/connection_pool)
 
 Generic connection pooling for Ruby.
 

data/Rakefile

@@ -1,14 +1,6 @@
-begin
-  require 'bundler'
-  Bundler::GemHelper.install_tasks
-rescue LoadError
-end
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-  test.warning = true
-  test.pattern = 'test/**/test_*.rb'
-end
+Rake::TestTask.new
 
 task :default => :test

data/connection_pool.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.license = "MIT"
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'minitest', '>= 5.0.0'
   s.add_development_dependency 'rake'
 end

data/lib/connection_pool.rb

@@ -2,7 +2,7 @@ require_relative 'connection_pool/version'
 require_relative 'connection_pool/timed_stack'
 
 # Generic connection pool class for e.g. sharing a limited number of network connections
-# among many threads.  Note: Connections are eager created.
+# among many threads.  Note: Connections are lazily created.
 #
 # Example usage with block (faster):
 #
@@ -53,22 +53,31 @@ class ConnectionPool
   end
 
   def with(options = {})
+    # Connections can become corrupted via Timeout::Error.  Discard
+    # any connection whose usage after checkout does not finish as expected.
+    # See #67
+    success = false
     conn = checkout(options)
     begin
-      yield conn
+      result = yield conn
+      success = true # means the connection wasn't interrupted
+      result
     ensure
-      checkin
+      if success
+        # everything is roses, we can safely check the connection back in
+        checkin
+      else
+        @available.discard!(pop_connection)
+      end
     end
   end
 
   def checkout(options = {})
-    stack = ::Thread.current[@key] ||= []
-
-    if stack.empty?
+    conn = if stack.empty?
       timeout = options[:timeout] || @timeout
-      conn = @available.pop(timeout: timeout)
+      @available.pop(timeout: timeout)
     else
-      conn = stack.last
+      stack.last
     end
 
     stack.push conn
@@ -76,14 +85,9 @@ class ConnectionPool
   end
 
   def checkin
-    stack = ::Thread.current[@key]
-    raise ConnectionPool::Error, 'no connections are checked out' if
-      !stack || stack.empty?
+    conn = pop_connection # mutates stack, must be on its own line
+    @available.push(conn) if stack.empty?
 
-    conn = stack.pop
-    if stack.empty?
-      @available << conn
-    end
     nil
   end
 
@@ -91,6 +95,20 @@ class ConnectionPool
     @available.shutdown(&block)
   end
 
+  private
+
+  def pop_connection
+    if stack.empty?
+      raise ConnectionPool::Error, 'no connections are checked out'
+    else
+      stack.pop
+    end
+  end
+
+  def stack
+    ::Thread.current[@key] ||= []
+  end
+
   class Wrapper < ::BasicObject
     METHODS = [:with, :pool_shutdown]
 
@@ -98,13 +116,8 @@ class ConnectionPool
       @pool = ::ConnectionPool.new(options, &block)
     end
 
-    def with
-      conn = @pool.checkout
-      begin
-        yield conn
-      ensure
-        @pool.checkin
-      end
+    def with(&block)
+      @pool.with(&block)
     end
 
     def pool_shutdown(&block)
@@ -112,11 +125,11 @@ class ConnectionPool
     end
 
     def respond_to?(id, *args)
-      METHODS.include?(id) || @pool.with { |c| c.respond_to?(id, *args) }
+      METHODS.include?(id) || with { |c| c.respond_to?(id, *args) }
     end
 
     def method_missing(name, *args, &block)
-      @pool.with do |connection|
+      with do |connection|
         connection.send(name, *args, &block)
       end
     end

data/lib/connection_pool/timed_stack.rb

@@ -117,6 +117,22 @@ class ConnectionPool::TimedStack
     @max - @created + @que.length
   end
 
+  ##
+  # Indicates that a connection isn't coming back, allowing a new one to be
+  # created to replace it.
+
+  def discard!(obj)
+    @mutex.synchronize do
+      if @shutdown_block
+        @shutdown_block.call(obj)
+      else
+        @created -= 1
+      end
+
+      @resource.broadcast
+    end
+  end
+
   private
 
   ##

data/lib/connection_pool/version.rb

@@ -1,3 +1,3 @@
 class ConnectionPool
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/test/helper.rb

@@ -3,8 +3,6 @@ gem 'minitest'
 require 'minitest/pride'
 require 'minitest/autorun'
 
-Thread.abort_on_exception = true
-
 $VERBOSE = 1
 
 require_relative '../lib/connection_pool'

data/test/test_connection_pool.rb

@@ -47,9 +47,13 @@ class TestConnectionPool < Minitest::Test
       end
     end.each do |thread|
       Thread.pass until thread.status == 'sleep'
-    end.map do |thread|
+    end
+  end
+
+  def kill_threads(threads)
+    threads.each do |thread|
       thread.kill
-      Thread.pass while thread.alive?
+      thread.join
     end
   end
 
@@ -105,6 +109,40 @@ class TestConnectionPool < Minitest::Test
     assert Thread.new { pool.checkout }.join
   end
 
+  def test_with_with_dangerous_timeouts
+    case RUBY_ENGINE.to_sym
+    when :jruby
+      skip('JRuby GC dislikes this test')
+    when :ruby
+      if RUBY_VERSION == '2.0.0' && RUBY_PATCHLEVEL == 598
+        skip("#{RUBY_VERSION}p#{RUBY_PATCHLEVEL} GC dislikes this test")
+      end
+    end
+
+    marker_class = Class.new
+    pool = ConnectionPool.new(:timeout => 0, :size => 1) { marker_class.new }
+
+    # no "connections" allocated yet
+    assert_equal [], ObjectSpace.each_object(marker_class).to_a
+
+    checkin_time = 0.05
+
+    assert_raises Timeout::Error do
+      Timeout.timeout(checkin_time) do
+        pool.with do
+          # a "connection" has been allocated
+          refute_equal [], ObjectSpace.each_object(marker_class).to_a
+          sleep 2 * checkin_time
+        end
+      end
+    end
+
+    GC.start
+
+    # no dangling references to this "connection" remain
+    assert_equal [], ObjectSpace.each_object(marker_class).to_a
+  end
+
   def test_with_timeout_override
     pool = ConnectionPool.new(:timeout => 0, :size => 1) { NetworkConnection.new }
 
@@ -130,21 +168,13 @@ class TestConnectionPool < Minitest::Test
     pool = ConnectionPool.new(:timeout => 0, :size => 1) { NetworkConnection.new }
     conn = pool.checkout
 
-    t1 = Thread.new do
-      pool.checkout
-    end
-
     assert_raises Timeout::Error do
-      t1.join
+      Thread.new { pool.checkout }.join
     end
 
     pool.checkin
 
-    t2 = Thread.new do
-      pool.checkout
-    end
-
-    assert_same conn, t2.value
+    assert_same conn, Thread.new { pool.checkout }.value
   end
 
   def test_returns_value
@@ -319,12 +349,14 @@ class TestConnectionPool < Minitest::Test
       Recorder.new.tap { |r| recorders << r }
     end
 
-    use_pool pool, 3
+    threads = use_pool pool, 3
 
     pool.shutdown do |recorder|
       recorder.do_work("shutdown")
     end
 
+    kill_threads(threads)
+
     assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
   end
 
@@ -345,7 +377,7 @@ class TestConnectionPool < Minitest::Test
       Recorder.new.tap { |r| recorders << r }
     end
 
-    use_pool pool, 3
+    threads = use_pool pool, 2
 
     pool.checkout
 
@@ -353,7 +385,9 @@ class TestConnectionPool < Minitest::Test
       recorder.do_work("shutdown")
     end
 
-    assert_equal [[], ["shutdown"], ["shutdown"]], recorders.map { |r| r.calls }.sort
+    kill_threads(threads)
+
+    assert_equal [["shutdown"], ["shutdown"], []], recorders.map { |r| r.calls }
 
     pool.checkin
 
@@ -375,12 +409,14 @@ class TestConnectionPool < Minitest::Test
       Recorder.new.tap { |r| recorders << r }
     end
 
-    use_pool wrapper, 3
+    threads = use_pool wrapper, 3
 
     wrapper.pool_shutdown do |recorder|
       recorder.do_work("shutdown")
     end
 
+    kill_threads(threads)
+
     assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: connection_pool
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Mike Perham
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Generic connection pool for Ruby