polyphony 0.45.2 → 0.45.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2fa4fa731ff52272d3aed456f7a26751e76c63b4335366919bffaf089bf96dd
-  data.tar.gz: 1afe67258c5c73d9cc1082ca238eb358dac0f5b7a975f90a77b4f6de6a23b2a4
+  metadata.gz: 52f8ebf1104d921c9e3b0afa0b4605ee8f912eabe8b6264898f23905d2cb6c6f
+  data.tar.gz: 38f0f7cd62997ba5681185c3c4859f57d86de875d8292faf67fffa53c7160181
 SHA512:
-  metadata.gz: 175edf315d759f85d2c0d934be36b9fcacd68342206d984ad64f800120a8b65668e9ea81595f47cbbb439402c256b47fde78f0cdad4b42e0c3b1d6ee321135b9
-  data.tar.gz: 01cfe1d8b51d60a736adb80062eb22e7983a1879a5491cb7a2e47ec4ad5734e0c8bd8664653870a4393276b42fa912953721658ecff634521a672419c8d3cab6
+  metadata.gz: 2429259a2e79757ec879c4c00db8fd8b87302b9e0a61c6ae2ddd5fdb6e1a3a06ac63d551ed33a4c77480e156eb1247a0fab4a263179a60fd2e9a2d3173831a58
+  data.tar.gz: 04f58dafb5faf1e21b08fd85d508ceb6e9869b0a69d63c133661a834f169eb750b599639ffdbff474abf7f92bc6bfee3a43b9442c2885a6dd88328657b0e1d36

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.45.4
+
+* Improve signal trapping mechanism
+
+## 0.45.3
+
+* Don't swallow error in `Process#kill_and_await`
+* Add `Fiber#mailbox` attribute reader
+* Fix bug in `Fiber.await`
+* Implement `IO#getc`, `IO#getbyte`
+
 ## 0.45.2
 
 * Rewrite `Fiber#<<`, `Fiber#await`, `Fiber#receive` in C

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polyphony (0.45.2)
+    polyphony (0.45.4)
 
 GEM
   remote: https://rubygems.org/
@@ -87,7 +87,7 @@ GEM
     rack (2.2.3)
     rainbow (3.0.0)
     rake (12.3.3)
-    rake-compiler (1.0.5)
+    rake-compiler (1.1.1)
       rake
     rb-fsevent (0.10.3)
     rb-inotify (0.10.1)
@@ -141,7 +141,7 @@ DEPENDENCIES
   polyphony!
   pry (= 0.13.1)
   rack (>= 2.0.8, < 2.3.0)
-  rake-compiler (= 1.0.5)
+  rake-compiler (= 1.1.1)
   redis (= 4.1.0)
   rubocop (= 0.85.1)
   sequel (= 5.34.0)

data/TODO.md

@@ -1,8 +1,14 @@
-0.45.2
+(
+  io_uring: some work has been done on an io_uring based scheduler here:
+    https://github.com/dsh0416/evt
+  
+  This can serve as a starting point for doing stuff with io_uring
+)
 
+0.45.4
+
+- Adapter for io/console (what does `IO#raw` do?)
 - Adapter for Pry and IRB (Which fixes #5 and #6)
-- Redesign signal handling - the current mechanism is problematic in that it
-  does not address signals that do not kill, for instance HUP or USR1.
 - Improve `#supervise`. It does not work as advertised, and seems to exhibit an
   inconsistent behaviour (see supervisor example).
 - Fix backtrace for `Timeout.timeout` API (see timeout example).

data/examples/io/raw.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+require 'io/console'
+
+c = STDIN.raw(min: 1, tim: 0, &:getbyte)
+p result: c
+exit
+
+puts '?' * 40
+c = STDIN.getbyte
+puts '*' * 40
+p c

data/examples/io/reline.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+require 'polyphony/adapters/readline'
+require 'pry'
+
+$counter = 0
+timer = spin do
+  throttled_loop(5) do
+    $counter += 1
+  end
+end
+
+at_exit { timer.stop }
+
+puts 'try typing $counter to see the counter incremented in the background'
+binding.pry

data/examples/performance/thread-vs-fiber/polyphony_server.rb

@@ -13,7 +13,7 @@ def handle_client(socket)
   parser.on_message_complete = proc do |env|
     reqs << Object.new # parser
   end
-  socket.read_loop |data|
+  socket.read_loop do |data|
     parser << data
     while (req = reqs.shift)
       handle_request(socket, req)

data/lib/polyphony.rb

@@ -76,10 +76,10 @@ module Polyphony
     end
 
     def install_terminating_signal_handlers
-      trap('SIGTERM', SystemExit)
+      trap('SIGTERM') { raise SystemExit }
       orig_trap('SIGINT') do
         orig_trap('SIGINT') { exit! }
-        Thread.current.break_out_of_ev_loop(Thread.main.main_fiber, Interrupt.new)
+        Fiber.schedule_priority_oob_fiber { raise Interrupt }
       end
     end
 

data/lib/polyphony/adapters/process.rb

@@ -24,9 +24,6 @@ module Polyphony
       def kill_and_await(sig, pid)
         ::Process.kill(sig, pid)
         Thread.current.backend.waitpid(pid)
-      rescue SystemCallError
-        # ignore
-        puts 'SystemCallError in kill_and_await'
       end
     end
   end

data/lib/polyphony/extensions/core.rb

@@ -149,32 +149,19 @@ module ::Kernel
     return orig_trap(sig, command) if command.is_a? String
 
     block = command if !block && command.respond_to?(:call)
-    exception = signal_exception(block, command)
 
     # The signal trap can be invoked at any time, including while the system
     # backend is blocking while polling for events. In order to deal with this
-    # correctly, we spin a fiber that will run the signal handler code, then
-    # call break_out_of_ev_loop, which will put the fiber at the front of the
-    # run queue, then wake up the backend.
-    #
-    # If the command argument is an exception class however, it will be raised
-    # directly in the context of the main fiber.
+    # correctly, we run the signal handler code in an out-of-band, priority
+    # scheduled fiber, that will pass any uncaught exception (including
+    # SystemExit and Interrupt) to the main thread's main fiber. See also
+    # `Fiber#schedule_priority_oob_fiber`.
     orig_trap(sig) do
-      Thread.current.break_out_of_ev_loop(Thread.main.main_fiber, exception)
+      Fiber.schedule_priority_oob_fiber(&block)
     end
   end
 end
 
-def signal_exception(block, command)
-  if block
-    Polyphony::Interjection.new(block)
-  elsif command.is_a?(Class)
-    command.new
-  else
-    raise ArgumentError, 'Must supply block or exception or callable object'
-  end
-end
-
 # Override Timeout to use cancel scope
 module ::Timeout
   def self.timeout(sec, klass = nil, message = nil, &block)

data/lib/polyphony/extensions/fiber.rb

@@ -103,7 +103,7 @@ module Polyphony
       suspend
       fibers.map(&:result)
     ensure
-      await_select_cleanup(state)
+      await_select_cleanup(state) if state
     end
     alias_method :join, :await
 
@@ -165,6 +165,20 @@ module Polyphony
         state[:selected] = true
       end
     end
+
+    # Creates and schedules with priority an out-of-band fiber that runs the
+    # supplied block. If any uncaught exception is raised while the fiber is
+    # running, it will bubble up to the main thread's main fiber, which will
+    # also be scheduled with priority. This method is mainly used trapping
+    # signals (see also the patched `Kernel#trap`)
+    def schedule_priority_oob_fiber(&block)
+      f = Fiber.new do
+        block.call
+      rescue Exception => e
+        Thread.current.break_out_of_ev_loop(Thread.main.main_fiber, e)
+      end
+      Thread.current.break_out_of_ev_loop(f, nil)
+    end
   end
 
   # Methods for controlling child fibers
@@ -173,9 +187,9 @@ module Polyphony
       (@children ||= {}).keys
     end
 
-    def spin(tag = nil, orig_caller = Kernel.caller, &block)
+    def spin(tag = nil, orig_caller = Kernel.caller, do_schedule: true, &block)
       f = Fiber.new { |v| f.run(v) }
-      f.prepare(tag, block, orig_caller, self)
+      f.prepare(tag, block, orig_caller, self, do_schedule: do_schedule)
       (@children ||= {})[f] = true
       f
     end
@@ -213,14 +227,14 @@ module Polyphony
 
   # Fiber life cycle methods
   module FiberLifeCycle
-    def prepare(tag, block, caller, parent)
+    def prepare(tag, block, caller, parent, do_schedule: true)
       @thread = Thread.current
       @tag = tag
       @parent = parent
       @caller = caller
       @block = block
       __fiber_trace__(:fiber_create, self)
-      schedule
+      schedule if do_schedule
     end
 
     def run(first_value)
@@ -314,7 +328,7 @@ class ::Fiber
   extend Polyphony::FiberControlClassMethods
 
   attr_accessor :tag, :thread, :parent
-  attr_reader :result
+  attr_reader :result, :mailbox
 
   def running?
     @running

data/lib/polyphony/extensions/io.rb

@@ -90,11 +90,22 @@ class ::IO
   # def each_codepoint
   # end
 
-  # def getbyte
-  # end
+  alias_method :orig_getbyte, :getbyte
+  def getbyte
+    char = getc
+    char ? char.getbyte(0) : nil
+  end
 
-  # def getc
-  # end
+  alias_method :orig_getc, :getc
+  def getc
+    return @read_buffer.slice!(0) if @read_buffer && !@read_buffer.empty?
+    
+    @read_buffer ||= +''
+    Thread.current.backend.read(self, @read_buffer, 8192, false)
+    return @read_buffer.slice!(0) if !@read_buffer.empty?
+
+    nil
+  end
 
   alias_method :orig_read, :read
   def read(len = nil)

data/lib/polyphony/version.rb

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

data/polyphony.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.6'
 
-  s.add_development_dependency  'rake-compiler',        '1.0.5'
+  s.add_development_dependency  'rake-compiler',        '1.1.1'
   s.add_development_dependency  'minitest',             '5.13.0'
   s.add_development_dependency  'minitest-reporters',   '1.4.2'
   s.add_development_dependency  'simplecov',            '0.17.1'

data/test/test_io.rb

@@ -92,6 +92,48 @@ class IOTest < MiniTest::Test
     assert_raises(EOFError) { i.readpartial(1) }    
   end
 
+  def test_getc
+    i, o = IO.pipe
+
+    buf = []
+    f = spin do
+      while (c = i.getc)
+        buf << c
+      end
+    end
+
+    snooze
+    assert_equal [], buf
+
+    o << 'f'
+    snooze
+    o << 'g'
+    o.close
+    f.await
+    assert_equal ['f', 'g'], buf
+  end
+
+  def test_getbyte
+    i, o = IO.pipe
+
+    buf = []
+    f = spin do
+      while (b = i.getbyte)
+        buf << b
+      end
+    end
+
+    snooze
+    assert_equal [], buf
+
+    o << 'f'
+    snooze
+    o << 'g'
+    o.close
+    f.await
+    assert_equal [102, 103], buf
+  end
+
   # see https://github.com/digital-fabric/polyphony/issues/30
   def test_reopened_tempfile
     file = Tempfile.new

data/test/test_signal.rb

@@ -3,18 +3,21 @@
 require_relative 'helper'
 
 class SignalTrapTest < Minitest::Test
+  def test_int_signal
+    Thread.new { sleep 0.001; Process.kill('INT', Process.pid) }
+    assert_raises(Interrupt) { sleep 5 }
+  end
+
+  def test_term_signal
+    Thread.new { sleep 0.001; Process.kill('TERM', Process.pid) }
+    assert_raises(SystemExit) { sleep 5 }
+  end
+
   def test_signal_exception_handling
     i, o = IO.pipe
     pid = Polyphony.fork do
       i.close
-      spin do
-        spin do
-          sleep 5
-        rescue ::Interrupt => e
-          # the signal should be raised only in the main fiber
-          o.puts "1-interrupt"
-        end.await
-      end.await
+      sleep 5
     rescue ::Interrupt => e
       o.puts "3-interrupt"
     ensure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.45.2
+  version: 0.45.4
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -377,6 +377,8 @@ files:
 - examples/io/open.rb
 - examples/io/pry.rb
 - examples/io/rack_server.rb
+- examples/io/raw.rb
+- examples/io/reline.rb
 - examples/io/system.rb
 - examples/io/tcpserver.rb
 - examples/io/tcpsocket.rb