async 1.28.6 → 1.29.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f37f30a9b3c4eecb9dd393813bd30545b4c9e07529be6fda43f50c63c35bc53
-  data.tar.gz: 12e98fb9b1758199fd7e06a1ae4ac1e6b696844ceb42f75827905bd216a2b9fa
+  metadata.gz: 94443a93442232e8189364cd931084a0cf188a9adea3fe91287f192fed44fc2e
+  data.tar.gz: cec386ffc8948123aeb771866d639b9e49a66cdb8e32fa42e15f07bbd06bd78e
 SHA512:
-  metadata.gz: bf2e4696aae38b3c9e61ea1cba7c9eb115bab9646eae5e68459cc6f82a4b9e34010a6bd111f5983c2e902dd1f8db2ffafae56d3b520698d923cabf539ed35f39
-  data.tar.gz: c71f02fa817c1d21dbefe64ade8aea5cbdfc410550c46aee478fa36a040e099a6ac137d59c32f591acc1d3aed67c23bf6b0e0e89d7f0a84fbadc9c10710fdd54
+  metadata.gz: 3cf4de1694de02a5c291b124d1ee62020b8ab8997a1e951977e6450a526d00a236918af520e1e0c4e63036c50731a07932d734b8a1f4b825f17661cb30f23e0f
+  data.tar.gz: 0c157b4af9bdd4a3ade74ccc12a4f2ea79162d45395d28e34c30e2d7cb7535b9137d37ed0688852b0b52834cf38c7a4207b11797deaa201d08d227c4a6e714ce

data/lib/async/debug/monitor.rb

@@ -20,25 +20,23 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'delegate'
+
 module Async
 	module Debug
-		class Monitor
+		class Monitor < Delegator
 			def initialize(monitor, selector)
 				@monitor = monitor
 				@selector = selector
 			end
 			
-			def close
-				@selector.deregister(@monitor.io)
-				@monitor.close
+			def __getobj__
+				@monitor
 			end
 			
-			def method_missing(*arguments, &block)
-				@monitor.send(*arguments)
-			end
-			
-			def respond_to?(*arguments)
-				@monitor.respond_to?(*arguments)
+			def close
+				@selector.deregister(self)
+				@monitor.close
 			end
 			
 			def inspect

data/lib/async/debug/selector.rb

@@ -24,6 +24,7 @@ require_relative 'monitor'
 require_relative '../logger'
 
 require 'nio'
+require 'set'
 
 module Async
 	module Debug
@@ -36,7 +37,7 @@ module Async
 		class Selector
 			def initialize(selector = NIO::Selector.new)
 				@selector = selector
-				@monitors = {}
+				@monitors = Set.new
 			end
 			
 			def register(object, interests)
@@ -46,26 +47,18 @@ module Async
 					raise RuntimeError, "Could not convert #{io} into IO!"
 				end
 				
-				if monitor = @monitors[io.fileno]
-					raise RuntimeError, "Trying to register monitor for #{object.inspect} but it was already registered: #{monitor.inspect}!"
-				end
-				
 				monitor = Monitor.new(@selector.register(object, interests), self)
 				
-				@monitors[io.fileno] = monitor
+				@monitors.add(monitor)
 				
 				return monitor
 			end
 			
-			def deregister(object)
-				Async.logger.debug(self) {"Deregistering #{object.inspect}."}
-				
-				unless io = ::IO.try_convert(object)
-					raise RuntimeError, "Could not convert #{io} into IO!"
-				end
+			def deregister(monitor)
+				Async.logger.debug(self) {"Deregistering #{monitor.inspect}."}
 				
-				unless @monitors.delete(io.fileno)
-					raise RuntimeError, "Trying to remove monitor for #{io.inspect} but it was not registered!"
+				unless @monitors.delete?(monitor)
+					raise RuntimeError, "Trying to remove monitor for #{monitor.inspect} but it was not registered!"
 				end
 			end
 			
@@ -75,7 +68,7 @@ module Async
 			
 			def close
 				if @monitors.any?
-					raise LeakError, @monitors.values
+					raise LeakError, @monitors
 				end
 			ensure
 				@selector.close

data/lib/async/node.rb

@@ -24,6 +24,7 @@ module Async
 	# A double linked list.
 	class List
 		def initialize
+			# The list behaves like a list node, so @tail points to the next item (the first one) and head points to the previous item (the last one). This may be slightly confusing but it makes the interface more natural.
 			@head = nil
 			@tail = nil
 			@size = 0
@@ -36,21 +37,21 @@ module Async
 		
 		# Inserts an item at the end of the list.
 		def insert(item)
-			unless @head
-				@head = item
+			unless @tail
 				@tail = item
+				@head = item
 				
 				# Consistency:
 				item.head = nil
 				item.tail = nil
 			else
-				@tail.tail = item
-				item.head = @tail
+				@head.tail = item
+				item.head = @head
 				
 				# Consistency:
 				item.tail = nil
 				
-				@tail = item
+				@head = item
 			end
 			
 			@size += 1
@@ -59,14 +60,14 @@ module Async
 		end
 		
 		def delete(item)
-			if @head.equal?(item)
-				@head = @head.tail
+			if @tail.equal?(item)
+				@tail = @tail.tail
 			else
 				item.head.tail = item.tail
 			end
 			
-			if @tail.equal?(item)
-				@tail = @tail.head
+			if @head.equal?(item)
+				@head = @head.head
 			else
 				item.tail.head = item.head
 			end
@@ -79,15 +80,17 @@ module Async
 			return self
 		end
 		
-		def each
+		def each(&block)
 			return to_enum unless block_given?
 			
-			item = @head
-			while item
-				# We store the tail pointer so we can remove the current item from the linked list:
-				tail = item.tail
-				yield item
-				item = tail
+			current = self
+			while node = current.tail
+				yield node
+				
+				# If the node has deleted itself or any subsequent node, it will no longer be the next node, so don't use it for continued traversal:
+				if current.tail.equal?(node)
+					current = node
+				end
 			end
 		end
 		
@@ -100,19 +103,19 @@ module Async
 		end
 		
 		def first
-			@head
+			@tail
 		end
 		
 		def last
-			@tail
+			@head
 		end
 		
 		def empty?
-			@head.nil?
+			@tail.nil?
 		end
 		
 		def nil?
-			@head.nil?
+			@tail.nil?
 		end
 	end
 	
@@ -276,6 +279,8 @@ module Async
 						if child.finished?
 							delete_child(child)
 						else
+							# In theory we don't need to do this... because we are throwing away the list. However, if you don't correctly update the list when moving the child to the parent, it foobars the enumeration, and subsequent nodes will be skipped, or in the worst case you might start enumerating the parents nodes.
+							delete_child(child)
 							parent.add_child(child)
 						end
 					end
@@ -297,8 +302,31 @@ module Async
 			end
 		end
 		
-		def stop
-			@children&.each(&:stop)
+		# Immediately terminate all children tasks, including transient tasks.
+		# Internally invokes `stop(false)` on all children.
+		def terminate
+			# Attempt to stop the current task immediately, and all children:
+			stop(false)
+			
+			# If that doesn't work, take more serious action:
+			@children&.each do |child|
+				child.terminate
+			end
+		end
+		
+		# Attempt to stop the current node immediately, including all non-transient children.
+		# Invokes {#stop_children} to stop all children.
+		# @parameter later [Boolean] Whether to defer stopping until some point in the future.
+		def stop(later = false)
+			# The implementation of this method may defer calling `stop_children`.
+			stop_children(later)
+		end
+		
+		# Attempt to stop all non-transient children.
+		private def stop_children(later = false)
+			@children&.each do |child|
+				child.stop(later) unless child.transient?
+			end
 		end
 		
 		def print_hierarchy(out = $stdout, backtrace: true)

data/lib/async/reactor.rb

@@ -47,9 +47,7 @@ module Async
 		# running.
 		def self.run(*arguments, **options, &block)
 			if current = Task.current?
-				reactor = current.reactor
-				
-				return reactor.async(*arguments, **options, &block)
+				return current.async(*arguments, **options, &block)
 			else
 				reactor = self.new
 				
@@ -96,6 +94,7 @@ module Async
 		end
 		
 		attr :scheduler
+		attr :logger
 		
 		# @reentrant Not thread safe.
 		def block(blocker, timeout)
@@ -111,7 +110,7 @@ module Async
 			
 			begin
 				@blocked += 1
-				Fiber.yield
+				Task.yield
 			ensure
 				@blocked -= 1
 			end
@@ -135,10 +134,6 @@ module Async
 			end
 		end
 		
-		def logger
-			@logger || Console.logger
-		end
-		
 		def to_s
 			"\#<#{self.description} #{@children&.size || 0} children (#{stopped? ? 'stopped' : 'running'})>"
 		end
@@ -167,7 +162,7 @@ module Async
 			# - Avoid scheduler overhead if no blocking operation is performed.
 			task.run(*arguments)
 			
-			# logger.debug "Initial execution of task #{fiber} complete (#{result} -> #{fiber.alive?})..."
+			# Console.logger.debug "Initial execution of task #{fiber} complete (#{result} -> #{fiber.alive?})..."
 			return task
 		end
 		
@@ -198,7 +193,7 @@ module Async
 		def yield(fiber = Fiber.current)
 			@ready << fiber
 			
-			Fiber.yield
+			Task.yield
 		end
 		
 		def finished?
@@ -210,7 +205,7 @@ module Async
 		# @param timeout [Float | nil] the maximum timeout, or if nil, indefinite.
 		# @return [Boolean] whether there is more work to do.
 		def run_once(timeout = nil)
-			# logger.debug(self) {"@ready = #{@ready} @running = #{@running}"}
+			# Console.logger.debug(self) {"@ready = #{@ready} @running = #{@running}"}
 			
 			if @ready.any?
 				# running used to correctly answer on `finished?`, and to reuse Array object.
@@ -258,7 +253,7 @@ module Async
 				interval = timeout
 			end
 			
-			# logger.info(self) {"Selecting with #{@children&.size} children with interval = #{interval ? interval.round(2) : 'infinite'}..."}
+			# Console.logger.info(self) {"Selecting with #{@children&.size} children with interval = #{interval ? interval.round(2) : 'infinite'}..."}
 			if monitors = @selector.select(interval)
 				monitors.each do |monitor|
 					monitor.value.resume
@@ -295,35 +290,26 @@ module Async
 			return initial_task
 		ensure
 			@scheduler&.clear!
-			logger.debug(self) {"Exiting run-loop because #{$! ? $! : 'finished'}."}
-		end
-		
-		def stop(later = true)
-			@children&.each do |child|
-				# We don't want this process to propagate `Async::Stop` exceptions, so we schedule tasks to stop later.
-				child.stop(later)
-			end
+			Console.logger.debug(self) {"Exiting run-loop because #{$! ? $! : 'finished'}."}
 		end
 		
 		# Stop each of the children tasks and close the selector.
-		# 
-		# @return [void]
 		def close
-			# This is a critical step. Because tasks could be stored as instance variables, and since the reactor is (probably) going out of scope, we need to ensure they are stopped. Otherwise, the tasks will belong to a reactor that will never run again and are not stopped.
-			self.stop(false)
+			# This is a critical step. Because tasks could be stored as instance variables, and since the reactor is (probably) going out of scope, we need to ensure they are stopped. Otherwise, the tasks will belong to a reactor that will never run again and are not stopped:
+			self.terminate
 			
 			@selector.close
 			@selector = nil
 		end
 		
 		# Check if the selector has been closed.
-		# @return [Boolean]
+		# @returns [Boolean]
 		def closed?
 			@selector.nil?
 		end
 		
 		# Put the calling fiber to sleep for a given ammount of time.
-		# @param duration [Numeric] The time in seconds, to sleep for.
+		# @parameter duration [Numeric] The time in seconds, to sleep for.
 		def sleep(duration)
 			fiber = Fiber.current
 			
@@ -347,7 +333,7 @@ module Async
 			timer = @timers.after(timeout) do
 				if fiber.alive?
 					error = exception.new("execution expired")
-					fiber.resume error
+					fiber.resume(error)
 				end
 			end
 			

data/lib/async/scheduler.rb

@@ -68,6 +68,8 @@ module Async
 			end
 			
 			return false
+		rescue TimeoutError
+			return nil
 		ensure
 			wrapper.reactor = nil
 		end

data/lib/async/task.rb

@@ -81,11 +81,13 @@ module Async
 			@result = nil
 			@finished = finished
 			
-			@logger = logger
+			@logger = logger || @parent.logger
 			
 			@fiber = make_fiber(&block)
 		end
 		
+		attr :logger
+		
 		if Fiber.current.respond_to?(:backtrace)
 			def backtrace(*arguments)
 				@fiber&.backtrace(*arguments)
@@ -96,10 +98,6 @@ module Async
 			"\#<#{self.description} (#{@status})>"
 		end
 		
-		def logger
-			@logger || Console.logger
-		end
-		
 		# @attr ios [Reactor] The reactor the task was created within.
 		attr :reactor
 		
@@ -158,7 +156,6 @@ module Async
 		# Soon to become attr :result
 		
 		# Stop the task and all of its children.
-		# @return [void]
 		def stop(later = false)
 			if self.stopped?
 				# If we already stopped this task... don't try to stop it again:
@@ -242,9 +239,9 @@ module Async
 				raise
 			elsif @finished.nil?
 				# If no one has called wait, we log this as an error:
-				logger.error(self) {$!}
+				Console.logger.error(self) {$!}
 			else
-				logger.debug(self) {$!}
+				Console.logger.debug(self) {$!}
 			end
 		end
 		
@@ -252,9 +249,7 @@ module Async
 			# logger.debug(self) {"Task was stopped with #{@children&.size.inspect} children!"}
 			@status = :stopped
 			
-			@children&.each do |child|
-				child.stop(true)
-			end
+			stop_children(true)
 		end
 		
 		def make_fiber(&block)
@@ -264,7 +259,7 @@ module Async
 				begin
 					@result = yield(self, *arguments)
 					@status = :complete
-					# logger.debug(self) {"Task was completed with #{@children.size} children!"}
+					# Console.logger.debug(self) {"Task was completed with #{@children.size} children!"}
 				rescue Stop
 					stop!
 				rescue StandardError => error
@@ -272,7 +267,7 @@ module Async
 				rescue Exception => exception
 					fail!(exception, true)
 				ensure
-					# logger.debug(self) {"Task ensure $!=#{$!} with #{@children.size} children!"}
+					# Console.logger.debug(self) {"Task ensure $!=#{$!} with #{@children.size} children!"}
 					finish!
 				end
 			end

data/lib/async/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Async
-	VERSION = "1.28.6"
+	VERSION = "1.29.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.28.6
+  version: 1.29.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A concurrency framework for Ruby.