ezpool 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a26d4a215e4a1e76ad3bfcdc570986a20e42f878
+  data.tar.gz: 5069ba506dcb424d68b7beb1d7c9843beb409fa9
+SHA512:
+  metadata.gz: 8d3538e8663f049aef366a5665e69d69f9ee3444b256fa41f0fa4c846370675bd6759f4c3a3353a5e07aa1aaa56e8cc21b2d92519d977c645b655d4d11761d4a
+  data.tar.gz: 67fdd2120df11acd5ce1856c33ab0a52c3abb8c354955f519b3daca7182a67093323a4501af947dbb56ef85dad1b764f5acbb77ad878e356fdfc229432113da3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+  - 2.3.3
+  - jruby

data/Changes.md

@@ -0,0 +1,131 @@
+ezpool ChangeLog
+================
+
+1.0.0
+-----
+- Initial release of fork under the new name `ezpool` 
+- connect / disconnect methods are now arguments to the `EzPool` constructor
+- Adds a new `max_age` parameter to gracefully recycle connections
+- Removes re-entrant/recursive connection handling
+
+
+Previous versions (pre-fork):
+
+
+connection\_pool changelog
+===========================
+
+2.2.1
+------
+
+- Allow CP::Wrapper to use an existing pool [#87, etiennebarrie]
+- Use monotonic time for more accurate timeouts [#84, jdantonio]
+
+2.2.0
+------
+
+- Rollback `Timeout` handling introduced in 2.1.1 and 2.1.2.  It seems
+  impossible to safely work around the issue. Please never, ever use
+  `Timeout.timeout` in your code or you will see rare but mysterious bugs. [#75]
+
+2.1.3
+------
+
+- Don't increment created count until connection is successfully
+  created. [mylesmegyesi, #73]
+
+2.1.2
+------
+
+- The connection\_pool will now close any connections which respond to
+  `close` (Dalli) or `disconnect!` (Redis).  This ensures discarded connections
+  from the fix in 2.1.1 are torn down ASAP and don't linger open.
+
+
+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
+------
+
+- Refactoring to better support connection pool subclasses [drbrain,
+  #55]
+- `with` should return value of the last expression [#59]
+
+
+2.0.0
+-----
+
+- The connection pool is now lazy.  Connections are created as needed
+  and retained until the pool is shut down. [drbrain, #52]
+
+1.2.0
+-----
+
+- Add `with(options)` and `checkout(options)`. [mattcamuto]
+  Allows the caller to override the pool timeout.
+```ruby
+@pool.with(:timeout => 2) do |conn|
+end
+```
+
+1.1.0
+-----
+
+- New `#shutdown` method (simao)
+
+    This method accepts a block and calls the block for each
+    connection in the pool. After calling this method, trying to get a
+    connection from the pool raises `PoolShuttingDownError`.
+
+1.0.0
+-----
+
+- `#with_connection` is now gone in favor of `#with`.
+
+- We no longer pollute the top level namespace with our internal
+`TimedStack` class.
+
+0.9.3
+--------
+
+- `#with_connection` is now deprecated in favor of `#with`.
+
+    A warning will be issued in the 0.9 series and the method will be
+    removed in 1.0.
+
+- We now reuse objects when possible.
+
+    This means that under no contention, the same object will be checked
+    out from the pool after subsequent calls to `ConnectionPool#with`.
+
+    This change should have no impact on end user performance. If
+    anything, it should be an improvement, depending on what objects you
+    are pooling.
+
+0.9.2
+--------
+
+- Fix reentrant checkout leading to early checkin.
+
+0.9.1
+--------
+
+- Fix invalid superclass in version.rb
+
+0.9.0
+--------
+
+- Move method\_missing magic into ConnectionPool::Wrapper (djanowski)
+- Remove BasicObject superclass (djanowski)
+
+0.1.0
+--------
+
+- More precise timeouts and better error message
+- ConnectionPool now subclasses BasicObject so `method_missing` is more effective.

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec(development_group: :runtime)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mike Perham
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+ezpool
+=================
+[![Build Status](https://travis-ci.org/EasyPost/ezpool.svg?branch=master)](https://travis-ci.org/EasyPost/ezpool)
+
+Generic connection pooling for Ruby. Originally forked from
+[connection_pool](https://github.com/mperham/connection_pool), but with moderately different semantics.
+
+MongoDB has its own connection pool.  ActiveRecord has its own connection pool.
+This is a generic connection pool that can be used with anything, e.g. Redis,
+Dalli and other Ruby network clients.
+
+
+Usage
+-----
+
+Create a pool of objects to share amongst the fibers or threads in your Ruby
+application:
+
+```ruby
+$memcached = EzPool.new(
+  size: 5,
+  timeout: 5,
+  connect: proc { Dalli::Client.new }
+)
+```
+
+You can also pass your connection function as a block:
+
+```ruby
+$memcached = EzPool.new(size: 5, timeout: 5) { Dalli::Client.new }
+```
+
+Or you can configure it later:
+
+```ruby
+$memcached = EzPool.new(size: 5, timeout: 5)
+$memcached.connect_with { Dalli::Client.new }
+```
+
+Then use the pool in your application:
+
+``` ruby
+$memcached.with do |conn|
+  conn.get('some-count')
+end
+```
+
+If all the objects in the connection pool are in use, `with` will block
+until one becomes available.  If no object is available within `:timeout` seconds,
+`with` will raise a `Timeout::Error`.
+
+Optionally, you can specify a timeout override using the with-block semantics:
+
+``` ruby
+$memcached.with(timeout: 2.0) do |conn|
+  conn.get('some-count')
+end
+```
+
+This will only modify the resource-get timeout for this particular
+invocation. This is useful if you want to fail-fast on certain non critical
+sections when a resource is not available, or conversely if you are comfortable
+blocking longer on a particular resource. This is not implemented in the below
+`EzPool::Wrapper` class.
+
+Note that you can also explicitly check-in/check-out connections using the `#checkin`
+and `#checkout` methods; however, there are no safety nets here! Once you check out a connection,
+nobody else may use it until you check it back in, and if you leak it, it's gone for good;
+we don't do anything clever like override the finalizer so that we can detect when
+the connection goes out of scope and return it to the pool. Caveat emptor!
+
+## Migrating to a Connection Pool
+
+You can use `EzPool::Wrapper` to wrap a single global connection,
+making it easier to migrate existing connection code over time:
+
+``` ruby
+$redis = EzPool::Wrapper.new(size: 5, timeout: 3) { Redis.connect }
+$redis.sadd('foo', 1)
+$redis.smembers('foo')
+```
+
+The wrapper uses `method_missing` to checkout a connection, run the requested
+method and then immediately check the connection back into the pool.  It's
+**not** high-performance so you'll want to port your performance sensitive code
+to use `with` as soon as possible.
+
+``` ruby
+$redis.with do |conn|
+  conn.sadd('foo', 1)
+  conn.smembers('foo')
+end
+```
+
+And, of course, if there's any kind of load balancing or distribution on
+the other end of the connection, there is no guarantee that two subsequent calls
+to a `Wrapper`-wrapped object will go to the same database.
+
+Once you've ported your entire system to use `with`, you can simply remove
+`Wrapper` and use the simpler and faster `EzPool`.
+
+## Thread-safety / Connection Multiplexing
+
+`EzPool`s are thread-safe and re-entrant in that the pool itself can be shared between different
+threads and it is guaranteed that the same connection will never be returned from overlapping calls
+to `#checkout` / `#with`. Note that this is achieved through the judicious use of mutexes; this code
+is not appropriate for systems with hard real-time requiremnts. Then again, neither is Ruby.
+
+The original `connection_pool` library had special functionality so that if you checked out
+a connection from a thread which already had a checked out connection, you would be guaranteed
+to get the same connection back again. This logic prevents a number of valable use cases,
+so no longer exists. Each overlapping call to `pool.checkout` / `pool.with` will get a different
+connection.
+
+In particular, this feature could be abused to assume that adjacent calls to `Wrap`ed connections
+from the same thread would go to the same database connection and perhaps the same session/transaction.
+Don't do that. If you care about transactions or database sessions, you need to be explicitly checking
+out and passing around connections.
+
+
+## Shutdown
+
+You can shut down a EzPool instance once it should no longer be used.
+Further checkout attempts will immediately raise an error but existing checkouts
+will work.
+
+```ruby
+cp = EzPool.new(
+    connect: lambda { Redis.new },
+    disconnect: lambda { |conn| conn.quit }
+)
+cp.shutdown
+```
+
+Shutting down a connection pool will block until all connections are checked in and closed.
+**Note that shutting down is completely optional**; Ruby's garbage collector will reclaim
+unreferenced pools under normal circumstances.
+
+## Connection recycling
+
+If you specify the `max_age` parameter to a connection pool, it will attempt to gracefully recycle
+connections once they reach a certain age. This can be beneficial for, e.g., load balancers where you
+want client applications to eventually pick up new databases coming into service without having to
+explicitly restart the client processes.
+
+
+Notes
+-----
+
+- Connections are lazily created as needed.
+- There is no provision for repairing or checking the health of a connection;
+  connections should be self-repairing.  This is true of the Dalli and Redis
+  clients.
+- **WARNING**: Don't ever use `Timeout.timeout` in your Ruby code or you will see
+  occasional silent corruption and mysterious errors.  The Timeout API is unsafe
+  and cannot be used correctly, ever.  Use proper socket timeout options as
+  exposed by Net::HTTP, Redis, Dalli, etc.
+
+
+Author
+------
+
+Originally by Mike Perham, [@mperham](https://twitter.com/mperham), <http://mikeperham.com>
+
+Forked and modified by engineers at [EasyPost](https://www.easypost.com).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new
+
+task :default => :test

data/ezpool.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require "./lib/ezpool/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ezpool"
+  s.version     = EzPool::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mike Perham", "Damian Janowski", "James Brown"]
+  s.email       = ["oss@easypost.com"]
+  s.homepage    = "https://github.com/EasyPost/ezpool"
+  s.description = s.summary = %q{More featureful generic connection pool for Ruby}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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/ezpool.rb

@@ -0,0 +1,190 @@
+require_relative 'ezpool/version'
+require_relative 'ezpool/timed_stack'
+require_relative 'ezpool/errors'
+require_relative 'ezpool/connection_manager'
+
+
+# Generic connection pool class for e.g. sharing a limited number of network connections
+# among many threads.  Note: Connections are lazily created.
+#
+# Example usage with block (faster):
+#
+#    @pool = EzPool.new { Redis.new }
+#
+#    @pool.with do |redis|
+#      redis.lpop('my-list') if redis.llen('my-list') > 0
+#    end
+#
+# Using optional timeout override (for that single invocation)
+#
+#    @pool.with(timeout: 2.0) do |redis|
+#      redis.lpop('my-list') if redis.llen('my-list') > 0
+#    end
+#
+# Example usage replacing an existing connection (slower):
+#
+#    $redis = EzPool.wrap { Redis.new }
+#
+#    def do_work
+#      $redis.lpop('my-list') if $redis.llen('my-list') > 0
+#    end
+#
+# Note that there's no way to pass a disconnection function to this
+# usage, nor any way to guarantee that subsequent calls will go to the
+# same connection (if your connection has any concept of sessions, this
+# may be important). We strongly recommend against using wrapped
+# connections in production environments.
+#
+# Accepts the following options:
+# - :size - number of connections to pool, defaults to 5
+# - :timeout - amount of time to wait for a connection if none currently available, defaults to 5 seconds
+# - :max_age - maximum number of seconds that a connection may be alive for (will recycle on checkin/checkout)
+# - :connect_with - callable for creating a connection
+# - :disconnect-_with - callable for shutting down a connection
+#
+class EzPool
+  DEFAULTS = {size: 5, timeout: 1, max_age: Float::INFINITY}
+
+  def self.wrap(options, &block)
+    if block_given?
+      options[:connect_with] = block
+    end
+    Wrapper.new(options)
+  end
+
+  def initialize(options = {}, &block)
+    options = DEFAULTS.merge(options)
+
+    @size = options.fetch(:size)
+    @timeout = options.fetch(:timeout)
+    @max_age = options.fetch(:max_age).to_f
+
+    if @max_age <= 0
+      raise ArgumentError.new(":max_age must be > 0")
+    end
+
+    if block_given?
+      if options.include?(:connect_with)
+        raise ArgumentError.new("Block passed to EzPool *and* :connect_with in options")
+      else
+        options[:connect_with] = block
+      end
+    end
+
+    @manager = EzPool::ConnectionManager.new(options[:connect_with], options[:disconnect_with])
+
+    @available = TimedStack.new(@manager, @size)
+    @key = :"current-#{@available.object_id}"
+
+    @checked_out_connections = Hash.new
+    @mutex = Mutex.new
+  end
+
+  def connect_with(&block)
+    @manager.connect_with(&block)
+  end
+
+  def disconnect_with(&block)
+    @manager.disconnect_with(&block)
+  end
+
+if Thread.respond_to?(:handle_interrupt)
+  # MRI
+  def with(options = {})
+    Thread.handle_interrupt(Exception => :never) do
+      conn = checkout(options)
+      begin
+        Thread.handle_interrupt(Exception => :immediate) do
+          yield conn
+        end
+      ensure
+        checkin conn
+      end
+    end
+  end
+else
+  # non-MRI
+  def with(options = {})
+    conn = checkout(options)
+    begin
+      yield conn
+    ensure
+      checkin conn
+    end
+  end
+end
+
+  def checkout(options = {})
+    conn_wrapper = nil
+    while conn_wrapper.nil? do
+      timeout = options[:timeout] || @timeout
+      conn_wrapper = @available.pop(timeout: timeout)
+      if expired? conn_wrapper
+        @available.abandon(conn_wrapper)
+        conn_wrapper = nil
+      end
+    end
+
+    @mutex.synchronize do
+      @checked_out_connections[conn_wrapper.raw_conn.object_id] = conn_wrapper
+    end
+    conn_wrapper.raw_conn
+  end
+
+  def checkin(conn)
+    conn_wrapper = @mutex.synchronize do
+      @checked_out_connections.delete(conn.object_id)
+    end
+    if conn_wrapper.nil?
+      raise EzPool::CheckedInUnCheckedOutConnectionError
+    end
+    if expired? conn_wrapper
+      @available.abandon(conn_wrapper)
+    else
+      @available.push(conn_wrapper)
+    end
+    nil
+  end
+
+  def shutdown
+    if block_given?
+      raise ArgumentError.new("shutdown no longer accepts a block; call #disconnect_with to set the disconnect method, or pass the disconnect: option to the EzPool initializer")
+    end
+    @available.shutdown
+  end
+
+  private
+  def expired?(connection_wrapper)
+    if @max_age.finite?
+      connection_wrapper.age > @max_age
+    else
+      false
+    end
+  end
+
+  class Wrapper < ::BasicObject
+    METHODS = [:with, :pool_shutdown]
+
+    def initialize(options = {}, &block)
+      @pool = options.fetch(:pool) { ::EzPool.new(options, &block) }
+    end
+
+    def with(&block)
+      @pool.with(&block)
+    end
+
+    def pool_shutdown(&block)
+      @pool.shutdown(&block)
+    end
+
+    def respond_to?(id, *args)
+      METHODS.include?(id) || with { |c| c.respond_to?(id, *args) }
+    end
+
+    def method_missing(name, *args, &block)
+      with do |connection|
+        connection.send(name, *args, &block)
+      end
+    end
+  end
+end