polyphony 0.77 → 0.78

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10f049946dc02d9cdd984cc8658687d2319e0fd85f6f2cce74aa0a887bc714cb
-  data.tar.gz: 5118859d4640aebeddb9186c43d58617e9b455a63ea97c1dc8283432db954fd1
+  metadata.gz: 51eecc20956cb4f1a35a7f6510dea2730652700e99d29c7d42ade201a119ea2e
+  data.tar.gz: bc2b57dc2cc5a8918bba1d8bf526cdbe23f44d134f9bdca5018b9e9e66930f91
 SHA512:
-  metadata.gz: e107e21d6c42f9cd9e91521e288dfee37a6f0da4b7d8a8d311924bf88ccf732d2cc94de834dbbaa3c7a974e5bb84ce1d8d20efd68870c9f2dac9b73155d28558
-  data.tar.gz: 8e4f7005c9cbc46cd084bbe66a4e8f7145f6a4a3062ce027a70eee07c0e648f79289515591ef4b48010580b7125c403ab09e45417781346ebf6da4b2d528ec45
+  metadata.gz: 21c446f9a6fa032577b245e6de5155832c8e6932d6c17e58824a55923c82be014453b64b29ccbb66fe5d01cde8622d3275664acda403637954f1e7e6851e93c7
+  data.tar.gz: a57831fe861ac51fa43692b66175291a457077822cdb5f795a093fca1e44bf95fb2b6a312cfe8a6c2b3c3e873319ffd03436e6236874a6acdd45843a21bc4981

data/.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       POLYPHONY_USE_LIBEV: "1"
 
     steps:
-    - name: Setup OS
+    - name: Setup machine
       uses: actions/checkout@v1
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.78 2022-02-16
+
+- Fix Polyphony::Queue API compatibility (#72)
+
 ## 0.77 2022-02-07
 
 - Fix behaviour of signal traps (#71)

data/Gemfile.lock

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

data/ext/polyphony/fiber.c

@@ -97,7 +97,7 @@ VALUE Fiber_receive(VALUE self) {
     mailbox = rb_funcall(cQueue, ID_new, 0);
     rb_ivar_set(self, ID_ivar_mailbox, mailbox);
   }
-  return Queue_shift(mailbox);
+  return Queue_shift(0, 0, mailbox);
 }
 
 VALUE Fiber_mailbox(VALUE self) {

data/ext/polyphony/polyphony.h

@@ -74,7 +74,7 @@ void Fiber_make_runnable(VALUE fiber, VALUE value);
 
 VALUE Queue_push(VALUE self, VALUE value);
 VALUE Queue_unshift(VALUE self, VALUE value);
-VALUE Queue_shift(VALUE self);
+VALUE Queue_shift(int argc,VALUE *argv, VALUE self);
 VALUE Queue_shift_all(VALUE self);
 
 void Runqueue_push(VALUE self, VALUE fiber, VALUE value, int reschedule);

data/ext/polyphony/queue.c

@@ -2,6 +2,7 @@
 #include "ring_buffer.h"
 
 typedef struct queue {
+  unsigned int closed;
   ring_buffer values;
   ring_buffer shift_queue;
   ring_buffer push_queue;
@@ -9,6 +10,8 @@ typedef struct queue {
 } Queue_t;
 
 VALUE cQueue = Qnil;
+VALUE cClosedQueueError = Qnil;
+VALUE cThreadError = Qnil;
 
 static void Queue_mark(void *ptr) {
   Queue_t *queue = ptr;
@@ -49,6 +52,7 @@ static VALUE Queue_initialize(int argc, VALUE *argv, VALUE self) {
   Queue_t *queue;
   GetQueue(self, queue);
 
+  queue->closed = 0;
   ring_buffer_init(&queue->values);
   ring_buffer_init(&queue->shift_queue);
   ring_buffer_init(&queue->push_queue);
@@ -99,6 +103,9 @@ VALUE Queue_push(VALUE self, VALUE value) {
   Queue_t *queue;
   GetQueue(self, queue);
 
+  if (queue->closed)
+    rb_raise(cClosedQueueError, "queue closed");
+
   if (queue->capacity) capped_queue_block_push(queue);
 
   queue_schedule_first_blocked_fiber(&queue->shift_queue);
@@ -111,6 +118,9 @@ VALUE Queue_unshift(VALUE self, VALUE value) {
   Queue_t *queue;
   GetQueue(self, queue);
 
+  if (queue->closed)
+    rb_raise(cClosedQueueError, "queue closed");
+
   if (queue->capacity) capped_queue_block_push(queue);
 
   queue_schedule_first_blocked_fiber(&queue->shift_queue);
@@ -119,14 +129,25 @@ VALUE Queue_unshift(VALUE self, VALUE value) {
   return self;
 }
 
-VALUE Queue_shift(VALUE self) {
-  Queue_t *queue;
+VALUE Queue_shift_nonblock(Queue_t *queue) {
+  if (queue->values.count) {
+    VALUE value = ring_buffer_shift(&queue->values);
+    if ((queue->capacity) && (queue->capacity > queue->values.count))
+      queue_schedule_first_blocked_fiber(&queue->push_queue);
+    RB_GC_GUARD(value);
+    return value;
+  }
+  rb_raise(cThreadError, "queue empty");
+}
+
+VALUE Queue_shift_block(Queue_t *queue) {
   VALUE fiber = rb_fiber_current();
   VALUE thread = rb_thread_current();
   VALUE backend = rb_ivar_get(thread, ID_ivar_backend);
   VALUE value;
 
-  GetQueue(self, queue);
+  if (queue->closed && !queue->values.count)
+    rb_raise(cClosedQueueError, "queue closed");
 
   while (1) {
     VALUE switchpoint_result;
@@ -140,6 +161,7 @@ VALUE Queue_shift(VALUE self) {
     RAISE_IF_EXCEPTION(switchpoint_result);
     RB_GC_GUARD(switchpoint_result);
     if (queue->values.count) break;
+    if (queue->closed) return Qnil;
   }
   value = ring_buffer_shift(&queue->values);
   if ((queue->capacity) && (queue->capacity > queue->values.count))
@@ -148,6 +170,16 @@ VALUE Queue_shift(VALUE self) {
   return value;
 }
 
+VALUE Queue_shift(int argc,VALUE *argv, VALUE self) {
+  int nonblock = argc && RTEST(argv[0]);
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  return nonblock ?
+    Queue_shift_nonblock(queue) :
+    Queue_shift_block(queue);
+}
+
 VALUE Queue_delete(VALUE self, VALUE value) {
   Queue_t *queue;
   GetQueue(self, queue);
@@ -244,6 +276,13 @@ VALUE Queue_pending_p(VALUE self) {
   return (queue->shift_queue.count) ? Qtrue : Qfalse;
 }
 
+VALUE Queue_num_waiting(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  return INT2NUM(queue->shift_queue.count);
+}
+
 VALUE Queue_size_m(VALUE self) {
   Queue_t *queue;
   GetQueue(self, queue);
@@ -251,20 +290,54 @@ VALUE Queue_size_m(VALUE self) {
   return INT2NUM(queue->values.count);
 }
 
+VALUE Queue_closed_p(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  return (queue->closed) ? Qtrue : Qfalse;
+}
+
+VALUE Queue_close(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  if (queue->closed) goto end;
+  queue->closed = 1;
+
+  // release all fibers waiting on `#shift`
+  while (queue->shift_queue.count) {
+    VALUE fiber = ring_buffer_shift(&queue->shift_queue);
+    if (fiber == Qnil) break;
+    Fiber_make_runnable(fiber, Qnil);
+  }
+
+end:
+  return self;
+}
+
 void Init_Queue() {
+  cClosedQueueError = rb_const_get(rb_cObject, rb_intern("ClosedQueueError"));
+  cThreadError = rb_const_get(rb_cObject, rb_intern("ThreadError"));
+
   cQueue = rb_define_class_under(mPolyphony, "Queue", rb_cObject);
   rb_define_alloc_func(cQueue, Queue_allocate);
 
   rb_define_method(cQueue, "initialize", Queue_initialize, -1);
   rb_define_method(cQueue, "push", Queue_push, 1);
   rb_define_method(cQueue, "<<", Queue_push, 1);
+  rb_define_method(cQueue, "enq", Queue_push, 1);
   rb_define_method(cQueue, "unshift", Queue_unshift, 1);
 
-  rb_define_method(cQueue, "shift", Queue_shift, 0);
-  rb_define_method(cQueue, "pop", Queue_shift, 0);
+  rb_define_method(cQueue, "shift", Queue_shift, -1);
+  rb_define_method(cQueue, "pop", Queue_shift, -1);
+  rb_define_method(cQueue, "deq", Queue_shift, -1);
+
   rb_define_method(cQueue, "delete", Queue_delete, 1);
   rb_define_method(cQueue, "clear", Queue_clear, 0);
 
+  rb_define_method(cQueue, "size", Queue_size_m, 0);
+  rb_define_method(cQueue, "length", Queue_size_m, 0);
+
   rb_define_method(cQueue, "cap", Queue_cap, 1);
   rb_define_method(cQueue, "capped?", Queue_capped_p, 0);
 
@@ -273,5 +346,8 @@ void Init_Queue() {
   rb_define_method(cQueue, "flush_waiters", Queue_flush_waiters, 1);
   rb_define_method(cQueue, "empty?", Queue_empty_p, 0);
   rb_define_method(cQueue, "pending?", Queue_pending_p, 0);
-  rb_define_method(cQueue, "size", Queue_size_m, 0);
+  rb_define_method(cQueue, "num_waiting", Queue_num_waiting, 0);
+
+  rb_define_method(cQueue, "closed?", Queue_closed_p, 0);
+  rb_define_method(cQueue, "close", Queue_close, 0);
 }

data/lib/polyphony/core/debug.rb

@@ -6,6 +6,8 @@ module ::Kernel
   def format_trace(args)
     if args.size > 1 && args.first.is_a?(String)
       format("%s: %p\n", args.shift, args.size == 1 ? args.first : args)
+    elsif args.size == 1 && args.first.is_a?(String)
+      "#{args.first}\n"
     else
       format("%p\n", args.size == 1 ? args.first : args)
     end

data/lib/polyphony/version.rb

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

data/test/test_queue.rb

@@ -21,6 +21,44 @@ class QueueTest < MiniTest::Test
     assert_equal [1, 2, 3, 4], buf
   end
 
+  def test_chained_push
+    @queue << 5 << 6 << 7
+
+    buf = []
+    3.times { buf << @queue.shift }
+    assert_equal [5, 6, 7], buf
+  end
+
+  def test_push_aliases
+    @queue.push 1
+    @queue << 2
+    @queue.enq 3
+
+    buf = []
+    3.times { buf << @queue.shift }
+    assert_equal [1, 2, 3], buf
+  end
+
+  def test_pop_aliases
+    @queue << 1 << 2 << 3
+
+    assert_equal 1, @queue.pop
+    assert_equal 2, @queue.deq
+    assert_equal 3, @queue.shift
+
+    @queue << 1 << 2 << 3
+
+    assert_equal 1, @queue.pop(false)
+    assert_equal 2, @queue.deq(false)
+    assert_equal 3, @queue.shift(false)
+  end
+
+  def test_nonblocking_pop
+    assert_raises(ThreadError) { @queue.pop(true) }
+    assert_raises(ThreadError) { @queue.deq(true) }
+    assert_raises(ThreadError) { @queue.shift(true) }
+  end
+
   def test_unshift
     @queue.push 1
     @queue.push 2
@@ -112,22 +150,86 @@ class QueueTest < MiniTest::Test
 
   def test_queue_size
     assert_equal 0, @queue.size
+    assert_equal 0, @queue.length
 
     @queue.push 1
 
     assert_equal 1, @queue.size
+    assert_equal 1, @queue.length
 
     @queue.push 2
 
     assert_equal 2, @queue.size
+    assert_equal 2, @queue.length
 
     @queue.shift
 
     assert_equal 1, @queue.size
+    assert_equal 1, @queue.length
 
     @queue.shift
 
     assert_equal 0, @queue.size
+    assert_equal 0, @queue.length
+  end
+
+  def test_pending?
+    assert_equal false, @queue.pending?
+
+    buf = []
+    f = spin { buf << @queue.shift }
+    snooze
+    assert_equal true, @queue.pending?
+
+    @queue << 42
+    f.await
+    assert_equal [42], buf
+    assert_equal false, @queue.pending?
+  end
+
+  def test_num_waiting
+    assert_equal 0, @queue.num_waiting
+
+    f1 = spin { @queue.shift }
+    snooze # allow fiber to start
+    assert_equal 1, @queue.num_waiting
+
+    f2 = spin { @queue.shift }
+    snooze # allow fiber to start
+    assert_equal 2, @queue.num_waiting
+
+    @queue << 1
+    f1.await
+    assert_equal 1, @queue.num_waiting
+
+    @queue << 2
+    f2.await
+    assert_equal 0, @queue.num_waiting
+  end
+
+  def test_closed_queue
+    assert_equal false, @queue.closed?
+
+    buf = []
+    f = spin { buf << @queue.shift }
+    snooze # allow fiber to start
+
+    @queue.close
+    assert_equal true, @queue.closed?
+    cancel_after(1) { f.await }
+    assert_equal [nil], buf
+
+    assert_raises(ClosedQueueError) { @queue << 1 }
+    assert_raises(ClosedQueueError) { @queue.deq }
+    assert_raises(ThreadError) { @queue.pop(true) }
+
+    # test deq on closed non-empty queue
+    @queue = Polyphony::Queue.new
+    @queue << 42 << 43
+    @queue.close
+
+    assert_equal 42, @queue.deq(false)
+    assert_equal 43, @queue.deq(true)
   end
 end
 
@@ -246,4 +348,4 @@ class CappedQueueTest < MiniTest::Test
     a.join
     assert_equal [1, 2, 3, :d5, 4, :d8, 5], buffer
   end
-end
+end

data/test/test_supervise.rb

@@ -269,4 +269,31 @@ class SuperviseTest < MiniTest::Test
     snooze
     assert_equal [[f1, :foo], [f2, :bar]], buffer
   end
+
+  def test_detached_supervisor
+    buffer = []
+
+    s = nil
+    f = spin {
+      foo = spin do
+        sleep 0.1
+      ensure
+        buffer << :foo
+      end
+      bar = spin do
+        sleep 0.2
+      ensure
+        buffer << :bar
+      end
+
+      s = spin { supervise }.detach
+      Fiber.current.attach_all_children_to(s)
+
+      s.terminate(true)
+    }
+
+    f.await
+    s.await
+    assert_equal [:foo, :bar], buffer
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: '0.77'
+  version: '0.78'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler