polyphony 0.20 → 0.21

data/ext/gyro/io.c

@@ -10,7 +10,6 @@ struct Gyro_IO {
   struct  ev_io ev_io;
   int     active;
   int     event_mask;
-  VALUE   callback;
   VALUE   fiber;
 };
 
@@ -23,9 +22,6 @@ static size_t Gyro_IO_size(const void *ptr);
 
 static VALUE Gyro_IO_initialize(VALUE self, VALUE io, VALUE event_mask);
 
-static VALUE Gyro_IO_start(VALUE self);
-static VALUE Gyro_IO_stop(VALUE self);
-
 void Gyro_IO_callback(struct ev_loop *ev_loop, struct ev_io *io, int revents);
 
 static int Gyro_IO_symbol2event_mask(VALUE sym);
@@ -41,8 +37,6 @@ void Init_Gyro_IO() {
   rb_define_alloc_func(cGyro_IO, Gyro_IO_allocate);
 
   rb_define_method(cGyro_IO, "initialize", Gyro_IO_initialize, 2);
-  rb_define_method(cGyro_IO, "start", Gyro_IO_start, 0);
-  rb_define_method(cGyro_IO, "stop", Gyro_IO_stop, 0);
   rb_define_method(cGyro_IO, "await", Gyro_IO_await, 0);
 
   VALUE cIO = rb_const_get(rb_cObject, rb_intern("IO"));
@@ -71,9 +65,6 @@ static VALUE Gyro_IO_allocate(VALUE klass) {
 
 static void Gyro_IO_mark(void *ptr) {
   struct Gyro_IO *io = ptr;
-  if (io->callback != Qnil) {
-    rb_gc_mark(io->callback);
-  }
   if (io->fiber != Qnil) {
     rb_gc_mark(io->fiber);
   }
@@ -101,7 +92,6 @@ static VALUE Gyro_IO_initialize(VALUE self, VALUE io_obj, VALUE event_mask) {
   GetGyro_IO(self, io);
 
   io->event_mask = Gyro_IO_symbol2event_mask(event_mask);
-  io->callback = Qnil;
   io->fiber = Qnil;
   io->active = 0;
 
@@ -122,42 +112,11 @@ void Gyro_IO_callback(struct ev_loop *ev_loop, struct ev_io *ev_io, int revents)
     io->fiber = Qnil;
     SCHEDULE_FIBER(fiber, 0);
   }
-  else if (io->callback != Qnil) {
-    rb_funcall(io->callback, ID_call, 1, INT2NUM(revents));
-  }
   else {
     ev_io_stop(EV_DEFAULT, ev_io);
   }
 }
 
-static VALUE Gyro_IO_start(VALUE self) {
-  struct Gyro_IO *io;
-  GetGyro_IO(self, io);
-
-  if (rb_block_given_p()) {
-    io->callback = rb_block_proc();
-  }
-
-  if (!io->active) {
-    ev_io_start(EV_DEFAULT, &io->ev_io);
-    io->active = 1;
-  }
-
-  return self;
-}
-
-static VALUE Gyro_IO_stop(VALUE self) {
-  struct Gyro_IO *io;
-  GetGyro_IO(self, io);
-
-  if (io->active) {
-    ev_io_stop(EV_DEFAULT, &io->ev_io);
-    io->active = 0;
-  }
-
-  return self;
-}
-
 VALUE Gyro_IO_await(VALUE self) {
   struct Gyro_IO *io;
   VALUE ret;

data/lib/polyphony/core/coprocess.rb

@@ -100,6 +100,14 @@ class Coprocess
     @fiber
   end
 
+  def caller
+    @fiber&.__caller__[2..]
+  end
+
+  def location
+    caller[0]
+  end
+
   # Kernel.await expects the given argument / block to be a callable, so #call
   # in fact waits for the coprocess to finish
   def await

data/lib/polyphony/core/supervisor.rb

@@ -9,12 +9,14 @@ Exceptions  = import('./exceptions')
 class Supervisor
   def initialize
     @coprocesses = []
+    @pending = []
   end
 
   def await(&block)
     @supervisor_fiber = Fiber.current
     block&.(self)
     suspend
+    @coprocesses.map { |cp| cp.result }
   rescue Exceptions::MoveOn => e
     e.value
   ensure
@@ -30,12 +32,21 @@ class Supervisor
     end
   end
 
-  def spin(proc = nil, &block)
-    proc = Coprocess.new(&(proc || block)) unless proc.is_a?(Coprocess)
-    @coprocesses << proc
-    proc.when_done { task_completed(proc) }
-    proc.run unless proc.alive?
-    proc
+  def spin(coproc = nil, &block)
+    coproc = Coprocess.new(&(coproc || block)) unless coproc.is_a?(Coprocess)
+    @coprocesses << coproc
+    @pending << coproc
+    coproc.when_done { task_completed(coproc) }
+    coproc.run unless coproc.alive?
+    coproc
+  end
+
+  def add(coproc)
+    @coprocesses << coproc
+    @pending << coproc
+    coproc.when_done { task_completed(coproc) }
+    coproc.run unless coproc.alive?
+    coproc
   end
 
   def still_running?
@@ -51,15 +62,23 @@ class Supervisor
 
   def stop_all_tasks
     exception = Exceptions::MoveOn.new
-    @coprocesses.each do |c|
+    @pending.each do |c|
       c.transfer(exception)
     end
   end
 
   def task_completed(coprocess)
-    return unless @coprocesses.include?(coprocess)
+    return unless @pending.include?(coprocess)
 
-    @coprocesses.delete(coprocess)
-    @supervisor_fiber&.transfer if @coprocesses.empty?
+    @pending.delete(coprocess)
+    @supervisor_fiber&.transfer if @pending.empty?
   end
 end
+
+class Coprocess
+  def self.await(*coprocs)
+    supervise do |s|
+      coprocs.each { |cp| s.add cp }
+    end
+  end
+end

data/lib/polyphony/extensions/core.rb

@@ -12,7 +12,7 @@ Throttler   = import('../core/throttler')
 # Fiber extensions
 class ::Fiber
   attr_accessor :__calling_fiber__
-  attr_writer :__caller__
+  attr_accessor :__caller__
   attr_writer :cancelled
   attr_accessor :coprocess, :scheduled_value
 

data/lib/polyphony/http/server/http2.rb

@@ -19,10 +19,16 @@ class Protocol
     @upgrade_headers = upgrade_headers
 
     @interface = ::HTTP2::Server.new
-    @interface.on(:frame) { |bytes| @conn << bytes }
+    @connection_fiber = Fiber.current
+    @interface.on(:frame, &method(:send_frame))
+    @streams = {}
   end
 
-  # request API
+  def send_frame(data)
+    @conn << data
+  rescue Exception => e
+    @connection_fiber.transfer e
+  end
 
   UPGRADE_MESSAGE = <<~HTTP.gsub("\n", "\r\n")
     HTTP/1.1 101 Switching Protocols
@@ -34,6 +40,7 @@ class Protocol
   def upgrade
     @conn << UPGRADE_MESSAGE
     settings = @upgrade_headers['HTTP2-Settings']
+    Fiber.current.schedule(nil)
     @interface.upgrade(settings, @upgrade_headers, '')
   ensure
     @upgrade_headers = nil
@@ -41,7 +48,7 @@ class Protocol
 
   # Iterates over incoming requests
   def each(&block)
-    @interface.on(:stream) { |stream| Stream.new(stream, &block) }
+    @interface.on(:stream) { |stream| start_stream(stream, &block) }
     upgrade if @upgrade_headers
 
     while (data = @conn.readpartial(8192))
@@ -51,8 +58,17 @@ class Protocol
   rescue SystemCallError, IOError
     # ignore
   ensure
-    # release references to various objects
+    finalize_client_loop
+  end
+
+  def start_stream(stream, &block)
+    stream = Stream.new(stream, &block)
+    @streams[stream] = true
+  end
+
+  def finalize_client_loop
     @interface = nil
+    @streams.each_key(&:stop)
     @conn.close
   end
 

data/lib/polyphony/http/server/http2_stream.rb

@@ -5,6 +5,7 @@ export_default :StreamHandler
 require 'http/2'
 
 Request = import './request'
+Exceptions = import '../../core/exceptions'
 
 # Manages an HTTP 2 stream
 class StreamHandler
@@ -12,14 +13,38 @@ class StreamHandler
 
   def initialize(stream, &block)
     @stream = stream
-    @stream_fiber = Fiber.new(&block)
-
-    # stream callbacks occur on connection fiber
+    @calling_fiber = Fiber.current
+    @stream_fiber = Fiber.new { |req| handle_request(req, &block) }
+
+    # Stream callbacks occur on the connection fiber (see HTTP2::Protocol#each).
+    # The request handler is run on a separate fiber for each stream, allowing
+    # concurrent handling of incoming requests on the same HTTP/2 connection.
+    #
+    # The different stream adapter APIs suspend the stream fiber, waiting for
+    # stream callbacks to be called. The callbacks, in turn, transfer control to
+    # the stream fiber, effectively causing the return of the adapter API calls.
+    #
+    # Note: the request handler is run once headers are received. Reading the
+    # request body, if present, is at the discretion of the request handler.
+    # This mirrors the behaviour of the HTTP/1 adapter.
     stream.on(:headers, &method(:on_headers))
     stream.on(:data, &method(:on_data))
     stream.on(:half_close, &method(:on_half_close))
   end
 
+  def handle_request(request, &block)
+    error = nil
+    block.(request)
+    @calling_fiber.transfer
+  rescue Exceptions::MoveOn
+    # ignore
+  rescue Exception => e
+    error = e
+  ensure
+    @done = true
+    @calling_fiber.transfer error
+  end
+
   def on_headers(headers)
     @request = Request.new(headers.to_h, self)
     @stream_fiber.transfer(@request)
@@ -101,4 +126,11 @@ class StreamHandler
       @stream.headers(headers, end_stream: true)
     end
   end
+
+  def stop
+    return if @done
+
+    @stream.close
+    @stream_fiber.schedule(Polyphony::MoveOn.new)
+  end
 end

data/lib/polyphony/version.rb

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

data/lib/polyphony.rb

@@ -32,11 +32,23 @@ module Polyphony
   )
 
   class << self
-    def trap(sig, ref = false, &callback)
-      sig = Signal.list[sig.to_s.upcase] if sig.is_a?(Symbol)
-      watcher = Gyro::Signal.new(sig, &callback)
-      Gyro.unref unless ref
-      watcher
+    # def trap(sig, ref = false, &callback)
+    #   sig = Signal.list[sig.to_s.upcase] if sig.is_a?(Symbol)
+    #   puts "sig = #{sig.inspect}"
+    #   watcher = Gyro::Signal.new(sig, &callback)
+    #   # Gyro.unref unless ref
+    #   watcher
+    # end
+
+    def wait_for_signal(sig)
+      fiber = Fiber.current
+      Gyro.ref
+      trap(sig) do
+        trap(sig, :DEFAULT)
+        Gyro.unref
+        fiber.transfer(sig)
+      end
+      suspend
     end
 
     def fork(&block)

data/test/test_async.rb

@@ -5,10 +5,12 @@ require_relative 'helper'
 class AsyncTest < MiniTest::Test
   def test_that_async_watcher_receives_signal_across_threads
     count = 0
-    a = Gyro::Async.new do
+    a = Gyro::Async.new
+    spin {
+      a.await
       count += 1
-      a.stop
-    end
+    }
+    snooze
     Thread.new do
       sync_sleep 0.001
       a.signal!
@@ -19,10 +21,15 @@ class AsyncTest < MiniTest::Test
 
   def test_that_async_watcher_coalesces_signals
     count = 0
-    a = Gyro::Async.new do
-      count += 1
-      Gyro::Timer.new(0.01, 0).start { a.stop }
-    end
+    a = Gyro::Async.new
+    coproc = spin {
+      loop {
+        a.await
+        count += 1
+        after(0.01) { coproc.stop }
+      }
+    }
+    snooze
     Thread.new do
       sync_sleep 0.001
       3.times { a.signal! }

data/test/test_coprocess.rb

@@ -229,22 +229,52 @@ class CoprocessTest < MiniTest::Test
     assert(raised_error)
     assert_equal('foo', raised_error.message)
   end
-end
 
-def test_exception_propagation_for_orphan_fiber
-  raised_error = nil
-  spin do
+  def test_exception_propagation_for_orphan_fiber
+    raised_error = nil
     spin do
-      snooze
-      raise 'bar'
+      spin do
+        snooze
+        raise 'bar'
+      end
+    end
+    suspend
+  rescue Exception => e
+    raised_error = e
+  ensure
+    assert(raised_error)
+    assert_equal('bar', raised_error.message)
+  end
+
+  def test_await_multiple_coprocesses
+    cp1 = spin { sleep 0.01; :foo }
+    cp2 = spin { sleep 0.01; :bar }
+    cp3 = spin { sleep 0.01; :baz }
+
+    result = Polyphony::Coprocess.await(cp1, cp2, cp3)
+    assert_equal %i{foo bar baz}, result
+  end
+
+  def test_caller
+    location = /^#{__FILE__}:#{__LINE__ + 1}/
+    cp = spin do
+      sleep 0.01
+    end
+    snooze
+
+    caller = cp.caller
+    assert caller[0] =~ location
+  end
+
+  def test_location
+    location = /^#{__FILE__}:#{__LINE__ + 1}/
+    cp = spin do
+      sleep 0.01
     end
+    snooze
+
+    assert cp.location =~ location
   end
-  suspend
-rescue Exception => e
-  raised_error = e
-ensure
-  assert(raised_error)
-  assert_equal('bar', raised_error.message)
 end
 
 class MailboxTest < MiniTest::Test

data/test/test_core.rb

@@ -216,3 +216,29 @@ class ExceptionTest < MiniTest::Test
     assert_kind_of RuntimeError, error
   end
 end
+
+class MoveOnAfterTest < MiniTest::Test
+  def test_move_on_after
+    t0 = Time.now
+    v = move_on_after(0.01) do
+      sleep 1
+      :foo
+    end
+    t1 = Time.now
+
+    assert t1 - t0 < 0.02
+    assert_nil v
+  end
+
+  def test_move_on_after_with_value
+    t0 = Time.now
+    v = move_on_after(0.01, with_value: :bar) do
+      sleep 1
+      :foo
+    end
+    t1 = Time.now
+
+    assert t1 - t0 < 0.02
+    assert_equal :bar, v
+  end
+end

data/test/test_io.rb

@@ -6,14 +6,23 @@ class GyroIOTest < MiniTest::Test
   def test_that_reading_works
     i, o = IO.pipe
     data = +''
-    w = Gyro::IO.new(i, :r)
-    w.start do
+    sequence = []
+    watcher = Gyro::IO.new(i, :r)
+    spin {
+      sequence << 1
+      watcher.await
+      sequence << 2
       i.read_nonblock(8192, data)
-      w.stop unless data.empty?
+    }
+    snooze
+    sequence << 3
+    defer do
+      o << 'hello'
+      sequence << 4
     end
-    defer { o << 'hello' }
     suspend
-    assert_equal('hello', data)
+    assert_equal 'hello', data
+    assert_equal [1, 3, 4, 2], sequence
   end
 end
 

data/test/test_signal.rb

@@ -18,19 +18,15 @@ class SignalTest < MiniTest::Test
     assert_equal(1, count)
   end
 
-  def test_trap_api
+  def test_wait_for_signal_api
     count = 0
-    w = Polyphony.trap(:usr1, true) do
+    spin do
+      Polyphony.wait_for_signal 'SIGHUP'
       count += 1
-      w.stop
     end
 
-    assert_kind_of(Gyro::Signal, w)
-    Thread.new do
-      sync_sleep 0.001
-      Process.kill(:USR1, Process.pid)
-    end
-    suspend
-    assert_equal(1, count)
+    snooze
+    Process.kill(:HUP, Process.pid)
+    assert_equal 1, count
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: '0.20'
+  version: '0.21'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modulation
@@ -213,11 +213,21 @@ files:
 - Rakefile
 - TODO.md
 - bin/poly
-- docs/getting-started/getting-started.md
+- docs/README.md
+- docs/getting-started/installing.md
 - docs/getting-started/tutorial.md
 - docs/summary.md
+- docs/technical-overview/concurrency.md
+- docs/technical-overview/design-principles.md
 - docs/technical-overview/exception-handling.md
+- docs/technical-overview/extending.md
+- docs/technical-overview/faq.md
 - docs/technical-overview/fiber-scheduling.md
+- docs/user-guide/web-server.md
+- examples/core/01-spinning-up-coprocesses.rb
+- examples/core/02-awaiting-coprocesses.rb
+- examples/core/03-interrupting.rb
+- examples/core/04-no-auto-run.rb
 - examples/core/cancel.rb
 - examples/core/channel_echo.rb
 - examples/core/defer.rb
@@ -227,6 +237,7 @@ files:
 - examples/core/fork.rb
 - examples/core/genserver.rb
 - examples/core/lock.rb
+- examples/core/mem-usage.rb
 - examples/core/move_on.rb
 - examples/core/move_on_twice.rb
 - examples/core/move_on_with_ensure.rb
@@ -243,8 +254,6 @@ files:
 - examples/core/sleep.rb
 - examples/core/sleep_spin.rb
 - examples/core/snooze.rb
-- examples/core/spin.rb
-- examples/core/spin_cancel.rb
 - examples/core/spin_error.rb
 - examples/core/spin_error_backtrace.rb
 - examples/core/spin_uncaught_error.rb
@@ -258,6 +267,7 @@ files:
 - examples/core/thread_pool.rb
 - examples/core/throttle.rb
 - examples/core/timeout.rb
+- examples/core/wait_for_signal.rb
 - examples/fs/read.rb
 - examples/http/config.ru
 - examples/http/cuba.ru
@@ -269,6 +279,8 @@ files:
 - examples/http/http_server.js
 - examples/http/http_server.rb
 - examples/http/http_server_forked.rb
+- examples/http/http_server_graceful.rb
+- examples/http/http_server_simple.rb
 - examples/http/http_server_throttled.rb
 - examples/http/http_ws_server.rb
 - examples/http/https_raw_client.rb

data/docs/getting-started/getting-started.md

@@ -1,10 +0,0 @@
-# Installing
-
-## Installing
-
-```bash
-$ gem install polyphony
-```
-
-## Tutorial
-

data/examples/core/spin.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'polyphony/auto_run'
-
-def my_sleep(t)
-  puts 'going to sleep...'
-  sleep t
-  puts 'woke up'
-end
-
-spin do
-  spin { my_sleep(1) }.await
-end

data/examples/core/spin_cancel.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'polyphony/auto_run'
-
-spin do
-  cancel_after(1) do
-    spin do
-      puts 'going to sleep...'
-      sleep(2)
-    ensure
-      puts 'woke up'
-    end.await
-  end
-rescue Polyphony::Cancel => e
-  puts "got error: #{e}"
-end