connection_pool 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9fefa40cd9db0f5add54482a9f980d808b5bb578e83a5a8bf287c636c41704d
-  data.tar.gz: ec25d36c42cfb863e768bf49b18316d955397edaa8862f92d27687ab2a089bf0
+  metadata.gz: 0af12e8d2f551b932ee863a1385ddc9a3f3140fff886cacaca25298a4c21d218
+  data.tar.gz: 16bd7b78d7b35337d35befe063ceeb2cb749dfc9e68cd373e7f76bd856f6cba3
 SHA512:
-  metadata.gz: d8653437078b6334be998d16f4851e12a21e8caca8338a07559c9bfbe646dc6023a7370aad6e33be905b05d6eaab8f249387eaa72b16a478f57c9c497adbbf30
-  data.tar.gz: 2a437d085a3f11376338ee32debe5e7ff38fc28fdc8d0d318287c2890bc90ce2d282468981dde43c8391798d113e1391d7998a5f5e571f1021ae99dfff6893e2
+  metadata.gz: edb345021997307fe736408ad3e3cbebd2ce86fcbdc636fe2d4f03d61258ecea22285a4f91e854d43631533513d6500c9f6cf2094f52d6756a2d61ee2daba256
+  data.tar.gz: d58d7519b9d4be9bcf7b0628e2aa9d937df2d61d0d1a9423b43618685adf242810256b9decc22bca90cb3ee3eec88e8eabffb409aa9e49f28d56815f26056b81

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.4", "2.5", "2.6", "2.7", "3.0", "jruby", "truffleruby"]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+
+    - name: Run tests
+      timeout-minutes: 5
+      run: ${{matrix.env}} bundle exec rake

data/Changes.md

@@ -1,5 +1,11 @@
 # connection_pool Changelog
 
+2.2.4
+------
+
+- Add `reload` to close all connections, recreating them afterwards [Andrew Marshall, #140]
+- Add `then` as a way to use a pool or a bare connection with the same code path [#138]
+
 2.2.3
 ------
 

data/Gemfile

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

data/README.md

@@ -31,6 +31,14 @@ 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`.
 
+You can also use `ConnectionPool#then` to support _both_ a
+connection pool and a raw client (requires Ruby 2.5+).
+
+```ruby
+# Compatible with a raw Redis::Client, and ConnectionPool Redis
+$redis.then { |r| r.set 'foo' 'bar' }
+```
+
 Optionally, you can specify a timeout override using the with-block semantics:
 
 ``` ruby
@@ -87,6 +95,22 @@ Shutting down a connection pool will block until all connections are checked in
 **Note that shutting down is completely optional**; Ruby's garbage collector will reclaim
 unreferenced pools under normal circumstances.
 
+## Reload
+
+You can reload a ConnectionPool instance in the case it is desired to close all
+connections to the pool and, unlike `shutdown`, afterwards recreate connections
+so the pool may continue to be used. Reloading may be useful after forking the
+process.
+
+```ruby
+cp = ConnectionPool.new { Redis.new }
+cp.reload { |conn| conn.quit }
+cp.with { |conn| conn.get('some-count') }
+```
+
+Like `shutdown`, this will block until all connections are checked in and
+closed.
+
 ## Current State
 
 There are several methods that return information about a pool.
@@ -107,15 +131,15 @@ 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
+  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
+  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
 ------
 
-Mike Perham, [@mperham](https://twitter.com/mperham), <http://mikeperham.com>
+Mike Perham, [@getajobmike](https://twitter.com/getajobmike), <https://www.mikeperham.com>

data/Rakefile

@@ -1,7 +1,6 @@
 require "bundler/gem_tasks"
 
 require "rake/testtask"
-require "standard/rake"
 Rake::TestTask.new
 
 task default: :test

data/connection_pool.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler"
   s.add_development_dependency "minitest", ">= 5.0.0"
   s.add_development_dependency "rake"
+  s.required_ruby_version = ">= 2.2.0"
 end

data/lib/connection_pool.rb

@@ -67,6 +67,7 @@ class ConnectionPool
       end
     end
   end
+  alias then with
 
   def checkout(options = {})
     if ::Thread.current[@key]
@@ -83,6 +84,7 @@ class ConnectionPool
       if ::Thread.current[@key_count] == 1
         @available.push(::Thread.current[@key])
         ::Thread.current[@key] = nil
+        ::Thread.current[@key_count] = nil
       else
         ::Thread.current[@key_count] -= 1
       end
@@ -93,10 +95,24 @@ class ConnectionPool
     nil
   end
 
+  ##
+  # Shuts down the ConnectionPool by passing each connection to +block+ and
+  # then removing it from the pool. Attempting to checkout a connection after
+  # shutdown will raise +ConnectionPool::PoolShuttingDownError+.
+
   def shutdown(&block)
     @available.shutdown(&block)
   end
 
+  ##
+  # Reloads the ConnectionPool by passing each connection to +block+ and then
+  # removing it the pool. Subsequent checkouts will create new connections as
+  # needed.
+
+  def reload(&block)
+    @available.shutdown(reload: true, &block)
+  end
+
   # Size of this connection pool
   attr_reader :size
 

data/lib/connection_pool/timed_stack.rb

@@ -15,7 +15,7 @@
 #
 #    conn = ts.pop
 #    ts.pop timeout: 5
-#    #=> raises Timeout::Error after 5 seconds
+#    #=> raises ConnectionPool::TimeoutError after 5 seconds
 
 class ConnectionPool::TimedStack
   attr_reader :max
@@ -54,7 +54,7 @@ class ConnectionPool::TimedStack
   ##
   # 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 a ConnectionPool::TimeoutError 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
@@ -81,10 +81,12 @@ class ConnectionPool::TimedStack
   end
 
   ##
-  # Shuts down the TimedStack which prevents connections from being checked
-  # out.  The +block+ is called once for each connection on the stack.
+  # Shuts down the TimedStack by passing each connection to +block+ and then
+  # removing it from the pool. Attempting to checkout a connection after
+  # shutdown will raise +ConnectionPool::PoolShuttingDownError+ unless
+  # +:reload+ is +true+.
 
-  def shutdown(&block)
+  def shutdown(reload: false, &block)
     raise ArgumentError, "shutdown must receive a block" unless block_given?
 
     @mutex.synchronize do
@@ -92,6 +94,7 @@ class ConnectionPool::TimedStack
       @resource.broadcast
 
       shutdown_connections
+      @shutdown_block = nil if reload
     end
   end
 
@@ -143,6 +146,7 @@ class ConnectionPool::TimedStack
       conn = fetch_connection(options)
       @shutdown_block.call(conn)
     end
+    @created = 0
   end
 
   ##

data/lib/connection_pool/version.rb

@@ -1,3 +1,3 @@
 class ConnectionPool
-  VERSION = "2.2.3"
+  VERSION = "2.2.4"
 end

data/lib/connection_pool/wrapper.rb

@@ -32,9 +32,17 @@ class ConnectionPool
 
     # rubocop:disable Style/MethodMissingSuper
     # rubocop:disable Style/MissingRespondToMissing
-    def method_missing(name, *args, &block)
-      with do |connection|
-        connection.send(name, *args, &block)
+    if ::RUBY_VERSION >= "2.7.0"
+      def method_missing(name, *args, **kwargs, &block)
+        with do |connection|
+          connection.send(name, *args, **kwargs, &block)
+        end
+      end
+    else
+      def method_missing(name, *args, &block)
+        with do |connection|
+          connection.send(name, *args, &block)
+        end
       end
     end
     # rubocop:enable Style/MethodMissingSuper

data/test/test_connection_pool.rb

@@ -8,8 +8,8 @@ class TestConnectionPool < Minitest::Test
       @x = 0
     end
 
-    def do_something
-      @x += 1
+    def do_something(*_args, increment: 1)
+      @x += increment
       sleep SLEEP_TIME
       @x
     end
@@ -117,6 +117,12 @@ class TestConnectionPool < Minitest::Test
     assert Thread.new { pool.checkout }.join
   end
 
+  def test_then
+    pool = ConnectionPool.new { Object.new }
+
+    assert_equal pool.method(:then), pool.method(:with)
+  end
+
   def test_with_timeout
     pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
 
@@ -326,6 +332,7 @@ class TestConnectionPool < Minitest::Test
     assert_equal 2, pool.do_something
     assert_equal 5, pool.do_something_with_block { 3 }
     assert_equal 6, pool.with { |net| net.fast }
+    assert_equal 8, pool.do_something(increment: 2)
   end
 
   def test_passthru_respond_to

data/test/test_connection_pool_timed_stack.rb

@@ -102,6 +102,16 @@ class TestConnectionPoolTimedStack < Minitest::Test
     end
   end
 
+  def test_pop_shutdown_reload
+    stack = ConnectionPool::TimedStack.new(1) { Object.new }
+    object = stack.pop
+    stack.push(object)
+
+    stack.shutdown(reload: true) {}
+
+    refute_equal object, stack.pop
+  end
+
   def test_push
     stack = ConnectionPool::TimedStack.new(1) { Object.new }
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: connection_pool
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Mike Perham
 - Damian Janowski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,8 +61,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Changes.md
 - Gemfile
 - LICENSE
@@ -80,7 +80,7 @@ homepage: https://github.com/mperham/connection_pool
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,15 +88,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Generic connection pool for Ruby
 test_files:

data/.travis.yml

@@ -1,12 +0,0 @@
----
-cache: bundler
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby
-jdk:
-  - openjdk11