ezpool 1.0.0

data/lib/ezpool/connection_manager.rb

@@ -0,0 +1,37 @@
+require_relative 'connection_wrapper'
+require_relative 'errors'
+
+
+class EzPool::ConnectionManager
+  def initialize(connect_with, disconnect_with = nil)
+    @connect_with = connect_with
+    @disconnect_with = disconnect_with
+  end
+
+  def connect
+    if @connect_with.nil?
+      raise EzPool::ConnectCallableNeverConfigured.new()
+    end
+    @connect_with.call
+  end
+
+  def disconnect(conn)
+    if !@disconnect_with.nil?
+      @disconnect_with.call(conn)
+    end
+  end
+
+  def connect_with(&block)
+    @connect_with = block
+  end
+
+  def disconnect_with(&block)
+    @disconnect_with = block
+  end
+
+  ##
+  # Create a new wrapped connection
+  def create_new
+    EzPool::ConnectionWrapper.new(connect, self)
+  end
+end

data/lib/ezpool/connection_wrapper.rb

@@ -0,0 +1,20 @@
+require_relative 'monotonic_time'
+
+class EzPool::ConnectionWrapper
+  attr_reader :raw_conn
+
+  def initialize(conn, connection_manager)
+    @raw_conn = conn
+    @created_at = EzPool.monotonic_time
+    @manager = connection_manager
+  end
+
+  # Shut down the connection. Can no longer be used after this!
+  def shutdown!
+    @manager.disconnect(@raw_conn)
+  end
+
+  def age
+    EzPool.monotonic_time - @created_at
+  end
+end

data/lib/ezpool/errors.rb

@@ -0,0 +1,8 @@
+class EzPool::Error < RuntimeError
+end
+
+class EzPool::CheckedInUnCheckedOutConnectionError < EzPool::Error
+end
+
+class EzPool::ConnectCallableNeverConfigured < EzPool::Error
+end

data/lib/ezpool/monotonic_time.rb

@@ -0,0 +1,66 @@
+# Global monotonic clock from Concurrent Ruby 1.0.
+# Copyright (c) Jerry D'Antonio -- released under the MIT license.
+# Slightly modified; used with permission.
+# https://github.com/ruby-concurrency/concurrent-ruby
+
+require 'thread'
+
+class EzPool
+
+  class_definition = Class.new do
+
+    if defined?(Process::CLOCK_MONOTONIC)
+
+      # @!visibility private
+      def get_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
+    elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+
+      # @!visibility private
+      def get_time
+        java.lang.System.nanoTime() / 1_000_000_000.0
+      end
+
+    else
+
+      # @!visibility private
+      def initialize
+        @mutex = Mutex.new
+        @last_time = Time.now.to_f
+      end
+
+      # @!visibility private
+      def get_time
+        @mutex.synchronize do
+          now = Time.now.to_f
+          if @last_time < now
+            @last_time = now
+          else # clock has moved back in time
+            @last_time += 0.000_001
+          end
+        end
+      end
+    end
+  end
+
+  ##
+  # Clock that cannot be set and represents monotonic time since
+  # some unspecified starting point.
+  #
+  # @!visibility private
+  GLOBAL_MONOTONIC_CLOCK = class_definition.new
+  private_constant :GLOBAL_MONOTONIC_CLOCK
+
+  class << self
+    ##
+    # Returns the current time a tracked by the application monotonic clock.
+    #
+    # @return [Float] The current monotonic time when `since` not given else
+    #   the elapsed monotonic time between `since` and the current time
+    def monotonic_time
+      GLOBAL_MONOTONIC_CLOCK.get_time
+    end
+  end
+end

data/lib/ezpool/timed_stack.rb

@@ -0,0 +1,207 @@
+require 'thread'
+require 'timeout'
+require_relative 'monotonic_time'
+
+##
+# Raised when you attempt to retrieve a connection from a pool that has been
+# shut down.
+
+class EzPool::PoolShuttingDownError < RuntimeError; end
+
+
+##
+# The TimedStack manages a pool of homogeneous connections (or any resource
+# you wish to manage).  Connections are created lazily up to a given maximum
+# number.
+
+# Examples:
+#
+#    ts = TimedStack.new(1) { MyConnection.new }
+#
+#    # fetch a connection
+#    conn = ts.pop
+#
+#    # return a connection
+#    ts.push conn
+#
+#    conn = ts.pop
+#    ts.pop timeout: 5
+#    #=> raises Timeout::Error after 5 seconds
+
+class EzPool::TimedStack
+
+  ##
+  # Creates a new pool with +size+ connections that are created by
+  # constructing the given +connection_wrapper+ class
+
+  def initialize(connection_manager, size = 0)
+    @created = 0
+    @que = []
+    @max = size
+    @mutex = Mutex.new
+    @resource = ConditionVariable.new
+    @connection_manager = connection_manager
+    @shutting_down = false
+  end
+
+  ##
+  # Returns +obj+ to the stack.  +options+ is ignored in TimedStack but may be
+  # used by subclasses that extend TimedStack.
+
+  def push(wrapper, options = {})
+    @mutex.synchronize do
+      if @shutting_down
+        wrapper.shutdown!
+      else
+        store_connection wrapper, options
+      end
+
+      @resource.broadcast
+    end
+  end
+  alias_method :<<, :push
+
+  ##
+  # Retrieves a connection from the stack.  If a connection is available it is
+  # immediately returned.  If no connection is available within the given
+  # timeout a Timeout::Error is raised.
+  #
+  # +:timeout+ is the only checked entry in +options+ and is preferred over
+  # the +timeout+ argument (which will be removed in a future release).  Other
+  # options may be used by subclasses that extend TimedStack.
+
+  def pop(timeout = 0.5, options = {})
+    options, timeout = timeout, 0.5 if Hash === timeout
+    timeout = options.fetch :timeout, timeout
+
+    deadline = EzPool.monotonic_time + timeout
+    @mutex.synchronize do
+      loop do
+        raise EzPool::PoolShuttingDownError if @shutting_down
+        return fetch_connection(options) if connection_stored?(options)
+
+        connection = try_create(options)
+        return connection if connection
+
+        to_wait = deadline - EzPool.monotonic_time
+        raise Timeout::Error, "Waited #{timeout} sec" if to_wait <= 0
+        @resource.wait(@mutex, to_wait)
+      end
+    end
+  end
+
+  ##
+  # Mark a connection as abandoned so that it cannot be used again.
+  # Will call the pre-configured shutdown proc, if provided.
+  #
+  def abandon(connection_wrapper)
+    @mutex.synchronize do
+      connection_wrapper.shutdown!
+      @created -= 1
+    end
+  end
+
+  ##
+  # Shuts down the TimedStack which prevents connections from being checked
+  # out. Calls the shutdown program specified in the EzPool
+  # initializer
+
+  def shutdown()
+    @mutex.synchronize do
+      @shutting_down = true
+      @resource.broadcast
+
+      shutdown_connections
+    end
+  end
+
+  ##
+  # Returns +true+ if there are no available connections.
+
+  def empty?
+    (@created - @que.length) >= @max
+  end
+
+  ##
+  # The number of connections available on the stack.
+
+  def length
+    @max - @created + @que.length
+  end
+
+  ##
+  # Pre-create all possible connections
+  def fill
+    while add_one
+    end
+  end
+
+  ##
+  # Add one connection to the queue
+  #
+  # Returns true iff a connection was successfully created
+  def add_one
+    connection = try_create
+    if connection.nil?
+      false
+    else
+      push(connection)
+      true
+    end
+  end
+
+  private
+
+  ##
+  # This is an extension point for TimedStack and is called with a mutex.
+  #
+  # This method must returns true if a connection is available on the stack.
+
+  def connection_stored?(options = nil)
+    !@que.empty?
+  end
+
+  ##
+  # This is an extension point for TimedStack and is called with a mutex.
+  #
+  # This method must return a connection from the stack.
+
+  def fetch_connection(options = nil)
+    @que.pop
+  end
+
+  ##
+  # This is an extension point for TimedStack and is called with a mutex.
+  #
+  # This method must shut down all connections on the stack.
+
+  def shutdown_connections(options = nil)
+    while connection_stored?(options)
+      conn = fetch_connection(options)
+      conn.shutdown!
+    end
+  end
+
+  ##
+  # This is an extension point for TimedStack and is called with a mutex.
+  #
+  # This method must return +obj+ to the stack.
+
+  def store_connection(obj, options = nil)
+    @que.push obj
+  end
+
+  ##
+  # This is an extension point for TimedStack and is called with a mutex.
+  #
+  # This method must create a connection if and only if the total number of
+  # connections allowed has not been met.
+
+  def try_create(options = nil)
+    unless @created == @max
+      object = @connection_manager.create_new()
+      @created += 1
+      object
+    end
+  end
+end

data/lib/ezpool/version.rb

@@ -0,0 +1,3 @@
+class EzPool
+  VERSION = "1.0.0"
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+gem 'minitest'
+
+require 'minitest/pride'
+require 'minitest/autorun'
+
+$VERBOSE = 1
+
+require_relative '../lib/ezpool'

data/test/test_ezpool.rb

@@ -0,0 +1,519 @@
+require_relative 'helper'
+
+class TestEzPool < Minitest::Test
+
+  class NetworkConnection
+    SLEEP_TIME = 0.1
+
+    def initialize
+      @x = 0
+    end
+
+    def do_something
+      @x += 1
+      sleep SLEEP_TIME
+      @x
+    end
+
+    def fast
+      @x += 1
+    end
+
+    def do_something_with_block
+      @x += yield
+      sleep SLEEP_TIME
+      @x
+    end
+
+    def respond_to?(method_id, *args)
+      method_id == :do_magic || super(method_id, *args)
+    end
+  end
+
+  class Recorder
+    def initialize
+      @calls = []
+    end
+
+    attr_reader :calls
+
+    def do_work(label)
+      @calls << label
+    end
+  end
+
+  def use_pool(pool, size)
+    Array.new(size) do
+      Thread.new do
+        pool.with do sleep end
+      end
+    end.each do |thread|
+      Thread.pass until thread.status == 'sleep'
+    end
+  end
+
+  def kill_threads(threads)
+    threads.each do |thread|
+      thread.kill
+      thread.join
+    end
+  end
+
+  def test_basic_multithreaded_usage
+    pool_size = 5
+    pool = EzPool.new(size: pool_size) { NetworkConnection.new }
+
+    start = Time.new
+
+    generations = 3
+
+    result = Array.new(pool_size * generations) do
+      Thread.new do
+        pool.with do |net|
+          net.do_something
+        end
+      end
+    end.map(&:value)
+
+    finish = Time.new
+
+    assert_equal((1..generations).cycle(pool_size).sort, result.sort)
+
+    assert_operator(finish - start, :>, generations * NetworkConnection::SLEEP_TIME)
+  end
+
+  def test_timeout
+    pool = EzPool.new(timeout: 0, size: 1) { NetworkConnection.new }
+    thread = Thread.new do
+      pool.with do |net|
+        net.do_something
+        sleep 0.01
+      end
+    end
+
+    Thread.pass while thread.status == 'run'
+
+    assert_raises Timeout::Error do
+      pool.with { |net| net.do_something }
+    end
+
+    thread.join
+
+    pool.with do |conn|
+      refute_nil conn
+    end
+  end
+
+  def test_with
+    pool = EzPool.new(
+      timeout: 0,
+      size: 1,
+      connect_with: lambda { Object.new }
+    )
+
+    pool.with do
+      assert_raises Timeout::Error do
+        Thread.new { pool.checkout }.join
+      end
+    end
+
+    assert Thread.new { pool.checkout }.join
+  end
+
+  def test_with_timeout
+    pool = EzPool.new(
+      timeout: 0,
+      size: 1,
+      connect_with: lambda { Object.new }
+    )
+
+    assert_raises Timeout::Error do
+      Timeout.timeout(0.01) do
+        pool.with do |obj|
+          assert_equal 0, pool.instance_variable_get(:@available).instance_variable_get(:@que).size
+          sleep 0.015
+        end
+      end
+    end
+    assert_equal 1, pool.instance_variable_get(:@available).instance_variable_get(:@que).size
+  end
+
+  def test_checkout_ignores_timeout
+    skip("Thread.handle_interrupt not available") unless Thread.respond_to?(:handle_interrupt)
+
+    pool = EzPool.new(
+      timeout: 0,
+      size: 1,
+      connect_with: lambda { Object.new }
+    )
+
+    def pool.checkout(options)
+      sleep 0.015
+      super
+    end
+
+    did_something = false
+    assert_raises Timeout::Error do
+      Timeout.timeout(0.01) do
+        pool.with do |obj|
+          did_something = true
+          # Timeout::Error will be triggered by any non-trivial Ruby code
+          # executed here since it couldn't be raised during checkout.
+          # It looks like setting the local variable above does not trigger
+          # the Timeout check in MRI 2.2.1.
+          obj.tap { obj.hash }
+        end
+      end
+    end
+    assert did_something
+    assert_equal 1, pool.instance_variable_get(:@available).instance_variable_get(:@que).size
+  end
+
+  def test_explicit_return
+    pool = EzPool.new(timeout: 0, size: 1)
+    pool.connect_with do
+      mock = Minitest::Mock.new
+      def mock.disconnect!
+        raise "should not disconnect upon explicit return"
+      end
+      mock
+    end
+
+    pool.with do |conn|
+      return true
+    end
+  end
+
+  def test_with_timeout_override
+    pool = EzPool.new(timeout: 0, size: 1) { NetworkConnection.new }
+
+    t = Thread.new do
+      pool.with do |net|
+        net.do_something
+        sleep 0.01
+      end
+    end
+
+    Thread.pass while t.status == 'run'
+
+    assert_raises Timeout::Error do
+      pool.with { |net| net.do_something }
+    end
+
+    pool.with(timeout: 2 * NetworkConnection::SLEEP_TIME) do |conn|
+      refute_nil conn
+    end
+  end
+
+  def test_checkin
+    pool = EzPool.new(timeout: 0, size: 1) { NetworkConnection.new }
+    conn = pool.checkout
+
+    assert_raises Timeout::Error do
+      Thread.new { pool.checkout }.join
+    end
+
+    pool.checkin conn
+
+    assert_same conn, Thread.new { pool.checkout }.value
+  end
+
+  def test_returns_value
+    pool = EzPool.new(timeout: 0, size: 1) { Object.new }
+    assert_equal 1, pool.with {|o| 1 }
+  end
+
+  def test_checkin_garbage
+    pool = EzPool.new(timeout: 0, size: 1) { Object.new }
+
+     assert_raises EzPool::CheckedInUnCheckedOutConnectionError do
+      pool.checkin Object.new
+    end
+  end
+
+  def test_checkout
+    pool = EzPool.new(size: 2) { NetworkConnection.new }
+
+    conn = pool.checkout
+
+    assert_kind_of NetworkConnection, conn
+
+    refute_same conn, pool.checkout
+  end
+
+  def test_checkout_multithread
+    pool = EzPool.new(size: 2) { NetworkConnection.new }
+    conn = pool.checkout
+
+    t = Thread.new do
+      pool.checkout
+    end
+
+    refute_same conn, t.value
+  end
+
+  def test_checkout_timeout
+    pool = EzPool.new(timeout: 0, size: 0) { Object.new }
+
+    assert_raises Timeout::Error do
+      pool.checkout
+    end
+  end
+
+  def test_checkout_timeout_override
+    pool = EzPool.new(timeout: 0, size: 1) { NetworkConnection.new }
+
+    thread = Thread.new do
+      pool.with do |net|
+        net.do_something
+        sleep 0.01
+      end
+    end
+
+    Thread.pass while thread.status == 'run'
+
+    assert_raises Timeout::Error do
+      pool.checkout
+    end
+
+    assert pool.checkout timeout: 2 * NetworkConnection::SLEEP_TIME
+  end
+
+  def test_passthru
+    pool = EzPool.wrap(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
+    assert_equal 1, pool.do_something
+    assert_equal 2, pool.do_something
+    assert_equal 5, pool.do_something_with_block { 3 }
+    assert_equal 6, pool.with { |net| net.fast }
+  end
+
+  def test_passthru_respond_to
+    pool = EzPool.wrap(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
+    assert pool.respond_to?(:with)
+    assert pool.respond_to?(:do_something)
+    assert pool.respond_to?(:do_magic)
+    refute pool.respond_to?(:do_lots_of_magic)
+  end
+
+  def test_return_value
+    pool = EzPool.new(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
+    result = pool.with do |net|
+      net.fast
+    end
+    assert_equal 1, result
+  end
+
+  def test_heavy_threading
+    pool = EzPool.new(timeout: 0.5, size: 3) { NetworkConnection.new }
+
+    threads = Array.new(20) do
+      Thread.new do
+        pool.with do |net|
+          sleep 0.01
+        end
+      end
+    end
+
+    threads.map { |thread| thread.join }
+  end
+
+  def test_reuses_objects_when_pool_not_saturated
+    pool = EzPool.new(size: 5) { NetworkConnection.new }
+
+    ids = 10.times.map do
+      pool.with { |c| c.object_id }
+    end
+
+    assert_equal 1, ids.uniq.size
+  end
+
+  def test_nested_checkout_fails
+    recorder = Recorder.new
+    pool = EzPool.new(size: 1) { recorder }
+    pool.with do |r_outer|
+      @other = Thread.new do |t|
+        pool.with do |r_other|
+          r_other.do_work('other')
+        end
+      end
+
+      Thread.pass
+
+      r_outer.do_work('outer')
+    end
+
+    @other.join
+
+    assert_equal ['outer', 'other'], recorder.calls
+  end
+
+  def test_shutdown_is_executed_for_all_connections
+    recorders = []
+
+    pool = EzPool.new(size: 3) do
+      Recorder.new.tap { |r| recorders << r }
+    end
+
+    threads = use_pool pool, 3
+
+    pool.disconnect_with do |recorder|
+      recorder.do_work("shutdown")
+    end
+
+    pool.shutdown
+
+    kill_threads(threads)
+
+    assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
+  end
+
+  def test_shutdown_works_as_argument_to_ezpool
+    recorders = []
+    pool = EzPool.new(
+      size: 3,
+      connect_with: lambda { Recorder.new.tap { |r| recorders << r } },
+      disconnect_with: lambda { |recorder| recorder.do_work("shutdown")}
+    )
+
+    threads = use_pool pool, 3
+
+    pool.shutdown
+
+    kill_threads(threads)
+
+    assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
+  end
+
+  def test_raises_error_after_shutting_down
+    pool = EzPool.new(size: 1) { true }
+
+    pool.shutdown
+
+    assert_raises EzPool::PoolShuttingDownError do
+      pool.checkout
+    end
+  end
+
+  def test_runs_shutdown_block_asynchronously_if_connection_was_in_use
+    recorders = []
+
+    pool = EzPool.new(
+      size: 3,
+      connect_with: lambda { Recorder.new.tap { |r| recorders << r } },
+      disconnect_with: lambda { |recorder| recorder.do_work("shutdown") }
+    )
+
+    threads = use_pool pool, 2
+
+    conn = pool.checkout
+
+    pool.shutdown
+
+    kill_threads(threads)
+
+    assert_equal [["shutdown"], ["shutdown"], []], recorders.map { |r| r.calls }
+
+    pool.checkin conn
+
+    assert_equal [["shutdown"], ["shutdown"], ["shutdown"]], recorders.map { |r| r.calls }
+  end
+
+  def test_max_age
+    recorders = []
+
+    pool = EzPool.new(
+      size: 3, max_age: 0.1,
+      connect_with: lambda { Recorder.new.tap { |r| recorders << r } },
+      disconnect_with: lambda { |conn| conn.do_work("shutdown") }
+    )
+
+    pool.with do |conn|
+      sleep(0.2)
+    end
+
+    pool.with do |conn|
+      sleep(0.2)
+    end
+
+    assert_equal [["shutdown"], ["shutdown"]], recorders.map { |r| r.calls }
+  end
+
+  def test_connect_with
+    conn_cls = Struct.new("Conn")
+
+    pool = EzPool.new(size: 1, connect_with: proc { conn_cls.new })
+    
+    pool.with do |conn|
+      assert_instance_of(conn_cls, conn)
+    end
+  end
+
+  def test_shutdown_is_executed_for_all_connections_in_wrapped_pool
+    recorders = []
+
+    wrapper = EzPool::Wrapper.new(
+      size: 3,
+      connect_with: lambda { Recorder.new.tap { |r| recorders << r } },
+      disconnect_with: lambda { |recorder| recorder.do_work("shutdown") }
+    )
+
+    threads = use_pool wrapper, 3
+
+    wrapper.pool_shutdown
+
+    kill_threads(threads)
+
+    assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
+  end
+
+  def test_wrapper_method_missing
+    wrapper = EzPool::Wrapper.new { NetworkConnection.new }
+    assert_equal 1, wrapper.fast
+  end
+
+  def test_wrapper_respond_to_eh
+    wrapper = EzPool::Wrapper.new { NetworkConnection.new }
+
+    assert_respond_to wrapper, :with
+
+    assert_respond_to wrapper, :fast
+    refute_respond_to wrapper, :"nonexistent method"
+  end
+
+  def test_wrapper_with
+    wrapper = EzPool::Wrapper.new(timeout: 0, size: 1) { Object.new }
+
+    wrapper.with do
+      assert_raises Timeout::Error do
+        Thread.new do
+          wrapper.with { flunk 'connection checked out :(' }
+        end.join
+      end
+    end
+
+    assert Thread.new { wrapper.with { } }.join
+  end
+
+  class ConnWithEval
+    def eval(arg)
+      "eval'ed #{arg}"
+    end
+  end
+
+  def test_wrapper_kernel_methods
+    wrapper = EzPool::Wrapper.new(timeout: 0, size: 1) { ConnWithEval.new }
+
+    assert_equal "eval'ed 1", wrapper.eval(1)
+  end
+
+  def test_wrapper_with_ezpool
+    recorder = Recorder.new
+    pool = EzPool.new(size: 1) { recorder }
+    wrapper = EzPool::Wrapper.new(pool: pool)
+
+    pool.with { |r| r.do_work('with') }
+    wrapper.do_work('wrapped')
+
+    assert_equal ['with', 'wrapped'], recorder.calls
+  end
+end