async-pool 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f51a25e4bec2c50dc1e0a3dd8b58dcea1deec49d964a1e96c2cb4e1ef4f6de91
-  data.tar.gz: 7ae894d17e1b977e20910dab375cf898f76051af6b71a165332143550efbb57c
+  metadata.gz: 8261d789df6f1e5666e9994a6b977a9a51f7c196701fffebe2f26eca28aab213
+  data.tar.gz: 9db4443e7e225ed235c8700c2a89292bced23af536abf5d5a625520ccc470c5f
 SHA512:
-  metadata.gz: d92167ce83dec22ac8224c10741bef3595884baeef9fb00c31ef71f7a3cced965d642965c4091902567476ba246cd6bfa1c79d16e3bc5e512e5d120184413c93
-  data.tar.gz: 44d97c8ea249bbae96158774832e983f88ceb871979b04ab2626aa962705a3e54210e3edf19e235448a623384bc7382b73e854281fa095c18b97c2d73d067918
+  metadata.gz: e570ea6d402c540b87f604e84b5df47744a69d6eb99f423069b5cae560e6f8e8cd75102dc7e6c9c8514671099a00cd7596a6c2f4a0ab551857684b3cf27f2c02
+  data.tar.gz: 34c158ab5216a2c6a8c9fc930f6f0042fc19b05a71fe3659e4ebd06dc91094effb18c8c36c1c01c160d32d2cc306a6957496c6bf9d3f78553e8cfe5dbf939a0d

data/lib/async/pool/controller.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 # Copyright, 2020, by Simon Perepelitsa.
 # Copyright, 2024, by Thomas Morgan.
 # Copyright, 2025, by Jean Boussier.
+# Copyright, 2026, by William T. Nelson.
 
 require "console/logger"
 
 require "async"
 require "async/semaphore"
 
+require "set"
 require "thread"
 
 module Async
@@ -26,9 +28,9 @@ module Async
 			#
 			# @parameter constructor [Proc] A block which creates a new resource.
 			# @parameter limit [Integer | Nil] The maximum number of resources that this pool can have at any given time. If nil, the pool can have an unlimited number of resources.
-			# @parameter concurrency [Integer] The maximum number of concurrent tasks that can be creating a new resource.
+			# @parameter concurrency [Integer] The maximum number of concurrent tasks that can be creating a new resource. Defaults to 1 to ensure the pool limit is enforced. Higher values may result in more resources being created than the limit under high load.
 			# @parameter policy [Policy] The pool policy.
-			def initialize(constructor, limit: nil, concurrency: (limit || 1), policy: nil, tags: nil)
+			def initialize(constructor, limit: nil, concurrency: 1, policy: nil, tags: nil)
 				@constructor = constructor
 				@limit = limit
 				
@@ -40,12 +42,12 @@ module Async
 				
 				@tags = tags
 				
-				# All available resources:
-				@resources = {}
+				# All allocated resources. Each resource is tracked by identity, irrespective of any value equality it may define:
+				@resources = {}.compare_by_identity
 				
-				# 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 = []
+				# Resources which may be available to be acquired. Resources are compared by identity and acquired in insertion order. Adding an existing resource preserves its position; a fully utilized resource is removed and reinserted at the end when capacity becomes available again.
+				# This set may contain false positives, or resources which were okay but have since entered a state which is unusable.
+				@available = Set.new.compare_by_identity
 				
 				# Used to signal when a resource has been released:
 				@mutex = Thread::Mutex.new
@@ -165,16 +167,31 @@ module Async
 			
 			# Make the resource resources and let waiting tasks know that there is something resources.
 			def release(resource)
-				processed = false
+				unless usage = decrement_usage(resource)
+					return false
+				end
 				
-				# A resource that is not good should also not be reusable.
 				if resource.reusable?
-					processed = reuse(resource)
+					@available.add(resource)
+				else
+					# The resource must not be acquired again, but it cannot be retired until all existing users have released it:
+					@available.delete(resource)
+					
+					if usage.zero?
+						retire(resource)
+						resource = nil
+						return true
+					end
 				end
 				
+				@mutex.synchronize{@condition.broadcast}
+				
 				# @policy.released(self, resource)
+				
+				resource = nil
+				return true
 			ensure
-				retire(resource) unless processed
+				retire(resource) if resource
 			end
 			
 			# Drain the pool, closing all resources.
@@ -234,7 +251,7 @@ module Async
 			def retire(resource)
 				Console.debug(self){"Retire #{resource}"}
 				
-				@resources.delete(resource)
+				return false unless @resources.delete(resource)
 				
 				resource.close
 				
@@ -281,27 +298,6 @@ module Async
 			# 	@resources.count{|resource, usage| usage == 0}
 			# end
 			
-			def reuse(resource)
-				Console.debug(self){"Reuse #{resource}"}
-				
-				usage = @resources[resource]
-				
-				if usage.nil? || usage.zero?
-					raise "Trying to reuse unacquired resource: #{resource}!"
-				end
-				
-				# If the resource was fully utilized, it now becomes available:
-				if usage == resource.concurrency
-					@available.push(resource)
-				end
-				
-				@resources[resource] = usage - 1
-				
-				@mutex.synchronize{@condition.broadcast}
-				
-				return true
-			end
-			
 			def wait_for_resource
 				# If we fail to create a resource (below), we will end up waiting for one to become resources.
 				until resource = available_resource
@@ -321,7 +317,7 @@ module Async
 					
 					# Make the resource available if it can be used multiple times:
 					if resource.concurrency > 1
-						@available.push(resource)
+						@available.add(resource)
 					end
 				end
 				
@@ -340,12 +336,23 @@ module Async
 				
 				return resource
 			rescue Exception
-				reuse(resource) if resource
+				release(resource) if resource
 				raise
 			end
 			
 			private
 			
+			def decrement_usage(resource)
+				usage = @resources[resource]
+				return unless usage
+				
+				if usage.zero?
+					raise "Trying to reuse unacquired resource: #{resource}!"
+				end
+				
+				return @resources[resource] = usage - 1
+			end
+			
 			# Acquire an existing resource with zero usage.
 			# If there are resources that are in use, wait until they are released.
 			def acquire_existing_resource
@@ -362,24 +369,24 @@ module Async
 			end
 			
 			def acquire_or_create_resource
-				while resource = @available.last
+				while resource = @available.first
 					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
+								@available.delete(resource)
 							end
 							
 							return resource
 						else
-							retire(resource)
-							@available.pop
+							@available.delete(resource)
+							retire(resource) if usage.zero?
 						end
 					else
 						# The resource has been removed already, so skip it and remove it from the availability list.
-						@available.pop
+						@available.delete(resource)
 					end
 				end
 				

data/lib/async/pool/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 
 module Async
 	module Pool
-		VERSION = "0.11.1"
+		VERSION = "0.12.0"
 	end
 end

data/license.md

@@ -1,10 +1,11 @@
 # MIT License
 
-Copyright, 2019-2025, by Samuel Williams.  
+Copyright, 2019-2026, by Samuel Williams.  
 Copyright, 2020, by Simon Perepelitsa.  
 Copyright, 2021, by Olle Jonsson.  
 Copyright, 2024, by Thomas Morgan.  
 Copyright, 2025, by Jean Boussier.  
+Copyright, 2026, by William T. Nelson.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -14,17 +14,37 @@ Please see the [project documentation](https://socketry.github.io/async-pool/) f
 
 Please see the [project releases](https://socketry.github.io/async-pool/releases/index) for all releases.
 
-### v0.11.0
+### v0.12.0
+
+  - Use identity-based tracking for pooled resources and preserve insertion order when selecting available resources.
+
+### v0.11.2
 
 ## Contributing
 
 We welcome contributions to this project.
 
-1.  Fork it.
+1.  Fork the repository.
 2.  Create your feature branch (`git checkout -b my-new-feature`).
-3.  Commit your changes (`git commit -am 'Add some 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.
+5.  Create a new pull request.
+
+### Running Tests
+
+To run the test suite:
+
+``` bash
+$ bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` bash
+$ bundle exec bake gem:release:patch # or minor or major
+```
 
 ### Developer Certificate of Origin
 

data/releases.md

@@ -1,3 +1,7 @@
 # Releases
 
-## v0.11.0
+## v0.12.0
+
+  - Use identity-based tracking for pooled resources and preserve insertion order when selecting available resources.
+
+## v0.11.2

data.tar.gz.sig

@@ -1,2 +1,4 @@
-%��HJ.�j��a��h^�%|���yt��sM�P\�V]�)?�i��
-K<K4җzS�Vk����b5�ş�$�����&`V��:0���ao���o<��bB�!>�7mid��5�����2vٲ�󖨄V��$7�oi\�2蓬���=h�����m�@K\m+��c�p��x�M�x��*��j�}�%(+��ll�!&y/of9��Nۅ���HĬ�")
+g�_r=GUwx:��]�<r1��W��ef4p�#׫
+�B�UE b��6�ϵ_�!n�!�K0��X�x�W��
��
��|�����u�1�U�p�LL�����'[��,�$�!?��
+�X���
�����#rq�U��Ci�5���߾!��ӏF���Rس�N?,�G��7�\�)(�4��=F�5���m�񖶼Z���B/7B�8h�&v~�]���Yw�.�K��s'(� �b�??�,�g�~�D�R[-K���#!�
+Ҁ1��=%\F����H����٣h�"@
����_߶Έ��ч�2�ϊv�dm"F7

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-pool
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -9,6 +9,7 @@ authors:
 - Olle Jonsson
 - Simon Perepelitsa
 - Thomas Morgan
+- William T. Nelson
 bindir: bin
 cert_chain:
 - |
@@ -72,6 +73,8 @@ homepage: https://github.com/socketry/async-pool
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/socketry/async-pool/issues
+  changelog_uri: https://github.com/socketry/async-pool/blob/main/releases.md
   documentation_uri: https://socketry.github.io/async-pool/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/socketry/async-pool.git
@@ -82,14 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A singleplex and multiplex resource pool for implementing robust clients.
 test_files: []