summaryrefslogtreecommitdiff
path: root/lib/bundler/vendor/connection_pool/lib/connection_pool.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/bundler/vendor/connection_pool/lib/connection_pool.rb')
-rw-r--r--lib/bundler/vendor/connection_pool/lib/connection_pool.rb161
1 files changed, 161 insertions, 0 deletions
diff --git a/lib/bundler/vendor/connection_pool/lib/connection_pool.rb b/lib/bundler/vendor/connection_pool/lib/connection_pool.rb
new file mode 100644
index 0000000000..fbcd26c765
--- /dev/null
+++ b/lib/bundler/vendor/connection_pool/lib/connection_pool.rb
@@ -0,0 +1,161 @@
+require_relative 'connection_pool/version'
+require_relative 'connection_pool/timed_stack'
+
+
+# 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 = Bundler::ConnectionPool.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 = Bundler::ConnectionPool.wrap { Redis.new }
+#
+# def do_work
+# $redis.lpop('my-list') if $redis.llen('my-list') > 0
+# end
+#
+# 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
+#
+class Bundler::ConnectionPool
+ DEFAULTS = {size: 5, timeout: 5}
+
+ class Error < RuntimeError
+ end
+
+ def self.wrap(options, &block)
+ Wrapper.new(options, &block)
+ end
+
+ def initialize(options = {}, &block)
+ raise ArgumentError, 'Connection pool requires a block' unless block
+
+ options = DEFAULTS.merge(options)
+
+ @size = options.fetch(:size)
+ @timeout = options.fetch(:timeout)
+
+ @available = TimedStack.new(@size, &block)
+ @key = :"current-#{@available.object_id}"
+ @key_count = :"current-#{@available.object_id}-count"
+ 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
+ end
+ end
+ end
+
+else
+
+ # jruby 1.7.x
+ def with(options = {})
+ conn = checkout(options)
+ begin
+ yield conn
+ ensure
+ checkin
+ end
+ end
+
+end
+
+ def checkout(options = {})
+ if ::Thread.current[@key]
+ ::Thread.current[@key_count]+= 1
+ ::Thread.current[@key]
+ else
+ ::Thread.current[@key_count]= 1
+ ::Thread.current[@key]= @available.pop(options[:timeout] || @timeout)
+ end
+ end
+
+ def checkin
+ if ::Thread.current[@key]
+ if ::Thread.current[@key_count] == 1
+ @available.push(::Thread.current[@key])
+ ::Thread.current[@key]= nil
+ else
+ ::Thread.current[@key_count]-= 1
+ end
+ else
+ raise Bundler::ConnectionPool::Error, 'no connections are checked out'
+ end
+
+ nil
+ end
+
+ def shutdown(&block)
+ @available.shutdown(&block)
+ end
+
+ # Size of this connection pool
+ def size
+ @size
+ end
+
+ # Number of pool entries available for checkout at this instant.
+ def available
+ @available.length
+ end
+
+ private
+
+ class Wrapper < ::BasicObject
+ METHODS = [:with, :pool_shutdown]
+
+ def initialize(options = {}, &block)
+ @pool = options.fetch(:pool) { ::Bundler::ConnectionPool.new(options, &block) }
+ end
+
+ def with(&block)
+ @pool.with(&block)
+ end
+
+ def pool_shutdown(&block)
+ @pool.shutdown(&block)
+ end
+
+ def pool_size
+ @pool.size
+ end
+
+ def pool_available
+ @pool.available
+ 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