polyphony 0.71 → 0.74

data/lib/polyphony/extensions/fiber.rb

@@ -1,25 +1,46 @@
 # frozen_string_literal: true
 
-require 'fiber'
-
 require_relative '../core/exceptions'
 
 module Polyphony
   # Fiber control API
   module FiberControl
+    # Returns the fiber's monitoring mailbox queue, used for receiving fiber
+    # monitoring messages.
+    #
+    # @return [Polyphony::Queue] Monitoring mailbox queue
     def monitor_mailbox
       @monitor_mailbox ||= Polyphony::Queue.new
     end
 
+    # call-seq:
+    #   fiber.stop(value = nil) -> fiber
+    #   Fiber.interrupt(value = nil) -> fiber
+    #
+    # Stops the fiber by raising a Polyphony::MoveOn exception. The given value
+    # will become the fiber's return value.
+    #
+    # @param value [any] Fiber's eventual return value
+    # @return [Fiber] fiber
     def interrupt(value = nil)
       return if @running == false
 
       schedule Polyphony::MoveOn.new(value)
+      self
     end
     alias_method :stop, :interrupt
 
+    # call-seq:
+    #   fiber.reset(value = nil) -> fiber
+    #   fiber.restart(value = nil) -> fiber
+    #
+    # Restarts the fiber, with the given value serving as the first value passed
+    # to the fiber's block.
+    #
+    # @param value [any] value passed to fiber block
+    # @return [Fiber] restarted fiber
     def restart(value = nil)
-      raise "Can''t restart main fiber" if @main
+      raise "Can't restart main fiber" if @main
 
       if @running
         schedule Polyphony::Restart.new(value)
@@ -33,32 +54,58 @@ module Polyphony
     end
     alias_method :reset, :restart
 
+    # Stops a fiber by raising a Polyphony::Cancel exception.
+    #
+    # @return [Fiber] fiber
     def cancel
       return if @running == false
 
       schedule Polyphony::Cancel.new
+      self
     end
 
+    # Sets the graceful shutdown flag for the fiber.
+    #
+    # @param graceful [bool] Whether or not to perform a graceful shutdown
     def graceful_shutdown=(graceful)
       @graceful_shutdown = graceful
     end
 
+    # Returns the graceful shutdown flag for the fiber.
+    #
+    # @return [bool]
     def graceful_shutdown?
       @graceful_shutdown
     end
 
+    # Terminates the fiber, optionally setting the graceful shutdown flag.
+    #
+    # @param graceful [bool] Whether to perform a graceful shutdown
+    # @return [Fiber]
     def terminate(graceful = false)
       return if @running == false
 
       @graceful_shutdown = graceful
       schedule Polyphony::Terminate.new
-    end
-
+      self
+    end
+
+    # call-seq:
+    #   fiber.raise(message) -> fiber
+    #   fiber.raise(exception_class) -> fiber
+    #   fiber.raise(exception_class, exception_message) -> fiber
+    #   fiber.raise(exception) -> fiber
+    #
+    # Raises an exception in the context of the fiber.
+    #
+    # @return [Fiber]
     def raise(*args)
       error = error_from_raise_args(args)
       schedule(error)
+      self
     end
 
+    # :no-doc:
     def error_from_raise_args(args)
       case (arg = args.shift)
       when String then RuntimeError.new(arg)
@@ -83,6 +130,8 @@ module Polyphony
     def supervise(*fibers, **opts, &block)
       block ||= supervise_opts_to_block(opts)
 
+      @supervise_mode = true
+      fibers = children if fibers.empty?
       fibers.each do |f|
         f.attach_to(self) unless f.parent == self
         f.monitor(self)
@@ -94,15 +143,18 @@ module Polyphony
         (fiber, result) = mailbox.shift
         block&.call(fiber, result)
       end
+    ensure
+      @supervise_mode = false
     end
 
     def supervise_opts_to_block(opts)
       block = opts[:on_done] || opts[:on_error]
-      return nil unless block || opts[:restart]
+      restart = opts[:restart]
+      return nil unless block || restart
 
       error_only = !!opts[:on_error]
-      restart_always = opts[:restart] == :always
-      restart_on_error = opts[:restart] == :on_error
+      restart_always = (restart == :always) || (restart == true)
+      restart_on_error = restart == :on_error
 
       ->(f, r) do
         is_error = r.is_a?(Exception)
@@ -114,6 +166,17 @@ module Polyphony
 
   # Class methods for controlling fibers (namely await and select)
   module FiberControlClassMethods
+    # call-seq:
+    #   Fiber.await(*fibers) -> [*results]
+    #   Fiber.join(*fibers) -> [*results]
+    #
+    # Waits for all given fibers to terminate, then returns the respective
+    # return values for all terminated fibers. If any of the awaited fibers
+    # terminates with an uncaught exception, `Fiber.await` will await all the
+    # other fibers to terminate, then reraise the exception.
+    #
+    # @param *fibers [Array<Fiber>] fibers to wait for
+    # @return [Array<any>] return values of given fibers
     def await(*fibers)
       return [] if fibers.empty?
 
@@ -147,9 +210,15 @@ module Polyphony
     end
     alias_method :join, :await
 
+    # Waits for at least one of the given fibers to terminate, returning an
+    # array containing the first terminated fiber and its return value. If an
+    # exception occurs in one of the given fibers, it will be reraised.
+    #
+    # @param *fibers [Array<Fiber>] Fibers to wait for
+    # @return [Array] Array containing the first terminated fiber and its return value
     def select(*fibers)
       return nil if fibers.empty?
-  
+
       current_fiber = self.current
       mailbox = current_fiber.monitor_mailbox
       fibers.each do |f|
@@ -163,7 +232,7 @@ module Polyphony
       while true
         (fiber, result) = mailbox.shift
         next unless fibers.include?(fiber)
-  
+
         fibers.each { |f| f.unmonitor(current_fiber) }
         if result.is_a?(Exception)
           raise result
@@ -197,6 +266,7 @@ module Polyphony
 
     def add_child(child_fiber)
       (@children ||= {})[child_fiber] = true
+      child_fiber.monitor(self) if @supervise_mode
     end
 
     def remove_child(child_fiber)
@@ -207,6 +277,7 @@ module Polyphony
       f = Fiber.new { |v| f.run(v) }
       f.prepare(tag, block, orig_caller, self)
       (@children ||= {})[f] = true
+      f.monitor(self) if @supervise_mode
       f
     end
 
@@ -237,10 +308,15 @@ module Polyphony
       end
     end
 
+    def attach_all_children_to(fiber)
+      @children&.keys.each { |c| c.attach_to(fiber) }
+    end
+
     def detach
       @parent.remove_child(self)
       @parent = @thread.main_fiber
       @parent.add_child(self)
+      self
     end
 
     def attach_to(fiber)
@@ -328,7 +404,7 @@ module Polyphony
     # the children are shut down, it is returned along with the uncaught_exception
     # flag set. Otherwise, it returns the given arguments.
     def finalize_children(result, uncaught_exception)
-      shutdown_all_children
+      shutdown_all_children(graceful_shutdown?)
       [result, uncaught_exception]
     rescue Exception => e
       [e, true]

data/lib/polyphony/extensions/io.rb

@@ -103,7 +103,7 @@ class ::IO
   alias_method :orig_getc, :getc
   def getc
     return @read_buffer.slice!(0) if @read_buffer && !@read_buffer.empty?
-    
+
     @read_buffer ||= +''
     Polyphony.backend_read(self, @read_buffer, 8192, false, -1)
     return @read_buffer.slice!(0) if !@read_buffer.empty?
@@ -116,7 +116,7 @@ class ::IO
     if buf
       return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    
+
     @read_buffer ||= +''
     result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
     return nil unless result

data/lib/polyphony/extensions/{core.rb → kernel.rb}

@@ -1,73 +1,7 @@
 # frozen_string_literal: true
 
-require 'fiber'
-require 'timeout'
 require 'open3'
 
-require_relative '../core/exceptions'
-
-# Exeption overrides
-class ::Exception
-  class << self
-    attr_accessor :__disable_sanitized_backtrace__
-  end
-
-  attr_accessor :source_fiber, :raising_fiber
-
-  alias_method :orig_initialize, :initialize
-  def initialize(*args)
-    @raising_fiber = Fiber.current
-    orig_initialize(*args)
-  end
-
-  alias_method :orig_backtrace, :backtrace
-  def backtrace
-    unless @backtrace_called
-      @backtrace_called = true
-      return orig_backtrace
-    end
-
-    sanitized_backtrace
-  end
-
-  def sanitized_backtrace
-    return sanitize(orig_backtrace) unless @raising_fiber
-
-    backtrace = orig_backtrace || []
-    sanitize(backtrace + @raising_fiber.caller)
-  end
-
-  POLYPHONY_DIR = File.expand_path(File.join(__dir__, '..'))
-
-  def sanitize(backtrace)
-    return backtrace if ::Exception.__disable_sanitized_backtrace__
-
-    backtrace.reject { |l| l[POLYPHONY_DIR] }
-  end
-
-  def invoke
-    Kernel.raise(self)
-  end
-end
-
-# Overrides for Process
-module ::Process
-  class << self
-    alias_method :orig_detach, :detach
-    def detach(pid)
-      fiber = spin { Polyphony.backend_waitpid(pid) }
-      fiber.define_singleton_method(:pid) { pid }
-      fiber
-    end
-
-    alias_method :orig_daemon, :daemon
-    def daemon(*args)
-      orig_daemon(*args)
-      Polyphony.original_pid = Process.pid
-    end
-  end
-end
-
 # Kernel extensions (methods available to all objects / call sites)
 module ::Kernel
   alias_method :orig_sleep, :sleep
@@ -159,10 +93,3 @@ module ::Kernel
     end
   end
 end
-
-# Override Timeout to use cancel scope
-module ::Timeout
-  def self.timeout(sec, klass = Timeout::Error, message = 'execution expired', &block)
-    cancel_after(sec, with_exception: [klass, message], &block)
-  end
-end

data/lib/polyphony/extensions/openssl.rb

@@ -130,24 +130,32 @@ class ::OpenSSL::SSL::SSLServer
       end
     end
 
+    # STDOUT.puts 'SSLServer#accept'
     sock, = @svr.accept
+    # STDOUT.puts "- raw sock: #{sock.inspect}"
     begin
       ssl = OpenSSL::SSL::SSLSocket.new(sock, @ctx)
+      # STDOUT.puts "- ssl sock: #{ssl.inspect}"
       ssl.sync_close = true
       if @use_accept_worker
+        # STDOUT.puts "- send to accept worker"
         @accept_worker_fiber << [ssl, Fiber.current]
-        receive
+        # STDOUT.puts "- wait for accept worker"
+        r = receive
+        # STDOUT.puts "- got reply from accept worker: #{r.inspect}"
+        r.invoke if r.is_a?(Exception)
       else
         ssl.accept
       end
       ssl
-    rescue Exception => ex
+    rescue Exception => e
+      # STDOUT.puts "- accept exception: #{e.inspect}"
       if ssl
         ssl.close
       else
         sock.close
       end
-      raise ex
+      raise e
     end
   end
 
@@ -156,11 +164,18 @@ class ::OpenSSL::SSL::SSLServer
     @accept_worker_thread = Thread.new do
       fiber << Fiber.current
       loop do
+        # STDOUT.puts "- accept_worker wait for work"
         socket, peer = receive
+        # STDOUT.puts "- accept_worker got socket from peer #{peer.inspect}"
         socket.accept
+        # STDOUT.puts "- accept_worker accept returned"
         peer << socket
-      rescue => e
-        peer.schedule(e) if fiber
+        # STDOUT.puts "- accept_worker sent socket back to peer"
+      rescue Polyphony::BaseException
+        raise
+      rescue Exception => e
+        # STDOUT.puts "- accept_worker error: #{e}"
+        peer << e if peer
       end
     end
     @accept_worker_fiber = receive

data/lib/polyphony/extensions/process.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Overrides for Process
+module ::Process
+  class << self
+    alias_method :orig_detach, :detach
+    def detach(pid)
+      fiber = spin { Polyphony.backend_waitpid(pid) }
+      fiber.define_singleton_method(:pid) { pid }
+      fiber
+    end
+
+    alias_method :orig_daemon, :daemon
+    def daemon(*args)
+      orig_daemon(*args)
+      Polyphony.original_pid = Process.pid
+    end
+  end
+end

data/lib/polyphony/extensions/socket.rb

@@ -31,8 +31,8 @@ class ::Socket
   alias_method :orig_read, :read
   def read(maxlen = nil, buf = nil, buf_pos = 0)
     return Polyphony.backend_recv(self, buf, maxlen, buf_pos) if buf
-    return Polyphony.backend_recv(self, buf || +'', maxlen, 0) if maxlen
-    
+    return Polyphony.backend_recv(self, +'', maxlen, 0) if maxlen
+
     buf = +''
     len = buf.bytesize
     while true
@@ -120,8 +120,16 @@ class ::TCPSocket
 
   attr_reader :io
 
+  def self.open(*args)
+    new(*args)
+  end
+
+  def address_family(host)
+    host =~ /\:\:/ ? Socket::AF_INET6 : Socket::AF_INET
+  end
+
   def initialize(remote_host, remote_port, local_host = nil, local_port = nil)
-    @io = Socket.new Socket::AF_INET, Socket::SOCK_STREAM
+    @io = Socket.new address_family(remote_host), Socket::SOCK_STREAM
     if local_host && local_port
       addr = Addrinfo.tcp(local_host, local_port)
       @io.bind(addr)
@@ -167,8 +175,8 @@ class ::TCPSocket
   alias_method :orig_read, :read
   def read(maxlen = nil, buf = nil, buf_pos = 0)
     return Polyphony.backend_recv(self, buf, maxlen, buf_pos) if buf
-    return Polyphony.backend_recv(self, buf || +'', maxlen, 0) if maxlen
-    
+    return Polyphony.backend_recv(self, +'', maxlen, 0) if maxlen
+
     buf = +''
     len = buf.bytesize
     while true
@@ -223,8 +231,12 @@ end
 
 # Override stock TCPServer code by encapsulating a Socket instance.
 class ::TCPServer
+  def address_family(host)
+    host =~ /\:\:/ ? Socket::AF_INET6 : Socket::AF_INET
+  end
+
   def initialize(hostname = nil, port = 0)
-    @io = Socket.new Socket::AF_INET, Socket::SOCK_STREAM
+    @io = Socket.new address_family(hostname), Socket::SOCK_STREAM
     @io.bind(Addrinfo.tcp(hostname, port))
     @io.listen(0)
   end
@@ -232,7 +244,6 @@ class ::TCPServer
   alias_method :orig_accept, :accept
   def accept
     Polyphony.backend_accept(@io, TCPSocket)
-    # @io.accept
   end
 
   def accept_loop(&block)
@@ -260,8 +271,8 @@ class ::UNIXSocket
   alias_method :orig_read, :read
   def read(maxlen = nil, buf = nil, buf_pos = 0)
     return Polyphony.backend_recv(self, buf, maxlen, buf_pos) if buf
-    return Polyphony.backend_recv(self, buf || +'', maxlen, 0) if maxlen
-    
+    return Polyphony.backend_recv(self, +'', maxlen, 0) if maxlen
+
     buf = +''
     len = buf.bytesize
     while true

data/lib/polyphony/extensions/thread.rb

@@ -18,14 +18,20 @@ class ::Thread
   def execute
     # backend must be created in the context of the new thread, therefore it
     # cannot be created in Thread#initialize
-    @backend = Polyphony::Backend.new
+    raise_error = false
+    begin
+      @backend = Polyphony::Backend.new
+    rescue Exception => e
+      raise_error = true
+      raise e
+    end
     setup
     @ready = true
     result = @block.(*@args)
   rescue Polyphony::MoveOn, Polyphony::Terminate => e
     result = e.value
   rescue Exception => e
-    result = e
+    raise_error ? (raise e) : (result = e)
   ensure
     @ready = true
     finalize(result)
@@ -48,7 +54,7 @@ class ::Thread
       @result = result
       signal_waiters(result)
     end
-    @backend.finalize
+    @backend&.finalize
   end
 
   def signal_waiters(result)

data/lib/polyphony/extensions/timeout.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+# Override Timeout to use cancel scope
+module ::Timeout
+  def self.timeout(sec, klass = Timeout::Error, message = 'execution expired', &block)
+    cancel_after(sec, with_exception: [klass, message], &block)
+  end
+end

data/lib/polyphony/extensions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative './extensions/exception'
+require_relative './extensions/fiber'
+require_relative './extensions/io'
+require_relative './extensions/kernel'
+require_relative './extensions/process'
+require_relative './extensions/thread'
+require_relative './extensions/timeout'

data/lib/polyphony/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Polyphony
-  VERSION = '0.71'
+  VERSION = '0.74'
 end

data/lib/polyphony.rb

@@ -2,15 +2,13 @@
 
 require 'fiber'
 require_relative './polyphony_ext'
-
-require_relative './polyphony/extensions/core'
 require_relative './polyphony/extensions/thread'
-require_relative './polyphony/extensions/fiber'
-require_relative './polyphony/extensions/io'
 
 Thread.current.setup_fiber_scheduling
 Thread.current.backend = Polyphony::Backend.new
 
+require_relative './polyphony/extensions'
+require_relative './polyphony/core/exceptions'
 require_relative './polyphony/core/global_api'
 require_relative './polyphony/core/resource_pool'
 require_relative './polyphony/core/sync'

data/polyphony.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency  'simplecov',            '0.17.1'
   s.add_development_dependency  'rubocop',              '0.85.1'
   s.add_development_dependency  'pry',                  '0.13.1'
-  
+
   s.add_development_dependency  'msgpack',              '1.4.2'
   s.add_development_dependency  'httparty',             '0.17.1'
   s.add_development_dependency  'localhost',            '~>1.1.4'

data/test/coverage.rb

@@ -24,10 +24,10 @@ module Coverage
       @result = {}
       trace = TracePoint.new(:line) do |tp|
         next if tp.path =~ /\(/
-      
+
         absolute = File.expand_path(tp.path)
         next unless LIB_FILES.include?(absolute)# =~ /^#{LIB_DIR}/
-        
+
         @result[absolute] ||= relevant_lines_for_filename(absolute)
         @result[absolute][tp.lineno - 1] = 1
       end