polyphony 0.47.5 → 0.49.2

data/lib/polyphony/extensions/fiber.rb

@@ -34,9 +34,18 @@ module Polyphony
       schedule Polyphony::Cancel.new
     end
 
-    def terminate
+    def graceful_shutdown=(graceful)
+      @graceful_shutdown = graceful
+    end
+
+    def graceful_shutdown?
+      @graceful_shutdown
+    end
+
+    def terminate(graceful = false)
       return if @running == false
 
+      @graceful_shutdown = graceful
       schedule Polyphony::Terminate.new
     end
 
@@ -66,7 +75,9 @@ module Polyphony
       @on_child_done = proc do |fiber, result|
         self << fiber unless result.is_a?(Exception)
       end
-      loop { supervise_perform(opts) }
+      while true
+        supervise_perform(opts)
+      end
     rescue Polyphony::MoveOn
       # generated in #supervise_perform to stop supervisor
     ensure
@@ -210,11 +221,14 @@ module Polyphony
       @on_child_done&.(child_fiber, result)
     end
 
-    def terminate_all_children
+    def terminate_all_children(graceful = false)
       return unless @children
 
       e = Polyphony::Terminate.new
-      @children.each_key { |c| c.raise e }
+      @children.each_key do |c|
+        c.graceful_shutdown = true if graceful
+        c.raise e
+      end
     end
 
     def await_all_children
@@ -230,9 +244,13 @@ module Polyphony
       results.values
     end
 
-    def shutdown_all_children
-      terminate_all_children
-      await_all_children
+    def shutdown_all_children(graceful = false)
+      return unless @children
+
+      @children.keys.each do |c|
+        c.terminate(graceful)
+        c.await
+      end
     end
   end
 
@@ -305,13 +323,10 @@ 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)
-      begin
-        shutdown_all_children
-      rescue Exception => e
-        result = e
-        uncaught_exception = true
-      end
+      shutdown_all_children
       [result, uncaught_exception]
+    rescue Exception => e
+      [e, true]
     end
 
     def inform_dependants(result, uncaught_exception)

data/lib/polyphony/extensions/io.rb

@@ -119,18 +119,11 @@ class ::IO
   end
 
   alias_method :orig_readpartial, :read
-  def readpartial(len, str = nil)
-    @read_buffer ||= +''
-    result = Thread.current.backend.read(self, @read_buffer, len, false)
+  def readpartial(len, str = +'')
+    result = Thread.current.backend.read(self, str, len, false)
     raise EOFError unless result
 
-    if str
-      str << @read_buffer
-    else
-      str = @read_buffer
-    end
-    @read_buffer = +''
-    str
+    result
   end
 
   alias_method :orig_write, :write
@@ -154,15 +147,16 @@ class ::IO
 
     @read_buffer ||= +''
 
-    loop do
+    while true
       idx = @read_buffer.index(sep)
       return @read_buffer.slice!(0, idx + sep_size) if idx
 
-      data = readpartial(8192)
+      data = readpartial(8192, +'')
+      return nil unless data
       @read_buffer << data
-    rescue EOFError
-      return nil
     end
+  rescue EOFError
+    return nil
   end
 
   # def print(*args)

data/lib/polyphony/extensions/openssl.rb

@@ -25,7 +25,7 @@ class ::OpenSSL::SSL::SSLSocket
 
   alias_method :orig_accept, :accept
   def accept
-    loop do
+    while true
       result = accept_nonblock(exception: false)
       case result
       when :wait_readable then Thread.current.backend.wait_io(io, false)
@@ -37,14 +37,14 @@ class ::OpenSSL::SSL::SSLSocket
   end
 
   def accept_loop
-    loop do
+    while true
       yield accept
     end
   end
 
   alias_method :orig_sysread, :sysread
   def sysread(maxlen, buf = +'')
-    loop do
+    while true
       case (result = read_nonblock(maxlen, buf, exception: false))
       when :wait_readable then Thread.current.backend.wait_io(io, false)
       when :wait_writable then Thread.current.backend.wait_io(io, true)
@@ -55,7 +55,7 @@ class ::OpenSSL::SSL::SSLSocket
 
   alias_method :orig_syswrite, :syswrite
   def syswrite(buf)
-    loop do
+    while true
       case (result = write_nonblock(buf, exception: false))
       when :wait_readable then Thread.current.backend.wait_io(io, false)
       when :wait_writable then Thread.current.backend.wait_io(io, true)

data/lib/polyphony/extensions/socket.rb

@@ -11,6 +11,10 @@ class ::Socket
     Thread.current.backend.accept(self, TCPSocket)
   end
 
+  def accept_loop(&block)
+    Thread.current.backend.accept_loop(self, TCPSocket, &block)
+  end
+
   NO_EXCEPTION = { exception: false }.freeze
 
   def connect(addr)
@@ -29,7 +33,7 @@ class ::Socket
 
   def recvfrom(maxlen, flags = 0)
     @read_buffer ||= +''
-    loop do
+    while true
       result = recvfrom_nonblock(maxlen, flags, @read_buffer, **NO_EXCEPTION)
       case result
       when nil then raise IOError

data/lib/polyphony/extensions/thread.rb

@@ -41,8 +41,7 @@ class ::Thread
 
   def finalize(result)
     unless Fiber.current.children.empty?
-      Fiber.current.terminate_all_children
-      Fiber.current.await_all_children
+      Fiber.current.shutdown_all_children
     end
     @finalization_mutex.synchronize do
       @terminated = true

data/lib/polyphony/net.rb

@@ -8,10 +8,7 @@ module Polyphony
   module Net
     class << self
       def tcp_connect(host, port, opts = {})
-        socket = ::Socket.new(:INET, :STREAM).tap do |s|
-          addr = ::Socket.sockaddr_in(port, host)
-          s.connect(addr)
-        end
+        socket = TCPSocket.new(host, port)
         if opts[:secure_context] || opts[:secure]
           secure_socket(socket, opts[:secure_context], opts.merge(host: host))
         else
@@ -23,7 +20,7 @@ module Polyphony
         host ||= '0.0.0.0'
         raise 'Port number not specified' unless port
 
-        socket = socket_from_options(host, port, opts)
+        socket = listening_socket_from_options(host, port, opts)
         if opts[:secure_context] || opts[:secure]
           secure_server(socket, opts[:secure_context], opts)
         else
@@ -31,7 +28,7 @@ module Polyphony
         end
       end
 
-      def socket_from_options(host, port, opts)
+      def listening_socket_from_options(host, port, opts)
         ::Socket.new(:INET, :STREAM).tap do |s|
           s.reuse_addr if opts[:reuse_addr]
           s.dont_linger if opts[:dont_linger]

data/lib/polyphony/version.rb

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

data/polyphony.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.licenses    = ['MIT']
   s.summary     = 'Fine grained concurrency for Ruby'
   s.author      = 'Sharon Rosner'
-  s.email       = 'ciconia@gmail.com'
+  s.email       = 'sharon@noteflakes.com'
   s.files       = `git ls-files`.split
   s.homepage    = 'https://digital-fabric.github.io/polyphony'
   s.metadata    = {

data/test/helper.rb

@@ -4,6 +4,7 @@ require 'bundler/setup'
 
 require_relative './coverage' if ENV['COVERAGE']
 
+require 'httparty'
 require 'polyphony'
 
 require 'fileutils'
@@ -56,8 +57,7 @@ class MiniTest::Test
 
   def teardown
     # trace "* teardown #{self.name}"
-    Fiber.current.terminate_all_children
-    Fiber.current.await_all_children
+    Fiber.current.shutdown_all_children
     Fiber.current.instance_variable_set(:@auto_watcher, nil)
   rescue => e
     puts e

data/test/test_backend.rb

@@ -100,12 +100,37 @@ class BackendTest < MiniTest::Test
     assert_equal [:ready, 'foo', 'bar', :done], buf
   end
 
+  def test_read_loop_terminate
+    i, o = IO.pipe
+
+    buf = []
+    parent = spin do
+      f = spin do
+        buf << :ready
+        @backend.read_loop(i) { |d| buf << d }
+        buf << :done
+      end
+      suspend
+    end
+
+    # writing always causes snoozing
+    o << 'foo'
+    sleep 0.01
+    o << 'bar'
+    sleep 0.01
+
+    parent.stop
+
+    parent.await
+    assert_equal [:ready, 'foo', 'bar'], buf
+  end
+
   def test_accept_loop
     server = TCPServer.new('127.0.0.1', 1234)
 
     clients = []
     server_fiber = spin do
-      @backend.accept_loop(server) { |c| clients << c }
+      @backend.accept_loop(server, TCPSocket) { |c| clients << c }
     end
 
     c1 = TCPSocket.new('127.0.0.1', 1234)

data/test/test_fiber.rb

@@ -639,7 +639,6 @@ class FiberTest < MiniTest::Test
         i.close
         f.await
       rescue Exception => e
-        trace e
         o << e.class.name
         o.close
       end
@@ -1038,3 +1037,82 @@ class RestartTest < MiniTest::Test
     assert_equal [f, 'foo', 'bar', :done, f2, 'baz', 42, :done], buffer
   end
 end
+
+class ChildrenTerminationTest < MiniTest::Test
+  def test_shutdown_all_children
+    f = spin do
+      1000.times { spin { suspend } }
+      suspend
+    end
+
+    snooze
+    assert_equal 1000, f.children.size
+
+    f.shutdown_all_children
+    assert_equal 0, f.children.size
+  end
+end
+
+class GracefulTerminationTest < MiniTest::Test
+  def test_graceful_termination
+    buffer = []
+    f = spin do
+      buffer << 1
+      snooze
+      buffer << 2
+      sleep 3
+      buffer << 3
+    ensure
+      buffer << 4 if Fiber.current.graceful_shutdown?
+    end
+
+    3.times { snooze }
+    f.terminate(false)
+    f.await
+    assert_equal [1, 2], buffer
+
+    buffer = []
+    f = spin do
+      buffer << 1
+      snooze
+      buffer << 2
+      sleep 3
+      buffer << 3
+    ensure
+      buffer << 4 if Fiber.current.graceful_shutdown?
+    end
+
+    3.times { snooze }
+    f.terminate(true)
+    f.await
+    assert_equal [1, 2, 4], buffer
+  end
+
+  def test_graceful_child_shutdown
+    buffer = []
+    f0 = spin do
+      f1 = spin do
+        sleep
+      ensure
+        buffer << 1 if Fiber.current.graceful_shutdown?
+      end
+
+      f2 = spin do
+        sleep
+      ensure
+        buffer << 2 if Fiber.current.graceful_shutdown?
+      end
+
+      sleep
+    ensure
+      Fiber.current.terminate_all_children(true) if Fiber.current.graceful_shutdown?
+      Fiber.current.await_all_children
+    end
+
+    3.times { snooze }
+    f0.terminate(true)
+    f0.await
+
+    assert_equal [1, 2], buffer
+  end
+end

data/test/test_global_api.rb

@@ -307,6 +307,36 @@ class SpinLoopTest < MiniTest::Test
     f.stop
     assert_in_range 1..3, counter
   end
+
+  def test_spin_loop_break
+    i = 0
+    f = spin_loop do
+      i += 1
+      snooze
+      break if i >= 5
+    end
+    f.await
+    assert_equal 5, i
+
+    i = 0
+    f = spin_loop do
+      i += 1
+      snooze
+      raise StopIteration if i >= 5
+    end
+    f.await
+    assert_equal 5, i
+  end
+
+  def test_throttled_spin_loop_break
+    i = 0
+    f = spin_loop(rate: 100) do
+      i += 1
+      break if i >= 5
+    end
+    f.await
+    assert_equal 5, i
+  end
 end
 
 class SpinScopeTest < MiniTest::Test

data/test/test_io.rb

@@ -92,6 +92,32 @@ class IOTest < MiniTest::Test
     assert_raises(EOFError) { i.readpartial(1) }    
   end
 
+  def test_gets
+    i, o = IO.pipe
+
+    buf = []
+    f = spin do
+      while (l = i.gets)
+        buf << l
+      end
+    end
+
+    snooze
+    assert_equal [], buf
+
+    o << 'fab'
+    snooze
+    assert_equal [], buf
+    
+    o << "ulous\n"
+    10.times { snooze }
+    assert_equal ["fabulous\n"], buf
+
+    o.close
+    f.await
+    assert_equal ["fabulous\n"], buf
+  end
+
   def test_getc
     i, o = IO.pipe