fiber_connection_pool 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3805c4817fd7ddab4eaafcdf30bacdd99dd79646
-  data.tar.gz: 2af6d4c85fd8d672b7d8c0b9eaea6a02a76e3658
+  metadata.gz: 9fdb88ab21985a6014912366f1a917da8d0df76c
+  data.tar.gz: cc131028a049c18efc0029e63e83966b24cc10b0
 SHA512:
-  metadata.gz: 65a29c9021d57a6f7de8390aa28cf56a5d330ed7b1259dd760b6b4dd5e5be67d8a7e5b1d0c127fb62d7b7c0d252746866269e4fd2a134cf2ab92e8dcba5a9b8c
-  data.tar.gz: ae6b1518828313527b91be4005e6cdc510f364158ed7626df6dff083feee43166006267baba0aae70f519df54bc20ee93bdf0b94e0fd97072bacf3fd6b4e823b
+  metadata.gz: 84abe69a34155bdf1307987d93a4b3c55cd0483be1d55ca0b50fadd8faf42f2582c46a1cada282beb9d245138c71829b00f3e86b8721a553ac75f6c8d1a9e414
+  data.tar.gz: d7f20e3e765f1e334405b0c333c86d63302804318856d2928823f9e10a00dc3015abfb826ccc773e39ab089621d958601301596564d062cfb7162cab7cc9bd3e

data/README.md

@@ -3,6 +3,7 @@ fiber_connection_pool
 
 [![Build Status](https://secure.travis-ci.org/rubencaro/fiber_connection_pool.png?branch=master)](http://travis-ci.org/rubencaro/fiber_connection_pool)
 [![Gem Version](https://badge.fury.io/rb/fiber_connection_pool.png)](http://rubygems.org/gems/fiber_connection_pool)
+[![Code Climate](https://codeclimate.com/github/rubencaro/fiber_connection_pool.png)](https://codeclimate.com/github/rubencaro/fiber_connection_pool)
 
 Fiber-based generic connection pool
 

data/lib/fiber_connection_pool.rb

@@ -2,12 +2,12 @@ require 'fiber'
 require_relative 'fiber_connection_pool/exceptions'
 
 class FiberConnectionPool
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 
-  RESERVED_BACKUP_TTL_SECS = 30 # reserved backup cleanup trigger
+  RESERVED_TTL_SECS = 30 # reserved cleanup trigger
   SAVED_DATA_TTL_SECS = 30 # saved_data cleanup trigger
 
-  attr_accessor :saved_data, :reserved_backup
+  attr_accessor :saved_data, :treated_exceptions
 
   # Initializes the pool with 'size' instances
   # running the given block to get each one. Ex:
@@ -19,8 +19,8 @@ class FiberConnectionPool
 
     @saved_data = {} # placeholder for requested save data
     @reserved  = {}   # map of in-progress connections
-    @reserved_backup = {}   # backup map of in-progress connections, to catch failures
-    @last_backup_cleanup = Time.now # reserved backup cleanup trigger
+    @treated_exceptions = [ PlaceholderException ]  # list of Exception classes that need further connection treatment
+    @last_reserved_cleanup = Time.now # reserved cleanup trigger
     @available = []   # pool of free connections
     @pending   = []   # pending reservations (FIFO)
     @save_data_requests = {} # blocks to be yielded to save data
@@ -119,14 +119,12 @@ class FiberConnectionPool
   # Identify the connection that just failed for current fiber.
   # Pass it to the given block, which must return a valid instance of connection.
   # After that, put the new connection into the pool in failed connection's place.
-  # Raises NoBackupConnection if cannot find the failed connection instance.
+  # Raises NoReservedConnection if cannot find the failed connection instance.
   #
   def with_failed_connection
-    f = Fiber.current
-    bad_conn = @reserved_backup[f]
-    raise NoBackupConnection.new if bad_conn.nil?
+    bad_conn = @reserved[Fiber.current]
+    raise NoReservedConnection.new if bad_conn.nil?
     new_conn = yield bad_conn
-    release_backup f
     @available.reject!{ |v| v == bad_conn }
     @reserved.reject!{ |k,v| v == bad_conn }
     @available.push new_conn
@@ -137,13 +135,13 @@ class FiberConnectionPool
     end
   end
 
-  # Delete any backups held for dead fibers
+  # Delete any reserved held for dead fibers
   #
-  def backup_cleanup
-    @reserved_backup.dup.each do |k,v|
-      @reserved_backup.delete(k) if not k.alive?
+  def reserved_cleanup
+    @last_reserved_cleanup = Time.now
+    @reserved.dup.each do |k,v|
+      release(k) if not k.alive?
     end
-    @last_backup_cleanup = Time.now
   end
 
   private
@@ -164,12 +162,18 @@ class FiberConnectionPool
       # save anything requested
       process_save_data(f, conn, method)
 
-      # successful run, release_backup
-      release_backup(f)
+      # successful run, release
+      release(f)
 
       retval
-    ensure
+    rescue *treated_exceptions => ex
+      # do not release connection for these
+      # maybe prepare something here to be used on connection repair
+      raise ex
+    rescue Exception => ex
+      # not successful run, but not meant to be treated
       release(f)
+      raise ex
     end
   end
 
@@ -191,8 +195,7 @@ class FiberConnectionPool
   #
   def acquire(fiber)
     if conn = @available.pop
-      @reserved[fiber.object_id] = conn
-      @reserved_backup[fiber] = conn
+      @reserved[fiber] = conn
       conn
     else
       Fiber.yield @pending.push fiber
@@ -200,21 +203,16 @@ class FiberConnectionPool
     end
   end
 
-  # Release connection from the backup hash
-  # Also perform cleanup if TTL is past
-  #
-  def release_backup(fiber)
-    @reserved_backup.delete(fiber)
-    # try cleanup
-    backup_cleanup if (Time.now - @last_backup_cleanup) >= RESERVED_BACKUP_TTL_SECS
-  end
-
   # Release connection assigned to the supplied fiber and
   # resume any other pending connections (which will
   # immediately try to run acquire on the pool)
+  # Also perform cleanup if TTL is past
   #
   def release(fiber)
-    @available.push(@reserved.delete(fiber.object_id)).compact!
+    @available.push @reserved.delete(fiber)
+
+    # try cleanup
+    reserved_cleanup if (Time.now - @last_reserved_cleanup) >= RESERVED_TTL_SECS
 
     if pending = @pending.shift
       pending.resume

data/lib/fiber_connection_pool/exceptions.rb

@@ -1,6 +1,8 @@
 
-class NoBackupConnection < Exception
+class NoReservedConnection < StandardError
   def initialize
-    super "No backup connection for this fiber!"
+    super "No reserved connection for this fiber!"
   end
 end
+
+class PlaceholderException < StandardError; end

data/test/fiber_connection_pool_test.rb

@@ -1,11 +1,13 @@
 require 'helper'
+require 'set'
+require 'yaml'
 
 class TestFiberConnectionPool < Minitest::Test
 
   def test_blocking_behaviour
     # get pool and fibers
     pool = FiberConnectionPool.new(:size => 5) { ::BlockingConnection.new(:delay => 0.05) }
-    info = { :threads => [], :fibers => [], :instances => []}
+    info = { :threads => [].to_set, :fibers => [].to_set, :instances => [].to_set}
 
     fibers = Array.new(15){ Fiber.new { pool.do_something(info) } }
 
@@ -21,14 +23,13 @@ class TestFiberConnectionPool < Minitest::Test
     # because as we are -blocking- it's always available
     # again for the next request
     # we should have visited 1 thread, 15 fibers and 1 instances
-    info.dup.each{ |k,v| info[k] = v.uniq }
     assert_equal 1, info[:threads].count
     assert_equal 15, info[:fibers].count
     assert_equal 1, info[:instances].count
   end
 
   def test_em_synchrony_behaviour
-    info = { :threads => [], :fibers => [], :instances => []}
+    info = { :threads => [].to_set, :fibers => [].to_set, :instances => [].to_set}
 
     # get pool and fibers
     pool = FiberConnectionPool.new(:size => 5) { ::EMSynchronyConnection.new(:delay => 0.05) }
@@ -44,7 +45,6 @@ class TestFiberConnectionPool < Minitest::Test
     assert_operator(lapse, :<, 0.20)
 
     # we should have visited 1 thread, 15 fibers and 5 instances
-    info.dup.each{ |k,v| info[k] = v.uniq }
     assert_equal 1, info[:threads].count
     assert_equal 15, info[:fibers].count
     assert_equal 5, info[:instances].count
@@ -68,19 +68,22 @@ class TestFiberConnectionPool < Minitest::Test
   end
 
   def test_failure_reaction
-    info = { :instances => [] }
+    info = { :instances => [].to_set, :repaired_connections => [].to_set, :failing_connections => [].to_set }
 
     # get pool and fibers
     pool = FiberConnectionPool.new(:size => 5) { ::EMSynchronyConnection.new(:delay => 0.05) }
 
     fibers = Array.new(14){ Fiber.new { pool.do_something(info) } }
 
+    # state which exceptions should be treated
+    pool.treated_exceptions = [ FakeException ]
+
     failing_fiber = Fiber.new do
       begin
         pool.fail(info)
       rescue
         pool.with_failed_connection do |connection|
-          info[:repaired_connection] = connection
+          info[:repaired_connections] << connection
           # replace it in the pool
           ::EMSynchronyConnection.new(:delay => 0.05)
         end
@@ -88,62 +91,78 @@ class TestFiberConnectionPool < Minitest::Test
     end
     # put it among others, not the first or the last
     # so we see it does not mistake the failing connection
-    fibers.insert 7,failing_fiber
+    fibers.insert 2,failing_fiber
+
+    failing_fiber_not_treated = Fiber.new do
+      begin
+        pool.fail_not_treated(info)
+      rescue
+        # not meant to be treated
+        assert_raises NoReservedConnection do
+          pool.with_failed_connection{ |c| 'boo' }
+        end
+      end
+    end
+    # put it among others, not the first or the last
+    # so we see it does not mistake the failing connection
+    fibers.insert 7,failing_fiber_not_treated
 
     run_em_reactor fibers
 
-    # we should have visited 1 thread, 15 fibers and 6 instances (including failed)
-    info.dup.each{ |k,v| info[k] = v.uniq if v.is_a?(Array) }
+
+    # we should have visited 1 thread, 15 fibers and 6 instances (including repaired)
     assert_equal 6, info[:instances].count
 
-    # assert we do not lose track of failing connection
-    assert_equal info[:repaired_connection], info[:failing_connection]
+    # assert we do not lose track of failing connections, but only repair those that needed it
+    assert_equal 2, info[:failing_connections].count
+    assert_equal 1, info[:repaired_connections].count
+    assert info[:failing_connections].include?(info[:repaired_connections].first)
 
     # assert we replaced it
-    refute pool.has_connection?(info[:failing_connection])
+    refute pool.has_connection?(info[:repaired_connections].first)
 
     # nothing left
-    assert_equal(0, pool.reserved_backup.count)
+    assert_equal(0, pool.instance_variable_get(:@reserved).count)
 
     # if dealing with failed connection where you shouldn't...
-    assert_raises NoBackupConnection do
+    assert_raises NoReservedConnection do
       pool.with_failed_connection{ |c| 'boo' }
     end
   end
 
-  def test_reserved_backups
+  def test_reserved
     # create pool, run fibers and gather info
-    pool, info = run_reserved_backups
+    pool, info = run_reserved
 
     # one left
-    assert_equal(1, pool.reserved_backup.count)
+    assert_equal(1, pool.instance_variable_get(:@reserved).count)
 
     # fire cleanup
-    pool.backup_cleanup
+    pool.reserved_cleanup
 
     # nothing left
-    assert_equal(0, pool.reserved_backup.count)
+    assert_equal(0, pool.instance_variable_get(:@reserved).count)
 
     # assert we did not replace it
-    assert pool.has_connection?(info[:failing_connection])
+    assert info[:failing_connections].all?{ |c| pool.has_connection?(c) }
   end
 
-  def test_auto_cleanup_reserved_backups
+  def test_auto_cleanup_reserved
     # lower ttl to force auto cleanup
-    prev_ttl = force_constant FiberConnectionPool, :RESERVED_BACKUP_TTL_SECS, 0
+    prev_ttl = force_constant FiberConnectionPool, :RESERVED_TTL_SECS, 0
 
     # create pool, run fibers and gather info
-    pool, info = run_reserved_backups
+    pool, info = run_reserved
 
     # nothing left, because failing fiber was not the last to run
     # the following fiber made the cleanup
-    assert_equal(0, pool.reserved_backup.count)
+    assert_equal(0, pool.instance_variable_get(:@reserved).count)
 
     # assert we did not replace it
-    assert pool.has_connection?(info[:failing_connection])
+    assert info[:failing_connections].all?{ |c| pool.has_connection?(c) }
   ensure
     # restore
-    force_constant FiberConnectionPool, :RESERVED_BACKUP_TTL_SECS, prev_ttl
+    force_constant FiberConnectionPool, :RESERVED_TTL_SECS, prev_ttl
   end
 
   def test_save_data
@@ -183,32 +202,41 @@ class TestFiberConnectionPool < Minitest::Test
 
   private
 
-  def run_reserved_backups
-    info = { :instances => [] }
+  def run_reserved
+    info = { :instances => [].to_set, :failing_connections => [].to_set }
 
     # get pool and fibers
     pool = FiberConnectionPool.new(:size => 2) { ::EMSynchronyConnection.new(:delay => 0.05) }
 
     fibers = Array.new(4){ Fiber.new { pool.do_something(info) } }
 
-    # we do not repair it, backup associated with this Fiber stays in the pool
+    # state which exceptions should be treated
+    pool.treated_exceptions = [ FakeException ]
+
+    # we do not repair it, stays reserved
     failing_fiber = Fiber.new { pool.fail(info) rescue nil }
 
     # put it among others, not the first or the last
     # so we see it does not mistake the failing connection
     fibers.insert 2,failing_fiber
 
+    # we do not repair it, but we did not mean to, it's released again
+    failing_fiber_not_treated = Fiber.new { pool.fail_not_treated(info) rescue nil }
+
+    # put it among others, not the first or the last
+    # so we see it does not mistake the failing connection
+    fibers.insert 1,failing_fiber_not_treated
+
     run_em_reactor fibers
 
-    # we should have visited only 2 instances (no instance added by repairing broken one)
-    info.dup.each{ |k,v| info[k] = v.uniq if v.is_a?(Array) }
+    # we should have visited only 2 instances (nothing was repaired this time)
     assert_equal 2, info[:instances].count
 
     [ pool, info ]
   end
 
   def run_saved_data
-    info = { :instances => [] }
+    info = { :instances => [].to_set }
 
     # get pool and fibers
     pool = FiberConnectionPool.new(:size => 2) { ::EMSynchronyConnection.new(:delay => 0.05) }
@@ -227,7 +255,6 @@ class TestFiberConnectionPool < Minitest::Test
     run_em_reactor fibers
 
     # we should have visited 2 instances
-    info.dup.each{ |k,v| info[k] = v.uniq if v.is_a?(Array) }
     assert_equal 2, info[:instances].count
 
     [ pool, fibers, info ]

data/test/helper.rb

@@ -21,6 +21,8 @@ class BlockingConnection
   end
 end
 
+class FakeException < StandardError; end
+
 class EMSynchronyConnection < BlockingConnection
   def do_something(info = {})
     fill_info info
@@ -29,7 +31,13 @@ class EMSynchronyConnection < BlockingConnection
 
   def fail(info)
     fill_info info
-    info[:failing_connection] = self
+    info[:failing_connections] << self
+    raise FakeException.new "Fakingly failing here..."
+  end
+
+  def fail_not_treated(info)
+    fill_info info
+    info[:failing_connections] << self
     raise "Sadly failing here..."
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber_connection_pool
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ruben Caro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-20 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest