polyphony 0.47.2 → 0.47.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f9e7ffec31a2009f8000e7b88473e21581de37640ee2d5c6357550883d7bc7c
-  data.tar.gz: d3f8262b8373e7a337dacc0c8e04b1b25ddf0254445b146787a5aa82520dee30
+  metadata.gz: 89890bc8a81fd4f0a80f6d84c7f5138cfda12bc99848e74ef8140abf681640e2
+  data.tar.gz: d18e210b24f3d0eb2f83c1dcb188e7c1c691f949231ef0b3d07bd926c988f4d6
 SHA512:
-  metadata.gz: 0203bd8d66851f3eeed446f7537183e5b66a422f5f5c68b79a1b99f5c3762e243d1027cd77ccbe255012b9450a56b336c9da2e78e91b867adee8f3353351db7c
-  data.tar.gz: 74ef01b9828d4ba0c6a67cd8a402551484c935234fb7d259146d6cfd5033149f7376aa98068dc8f30168c0ec783015208326455795926d02b385e1bda27d1f37
+  metadata.gz: c95bef00de396f601f91937c780202a26d0e9c5a3eb48f564d1dcb70d89b30c12ebbbc89c9ddb10b81b013f9a89398468b8b3b4c1d3158d00110e3e6ea5355a6
+  data.tar.gz: 3c31dac6a239e73b6dbf028edfeced82ac6b2d17ba2f5f2960a41aa9d74e57336082bbe038a8ed6701a2ceefaf68cacb74764f9f71c81ce1e36d5868702e5346

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.47.3
+
+* Enable I/O in signal handlers (#45)
+* Accept `:interval` argument in `#spin_loop`
+
 ## 0.47.2
 
 * Fix API compatibility between TCPSocket and IO

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polyphony (0.47.2)
+    polyphony (0.47.3)
 
 GEM
   remote: https://rubygems.org/

data/TODO.md

@@ -1,3 +1,35 @@
+Graceful shutdown again:
+
+- Add `Polyphony::GracefulShutdown` exception
+- Two exceptions for stopping fibers:
+  - `Polyphony::GracefulShutdown` - graceful shutdown
+  - `Polyphony::Terminate` - ungraceful shutdown
+- Fiber API:
+  - `Fiber#shutdown_children` - graceful shutdown of all children
+  - `Fiber#terminate_children` - ungraceful shutdown of all children
+
+- Add `Fiber#graceful_shutdown?` method
+  - Returns false unless a `Polyphony::GracefulShutdown` was raised
+- Override `Polyphony::Terminate#invoke` to reset the `@graceful_shutdown` fiber
+  flag
+
+And then we have:
+
+```ruby
+spin do
+  loop { do_some_stuff }
+ensure
+  return unless Fiber.current.graceful_shutdown?
+
+shutdown_gracefully
+end
+```
+
+- When a fiber is stopped it should use `Polyphony::Terminate` to stop child
+  fibers, *unless* it was stopped with a `Polyphony::GracefulShutdown` (which it
+  can check with `@graceful_shutdown`).
+
+
 ## Roadmap for Polyphony 1.0
 
 - Check why worker-thread example doesn't work.

data/lib/polyphony/core/global_api.rb

@@ -53,10 +53,10 @@ module Polyphony
       Fiber.current.spin(tag, caller, &block)
     end
 
-    def spin_loop(tag = nil, rate: nil, &block)
-      if rate
+    def spin_loop(tag = nil, rate: nil, interval: nil, &block)
+      if rate || interval
         Fiber.current.spin(tag, caller) do
-          throttled_loop(rate, &block)
+          throttled_loop(rate: rate, interval: interval, &block)
         end
       else
         Fiber.current.spin(tag, caller) { loop(&block) }
@@ -73,17 +73,8 @@ module Polyphony
       end.await
     end
 
-    def every(interval)
-      next_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) + interval
-      loop do
-        now = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-        Thread.current.backend.sleep(next_time - now)
-        yield
-        loop do
-          next_time += interval
-          break if next_time > now
-        end
-      end
+    def every(interval, &block)
+      Thread.current.backend.timer_loop(interval, &block)
     end
 
     def move_on_after(interval, with_value: nil, &block)

data/lib/polyphony/core/resource_pool.rb

@@ -58,18 +58,7 @@ module Polyphony
     # Discards the currently-acquired resource
     # instead of returning it to the pool when done.
     def discard!
-      if block_given?
-        @size.times do
-          acquire do |r|
-            next if yield(r)
-
-            @size -= 1
-            @acquired_resources.delete(Fiber.current)
-          end
-        end
-      else
-        @size -= 1 if @acquired_resources.delete(Fiber.current)
-      end
+      @size -= 1 if @acquired_resources.delete(Fiber.current)
     end
 
     def preheat!

data/lib/polyphony/extensions/fiber.rb

@@ -173,6 +173,7 @@ module Polyphony
     # signals (see also the patched `Kernel#trap`)
     def schedule_priority_oob_fiber(&block)
       f = Fiber.new do
+        Fiber.current.setup_raw
         block.call
       rescue Exception => e
         Thread.current.schedule_and_wakeup(Thread.main.main_fiber, e)
@@ -262,6 +263,7 @@ module Polyphony
     # allows the fiber to be scheduled and to receive messages.
     def setup_raw
       @thread = Thread.current
+      @running = true
     end
 
     def setup_main_fiber

data/lib/polyphony/version.rb

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

data/test/test_global_api.rb

@@ -210,7 +210,7 @@ class CancelAfterTest < MiniTest::Test
       sleep 0.007
     end
     t1 = Time.now
-    assert_in_range 0.014..0.02, t1 - t0
+    assert_in_range 0.014..0.024, t1 - t0
   end
 
   class CustomException < Exception
@@ -297,6 +297,16 @@ class SpinLoopTest < MiniTest::Test
     f.stop
     assert_in_range 1..3, counter
   end
+
+  def test_spin_loop_with_interval
+    buffer = []
+    counter = 0
+    t0 = Time.now
+    f = spin_loop(interval: 0.01) { buffer << (counter += 1) }
+    sleep 0.02
+    f.stop
+    assert_in_range 1..3, counter
+  end
 end
 
 class SpinScopeTest < MiniTest::Test

data/test/test_resource_pool.rb

@@ -48,27 +48,6 @@ class ResourcePoolTest < MiniTest::Test
     assert_equal 1, pool.size
   end
 
-  def test_discard_with_block
-    resources = [+'a', +'b', +'c', +'d', +'e', +'f']
-    pool = Polyphony::ResourcePool.new(limit: 4) { resources.shift }
-
-    buffer = []
-    (1..4).each do |i|
-      spin do
-        3.times do
-          pool.acquire { |r| buffer << [i, r]; trace [i]; snooze }
-        end
-      end
-    end
-
-    2.times { trace [0]; snooze }
-    assert_equal [[1, 'a'], [2, 'b'], [3, 'c'], [4, 'd']], buffer
-
-    pool.discard! { |r| r == 'a' || r == 'c' }
-    2.times { trace [0]; snooze }
-    assert_equal [[1, 'a'], [2, 'b'], [3, 'c'], [4, 'd'], [1, 'b'], [2, 'd'], [3, 'e'], [4, 'f']], buffer
-  end
-
   def test_single_resource_limit
     resources = [+'a', +'b']
     pool = Polyphony::ResourcePool.new(limit: 1) { resources.shift }

data/test/test_signal.rb

@@ -76,4 +76,22 @@ class SignalTrapTest < Minitest::Test
     buffer = i.read
     assert_equal "3-interrupt\n", buffer
   end
+
+  def test_io_in_signal_handler
+    i, o = IO.pipe
+    pid = Polyphony.fork do
+      trap('INT') { o.puts 'INT'; o.close; exit! }
+      i.close
+      sleep
+    ensure
+      o.close
+    end
+
+    o.close
+    sleep 0.1
+    Process.kill('INT', pid)
+    Thread.current.backend.waitpid(pid)
+    buffer = i.read
+    assert_equal "INT\n", buffer
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.47.2
+  version: 0.47.3
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler