async 2.24.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c1315007ff80d78bdd1538d2b2963ed951db5aa92906ea6f22560612540cbc
-  data.tar.gz: 03ffadcf7c2523827bd6c49340df0a846f8ab3214593d897b4359b548a765cef
+  metadata.gz: 44c11aa8f74922b9bc2ccce792fd3c419af4a3a261f97f2f2202e3d75a5bf8f5
+  data.tar.gz: e2327b997b32a42e2ebfe9a4e4950d26a12ce698ce34a89d9fe1be94b0241b1f
 SHA512:
-  metadata.gz: 62c15e0c19e7f3277ca9e4981b0304d5f039367fb0d6b996a8c562be170b3436f66e97f33fcfd5eb0ed8ec84e760ae2b565a022604e026f3b2c797613534fd59
-  data.tar.gz: 79c7148d35f3e06243b3845721b8a1ebcf5fd2e6244eab18ac5a0f42894088334df307c4da52d9d9c59b0d9499e457f0990022d570abf109202416cf168211a1
+  metadata.gz: 20961f535e5368753dffdb760d9bddf0fcf55e5910e5f6c71dba28ebb0405221d9328a8bfe5ef4e688ead71b4b5c4bde3949ce1edfa013b06af7db57adfe6d7f
+  data.tar.gz: d58c654852cd650978fa14fef7eaba00f4784137075960e5ad5b0b6b20ae3523912578b32b660f7d107df318cdd34945124e83231c4e574e336c5c4862a6c87c

data/lib/async/clock.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2022, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 module Async
 	# A convenient wrapper around the internal monotonic clock.

data/lib/async/limited_queue.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2025, by Samuel Williams.
 
 # The implementation lives in `queue.rb` but later we may move it here for better autoload/inference.
 require_relative "queue"

data/lib/async/queue.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 # Copyright, 2019, by Ryan Musgrave.
 # Copyright, 2020-2022, by Bruno Sutic.
+# Copyright, 2025, by Jahfer Husain.
 
 require_relative "notification"
 

data/lib/async/scheduler.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 # Copyright, 2020, by Jun Jiang.
 # Copyright, 2021, by Julien Portalier.
+# Copyright, 2025, by Shopify Inc.
 
 require_relative "clock"
 require_relative "task"
 require_relative "timeout"
-require_relative "worker_pool"
 
 require "io/event"
 
@@ -45,7 +45,29 @@ module Async
 		def self.supported?
 			true
 		end
+
+		# Used to augment the scheduler to add support for blocking operations.
+		module BlockingOperationWait
+			# Wait for the given work to be executed.
+			#
+			# @public Since *Async v2.21* and *Ruby v3.4*.
+			# @asynchronous May be non-blocking.
+			#
+			# @parameter work [Proc] The work to execute on a background thread.
+			# @returns [Object] The result of the work.
+			def blocking_operation_wait(work)
+				@worker_pool.call(work)
+			end
+		end
+
+		private_constant :BlockingOperationWait
 		
+		if ::IO::Event.const_defined?(:WorkerPool)
+			WorkerPool = ::IO::Event::WorkerPool
+		else
+			WorkerPool = nil
+		end
+
 		# Create a new scheduler.
 		#
 		# @public Since *Async v1*.
@@ -65,14 +87,15 @@ module Async
 			@idle_time = 0.0
 			
 			@timers = ::IO::Event::Timers.new
+			
 			if worker_pool == true
-				@worker_pool = WorkerPool.new
+				@worker_pool = WorkerPool&.new
 			else
 				@worker_pool = worker_pool
 			end
-			
+
 			if @worker_pool
-				self.singleton_class.prepend(WorkerPool::BlockingOperationWait)
+				self.singleton_class.prepend(BlockingOperationWait)
 			end
 		end
 		
@@ -234,7 +257,7 @@ module Async
 		# @parameter blocker [Object] The object that was blocking the fiber.
 		# @parameter fiber [Fiber] The fiber to unblock.
 		def unblock(blocker, fiber)
-			# $stderr.puts "unblock(#{blocker}, #{fiber})"
+			# Fiber.blocking{$stderr.puts "unblock(#{blocker}, #{fiber})"}
 			
 			# This operation is protected by the GVL:
 			if selector = @selector
@@ -250,6 +273,8 @@ module Async
 		#
 		# @parameter duration [Numeric | Nil] The time in seconds to sleep, or if nil, indefinitely.
 		def kernel_sleep(duration = nil)
+			# Fiber.blocking{$stderr.puts "kernel_sleep(#{duration}, #{Fiber.current})"}
+			
 			if duration
 				self.block(nil, duration)
 			else
@@ -348,6 +373,34 @@ module Async
 			end
 		end
 		
+		# Used to defer stopping the current task until later.
+		class FiberInterrupt
+			# Create a new stop later operation.
+			#
+			# @parameter task [Task] The task to stop later.
+			def initialize(fiber, exception)
+				@fiber = fiber
+				@exception = exception
+			end
+			
+			# @returns [Boolean] Whether the task is alive.
+			def alive?
+				@fiber.alive?
+			end
+			
+			# Transfer control to the operation - this will stop the task.
+			def transfer
+				# Fiber.blocking{$stderr.puts "FiberInterrupt#transfer(#{@fiber}, #{@exception})"}
+				@fiber.raise(@exception)
+			end
+		end
+		
+		# Raise an exception on the specified fiber, waking up the event loop if necessary.
+		def fiber_interrupt(fiber, exception)
+			# Fiber.blocking{$stderr.puts "fiber_interrupt(#{fiber}, #{exception})"}
+			unblock(nil, FiberInterrupt.new(fiber, exception))
+		end
+		
 		# Wait for the specified process ID to exit.
 		#
 		# @public Since *Async v2*.
@@ -361,6 +414,16 @@ module Async
 			return @selector.process_wait(Fiber.current, pid, flags)
 		end
 		
+		# Wait for the specified IOs to become ready for the specified events.
+		#
+		# @public Since *Async v2.25*.
+		# @asynchronous May be non-blocking.
+		def io_select(...)
+			Thread.new do
+				::IO.select(...)
+			end.value
+		end
+		
 		# Run one iteration of the event loop.
 		#
 		# When terminating the event loop, we already know we are finished. So we don't need to check the task tree. This is a logical requirement because `run_once` ignores transient tasks. For example, a single top level transient task is not enough to keep the reactor running, but during termination we must still process it in order to terminate child tasks.

data/lib/async/task.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2024, by Samuel Williams.
+# Copyright, 2017-2025, by Samuel Williams.
 # Copyright, 2017, by Kent Gruber.
 # Copyright, 2017, by Devin Christensen.
 # Copyright, 2020, by Patrik Wenger.
 # Copyright, 2023, by Math Ieu.
+# Copyright, 2025, by Shigeru Nakajima.
 
 require "fiber"
 require "console"

data/lib/async/variable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2024, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
 require_relative "condition"
 

data/lib/async/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2024, by Samuel Williams.
+# Copyright, 2017-2025, by Samuel Williams.
 
 module Async
-	VERSION = "2.24.0"
+	VERSION = "2.25.0"
 end

data/lib/metrics/provider/async/task.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require_relative "../../../async/task"
 require "metrics/provider"

data/lib/traces/provider/async/barrier.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2024, by Samuel Williams.
 
 require_relative "../../../async/barrier"
 require "traces/provider"

data/lib/traces/provider/async/task.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require_relative "../../../async/task"
 require "traces/provider"

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2017-2024, by Samuel Williams.  
+Copyright, 2017-2025, by Samuel Williams.  
 Copyright, 2017, by Kent Gruber.  
 Copyright, 2017, by Devin Christensen.  
 Copyright, 2018, by Sokolov Yura.  
@@ -27,6 +27,11 @@ Copyright, 2023, by Emil Tin.
 Copyright, 2023, by Gert Goet.  
 Copyright, 2024, by Dimitar Peychinov.  
 Copyright, 2024, by Jamie McCarthy.  
+Copyright, 2025, by Jahfer Husain.  
+Copyright, 2025, by Mark Montroy.  
+Copyright, 2025, by Shigeru Nakajima.  
+Copyright, 2025, by Alan Wu.  
+Copyright, 2025, by Shopify Inc.  
 
 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

@@ -35,6 +35,12 @@ Please see the [project documentation](https://socketry.github.io/async/) for mo
 
 Please see the [project releases](https://socketry.github.io/async/releases/index) for all releases.
 
+### v2.25.0
+
+  - Added support for `io_select` hook in the fiber scheduler, allowing non-blocking `IO.select` operations. This enables better integration with code that uses `IO.select` for multiplexing IO operations.
+  - [Use `IO::Event::WorkerPool` for Blocking Operations](https://socketry.github.io/async/releases/index#use-io::event::workerpool-for-blocking-operations)
+  - [Better handling of `IO#close` using `fiber_interrupt`](https://socketry.github.io/async/releases/index#better-handling-of-io#close-using-fiber_interrupt)
+
 ### v2.24.0
 
   - Ruby v3.1 support is dropped.

data/releases.md

@@ -1,5 +1,32 @@
 # Releases
 
+## v2.25.0
+
+  - Added support for `io_select` hook in the fiber scheduler, allowing non-blocking `IO.select` operations. This enables better integration with code that uses `IO.select` for multiplexing IO operations.
+
+### Use `IO::Event::WorkerPool` for Blocking Operations
+
+The `Async::WorkerPool` implementation has been removed in favor of using `IO::Event::WorkerPool` directly. This change simplifies the codebase by delegating worker pool functionality to the `io-event` gem, which provides a more efficient and well-tested implementation.
+
+To enable the worker pool, you can set the `ASYNC_SCHEDULER_WORKER_POOL` environment variable to `true`. This will allow the scheduler to use a worker pool for blocking operations, which can help improve performance in applications that perform a lot of CPU-bound operations (e.g. `rb_nogvl`).
+
+### Better handling of `IO#close` using `fiber_interrupt`
+
+`IO#close` interrupts fibers that are waiting on the IO using the new `fiber_interrupt` hook introduced in Ruby 3.5/4.0. This means that if you close an IO while a fiber is waiting on it, the fiber will be interrupted and will raise an `IOError`. This is a change from previous versions of Ruby, where closing an IO would not interrupt fibers waiting on it, and would instead interrupt the entire event loop (essentially a bug).
+
+``` ruby
+r, w = IO.pipe
+
+Async do
+	child = Async do
+		r.gets
+	end
+	
+	r.close # This will interrupt the child fiber.
+	child.wait # This will raise an `IOError` because the IO was closed.
+end
+```
+
 ## v2.24.0
 
   - Ruby v3.1 support is dropped.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 2.24.0
+  version: 2.25.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -13,21 +13,26 @@ authors:
 - Emil Tin
 - Jamie McCarthy
 - Kent Gruber
+- Alan Wu
 - Brian Morearty
 - Colin Kelley
 - Dimitar Peychinov
 - Gert Goet
+- Jahfer Husain
 - Jiang Jinyang
 - Julien Portalier
 - Jun Jiang
 - Ken Muryoi
 - Leon Löchner
+- Mark Montroy
 - Masafumi Okura
 - Masayuki Yamamoto
 - Math Ieu
 - Ryan Musgrave
 - Salim Semaoune
 - Shannon Skipper
+- Shigeru Nakajima
+- Shopify Inc.
 - Sokolov Yura
 - Stefan Wrobel
 - Trevor Turk
@@ -62,7 +67,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-05-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -98,42 +103,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: traces
+  name: metrics
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: metrics
+  name: traces
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.15'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -162,7 +167,6 @@ files:
 - lib/async/version.rb
 - lib/async/waiter.md
 - lib/async/waiter.rb
-- lib/async/worker_pool.rb
 - lib/kernel/async.rb
 - lib/kernel/sync.rb
 - lib/metrics/provider/async.rb
@@ -187,14 +191,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A concurrency framework for Ruby.
 test_files: []

data/lib/async/worker_pool.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
-
-require "etc"
-
-module Async
-	# A simple work pool that offloads work to a background thread.
-	#
-	# @private
-	class WorkerPool
-		# Used to augment the scheduler to add support for blocking operations.
-		module BlockingOperationWait
-			# Wait for the given work to be executed.
-			#
-			# @public Since *Async v2.21* and *Ruby v3.4*.
-			# @asynchronous May be non-blocking.
-			#
-			# @parameter work [Proc] The work to execute on a background thread.
-			# @returns [Object] The result of the work.
-			def blocking_operation_wait(work)
-				@worker_pool.call(work)
-			end
-		end
-		
-		# Execute the given work in a background thread.
-		class Promise
-			# Create a new promise.
-			#
-			# @parameter work [Proc] The work to be done.
-			def initialize(work)
-				@work = work
-				@state = :pending
-				@value = nil
-				@guard = ::Mutex.new
-				@condition = ::ConditionVariable.new
-				@thread = nil
-			end
-			
-			# Execute the work and resolve the promise.
-			def call
-				work = nil
-				
-				@guard.synchronize do
-					@thread = ::Thread.current
-					
-					return unless work = @work
-				end
-				
-				resolve(work.call)
-			rescue Exception => error
-				reject(error)
-			end
-			
-			private def resolve(value)
-				@guard.synchronize do
-					@work = nil
-					@thread = nil
-					@value = value
-					@state = :resolved
-					@condition.broadcast
-				end
-			end
-			
-			private def reject(error)
-				@guard.synchronize do
-					@work = nil
-					@thread = nil
-					@value = error
-					@state = :failed
-					@condition.broadcast
-				end
-			end
-			
-			# Cancel the work and raise an exception in the background thread.
-			def cancel
-				return unless @work
-				
-				@guard.synchronize do
-					@work = nil
-					@state = :cancelled
-					@thread&.raise(Interrupt)
-				end
-			end
-			
-			# Wait for the work to be done.
-			#
-			# @returns [Object] The result of the work.
-			def wait
-				@guard.synchronize do
-					while @state == :pending
-						@condition.wait(@guard)
-					end
-					
-					if @state == :failed
-						raise @value
-					else
-						return @value
-					end
-				end
-			end
-		end
-		
-		# A background worker thread.
-		class Worker
-			# Create a new worker.
-			def initialize
-				@work = ::Thread::Queue.new
-				@thread = ::Thread.new(&method(:run))
-			end
-			
-			# Execute work until the queue is closed.
-			def run
-				while work = @work.pop
-					work.call
-				end
-			end
-			
-			# Close the worker thread.
-			def close
-				if thread = @thread
-					@thread = nil
-					thread.kill
-				end
-			end
-			
-			# Call the work and notify the scheduler when it is done.
-			def call(work)
-				promise = Promise.new(work)
-				
-				@work.push(promise)
-				
-				begin
-					return promise.wait
-				ensure
-					promise.cancel
-				end
-			end
-		end
-		
-		# Create a new work pool.
-		#
-		# @parameter size [Integer] The number of threads to use.
-		def initialize(size: Etc.nprocessors)
-			@ready = ::Thread::Queue.new
-			
-			size.times do
-				@ready.push(Worker.new)
-			end
-		end
-		
-		# Close the work pool. Kills all outstanding work.
-		def close
-			if ready = @ready
-				@ready = nil
-				ready.close
-				
-				while worker = ready.pop
-					worker.close
-				end
-			end
-		end
-		
-		# Offload work to a thread.
-		#
-		# @parameter work [Proc] The work to be done.
-		def call(work)
-			if ready = @ready
-				worker = ready.pop
-				
-				begin
-					worker.call(work)
-				ensure
-					ready.push(worker)
-				end
-			else
-				raise RuntimeError, "No worker available!"
-			end
-		end
-	end
-end