polyphony 0.29 → 0.30

data/test/test_thread.rb

@@ -9,7 +9,7 @@ class ThreadTest < MiniTest::Test
     t = Thread.new do
       s1 = spin { (11..13).each { |i| snooze; buffer << i } }
       s2 = spin { (21..23).each { |i| snooze; buffer << i } }
-      Fiber.join(s1, s2)
+      Fiber.current.await_all_children
     end
     f.join
     t.join
@@ -18,22 +18,16 @@ class ThreadTest < MiniTest::Test
   end
 
   def test_thread_join
-    tr = nil
-    # tr = Polyphony::Trace.new(:fiber_all) { |r| p r[:event] }
-    # Gyro.trace(true)
-    # tr.enable
-
     buffer = []
     spin { (1..3).each { |i| snooze; buffer << i } }
-    t = Thread.new { sleep 0.01; buffer << 4 }
+    t = Thread.new { sleep 0.01; buffer << 4; :foo }
 
     r = t.join
 
     assert_equal [1, 2, 3, 4], buffer
-    assert_equal t, r
+    assert_equal :foo, r
   ensure
-    tr&.disable
-    Gyro.trace(nil)
+    t.kill
   end
 
   def test_thread_join_with_timeout
@@ -49,12 +43,54 @@ class ThreadTest < MiniTest::Test
   ensure
     # killing the thread will prevent stopping the sleep timer, as well as the
     # thread's event selector, leading to a memory leak.
-    t.kill if t.alive?
+    t&.kill if t&.alive?
+  end
+
+  def test_thread_await_alias_method
+    buffer = []
+    spin { (1..3).each { |i| snooze; buffer << i } }
+    t = Thread.new { sleep 0.01; buffer << 4; :foo }
+
+    r = t.await
+
+    assert_equal [1, 2, 3, 4], buffer
+    assert_equal :foo, r
+  ensure
+    t.kill
+  end
+
+  def test_join_race_condition_on_thread_spawning
+    buffer = []
+    t = Thread.new do
+      :foo
+    end
+    r = t.join
+    assert_equal :foo, r
+  end
+
+  def test_thread_uncaught_exception_propagation
+    t = Thread.new do
+      sleep 1
+    end
+    snooze
+    t.kill
+    t.await
+
+    t = Thread.new do
+      raise 'foo'
+    end
+    e = nil
+    begin
+      t.await
+    rescue Exception => e
+    end
+    assert_kind_of RuntimeError, e
+    assert_equal 'foo', e.message
   end
 
   def test_thread_inspect
     lineno = __LINE__ + 1
-    t = Thread.new {}
+    t = Thread.new { sleep 1 }
     str = format(
       "#<Thread:%d %s:%d (run)>",
       t.object_id,
@@ -62,11 +98,18 @@ class ThreadTest < MiniTest::Test
       lineno,
     )
     assert_equal str, t.inspect
+  rescue => e
+    p e
+  ensure
+    t.kill
+    t.join
   end
 
   def test_that_suspend_returns_immediately_if_no_watchers
     records = []
-    t = Polyphony::Trace.new(:fiber_all) { |r| records << r if r[:event] =~ /^fiber_/ }
+    t = Polyphony::Trace.new(:fiber_all) do |r|
+      records << r if r[:event] =~ /^fiber_/
+    end
     t.enable
     Gyro.trace(true)
 
@@ -78,50 +121,27 @@ class ThreadTest < MiniTest::Test
     Gyro.trace(false)
   end
 
-  def test_reset
-    values = []
-    f1 = spin do
-      values << :foo
-      snooze
-      values << :bar
-      suspend
-    end
-
-    f2 = spin do
-      Thread.current.reset_fiber_scheduling
-      values << :restarted
-      snooze
-      values << :baz
-    end
-
-    suspend
-
-    f1.schedule
-    suspend
-    assert_equal %i[foo restarted baz], values
-  end
-
-  def test_restart
-    values = []
-    spin do
-      values << :foo
-      snooze
-      # this part will not be reached, as Gyro state is reset
-      values << :bar
-      suspend
-    end
-
-    spin do
-      Thread.current.reset_fiber_scheduling
-
-      # control is transfer to the fiber that called Gyro.restart
-      values << :restarted
-      snooze
-      values << :baz
+  def test_thread_child_fiber_termination
+    buffer = []
+    t = Thread.new do
+      spin do
+        sleep 61
+      ensure
+        buffer << :foo
+      end
+      spin do
+        sleep 62
+      ensure
+        buffer << :bar
+      end
+      assert 2, Fiber.current.children.size
+      sleep 1
     end
+    sleep 0.05
+    assert_equal 2, t.main_fiber.children.size
+    t.kill
+    t.join
 
-    suspend
-
-    assert_equal %i[foo restarted baz], values
+    assert_equal [:foo, :bar], buffer
   end
 end

data/test/test_thread_pool.rb

@@ -5,11 +5,10 @@ require_relative 'helper'
 class ThreadPoolTest < MiniTest::Test
   def setup
     super
-    # @pool = Polyphony::ThreadPool.new
+    @pool = Polyphony::ThreadPool.new
   end
 
   def test_process
-    skip
     current_thread = Thread.current
 
     processing_thread = nil
@@ -22,7 +21,6 @@ class ThreadPoolTest < MiniTest::Test
   end
 
   def test_multi_process
-    skip
     current_thread = Thread.current
     threads = []
     results = []
@@ -44,7 +42,6 @@ class ThreadPoolTest < MiniTest::Test
   end
 
   def test_process_with_exception
-    skip
     result = nil
     begin
       result = @pool.process { raise 'foo' }
@@ -56,7 +53,6 @@ class ThreadPoolTest < MiniTest::Test
   end
 
   def test_cast
-    skip
     t0 = Time.now
     threads = []
     buffer = []
@@ -76,4 +72,30 @@ class ThreadPoolTest < MiniTest::Test
     assert_equal @pool.size, threads.uniq.size
     assert_equal (0..9).to_a, buffer.sort
   end
+
+  def test_busy?
+    assert_equal false, @pool.busy?
+
+    f = spin do
+      @pool.process { sleep 0.001 }
+    end
+
+    snooze
+    assert_equal true, @pool.busy?
+    f.await
+
+    assert_equal false, @pool.busy?
+  end
+
+  def test_default_thread_pool_process
+    current_thread = Thread.current
+
+    processing_thread = nil
+    result = Polyphony::ThreadPool.process do
+      processing_thread = Thread.current
+      +'foo' + 'bar'
+    end
+    assert_equal 'foobar', result
+    assert processing_thread != current_thread
+  end
 end

data/test/test_throttler.rb

@@ -9,6 +9,7 @@ class ThrottlerTest < MiniTest::Test
     f = spin { loop { t.process { buffer << 1 } } }
     sleep 0.02
     f.stop
+    snooze
     assert buffer.size >= 2
     assert buffer.size <= 3
   ensure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: '0.29'
+  version: '0.30'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modulation
@@ -266,24 +266,27 @@ files:
 - docs/getting-started/installing.md
 - docs/getting-started/tutorial.md
 - docs/index.md
-- docs/technical-overview.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/fiber-scheduling.md
+- docs/main-concepts.md
+- docs/main-concepts/concurrency.md
+- docs/main-concepts/design-principles.md
+- docs/main-concepts/exception-handling.md
+- docs/main-concepts/extending.md
+- docs/main-concepts/fiber-scheduling.md
 - docs/user-guide.md
 - docs/user-guide/all-about-timers.md
 - docs/user-guide/web-server.md
 - examples/core/01-spinning-up-fibers.rb
 - examples/core/02-awaiting-fibers.rb
 - examples/core/03-interrupting.rb
+- examples/core/xx-at_exit.rb
 - examples/core/xx-channels.rb
 - examples/core/xx-deadlock.rb
 - examples/core/xx-deferring-an-operation.rb
 - examples/core/xx-erlang-style-genserver.rb
+- examples/core/xx-fork-terminate.rb
 - examples/core/xx-forking.rb
 - examples/core/xx-move_on.rb
+- examples/core/xx-pingpong.rb
 - examples/core/xx-queue-async.rb
 - examples/core/xx-readpartial.rb
 - examples/core/xx-recurrent-timer.rb
@@ -295,6 +298,7 @@ files:
 - examples/core/xx-snooze-starve.rb
 - examples/core/xx-spin_error_backtrace.rb
 - examples/core/xx-state-machine.rb
+- examples/core/xx-stop.rb
 - examples/core/xx-supervisors.rb
 - examples/core/xx-thread-selector-sleep.rb
 - examples/core/xx-thread-selector-snooze.rb
@@ -379,7 +383,6 @@ files:
 - lib/polyphony/core/exceptions.rb
 - lib/polyphony/core/global_api.rb
 - lib/polyphony/core/resource_pool.rb
-- lib/polyphony/core/supervisor.rb
 - lib/polyphony/core/sync.rb
 - lib/polyphony/core/thread_pool.rb
 - lib/polyphony/core/throttler.rb
@@ -391,7 +394,6 @@ files:
 - lib/polyphony/extensions/thread.rb
 - lib/polyphony/fs.rb
 - lib/polyphony/irb.rb
-- lib/polyphony/line_reader.rb
 - lib/polyphony/net.rb
 - lib/polyphony/postgres.rb
 - lib/polyphony/redis.rb
@@ -407,12 +409,10 @@ files:
 - test/test_ext.rb
 - test/test_fiber.rb
 - test/test_global_api.rb
-- test/test_gyro.rb
 - test/test_io.rb
 - test/test_kernel.rb
 - test/test_resource_pool.rb
 - test/test_signal.rb
-- test/test_supervisor.rb
 - test/test_thread.rb
 - test/test_thread_pool.rb
 - test/test_throttler.rb

data/lib/polyphony/core/supervisor.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-export_default :Supervisor
-
-import '../extensions/fiber'
-Exceptions = import './exceptions'
-
-# Implements a supervision mechanism for controlling multiple fibers
-class Supervisor
-  def initialize
-    @fibers = []
-    @pending = {}
-    yield(self) if block_given?
-  end
-
-  def await(&block)
-    @mode = :await
-    @supervisor_fiber = Fiber.current
-    block&.(self)
-    suspend
-    @fibers.map(&:result)
-  rescue Exceptions::MoveOn => e
-    e.value
-  ensure
-    finalize_await
-  end
-  alias_method :join, :await
-
-  def select(&block)
-    @mode = :select
-    @select_fiber = nil
-    @supervisor_fiber = Fiber.current
-    block&.(self)
-    suspend
-    [@select_fiber.result, @select_fiber]
-  rescue Exceptions::MoveOn => e
-    e.value
-  ensure
-    finalize_select
-  end
-
-  def finalize_await
-    if still_running?
-      stop_all_tasks
-      suspend
-    else
-      @supervisor_fiber = nil
-    end
-  end
-
-  def finalize_select
-    stop_all_tasks if still_running?
-    @supervisor_fiber = nil
-  end
-
-  def spin(orig_caller = caller, &block)
-    add Fiber.spin(orig_caller, &block)
-  end
-
-  def add(fiber)
-    @fibers << fiber
-    @pending[fiber] = true
-    fiber.when_done { task_completed(fiber) }
-    fiber
-  end
-  alias_method :<<, :add
-
-  def still_running?
-    !@pending.empty?
-  end
-
-  def interrupt(result = nil)
-    return unless @supervisor_fiber && !@stopped
-
-    @stopped = true
-    @supervisor_fiber.schedule Exceptions::MoveOn.new(nil, result)
-  end
-  alias_method :stop, :interrupt
-
-  def stop_all_tasks
-    exception = Exceptions::MoveOn.new
-    @pending.each_key do |c|
-      c.schedule(exception)
-    end
-  end
-
-  def task_completed(fiber)
-    return unless @pending[fiber]
-
-    @pending.delete(fiber)
-    return unless @pending.empty? || (@mode == :select && !@select_fiber)
-
-    @select_fiber = fiber if @mode == :select
-    @supervisor_fiber&.schedule
-  end
-end
-
-# Supervision extensions for Fiber class
-class ::Fiber
-  class << self
-    def await(*fibers)
-      supervisor = Supervisor.new
-      fibers.each { |f| supervisor << f }
-      supervisor.await
-    end
-    alias_method :join, :await
-
-    def select(*fibers)
-      supervisor = Supervisor.new
-      fibers.each { |f| supervisor << f }
-      supervisor.select
-    end
-  end
-end

data/lib/polyphony/line_reader.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-export_default :LineReader
-
-Core = import('./core')
-
-# a stream that can read single lines from another stream
-class LineReader
-  # Initializes the line reader with a source and optional line separator
-  # @param source [Stream] source stream
-  # @param sep [String] line separator
-  def initialize(source = nil, sep = $/)
-    @source = source
-    if source
-      source.on(:data) { |data| push(data) }
-      source.on(:close) { close }
-      source.on(:error) { |err| error(err) }
-    end
-    @read_buffer = +''
-    @separator = sep
-    @separator_size = sep.bytesize
-  end
-
-  # Pushes data into the read buffer and emits lines
-  # @param data [String] data to be read
-  # @return [void]
-  def push(data)
-    @read_buffer << data
-    emit_lines
-  end
-
-  # Emits lines from the read buffer
-  # @return [void]
-  def emit_lines
-    while (line = _gets)
-      @lines_promise.resolve(line)
-    end
-  end
-
-  # Returns a line sliced from the read buffer
-  # @return [String] line
-  def _gets
-    idx = @read_buffer.index(@separator)
-    idx && @read_buffer.slice!(0, idx + @separator_size)
-  end
-
-  def gets
-    Core.promise do |p|
-      @lines_promise = p
-    end
-  end
-
-  # Returns a async generator of lines
-  # @return [Promise] line generator
-  def lines
-    Core.generator do |p|
-      @lines_promise = p
-    end
-  end
-
-  # Iterates asynchronously over lines received
-  # @return [void]
-  def each_line(&block)
-    lines.each(&block)
-  end
-
-  # Closes the stream and cancels any pending reads
-  # @return [void]
-  def close
-    @lines_promise&.stop
-  end
-
-  # handles error generated by source
-  # @param err [Exception] raised error
-  # @return [void]
-  def error(err)
-    return unless @lines_promise
-
-    @lines_promise.stop
-    @lines_promise.reject(err)
-  end
-end

data/test/test_gyro.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'helper'
-
-class GyroTest < MiniTest::Test
-  def test_break
-    skip "break is still not implemented for new scheduler"
-    values = []
-    Fiber.spin do
-      values << :foo
-      snooze
-      # here will never be reached
-      values << :bar
-      suspend
-    end
-
-    Fiber.spin do
-      Gyro.break!
-    end
-
-    suspend
-
-    assert_equal [:foo], values
-  end
-end