async 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c732b7d676e5d1248189f0e3b9fbce25c44026633bd2094c30a94c7a82ee40a3
-  data.tar.gz: a668963f5721f56883ca4fecd7fda0b198f9b8ec2e4276fb126d30d547d18589
+  metadata.gz: 0f62c8150ba7dba6f26532b080a4c99ecde97d86cf5f31746aec706d12644550
+  data.tar.gz: 99bbe4f65da2c18ab75bc67377896b7b6c26f6056eb789ef22d5601f43526228
 SHA512:
-  metadata.gz: 2480c08bd9dcd8ebfefcabb02d347f3b1aa3f4485202f101b351ac3b585390c2f5471f21fa34c959483ad2b976d6491b49c8dd63b869776f40157011e25a3404
-  data.tar.gz: 68b04041436ba8080614878d6903b7658ffe8a6c092b6ba38efa41e0fa9e9bdb1cffbcff7ed299f206c431b56ef8bbb089b1a07689c60c0eda3e34cd32ed9337
+  metadata.gz: 3c6a7fee5fb6d429b7533afb80dd38ad499c8dd313ee5f881cdd19479a8f1f28072f16f07f83305f6d2e6ddaa7907859938fcd69e2fc7b0e945b194588fd22e2
+  data.tar.gz: f10a739ba6013c928199c4abe884e9dbf9d4d48d7f8329ed3977bb9230584d100505d617a859c113bf04c25cbf9ae4353e525221563f930227467cbaebf153b1

data/lib/async/node.rb

@@ -5,6 +5,8 @@
 # Copyright, 2017, by Kent Gruber.
 # Copyright, 2022, by Shannon Skipper.
 
+require 'fiber/annotation'
+
 require_relative 'list'
 
 module Async
@@ -109,20 +111,27 @@ module Async
 		
 		def annotate(annotation)
 			if block_given?
-				previous_annotation = @annotation
-				@annotation = annotation
-				yield
-				@annotation = previous_annotation
+				begin
+					current_annotation = @annotation
+					@annotation = annotation
+					return yield
+				ensure
+					@annotation = current_annotation
+				end
 			else
 				@annotation = annotation
 			end
 		end
 		
+		def annotation
+			@annotation
+		end
+		
 		def description
 			@object_name ||= "#{self.class}:#{format '%#018x', object_id}#{@transient ? ' transient' : nil}"
 			
-			if @annotation
-				"#{@object_name} #{@annotation}"
+			if annotation = self.annotation
+				"#{@object_name} #{annotation}"
 			elsif line = self.backtrace(0, 1)&.first
 				"#{@object_name} #{line}"
 			else

data/lib/async/scheduler.rb

@@ -17,6 +17,12 @@ require 'resolv'
 module Async
 	# Handles scheduling of fibers. Implements the fiber scheduler interface.
 	class Scheduler < Node
+		class ClosedError < RuntimeError
+			def initialize(message = "Scheduler is closed!")
+				super
+			end
+		end
+		
 		# Whether the fiber scheduler is supported.
 		# @public Since `stable-v1`.
 		def self.supported?
@@ -150,6 +156,9 @@ module Async
 		
 		# @asynchronous May be non-blocking..
 		def address_resolve(hostname)
+			# On some platforms, hostnames may contain a device-specific suffix (e.g. %en0). We need to strip this before resolving.
+			# See <https://github.com/socketry/async/issues/180> for more details.
+			hostname = hostname.split("%", 2).first
 			::Resolv.getaddresses(hostname)
 		end
 		
@@ -179,8 +188,10 @@ module Async
 				@selector.io_read(Fiber.current, io, buffer, length, offset)
 			end
 			
-			def io_write(io, buffer, length, offset = 0)
-				@selector.io_write(Fiber.current, io, buffer, length, offset)
+			if RUBY_ENGINE != "ruby" || RUBY_VERSION >= "3.3.0"
+				def io_write(io, buffer, length, offset = 0)
+					@selector.io_write(Fiber.current, io, buffer, length, offset)
+				end
 			end
 		end
 		
@@ -231,7 +242,7 @@ module Async
 		
 		# Run the reactor until all tasks are finished. Proxies arguments to {#async} immediately before entering the loop, if a block is provided.
 		def run(...)
-			Kernel::raise RuntimeError, 'Reactor has been closed' if @selector.nil?
+			Kernel::raise ClosedError if @selector.nil?
 			
 			initial_task = self.async(...) if block_given?
 			
@@ -258,6 +269,8 @@ module Async
 		# @returns [Task] The task that was scheduled into the reactor.
 		# @deprecated With no replacement.
 		def async(*arguments, **options, &block)
+			Kernel::raise ClosedError if @selector.nil?
+			
 			task = Task.new(Task.current? || self, **options, &block)
 			
 			# I want to take a moment to explain the logic of this.

data/lib/async/task.rb

@@ -59,6 +59,12 @@ module Async
 	#
 	# @public Since `stable-v1`.
 	class Task < Node
+		class FinishedError < RuntimeError
+			def initialize(message = "Cannot create child task within a task that has finished execution!")
+				super
+			end
+		end
+		
 		# @deprecated With no replacement.
 		def self.yield
 			Fiber.scheduler.transfer
@@ -90,6 +96,22 @@ module Async
 			@fiber&.backtrace(*arguments)
 		end
 		
+		def annotate(annotation, &block)
+			if @fiber
+				@fiber.annotate(annotation, &block)
+			else
+				super
+			end
+		end
+		
+		def annotation
+			if @fiber
+				@fiber.annotation
+			else
+				super
+			end
+		end
+		
 		def to_s
 			"\#<#{self.description} (#{@status})>"
 		end
@@ -164,7 +186,7 @@ module Async
 		
 		# Run an asynchronous task as a child of the current task.
 		def async(*arguments, **options, &block)
-			raise "Cannot create child task within a task that has finished execution!" if self.finished?
+			raise FinishedError if self.finished?
 			
 			task = Task.new(self, **options, &block)
 			
@@ -199,6 +221,10 @@ module Async
 		attr :result
 		
 		# Stop the task and all of its children.
+		#
+		# If `later` is false, it means that `stop` has been invoked directly. When `later` is true, it means that `stop` is invoked by `stop_children` or some other indirect mechanism. In that case, if we encounter the "current" fiber, we can't stop it right away, as it's currently performing `#stop`. Stopping it immediately would interrupt the current stop traversal, so we need to schedule the stop to occur later.
+		#
+		# @parameter later [Boolean] Whether to stop the task later, or immediately.
 		def stop(later = false)
 			if self.stopped?
 				# If we already stopped this task... don't try to stop it again:
@@ -208,6 +234,7 @@ module Async
 			# If the fiber is alive, we need to stop it:
 			if @fiber&.alive?
 				if self.current?
+					# If the fiber is current, and later is `true`, we need to schedule the fiber to be stopped later, as it's currently invoking `stop`:
 					if later
 						# If the fiber is the current fiber and we want to stop it later, schedule it:
 						Fiber.scheduler.push(Stop::Later.new(self))
@@ -218,6 +245,7 @@ module Async
 				else
 					# If the fiber is not curent, we can raise the exception directly:
 					begin
+						# There is a chance that this will stop the fiber that originally called stop. If that happens, the exception handling in `#stopped` will rescue the exception and re-raise it later.
 						Fiber.scheduler.raise(@fiber, Stop)
 					rescue FiberError
 						# In some cases, this can cause a FiberError (it might be resumed already), so we schedule it to be stopped later:
@@ -244,7 +272,7 @@ module Async
 		end
 		
 		def current?
-			self.equal?(Thread.current[:async_task])
+			Fiber.current.equal?(@fiber)
 		end
 		
 		private
@@ -289,11 +317,23 @@ module Async
 		end
 		
 		def stopped!
-			# Console.logger.info(self, self.annotation) {"Task was stopped with #{@children&.size.inspect} children!"}
+			# Console.logger.info(self, status:) {"Task #{self} was stopped with #{@children&.size.inspect} children!"}
 			@status = :stopped
 			
-			# We are not running, but children might be so we should stop them:
-			stop_children(true)
+			stopped = false
+			
+			begin
+				# We are bnot running, but children might be so we should stop them:
+				stop_children(true)
+			rescue Stop
+				stopped = true
+				# If we are stopping children, and one of them tries to stop the current task, we should ignore it. We will be stopped later.
+				retry
+			end
+			
+			if stopped
+				raise Stop, "Stopping current task!"
+			end
 		end
 		
 		def stop!
@@ -303,7 +343,7 @@ module Async
 		end
 		
 		def schedule(&block)
-			@fiber = Fiber.new do
+			@fiber = Fiber.new(annotation: self.annotation) do
 				set!
 				
 				begin

data/lib/async/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2017-2022, by Samuel Williams.
 
 module Async
-	VERSION = "2.5.0"
+	VERSION = "2.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -56,7 +56,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: fiber-annotation
+  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: bake-test
   requirement: !ruby/object:Gem::Requirement
@@ -247,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A concurrency framework for Ruby.