polyphony 0.66 → 0.70

data/lib/polyphony/extensions/debug.rb

@@ -10,4 +10,4 @@ module ::Kernel
       format("%p\n", args.size == 1 ? args.first : args)
     end
   end
-end
+end

data/lib/polyphony/extensions/fiber.rb

@@ -7,6 +7,10 @@ require_relative '../core/exceptions'
 module Polyphony
   # Fiber control API
   module FiberControl
+    def monitor_mailbox
+      @monitor_mailbox ||= Polyphony::Queue.new
+    end
+
     def interrupt(value = nil)
       return if @running == false
 
@@ -23,6 +27,7 @@ module Polyphony
       end
 
       fiber = parent.spin(@tag, @caller, &@block)
+      @monitors&.each_key { |f| fiber.monitor(f) }
       fiber.schedule(value) unless value.nil?
       fiber
     end
@@ -75,46 +80,34 @@ module Polyphony
 
   # Fiber supervision
   module FiberSupervision
-    def supervise(opts = {})
-      @counter = 0
-      @on_child_done = proc do |fiber, result|
-        self << fiber unless result.is_a?(Exception)
+    def supervise(*fibers, **opts, &block)
+      block ||= supervise_opts_to_block(opts)
+
+      fibers.each do |f|
+        f.attach_to(self) unless f.parent == self
+        f.monitor(self)
       end
+
+      mailbox = monitor_mailbox
+
       while true
-        supervise_perform(opts)
+        (fiber, result) = mailbox.shift
+        block&.call(fiber, result)
       end
-  rescue Polyphony::MoveOn
-      # generated in #supervise_perform to stop supervisor
-    ensure
-      @on_child_done = nil
     end
 
-    def supervise_perform(opts)
-      fiber = receive
-      if fiber && opts[:restart]
-        restart_fiber(fiber, opts)
-      elsif Fiber.current.children.empty?
-        Fiber.current.stop
-      end
-    rescue Polyphony::Restart
-      restart_all_children
-    rescue Exception => e
-      Kernel.raise e if e.source_fiber.nil? || e.source_fiber == self
+    def supervise_opts_to_block(opts)
+      block = opts[:on_done] || opts[:on_error]
+      return nil unless block || opts[:restart]
 
-      if opts[:restart]
-        restart_fiber(e.source_fiber, opts)
-      elsif Fiber.current.children.empty?
-        Fiber.current.stop
-      end
-    end
+      error_only = !!opts[:on_error]
+      restart_always = opts[:restart] == :always
+      restart_on_error = opts[:restart] == :on_error
 
-    def restart_fiber(fiber, opts)
-      opts[:watcher]&.send [:restart, fiber]
-      case opts[:restart]
-      when true
-        fiber.restart
-      when :one_for_all
-        @children.keys.each(&:restart)
+      ->(f, r) do
+        is_error = r.is_a?(Exception)
+        block.(f, r) if block && (!error_only || is_error)
+        f.restart if restart_always || (restart_on_error && is_error)
       end
     end
   end
@@ -124,23 +117,24 @@ module Polyphony
     def await(*fibers)
       return [] if fibers.empty?
 
-      Fiber.current.message_on_child_termination = true
+      current_fiber = self.current
+      mailbox = current_fiber.monitor_mailbox
       results = {}
       fibers.each do |f|
         results[f] = nil
         if f.dead?
           # fiber already terminated, so queue message
-          Fiber.current.send [f, f.result]
+          mailbox << [f, f.result]
         else
-          f.monitor
+          f.monitor(current_fiber)
         end
       end
       exception = nil
       while !fibers.empty?
-        (fiber, result) = receive
+        (fiber, result) = mailbox.shift
         next unless fibers.include?(fiber)
-
         fibers.delete(fiber)
+        current_fiber.remove_child(fiber) if fiber.parent == current_fiber
         if result.is_a?(Exception)
           exception ||= result
           fibers.each { |f| f.terminate }
@@ -148,16 +142,16 @@ module Polyphony
           results[fiber] = result
         end
       end
-      results.values
-    ensure
-      Fiber.current.message_on_child_termination = false
       raise exception if exception
+      results.values
     end
     alias_method :join, :await
 
     def select(*fibers)
       return nil if fibers.empty?
   
+      current_fiber = self.current
+      mailbox = current_fiber.monitor_mailbox
       fibers.each do |f|
         if f.dead?
           result = f.result
@@ -165,21 +159,18 @@ module Polyphony
         end
       end
 
-      Fiber.current.message_on_child_termination = true
-      fibers.each { |f| f.monitor }
+      fibers.each { |f| f.monitor(current_fiber) }
       while true
-        (fiber, result) = receive
+        (fiber, result) = mailbox.shift
         next unless fibers.include?(fiber)
   
-        fibers.each { |f| f.unmonitor }
+        fibers.each { |f| f.unmonitor(current_fiber) }
         if result.is_a?(Exception)
           raise result
         else
           return [fiber, result]
         end
       end
-    ensure
-      Fiber.current.message_on_child_termination = false
     end
 
     # Creates and schedules with priority an out-of-band fiber that runs the
@@ -219,14 +210,6 @@ module Polyphony
       f
     end
 
-    def child_done(child_fiber, result)
-      @children.delete(child_fiber)
-
-      if result.is_a?(Exception) && !@message_on_child_termination
-        schedule_with_priority(result)
-      end
-    end
-
     def terminate_all_children(graceful = false)
       return unless @children
 
@@ -240,13 +223,15 @@ module Polyphony
     def await_all_children
       return unless @children && !@children.empty?
 
-      Fiber.await(*@children.keys)
+      Fiber.await(*@children.keys.reject { |c| c.dead? })
     end
 
     def shutdown_all_children(graceful = false)
       return unless @children
 
       @children.keys.each do |c|
+        next if c.dead?
+
         c.terminate(graceful)
         c.await
       end
@@ -258,10 +243,17 @@ module Polyphony
       @parent.add_child(self)
     end
 
-    def attach(parent)
+    def attach_to(fiber)
       @parent.remove_child(self)
-      @parent = parent
-      @parent.add_child(self)
+      @parent = fiber
+      fiber.add_child(self)
+    end
+
+    def attach_and_monitor(fiber)
+      @parent.remove_child(self)
+      @parent = fiber
+      fiber.add_child(self)
+      monitor(fiber)
     end
   end
 
@@ -323,9 +315,10 @@ module Polyphony
       Thread.backend.trace(:fiber_terminate, self, result)
       @result = result
 
-      inform_dependants(result, uncaught_exception)
+      inform_monitors(result, uncaught_exception)
       @running = false
     ensure
+      @parent&.remove_child(self)
       # Prevent fiber from being resumed after terminating
       @thread.fiber_unschedule(self)
       Thread.current.switch_fiber
@@ -341,24 +334,28 @@ module Polyphony
       [e, true]
     end
 
-    def inform_dependants(result, uncaught_exception)
+    def inform_monitors(result, uncaught_exception)
       if @monitors
         msg = [self, result]
-        @monitors.each { |f| f << msg }
+        @monitors.each_key { |f| f.monitor_mailbox << msg }
       end
 
-      @parent&.child_done(self, result)
+      if uncaught_exception && @parent
+        parent_is_monitor = @monitors&.has_key?(@parent)
+        @parent.schedule_with_priority(result) unless parent_is_monitor
+      end
     end
 
-    attr_accessor :message_on_child_termination 
+    def monitor(fiber)
+      (@monitors ||= {})[fiber] = true
+    end
 
-    def monitor
-      @monitors ||= []
-      @monitors << Fiber.current
+    def unmonitor(fiber)
+      (@monitors ||= []).delete(fiber)
     end
 
-    def unmonitor
-      @monitors.delete(Fiber.current) if @monitors
+    def monitors
+      @monitors&.keys || []
     end
 
     def dead?

data/lib/polyphony/extensions/io.rb

@@ -76,7 +76,7 @@ end
 
 # IO instance method patches
 class ::IO
-  def __polyphony_read_method__
+  def __parser_read_method__
     :backend_read
   end
 
@@ -160,8 +160,6 @@ class ::IO
       return @read_buffer.slice!(0, idx + sep_size) if idx
 
       result = readpartial(8192, @read_buffer, -1)
-        
-      #Polyphony.backend_read(self, @read_buffer, 8192, false, -1)
       return nil unless result
     end
   rescue EOFError

data/lib/polyphony/extensions/openssl.rb

@@ -5,7 +5,7 @@ require_relative './socket'
 
 # OpenSSL socket helper methods (to make it compatible with Socket API) and overrides
 class ::OpenSSL::SSL::SSLSocket
-  def __polyphony_read_method__
+  def __parser_read_method__
     :readpartial
   end
 
@@ -114,6 +114,68 @@ end
 
 # OpenSSL socket helper methods (to make it compatible with Socket API) and overrides
 class ::OpenSSL::SSL::SSLServer
+  attr_reader :ctx
+
+  alias_method :orig_accept, :accept
+  def accept
+    # when @ctx.servername_cb is set, we use a worker thread to run the
+    # ssl.accept call. We need to do this because:
+    # - We cannot switch fibers inside of the servername_cb proc (see
+    #   https://github.com/ruby/openssl/issues/415)
+    # - We don't want to stop the world while we're busy provisioning an ACME
+    #   certificate
+    if @use_accept_worker.nil?
+      if (@use_accept_worker = use_accept_worker_thread?)
+        start_accept_worker_thread
+      end
+    end
+
+    sock, = @svr.accept
+    begin
+      ssl = OpenSSL::SSL::SSLSocket.new(sock, @ctx)
+      ssl.sync_close = true
+      if @use_accept_worker
+        @accept_worker_fiber << [ssl, Fiber.current]
+        receive
+      else
+        ssl.accept
+      end
+      ssl
+    rescue Exception => ex
+      if ssl
+        ssl.close
+      else
+        sock.close
+      end
+      raise ex
+    end
+  end
+
+  def start_accept_worker_thread
+    fiber = Fiber.current
+    @accept_worker_thread = Thread.new do
+      fiber << Fiber.current
+      loop do
+        socket, peer = receive
+        socket.accept
+        peer << socket
+      rescue => e
+        peer.schedule(e) if fiber
+      end
+    end
+    @accept_worker_fiber = receive
+  end
+
+  def use_accept_worker_thread?
+    !!@ctx.servername_cb
+  end
+
+  alias_method :orig_close, :close
+  def close
+    @accept_worker_thread&.kill
+    orig_close
+  end
+
   def accept_loop(ignore_errors = true)
     loop do
       yield accept

data/lib/polyphony/extensions/socket.rb

@@ -6,7 +6,7 @@ require_relative './io'
 require_relative '../core/thread_pool'
 
 class BasicSocket
-  def __polyphony_read_method__
+  def __parser_read_method__
     :backend_recv
   end
 end
@@ -206,7 +206,7 @@ class ::TCPSocket
   #   Polyphony.backend_send(self, mesg, 0)
   # end
 
-  def readpartial(maxlen, str = +'', buffer_pos = 0, raise_on_eof)
+  def readpartial(maxlen, str = +'', buffer_pos = 0, raise_on_eof = true)
     result = Polyphony.backend_recv(self, str, maxlen, buffer_pos)
     raise EOFError if !result && raise_on_eof
     result
@@ -299,7 +299,7 @@ class ::UNIXSocket
     Polyphony.backend_send(self, mesg, 0)
   end
 
-  def readpartial(maxlen, str = +'', buffer_pos = 0, raise_on_eof)
+  def readpartial(maxlen, str = +'', buffer_pos = 0, raise_on_eof = true)
     result = Polyphony.backend_recv(self, str, maxlen, buffer_pos)
     raise EOFError if !result && raise_on_eof
     result

data/lib/polyphony/version.rb

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

data/test/helper.rb

@@ -46,12 +46,7 @@ end
 class MiniTest::Test
   def setup
     # trace "* setup #{self.name}"
-    if Fiber.current.children.size > 0
-      puts "Children left: #{Fiber.current.children.inspect}"
-      exit!
-    end
     Fiber.current.setup_main_fiber
-    Fiber.current.instance_variable_set(:@auto_watcher, nil)
     Thread.current.backend.finalize
     Thread.current.backend = Polyphony::Backend.new
     sleep 0.001
@@ -60,6 +55,10 @@ class MiniTest::Test
   def teardown
     # trace "* teardown #{self.name}"
     Fiber.current.shutdown_all_children
+    if Fiber.current.children.size > 0
+      puts "Children left after #{self.name}: #{Fiber.current.children.inspect}"
+      exit!
+    end
     Fiber.current.instance_variable_set(:@auto_watcher, nil)
   rescue => e
     puts e

data/test/stress.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
 count = ARGV[0] ? ARGV[0].to_i : 100
+test_name = ARGV[1]
 
-TEST_CMD = 'ruby test/run.rb'
+$test_cmd = +'ruby test/run.rb'
+if test_name
+  $test_cmd << " --name #{test_name}"
+end
 
 def run_test(count)
   puts "#{count}: running tests..."
   # sleep 1
-  system(TEST_CMD)
+  system($test_cmd)
   puts
 
   return if $?.exitstatus == 0

data/test/test_fiber.rb

@@ -46,7 +46,7 @@ class FiberTest < MiniTest::Test
   def test_await_dead_children
     f1 = spin { :foo }
     f2 = spin { :bar }
-    2.times { snooze }
+    4.times { snooze }
     
     assert_equal [:foo, :bar], Fiber.await(f1, f2)
   end
@@ -67,10 +67,10 @@ class FiberTest < MiniTest::Test
     }
     Fiber.await(f2, f3)
     assert_equal [:foo, :bar, :baz], buffer
-    assert_equal 0, Fiber.current.children.size
+    assert_equal [], Fiber.current.children
   end
 
-  def test_await_from_multiple_fibers_with_interruption=
+  def test_await_from_multiple_fibers_with_interruption
     buffer = []
     f1 = spin {
       sleep 0.02
@@ -563,10 +563,10 @@ class FiberTest < MiniTest::Test
     end
 
     snooze
-    child.monitor
+    child.monitor(Fiber.current)
     spin { child << :foo }
 
-    msg = receive
+    msg = Fiber.current.monitor_mailbox.shift
     assert_equal [child, :foo], msg
   end
 
@@ -578,14 +578,14 @@ class FiberTest < MiniTest::Test
     end
 
     snooze
-    child.monitor
+    child.monitor(Fiber.current)
     spin { child << :foo }
     snooze
 
-    child.unmonitor
+    child.unmonitor(Fiber.current)
 
-    Fiber.current << :bar
-    msg = receive
+    Fiber.current.monitor_mailbox << :bar
+    msg = Fiber.current.monitor_mailbox.shift
     assert_equal :bar, msg
   end
 
@@ -786,7 +786,7 @@ class FiberTest < MiniTest::Test
     ], buf
   end
 
-  def test_attach
+  def test_attach_to
     buf = []
     child = nil
     parent = spin(:parent) do
@@ -804,7 +804,7 @@ class FiberTest < MiniTest::Test
 
     snooze
     assert_equal parent, child.parent
-    child.attach(new_parent)
+    child.attach_to(new_parent)
     assert_equal new_parent, child.parent
     parent.await
     
@@ -1218,4 +1218,23 @@ class GracefulTerminationTest < MiniTest::Test
 
     assert_equal [1, 2], buffer
   end
+end
+
+class DebugTest < MiniTest::Test
+  def test_parking
+    buf = []
+    f = spin do
+      3.times { |i| snooze; buf << i }
+    end
+    assert_nil f.__parked__?
+    f.__park__
+    assert_equal true, f.__parked__?
+    10.times { snooze }
+    assert_equal [], buf
+    
+    f.__unpark__
+    assert_nil f.__parked__?
+    10.times { snooze }
+    assert_equal [0, 1, 2], buf
+  end
 end