async-pool 0.3.2 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60d511b499cd1be338be2e27e2f2a3266152a751174694fa9ce57df81137c59e
-  data.tar.gz: b8c2ef5e6bf6ed4150f4149c411dcaad6ff60da9736b83b0f63dc0524bc973a7
+  metadata.gz: 36dfa0c90392d3f6e3582b1bdd3e2fdb7667ddccb601fb4dd34df3e8aa3baa2e
+  data.tar.gz: bea9381873eed77a2fd9dcb4d90190e9fa3ebbbba0f38c5628ee369f5da58a97
 SHA512:
-  metadata.gz: f6277156f05069cae282cbb2152d2ffa1fa4270c233bf4d356dc3530bfb5b7ad99e3916a578565a59b7348d803a927a449db2f76836d480a8409ff530009d92f
-  data.tar.gz: edd54a4824cdb509ba987b53d4a49149fd655e160c96ca24c32e9d83e3ebca26b13100b215ac3d410f597ff0dfdab491f31b825eb22e41078054f8b0f3d917b4
+  metadata.gz: 7ece710c9d7ec8fcb62b92ae9fb19775de4f781f886a3b9e285f08a0a9483599bc15e6b5d727df7697202f1b11381cba5ebb731d84ad9236abc4c29d8293a508
+  data.tar.gz: 02d545782a0b63b7ba74ce19a450ab7851886548eb71805c2fd9e5b71f8daf838c5dfbd5013b6bec2b639a2f630a5dfc846baaf9b28581cf53cb26d9b975290d

data/lib/async/pool/controller.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'async/logger'
+require 'console/logger'
 
 require 'async'
 require 'async/notification'
@@ -32,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
@@ -45,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
@@ -66,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
@@ -98,6 +107,8 @@ module Async
 			end
 			
 			def close
+				@available.clear
+				
 				@resources.each_key(&:close)
 				@resources.clear
 				
@@ -119,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|
@@ -132,11 +145,19 @@ 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
 			
 			def retire(resource)
-				Async.logger.debug(self) {"Retire #{resource}"}
+				Console.logger.debug(self) {"Retire #{resource}"}
 				
 				@resources.delete(resource)
 				
@@ -150,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
@@ -170,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}"}
+				Console.logger.debug(self) {"Reuse #{resource}"}
+				usage = @resources[resource]
 				
-				@resources[resource] -= 1
-				@available.push(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] = usage - 1
 				
 				@notification.signal
 			end
@@ -185,7 +237,7 @@ module Async
 					@notification.wait
 				end
 				
-				Async.logger.debug(self) {"Wait for resource -> #{resource}"}
+				Console.logger.debug(self) {"Wait for resource -> #{resource}"}
 				
 				# if resource.concurrency > 1
 				# 	@notification.signal
@@ -194,6 +246,7 @@ module Async
 				return resource
 			end
 			
+			# @returns [Object] A new resource in a "used" state.
 			def create_resource
 				self.start_gardener
 				
@@ -201,37 +254,56 @@ 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
+				resource = nil
+				
 				@guard.acquire do
-					while resource = @available.last
-						if usage = @resources[resource] and usage < resource.concurrency
-							if resource.viable?
-								@resources[resource] += 1
-								
-								return resource
-							else
-								retire(resource)
+					resource = get_resource
+				end
+				
+				return resource
+			rescue Exception
+				reuse(resource) if resource
+				raise
+			end
+			
+			private def get_resource
+				while resource = @available.last
+					if usage = @resources[resource] and usage < resource.concurrency
+						if resource.viable?
+							usage = (@resources[resource] += 1)
+							
+							if usage == resource.concurrency
+								# The resource is used up to it's limit:
 								@available.pop
 							end
+							
+							return resource
 						else
+							retire(resource)
 							@available.pop
 						end
-					end
-					
-					if @limit.nil? or @resources.size < @limit
-						Async.logger.debug(self) {"No resources resources, allocating new one..."}
-						
-						return create_resource
+					else
+						# The resource has been removed already, so skip it and remove it from the availability list.
+						@available.pop
 					end
 				end
 				
-				return nil
+				if @limit.nil? or @resources.size < @limit
+					Console.logger.debug(self) {"No available resources, allocating new one..."}
+					
+					return create_resource
+				end
 			end
 		end
 	end

data/lib/async/pool/resource.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'async/logger'
+require 'console/logger'
 
 require 'async/notification'
 require 'async/semaphore'

data/lib/async/pool/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Pool
-		VERSION = "0.3.2"
+		VERSION = "0.3.7"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-pool
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.7
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2021-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -108,8 +108,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -123,7 +123,7 @@ licenses:
 - MIT
 metadata:
   funding_uri: https://github.com/sponsors/ioquatix/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -131,15 +131,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.0.dev
+signing_key:
 specification_version: 4
 summary: A singleplex and multiplex resource pool for implementing robust clients.
 test_files: []