async-pool 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 731a576d4114fb425b42892ddcaf142b716f8917bfd2b71b350b20693695d89c
-  data.tar.gz: a4741eac4eb25dafe84c6581c1b0483c0ff3f6e26a9477ea96af245d74f1130f
+  metadata.gz: 187ab4a00163af3f7b15cef9764a8ba46a33fe353c5784da7efa723f59bf4d07
+  data.tar.gz: d74bdfc5c5796709ec64e884e4b35b24d6fd438839135503a26cc5f7519dfda0
 SHA512:
-  metadata.gz: ca20d5353fac4bb839fa6b846a48c89ef48dc8ad86632420e504a4eb079e1be6d3cdd99d57f85238a3d5c93fa00e878dc297444bf188a12243bcc907cee6bf47
-  data.tar.gz: adf70450fdc1ca0def9eb6548d023bacfde995e2446f9b88db56ebc2f1f1e91436a780105ceec41580fe52c6acfafe64c265e02858b3a92802a93b43964faec8
+  metadata.gz: d089f3cbb49ae94b64527a6782f4d3f68c133b96b1a00b17c036356d233c50fde88feb28eb3f65ed367f18760f482b8328e68ba83fa9cd7d0090c57be4aa0f0b
+  data.tar.gz: e72e69324a4c23b6bd20175189a6350e73b6a2499485587f1465d14aa792dfcd5f7a6866ce4b0fa2ae420461df8d389209d8adf95a9d321a07fa54648227a4ce

data/lib/async/pool/controller.rb

@@ -20,6 +20,7 @@
 
 require 'async/logger'
 
+require 'async'
 require 'async/notification'
 require 'async/semaphore'
 
@@ -31,9 +32,13 @@ module Async
 			end
 			
 			def initialize(constructor, limit: nil)
+				# All available resources:
 				@resources = {}
 				
+				# Resources which may be available to be acquired:
+				# This list may contain false positives, or resources which were okay but have since entered a state which is unusuable.
 				@available = []
+				
 				@notification = Async::Notification.new
 				
 				@limit = limit
@@ -44,7 +49,7 @@ module Async
 				@gardener = nil
 			end
 			
-			# @attr [Hash<Resource, Integer>] all allocated resources, and their associated usage.
+			# @attribute [Hash(Resource, Integer)] all allocated resources, and their associated usage.
 			attr :resources
 			
 			def size
@@ -65,6 +70,11 @@ module Async
 				return false
 			end
 			
+			# Whether there are available resources, i.e. whether {#acquire} can reuse an existing resource.
+			def available?
+				@available.any?
+			end
+			
 			# Wait until a pool resource has been freed.
 			def wait
 				@notification.wait
@@ -97,6 +107,8 @@ module Async
 			end
 			
 			def close
+				@available.clear
+				
 				@resources.each_key(&:close)
 				@resources.clear
 				
@@ -118,7 +130,9 @@ module Async
 				unused = []
 				
 				@resources.each do |resource, usage|
-					unused << resource if usage.zero?
+					if usage.zero?
+						unused << resource
+					end
 				end
 				
 				unused.each do |resource|
@@ -131,6 +145,14 @@ module Async
 					break if @resources.size <= retain
 				end
 				
+				# Update availability list:
+				@available.clear
+				@resources.each do |resource, usage|
+					if usage < resource.concurrency and resource.reusable?
+						@available << resource
+					end
+				end
+				
 				return unused.size
 			end
 			
@@ -149,7 +171,7 @@ module Async
 			def start_gardener
 				return if @gardener
 				
-				Async(transient: true) do |task|
+				Async(transient: true, annotation: "#{self.class} Gardener") do |task|
 					@gardener = task
 					
 					Task.yield
@@ -169,11 +191,42 @@ module Async
 				end.join(";")
 			end
 			
+			def usage
+				@resources.count{|resource, usage| usage > 0}
+			end
+			
+			def free
+				@resources.count{|resource, usage| usage == 0}
+			end
+			
+			# @returns [Boolean] Whether the number of available resources is excessive and we should retire some.
+			def overflowing?
+				if @resources.any?
+					(self.free.to_f / @resources.size) > 0.5
+				end
+			end
+			
 			def reuse(resource)
 				Async.logger.debug(self) {"Reuse #{resource}"}
+				usage = @resources[resource]
+				
+				if usage.zero?
+					raise "Trying to reuse unacquired resource: #{resource}!"
+				end
+				
+				# We retire resources when adding to the @available list would overflow our pool:
+				if usage == 1
+					if overflowing?
+						return retire(resource)
+					end
+				end
+				
+				# If the resource was fully utilized, it now becomes available:
+				if usage == resource.concurrency
+					@available.push(resource)
+				end
 				
-				@resources[resource] -= 1
-				@available.push(resource)
+				@resources[resource] = usage - 1
 				
 				@notification.signal
 			end
@@ -193,6 +246,7 @@ module Async
 				return resource
 			end
 			
+			# @returns [Object] A new resource in a "used" state.
 			def create_resource
 				self.start_gardener
 				
@@ -200,18 +254,27 @@ module Async
 				if resource = @constructor.call
 					@resources[resource] = 1
 					
-					@available.push(resource) if resource.concurrency > 1
+					# Make the resource available if it can be used multiple times:
+					if resource.concurrency > 1
+						@available.push(resource)
+					end
 				end
 				
 				return resource
 			end
 			
+			# @returns [Object] An existing resource in a "used" state.
 			def available_resource
 				@guard.acquire do
 					while resource = @available.last
 						if usage = @resources[resource] and usage < resource.concurrency
 							if resource.viable?
-								@resources[resource] += 1
+								usage = (@resources[resource] += 1)
+								
+								if usage == resource.concurrency
+									# The resource is used up to it's limit:
+									@available.pop
+								end
 								
 								return resource
 							else
@@ -219,12 +282,13 @@ module Async
 								@available.pop
 							end
 						else
+							# The resource has been removed already, so skip it and remove it from the availability list.
 							@available.pop
 						end
 					end
 					
 					if @limit.nil? or @resources.size < @limit
-						Async.logger.debug(self) {"No resources resources, allocating new one..."}
+						Async.logger.debug(self) {"No available resources, allocating new one..."}
 						
 						return create_resource
 					end

data/lib/async/pool/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Pool
-		VERSION = "0.3.0"
+		VERSION = "0.3.5"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-pool
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bake-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bake-modernize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bake-bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,28 +94,36 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/development.yml"
-- ".gitignore"
-- ".rspec"
-- Gemfile
-- README.md
-- async-pool.gemspec
 - lib/async/pool.rb
 - lib/async/pool/controller.rb
 - lib/async/pool/resource.rb
 - lib/async/pool/version.rb
 homepage: https://github.com/socketry/async-pool
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -131,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: A Redis client library.
+summary: A singleplex and multiplex resource pool for implementing robust clients.
 test_files: []

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.github/workflows/development.yml

@@ -1,51 +0,0 @@
-name: Development
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ${{matrix.os}}-latest
-    continue-on-error: ${{matrix.experimental}}
-    
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-        
-        ruby:
-          - 2.5
-          - 2.6
-          - 2.7
-        
-        experimental: [false]
-        env: [""]
-        
-        include:
-          - os: ubuntu
-            ruby: truffleruby
-            experimental: true
-            env: JRUBY_OPTS="--debug -X+O"
-          - os: ubuntu
-            ruby: jruby
-            experimental: true
-          - os: ubuntu
-            ruby: head
-            experimental: true
-          - os: ubuntu
-            ruby: 2.6
-            experimental: false
-            env: COVERAGE=PartialSummary,Coveralls
-    
-    steps:
-    - uses: actions/checkout@v1
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{matrix.ruby}}
-    
-    - name: Install dependencies
-      run: ${{matrix.env}} bundle install
-    
-    - name: Run tests
-      timeout-minutes: 5
-      run: ${{matrix.env}} bundle exec rspec

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-# gem "async", path: "../async"

data/README.md

@@ -1,72 +0,0 @@
-# Async::Pool
-
-Provides support for connection pooling both singleplex and multiplex resources.
-
-[![Actions Status](https://github.com/socketry/async-pool/workflows/Development/badge.svg)](https://github.com/socketry/async-pool/actions?workflow=Development)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'async-pool'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install async-pool
-
-## Usage
-
-`Async::Pool::Controller` provides support for both singleplex (one stream at a time) and multiplex resources (multiple streams at a time).
-
-`Async::Pool::Resource` is provided as an interface and to document how to use the pools. However, you wouldn't need to use this in practice and just implement the appropriate interface on your own objects.
-
-```ruby
-pool = Async::Pool::Controller.new(Async::Pool::Resource)
-
-pool.acquire do |resource|
-	# resource is implicitly released when exiting the block.
-end
-
-resource = pool.acquire
-
-# Return the resource back to the pool:
-pool.release(resource)
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2019, by [Samuel G. D. Williams](http://www.codeotaku.com).
-
-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/async-pool.gemspec

@@ -1,28 +0,0 @@
-
-require_relative 'lib/async/pool/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "async-pool"
-	spec.version       = Async::Pool::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	
-	spec.summary       = "A Redis client library."
-	spec.homepage      = "https://github.com/socketry/async-pool"
-	
-	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-		f.match(%r{^(test|spec|features)/})
-	end
-	
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency("async", "~> 1.25")
-	
-	spec.add_development_dependency "async-rspec", "~> 1.1"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.6"
-	spec.add_development_dependency "bake-bundler"
-end