fiber_connection_pool 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1358d4ff597e542badbfb30345fdef7b203406d7
-  data.tar.gz: ea906574ace7273b3b95d50a29c6cbe63c994d53
+  metadata.gz: 6d5107300e5f00c78557fabe1ef21a964bc0d929
+  data.tar.gz: 06f8d340506aba8db7035d0c5f17fb6ddc4e563b
 SHA512:
-  metadata.gz: 0fde3b29fb2ca35e6cee5727af9eb920572bd5895b074cb5c7e67cfc03dfa49f7d4a9a413e0d0c384531d6b6f8780cf6710fa3e49114e05d4fb55617ccb7ac7b
-  data.tar.gz: ec672cc0be199ad25a6b70d57cd721d6d132b8d0370bba90077db48c383b0343e6716577b990a862074278fa504c5b57a7661be35c8f2d7cc292e485929d9662
+  metadata.gz: d258dabb23ce59218aa85cb5271a6efebc91817bd74748f2ad9933001a5b160f8373c38c2768f26694f3ff5bde7a1331455f6f515fd7af7ebfe8c24af81bc245
+  data.tar.gz: 03f4d89e6235a16501a1998752e6693d7b8e8cd824a5d7c49d956482c667549fd73d59ea0d3b7f9028d0023c67cd5bbf1c78c7359732c36a9874693ddbe285eb

data/Gemfile

@@ -1,3 +1,9 @@
 source "https://rubygems.org"
 
-gemspec(development_group: :runtime)
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'em-synchrony'
+end

data/README.md

@@ -2,6 +2,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)
 
 Fiber-based generic connection pool
 
@@ -16,3 +17,26 @@ with [Goliath](https://github.com/postrank-labs/goliath)
 and in promising experiments with
 [Reel](https://github.com/celluloid/reel)
 ([Celluloid](http://celluloid.io/) based) servers.
+
+Install
+----------------
+
+Add this line to your application's Gemfile:
+
+    gem 'fiber_connection_pool'
+
+Or install it yourself as:
+
+    $ gem install fiber_connection_pool
+
+Inside of your Ruby program, require FiberConnectionPool with:
+
+    require 'fiber_connection_pool'
+
+Supported Platforms
+-------------------
+
+Used in production environments on Ruby 1.9.3 and 2.0.0.
+Tested against Ruby 1.9.3, 2.0.0, and rbx-19mode ([See details..](http://travis-ci.org/rubencaro/fiber_connection_pool)).
+
+TODO: sparkling docs

data/examples/reel_server/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'celluloid', github: 'celluloid/celluloid', branch: 'master'
+gem 'celluloid-io', github: 'celluloid/celluloid-io', branch: 'master'
+gem 'reel', github: 'celluloid/reel', branch: 'master'
+gem 'ruby-mysql', github: 'rubencaro/ruby-mysql', branch: 'celluloid_io'
+gem 'fiber_connection_pool'

data/examples/reel_server/main.rb

@@ -0,0 +1,69 @@
+require 'reel'
+require 'mysql'
+require 'fiber'
+require 'fiber_connection_pool'
+require 'celluloid/autostart'
+
+Mysql.unixsocket_class = Celluloid::IO::UNIXSocket
+
+class Dispatcher
+  include Celluloid::IO
+
+  def initialize(opts = {})
+    @db_pool_size = opts[:db_pool_size] || 5
+    @pool = FiberConnectionPool.new(:size => @db_pool_size) do
+      Mysql.connect 'localhost','user','pass','bogusdb',nil,'/var/run/mysqld/mysqld.sock'
+    end
+    puts "DB Pool of size #{@db_pool_size} ready..."
+  end
+
+  def dispatch(request)
+    print '.'
+    @pool.query 'select sleep(2);'
+    puts "Done #{Thread.current.to_s}, #{Fiber.current.to_s}"
+    request.respond :ok, "hello, world! #{Time.now.strftime('%T')}"
+  end
+end
+
+
+class DispatcherPool
+
+  def initialize(opts = {})
+    @size = opts[:size] || 5
+    @dispatchers = []
+    @size.times{ |i| @dispatchers << "dispatcher_#{i}".to_sym }
+    @dispatchers.each{ |d| Dispatcher.supervise_as d }
+    @next_dispatcher = 0
+    puts "Pool of #{@size} dispatchers ready."
+  end
+
+  def dispatch(request)
+    d = @next_dispatcher
+    @next_dispatcher += 1
+    @next_dispatcher = 0 if @next_dispatcher >= @dispatchers.count
+    Celluloid::Actor[@dispatchers[d]].dispatch(request)
+  rescue => ex
+    puts "Someone died: #{ex}"
+    request.respond :internal_server_error, "Someone died"
+  end
+
+end
+
+
+class MyServer < Reel::Server
+
+  def initialize(host = "127.0.0.1", port = 3000)
+    super(host, port, &method(:on_connection))
+    @dispatcher = DispatcherPool.new
+    puts "Listening on #{host}:#{port}..."
+  end
+
+  def on_connection(connection)
+    while request = connection.request
+      @dispatcher.dispatch(request)
+    end
+  end
+
+end
+
+MyServer.run

data/lib/fiber_connection_pool.rb

@@ -1,18 +1,25 @@
+require 'fiber'
+
 class FiberConnectionPool
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
   attr_accessor :saved_data
 
-  def initialize(opts, &block)
+  # Initializes the pool with 'size' instances
+  # running the given block to get each one. Ex:
+  #
+  #   pool = FiberConnectionPool.new(:size => 5) { MyConnection.new }
+  #
+  def initialize(opts)
+    raise ArgumentError.new('size > 0 is mandatory') if opts[:size].to_i <= 0
+
     @saved_data = {} # placeholder for requested save data
     @reserved  = {}   # map of in-progress connections
     @reserved_backup = {}   # backup map of in-progress connections, to catch failures
     @available = []   # pool of free connections
     @pending   = []   # pending reservations (FIFO)
 
-    opts[:size].times do
-      @available.push(block.call) if block_given?
-    end
+    @available = Array.new(opts[:size].to_i) { yield }
   end
 
   def save_data_for_fiber
@@ -39,12 +46,16 @@ class FiberConnectionPool
     end
   end
 
+  ##
+  # avoid method_missing for most common methods
+  #
   def query(sql)
     execute(false,'query') do |conn|
       conn.query sql
     end
   end
 
+
   def recreate_connection(new_conn)
     bad_conn = @reserved_backup[Fiber.current.object_id]
     release_backup Fiber.current

data/test/fiber_connection_pool_test.rb

@@ -3,8 +3,72 @@ require 'helper'
 
 class TestFiberConnectionPool < Minitest::Test
 
-  def test_bogus
-    assert true
+  def test_blocking_behaviour
+    # get pool and fibers
+    pool = FiberConnectionPool.new(:size => 5) { ::BlockingConnection.new(:delay => 0.05) }
+
+    fibers = Array.new(15){ Fiber.new { pool.do_something } }
+
+    a = Time.now
+    result = fibers.map(&:resume)
+    b = Time.now
+
+    # 15 fibers on a size 5 pool, but -blocking- connections
+    # with a 0.05 delay we expect to spend at least: 0.05*15 = 0.75
+    assert_operator((b - a), :>, 0.75)
+
+    # Also we only use the first connection from the pool,
+    # because as we are -blocking- it's always available
+    # again for the next request
+    assert_equal 1, result.uniq.count
   end
 
+  def test_em_synchrony_behaviour
+    require 'em-synchrony'
+
+    a = b = nil
+    info = { :threads => [], :fibers => [], :instances => []}
+
+    EM.synchrony do
+      # get pool and fibers
+      pool = FiberConnectionPool.new(:size => 5) { ::EMSynchronyConnection.new(:delay => 0.05) }
+
+      fibers = Array.new(15){ Fiber.new { pool.do_something(info) } }
+
+      a = Time.now
+      fibers.each{ |f| f.resume }
+      # wait all fibers to end
+      while fibers.any?{ |f| f.alive? } do
+        EM::Synchrony.sleep 0.01
+      end
+      b = Time.now
+      EM.stop
+    end
+
+    # 15 fibers on a size 5 pool, and -non-blocking- connections
+    # with a 0.05 delay we expect to spend at least: 0.05*15/5 = 0.15
+    # plus some breeze lost on precision on the wait loop
+    # then we should be under 0.20 for sure
+    assert_operator((b - a), :<, 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
+  end
+
+  def test_size_is_mandatory
+    assert_raises ArgumentError do
+      FiberConnectionPool.new { ::BlockingConnection.new }
+    end
+    assert_raises ArgumentError do
+      FiberConnectionPool.new(:size => 'a') { ::BlockingConnection.new }
+    end
+    assert_raises ArgumentError do
+      FiberConnectionPool.new(:size => 0) { ::BlockingConnection.new }
+    end
+  end
+
+
 end

data/test/helper.rb

@@ -1,6 +1,24 @@
 require 'minitest/pride'
 require 'minitest/autorun'
 
-$VERBOSE = 1
-
 require_relative '../lib/fiber_connection_pool'
+
+class BlockingConnection
+  def initialize(opts = {})
+    @delay = opts[:delay] || 0.05
+  end
+
+  def do_something
+    sleep @delay
+    self.object_id
+  end
+end
+
+class EMSynchronyConnection < BlockingConnection
+  def do_something(info)
+    info[:threads] << Thread.current.object_id
+    info[:fibers] << Fiber.current.object_id
+    info[:instances] << self.object_id
+    EM::Synchrony.sleep @delay
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber_connection_pool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ruben Caro
@@ -56,6 +56,8 @@ files:
 - README.md
 - Rakefile
 - examples/.placeholder
+- examples/reel_server/Gemfile
+- examples/reel_server/main.rb
 - fiber_connection_pool.gemspec
 - lib/fiber_connection_pool.rb
 - test/fiber_connection_pool_test.rb