async-pool 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc00b6087965cc5fc3f58ae151a0048fc8cf351aab9c06bdaf46b0eb65bb877
-  data.tar.gz: 7f9e3067d5bc75de995735ac4a025cb6cea4ee72e0e63201ec4f28c000301cc2
+  metadata.gz: 8d877fb908af8482011de394630982c4c593e36a5efd9ef19a885bba5774f6e8
+  data.tar.gz: be2d7efd8c65a9eec5237acc4f432e76a3f401da0b13e7e10b089f9849382f2a
 SHA512:
-  metadata.gz: e6933852df812446375faf0c0c921c137bdd972beec9f1e392f6bdfc0c803ddf1cf62151323fbd18f8431c9ab1021eaac2c90ab461f03679d3e93cebfbc039b0
-  data.tar.gz: 76a83cc5cc6a5dc2230ae6ad3eedc12a0e4fc24170d7391d5a1c032553d4a5653fc89b12060e331bd64687fefb5308d64785bbdc9cc70701b3f86e394de718f2
+  metadata.gz: 3e472af40018c10b2a8d726fc31b04ea96557d790c55e4fe6449a891b048c96da66794926eb7ca726195f778d0bea1e6c9d762b274a06a0922f382d5a8794ab7
+  data.tar.gz: 8abacfdcb4b32eb573e0108aecdbdd7ff385386e8a8de2710550b976a81467286e73fa8f36292162e801d5f000fc2a222aabf99f7cf334a35d7e22e47833ded1

data/lib/async/pool/controller.rb

@@ -11,6 +11,9 @@ require 'async'
 require 'async/notification'
 require 'async/semaphore'
 
+require 'traces'
+require 'metrics'
+
 module Async
 	module Pool
 		# A resource pool controller.
@@ -154,20 +157,20 @@ module Async
 				retire(resource) unless processed
 			end
 			
-			# Close all resources in the pool.
-			def close
-				@available.clear
+			def drain
+				Console.debug(self, "Draining pool...", size: @resources.size)
 				
-				while pair = @resources.shift
-					resource, usage = pair
-					
-					if usage > 0
-						Console.warn(self, resource: resource, usage: usage) {"Closing resource while still in use!"}
-					end
-					
-					resource.close
+				# Enumerate all existing resources and retire them:
+				while resource = acquire_existing_resource
+					retire(resource)
 				end
+			end
+			
+			# Close all resources in the pool.
+			def close
+				self.drain
 				
+				@available.clear
 				@gardener&.stop
 			end
 			
@@ -224,6 +227,8 @@ module Async
 			def start_gardener
 				return if @gardener
 				
+				@gardener = true
+				
 				Async(transient: true, annotation: "#{self.class} Gardener") do |task|
 					@gardener = task
 					
@@ -262,6 +267,7 @@ module Async
 			
 			def reuse(resource)
 				Console.debug(self) {"Reuse #{resource}"}
+				
 				usage = @resources[resource]
 				
 				if usage.nil? || usage.zero?
@@ -286,11 +292,7 @@ module Async
 					@notification.wait
 				end
 				
-				Console.debug(self) {"Wait for resource -> #{resource}"}
-				
-				# if resource.concurrency > 1
-				# 	@notification.signal
-				# end
+				# Be careful not to context switch or fail here.
 				
 				return resource
 			end
@@ -318,19 +320,40 @@ module Async
 			def available_resource
 				resource = nil
 				
+				Console.debug(self, "Acquiring concurrency guard...", blocking: @guard.blocking?)
+				
 				@guard.acquire do
-					resource = get_resource
+					Console.debug(self, "Acquired concurrency guard.")
+					
+					resource = acquire_or_create_resource
 				end
 				
 				return resource
-			rescue Exception
+			rescue Exception => error
 				reuse(resource) if resource
 				raise
 			end
 			
 			private
 			
-			def get_resource
+			# Acquire an existing resource with zero usage.
+			# If there are resources that are in use, wait until they are released.
+			def acquire_existing_resource
+				while @resources.any?
+					@resources.each do |resource, usage|
+						if usage == 0
+							return resource
+						end
+					end
+					
+					@notification.wait
+				end
+				
+				# Only when the pool has been completely drained, return nil:
+				return nil
+			end
+			
+			def acquire_or_create_resource
 				while resource = @available.last
 					if usage = @resources[resource] and usage < resource.concurrency
 						if resource.viable?
@@ -358,6 +381,50 @@ module Async
 					return create_resource
 				end
 			end
+			
+			Traces::Provider(self) do
+				def create_resource(...)
+					attributes = {
+						concurrency: @guard.limit,
+						size: @resources.size,
+						limit: @limit,
+					}
+					
+					Traces.trace('async.pool.create', attributes: attributes) {super}
+				end
+				
+				def drain(...)
+					attributes = {
+						size: @resources.size,
+					}
+					
+					Traces.trace('async.pool.drain', attributes: attributes) {super}
+				end
+			end
+			
+			Metrics::Provider(self) do
+				ACQUIRE_COUNT = Metrics.metric('async.pool.acquire', :counter, description: 'Number of times a resource was invoked.')
+				RELEASE_COUNT = Metrics.metric('async.pool.release', :counter, description: 'Number of times a resource was released.')
+				RETIRE_COUNT = Metrics.metric('async.pool.retire', :counter, description: 'Number of times a resource was retired.')
+				
+				def acquire(...)
+					ACQUIRE_COUNT.emit(1)
+					
+					super
+				end
+				
+				def release(...)
+					super.tap do
+						RELEASE_COUNT.emit(1)
+					end
+				end
+				
+				def retire(...)
+					super.tap do
+						RETIRE_COUNT.emit(1)
+					end
+				end
+			end
 		end
 	end
 end

data/lib/async/pool/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Pool
-		VERSION = "0.7.1"
+		VERSION = "0.8.1"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-pool
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-03 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -56,6 +56,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: traces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables: []