fiber_connection_pool 0.2.5 → 0.3.0

data/lib/fiber_connection_pool.rb

@@ -2,12 +2,14 @@ require 'fiber'
 require_relative 'fiber_connection_pool/exceptions'
 
 class FiberConnectionPool
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 
   RESERVED_TTL_SECS = 30 # reserved cleanup trigger
   SAVED_DATA_TTL_SECS = 30 # saved_data cleanup trigger
 
   attr_accessor :saved_data, :treated_exceptions
+  
+  attr_reader :size
 
   # Initializes the pool with 'size' instances
   # running the given block to get each one. Ex:
@@ -16,6 +18,8 @@ class FiberConnectionPool
   #
   def initialize(opts)
     raise ArgumentError.new('size > 0 is mandatory') if opts[:size].to_i <= 0
+    
+    @size = opts[:size].to_i
 
     @saved_data = {} # placeholder for requested save data
     @reserved  = {}   # map of in-progress connections
@@ -25,8 +29,9 @@ class FiberConnectionPool
     @pending   = []   # pending reservations (FIFO)
     @save_data_requests = {} # blocks to be yielded to save data
     @last_data_cleanup = Time.now # saved_data cleanup trigger
+    @keep_connection = {} # keep reserved connections for fiber
 
-    @available = Array.new(opts[:size].to_i) { yield }
+    @available = Array.new(@size) { yield }
   end
 
   # DEPRECATED: use save_data
@@ -137,6 +142,52 @@ class FiberConnectionPool
     @reserved.dup.each do |k,v|
       release(k) if not k.alive?
     end
+    @keep_connection.dup.each do |k,v|
+      @keep_connection.delete(k) if not k.alive?
+    end
+  end
+
+  # Acquire a lock on a connection and assign it to given fiber
+  # If no connection is available, yield the given fiber on the pending array
+  #
+  # If :keep => true is given (by default), connection is kept, you must call 'release' at some point
+  #
+  # Ex:
+  #
+  #   ...
+  #
+  #
+  #
+  def acquire(fiber = nil, opts = { :keep => true })
+    fiber = Fiber.current if fiber.nil?
+    @keep_connection[fiber] = true if opts[:keep]
+    return @reserved[fiber] if @reserved[fiber] # already reserved? then use it
+    if conn = @available.pop
+      @reserved[fiber] = conn
+      conn
+    else
+      Fiber.yield @pending.push fiber
+      acquire(fiber,opts)
+    end
+  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 = nil)
+    fiber = Fiber.current if fiber.nil?
+    @keep_connection.delete fiber
+    
+    @available.unshift @reserved.delete(fiber)
+
+    # try cleanup
+    reserved_cleanup if (Time.now - @last_reserved_cleanup) >= RESERVED_TTL_SECS
+
+    if pending = @pending.shift
+      pending.resume
+    end
   end
 
   private
@@ -151,14 +202,14 @@ class FiberConnectionPool
     f = Fiber.current
     begin
       # get a connection and use it
-      conn = acquire(f)
+      conn = acquire(f, :keep => false)
       retval = yield conn
 
       # save anything requested
       process_save_data(f, conn, method, args)
 
-      # successful run, release
-      release(f)
+      # successful run, release if not keeping
+      release(f) if not @keep_connection[f]
 
       retval
     rescue *treated_exceptions => ex
@@ -166,8 +217,8 @@ class FiberConnectionPool
       # 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)
+      # not successful run, but not meant to be treated, release if not keeping
+      release(f) if not @keep_connection[f]
       raise ex
     end
   end
@@ -185,36 +236,6 @@ class FiberConnectionPool
     save_data_cleanup if (Time.now - @last_data_cleanup) >= SAVED_DATA_TTL_SECS
   end
 
-  # Acquire a lock on a connection and assign it to given fiber
-  # If no connection is available, yield the given fiber on the pending array
-  #
-  def acquire(fiber)
-    return @reserved[fiber] if @reserved[fiber] # already reserved? then use it
-    if conn = @available.pop
-      @reserved[fiber] = conn
-      conn
-    else
-      Fiber.yield @pending.push fiber
-      acquire(fiber)
-    end
-  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.unshift @reserved.delete(fiber)
-
-    # try cleanup
-    reserved_cleanup if (Time.now - @last_reserved_cleanup) >= RESERVED_TTL_SECS
-
-    if pending = @pending.shift
-      pending.resume
-    end
-  end
-
   # Allow the pool to behave as the underlying connection
   #
   # Yield the connection within execute method and release

data/test/fiber_connection_pool_test.rb

@@ -164,6 +164,86 @@ class TestFiberConnectionPool < Minitest::Test
     # restore
     force_constant FiberConnectionPool, :RESERVED_TTL_SECS, prev_ttl
   end
+  
+  
+  def test_working_manual_reserve
+    info = { :instances => [].to_set, :failing_connections => [].to_set }
+    
+    # get pool and fibers
+    pool = FiberConnectionPool.new(:size => 4) { ::EMSynchronyConnection.new(:delay => 0.05) }
+
+    fibers = []
+    fibers << Fiber.new do 
+      begin
+        pool.acquire
+        pool.size.times{ pool.do_something(info) }
+      ensure
+        pool.release
+      end
+    end
+    
+    fibers <<  Fiber.new do 
+      n = 0
+      begin
+        pool.acquire
+        pool.fail(info)
+      rescue
+        n += 1
+        retry if n < pool.size
+      ensure
+        pool.release
+      end
+    end
+
+    run_em_reactor fibers
+    
+    # we should have used only two instances
+    assert_equal 2, info[:instances].count
+    
+    # only one failing connection
+    assert_equal 1, info[:failing_connections].count
+    
+    # nothing left, because we made manual release
+    assert_equal(0, pool.instance_variable_get(:@reserved).count)
+    assert_equal(0, pool.instance_variable_get(:@keep_connection).count)
+  end
+  
+  def test_manual_reserve_cleanup
+    # lower ttl to force auto cleanup
+    prev_ttl = force_constant FiberConnectionPool, :RESERVED_TTL_SECS, 0
+    
+    info = { :instances => [].to_set, :failing_connections => [].to_set }
+    
+    # get pool and fibers
+    pool = FiberConnectionPool.new(:size => 4) { ::EMSynchronyConnection.new(:delay => 0.05) }
+
+    fibers = []
+    fibers << Fiber.new do 
+      begin
+        pool.acquire
+        pool.size.times{ pool.do_something(info) } # not releasing!
+      end
+    end
+
+    run_em_reactor fibers
+    
+    # we should have used only one instance
+    assert_equal 1, info[:instances].count
+    # still kept, until cleanup is fired
+    assert_equal(1, pool.instance_variable_get(:@reserved).count)
+    assert_equal(1, pool.instance_variable_get(:@keep_connection).count)
+    
+    # will fire cleanup (RESERVED_TTL_SECS = 0)
+    pool.release
+    
+    # nothing left
+    assert_equal(0, pool.instance_variable_get(:@reserved).count)
+    assert_equal(0, pool.instance_variable_get(:@keep_connection).count)
+    
+  ensure
+    # restore
+    force_constant FiberConnectionPool, :RESERVED_TTL_SECS, prev_ttl
+  end
 
   def test_save_data
     # create pool, run fibers and gather info
@@ -199,6 +279,22 @@ class TestFiberConnectionPool < Minitest::Test
     # restore
     force_constant FiberConnectionPool, :SAVED_DATA_TTL_SECS, prev_ttl
   end
+  
+  def test_round_robin
+    info = { :instances => [].to_set }
+    
+    # get pool and fibers
+    pool = FiberConnectionPool.new(:size => 4) { ::EMSynchronyConnection.new(:delay => 0.05) }
+    
+    fiber = Fiber.new do 
+      pool.size.times{ pool.do_something(info) }
+    end
+
+    run_em_reactor [ fiber ]
+    
+    # we should have passed through every instance
+    assert_equal pool.size, info[:instances].count
+  end
 
   private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber_connection_pool
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest