polyphony 0.13 → 0.14

data/test/test_ev.rb

@@ -0,0 +1,117 @@
+require 'minitest/autorun'
+require 'modulation'
+
+module EVTest
+  Core = import('../lib/polyphony/core')
+
+  class RunTest < Minitest::Test
+    def setup
+      EV.break
+      EV.restart
+    end
+
+    def test_that_run_loop_returns_immediately_if_no_watchers
+      t0 = Time.now
+      suspend
+      t1 = Time.now
+      assert (t1 - t0) < 0.001
+    end
+  end
+
+  class TimerTest < MiniTest::Test
+    def setup
+      EV.break
+      EV.restart
+    end
+
+    def test_that_one_shot_timer_works
+      count = 0
+      t = EV::Timer.new(0.01, 0)
+      t.start { count += 1}
+      suspend
+      assert_equal(1, count)
+    end
+
+    def test_that_repeating_timer_works
+      count = 0
+      t = EV::Timer.new(0.001, 0.001)
+      t.start { count += 1; t.stop if count >= 3}
+      suspend
+      assert_equal(3, count)
+    end
+  end
+  
+  class IOTest < MiniTest::Test
+    def setup
+      EV.break
+      EV.restart
+    end
+
+    def test_that_reading_works
+      i, o = IO.pipe
+      data = +''
+      w = EV::IO.new(i, :r)
+      w.start do
+        i.read_nonblock(8192, data)
+        w.stop unless data.empty?
+      end
+      EV::Timer.new(0, 0).start { o << 'hello' }
+      suspend
+      assert_equal('hello', data)
+    end
+  end
+
+  class SignalTest < MiniTest::Test
+    def setup
+      EV.break
+      EV.restart
+    end
+
+    def test_that_signal_watcher_receives_signal
+      sig = Signal.list['USR1']
+      count = 0
+      w = EV::Signal.new(sig) { count += 1; w.stop }
+      Thread.new { sync_sleep 0.001; Process.kill(:USR1, Process.pid) }
+      suspend
+      assert_equal(1, count)
+    end
+
+    def test_that_signal_watcher_receives_signal
+      count = 0
+      w = Core.trap(:usr1, true) { count += 1; w.stop }
+      assert_kind_of(EV::Signal, w)
+      Thread.new { sync_sleep 0.001; Process.kill(:USR1, Process.pid) }
+      suspend
+      assert_equal(1, count)
+    end
+  end
+
+  class AsyncTest < MiniTest::Test
+    def setup
+      EV.break
+      EV.restart
+    end
+
+    def test_that_async_watcher_receives_signal_across_threads
+      count = 0
+      a = EV::Async.new { count += 1; a.stop }
+      Thread.new { sync_sleep 0.001; a.signal! }
+      suspend
+      assert_equal(1, count)
+    end
+
+    def test_that_async_watcher_coalesces_signals
+      count = 0
+      a = EV::Async.new do
+        count += 1
+        EV::Timer.new(0.01, 0).start { a.stop }
+      end
+      Thread.new do
+        sync_sleep 0.001
+        3.times { a.signal! }
+      end
+      suspend
+      assert_equal(1, count)
+    end
+  end
+end

data/test/test_io.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+require 'modulation'
+
+module IOTests
+  Core        = import('../lib/polyphony/core')
+  import('../lib/polyphony/extensions/io')
+
+  class IOTest < MiniTest::Test
+    def setup
+      EV.rerun
+    end
+
+    def test_that_io_does_not_block
+      i, o = IO.pipe
+      count = 0
+      msg = nil
+      [
+        spawn {
+          o.write("hello")
+          o.close
+        },
+
+        spawn {
+          while count < 5
+            sleep 0.01
+            count += 1
+          end
+        }, 
+
+        spawn {
+          msg = i.read
+        }
+      ].each(&:await)
+      assert_equal(5, count)
+      assert_equal("hello", msg)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: '0.13'
+  version: '0.14'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-05 00:00:00.000000000 Z
+date: 2019-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modulation
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
@@ -102,15 +102,116 @@ extensions:
 extra_rdoc_files:
 - README.md
 files:
+- ".gitbook.yaml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".vscode/launch.json"
 - CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
+- Rakefile
+- TODO.md
+- docs/getting-started/getting-started.md
+- docs/getting-started/tutorial.md
+- docs/summary.md
+- examples/core/cancel.rb
+- examples/core/channel_echo.rb
+- examples/core/enumerator.rb
+- examples/core/fork.rb
+- examples/core/genserver.rb
+- examples/core/lock.rb
+- examples/core/move_on.rb
+- examples/core/move_on_twice.rb
+- examples/core/move_on_with_ensure.rb
+- examples/core/multiple_async.rb
+- examples/core/nested_async.rb
+- examples/core/nested_cancel.rb
+- examples/core/nested_multiple_async.rb
+- examples/core/next_tick.rb
+- examples/core/pulse.rb
+- examples/core/resource.rb
+- examples/core/resource_cancel.rb
+- examples/core/resource_delegate.rb
+- examples/core/sleep.rb
+- examples/core/sleep2.rb
+- examples/core/spawn.rb
+- examples/core/spawn_cancel.rb
+- examples/core/spawn_error.rb
+- examples/core/supervisor.rb
+- examples/core/supervisor_with_cancel_scope.rb
+- examples/core/supervisor_with_error.rb
+- examples/core/supervisor_with_manual_move_on.rb
+- examples/core/thread.rb
+- examples/core/thread_cancel.rb
+- examples/core/thread_pool.rb
+- examples/core/throttle.rb
+- examples/fs/read.rb
+- examples/interfaces/pg_client.rb
+- examples/interfaces/pg_pool.rb
+- examples/interfaces/pg_query.rb
+- examples/interfaces/redis_channels.rb
+- examples/interfaces/redis_client.rb
+- examples/interfaces/redis_pubsub.rb
+- examples/interfaces/redis_pubsub_perf.rb
+- examples/io/config.ru
+- examples/io/echo_client.rb
+- examples/io/echo_server.rb
+- examples/io/echo_server_with_timeout.rb
+- examples/io/echo_stdin.rb
+- examples/io/happy_eyeballs.rb
+- examples/io/http_client.rb
+- examples/io/http_server.js
+- examples/io/http_server.rb
+- examples/io/http_server_forked.rb
+- examples/io/http_server_throttled.rb
+- examples/io/http_ws_server.rb
+- examples/io/https_client.rb
+- examples/io/https_server.rb
+- examples/io/https_wss_server.rb
+- examples/io/rack_server.rb
+- examples/io/rack_server_https.rb
+- examples/io/rack_server_https_forked.rb
+- examples/io/websocket_server.rb
+- examples/io/ws_page.html
+- examples/io/wss_page.html
+- examples/performance/perf_multi_snooze.rb
+- examples/performance/perf_snooze.rb
+- examples/performance/thread-vs-fiber/polyphony_server.rb
+- examples/performance/thread-vs-fiber/threaded_server.rb
+- examples/streams/lines.rb
+- examples/streams/stdio.rb
+- ext/ev/async.c
+- ext/ev/child.c
+- ext/ev/ev.h
+- ext/ev/ev_ext.c
+- ext/ev/ev_module.c
 - ext/ev/extconf.rb
+- ext/ev/io.c
+- ext/ev/libev.h
+- ext/ev/signal.c
+- ext/ev/timer.c
+- ext/libev/Changes
+- ext/libev/LICENSE
+- ext/libev/README
+- ext/libev/README.embed
+- ext/libev/ev.c
+- ext/libev/ev.h
+- ext/libev/ev_epoll.c
+- ext/libev/ev_kqueue.c
+- ext/libev/ev_poll.c
+- ext/libev/ev_port.c
+- ext/libev/ev_select.c
+- ext/libev/ev_vars.h
+- ext/libev/ev_win32.c
+- ext/libev/ev_wrap.h
+- ext/libev/test_libev_win32.c
 - lib/polyphony.rb
 - lib/polyphony/core.rb
-- lib/polyphony/core/async.rb
 - lib/polyphony/core/cancel_scope.rb
 - lib/polyphony/core/channel.rb
-- lib/polyphony/core/coroutine.rb
+- lib/polyphony/core/coprocess.rb
 - lib/polyphony/core/exceptions.rb
 - lib/polyphony/core/fiber_pool.rb
 - lib/polyphony/core/supervisor.rb
@@ -134,11 +235,16 @@ files:
 - lib/polyphony/http/server.rb
 - lib/polyphony/line_reader.rb
 - lib/polyphony/net.rb
-- lib/polyphony/net_old.rb
 - lib/polyphony/resource_pool.rb
 - lib/polyphony/server_task.rb
 - lib/polyphony/testing.rb
 - lib/polyphony/version.rb
+- lib/polyphony/websocket.rb
+- polyphony.gemspec
+- test/test_coprocess.rb
+- test/test_core.rb
+- test/test_ev.rb
+- test/test_io.rb
 homepage: http://github.com/digital-fabric/polyphony
 licenses:
 - MIT

data/lib/polyphony/core/async.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-export :async_decorate, :call_proc_with_optional_block
-
-Coroutine = import('./coroutine')
-FiberPool = import('./fiber_pool')
-
-# Converts a regular method into an async method, i.e. a method that returns a
-# proc that eventually executes the original code.
-# @param receiver [Object] object receiving the method call
-# @param sym [Symbol] method name
-# @return [void]
-def async_decorate(receiver, sym)
-  sync_sym = :"sync_#{sym}"
-  receiver.alias_method(sync_sym, sym)
-  receiver.define_method(sym) do |*args, &block|
-    Coroutine.new { send(sync_sym, *args, &block) }
-  end
-end
-
-# Calls a proc with a block if both are given. Otherwise, call the first
-# non-nil proc. This allows syntax such as:
-#
-#     # in fact, the call to #nexus returns a proc which takes a block
-#     await nexus { ... }
-#
-# @param proc [Proc] proc A
-# @param block [Proc] proc B
-# @return [any] return value of proc invocation
-def call_proc_with_optional_block(proc, block)
-  if proc && block
-    proc.call(&block)
-  else
-    (proc || block).call
-  end
-end

data/lib/polyphony/net_old.rb

@@ -1,299 +0,0 @@
-# frozen_string_literal: true
-
-export :Server, :Socket
-
-require 'socket'
-require 'openssl'
-
-Core  = import('./core')
-IO    = import('./io')
-
-# Implements a TCP server
-class Server
-  # Initializes server
-  def initialize(opts = {})
-    @opts = opts
-    @callbacks = {}
-  end
-
-  # Listens on host and port given in opts
-  # @param opts [Hash] options
-  # @return [void]
-  def listen(opts)
-    @secure_context = opts[:secure_context]
-    @server = opts[:socket] || create_server_socket(opts)
-    @watcher = EV::IO.new(@server, :r, true) { accept_from_socket }
-  end
-
-  # Creates a server socket for listening to incoming connections
-  # @param opts [Hash] listening options
-  # @return [Net::Socket]
-  def create_server_socket(opts)
-    socket = TCPServer.new(opts[:host] || '127.0.0.1', opts[:port])
-    if @secure_context
-      socket = OpenSSL::SSL::SSLServer.new(socket, @secure_context)
-      socket.start_immediately = false
-      setup_alpn(opts[:alpn_protocols]) if opts[:alpn_protocols]
-    end
-    socket
-  end
-
-  # Sets up ALPN protocols negotiated during handshake
-  # @param server_protocols [Array<String>] protocols supported by server
-  # @return [void]
-  def setup_alpn(server_protocols)
-    @secure_context.alpn_protocols = server_protocols
-    @secure_context.alpn_select_cb = proc do |client_protocols|
-      # select first common protocol
-      (server_protocols & client_protocols).first
-    end
-  end
-
-  # Returns true if server is listening
-  # @return [Boolean]
-  def listening?
-    @server
-  end
-
-  # Closes the server socket
-  # @return [void]
-  def close
-    Core.unwatch(@server)
-    @server.close
-    @server = nil
-  end
-
-  # Accepts an incoming connection, triggers the :connection callback
-  # @return [void]
-  def accept_from_socket
-    socket = @server.accept
-    setup_connection(socket) if socket
-  rescue StandardError => e
-    puts "error in accept_from_socket: #{e.inspect}"
-    puts e.backtrace.join("\n")
-  end
-
-  # Sets up an accepted connection
-  # @param socket [TCPSocket] accepted socket
-  # @return [Net::Socket]
-  def setup_connection(socket)
-    opts = { connected: true, secure_context: @secure_context }
-    if @secure_context
-      connection = SecureSocket.new(socket, opts)
-      connection.on(:handshake, &@callbacks[:connection])
-    else
-      connection = Socket.new(socket, opts)
-      @callbacks[:connection]&.(connection)
-    end
-  end
-
-  # Registers a callback for given event
-  # @param event [Symbol] event kind
-  # @return [void]
-  def on(event, &block)
-    @callbacks[event] = block
-  end
-
-  # Returns a promise fulfilled upon the first incoming connection
-  # @return [Promise]
-  def connection(&block)
-    Core.promise(then: block, catch: block) do |p|
-      @callbacks[:connection] = p.to_proc
-    end
-  end
-
-  # Creates a generator promise, iterating asynchronously over incoming
-  # connections
-  # @return [void]
-  def each_connection(&block)
-    Core.promise(recurring: true) do |p|
-      @callbacks[:connection] = p.to_proc
-    end.each(&block)
-  end
-end
-
-# Client connection functionality
-module ClientConnection
-  # Connects to the given host & port, returning a promise fulfilled once
-  # connected. Options can include:
-  #   :timeout => connection timeout in seconds
-  # @param host [String] host domain name or IP address
-  # @param port [Integer] port number
-  # @param opts [Hash] options
-  # @return [Promise] connection promise
-  def connect(host, port, opts = {})
-    Core.promise do |p|
-      socket = ::Socket.new(::Socket::AF_INET, ::Socket::SOCK_STREAM)
-      p.timeout(opts[:timeout]) { connect_timeout(socket) } if opts[:timeout]
-      connect_async(socket, host, port, p)
-    end
-  end
-
-  # Connects asynchronously to a TCP Server
-  # @param socket [TCPSocket] socket to use for connection
-  # @param host [String] host domain name or ip address
-  # @param port [Integer] server port number
-  # @param promise [Promise] connection promise
-  # @return [void]
-  def connect_async(socket, host, port, promise)
-    addr = ::Socket.sockaddr_in(port, host)
-    result = socket.connect_nonblock addr, exception: false
-    handle_connect_result(result, socket, host, port, promise)
-  rescue StandardError => e
-    promise.reject(e)
-  end
-
-  # Handles result of asynchronous connection
-  # @param result [Integer, Symbol, nil] result of call to IO#connect_nonblock
-  # @param socket [TCPSocket] socket to use for connection
-  # @param host [String] host domain name or ip address
-  # @param port [Integer] server port number
-  # @param promise [Promise] connection promise
-  # @return [void]
-  def handle_connect_result(result, socket, host, port, promise)
-    case result
-    when :wait_writable
-      connect_async_pending(socket, host, port, promise)
-    when 0
-      @connection_pending = false
-      connect_success(socket, promise)
-    else
-      handle_invalid_connect_result(result, socket)
-    end
-  end
-
-  # Handles result of asynchronous connection
-  # @param result [Integer, Symbol, nil] result of call to IO#connect_nonblock
-  # @param socket [TCPSocket] socket to use for connection
-  def handle_invalid_connect_result(result, socket)
-    invalid_connect_result(result, socket)
-    @connection_pending = false
-    Core.unwatch(socket)
-    @monitor = nil
-    raise "Invalid result from connect_nonblock: #{result.inspect}"
-  end
-
-  # Sets connection pending state
-  # @param socket [TCPSocket] socket to use for connection
-  # @param host [String] host domain name or ip address
-  # @param port [Integer] server port number
-  # @param promise [Promise] connection promise
-  # @return [void]
-  def connect_async_pending(socket, host, port, promise)
-    create_watcher(socket, true, true)
-    @connection_pending = [socket, host, port, promise]
-  end
-
-  # Overrides IO#write_to_io to support async connection
-  # @return [void]
-  def write_to_io
-    @connection_pending ? connect_async(*@connection_pending) : super
-  end
-
-  # Sets socket and connected status on successful connection
-  # @param socket [TCPSocket] TCP socket
-  # @param promise [Promise] connection promise
-  # @return [void]
-  def connect_success(socket, promise)
-    @io = socket
-    @connected = true
-    promise.resolve(socket)
-  end
-
-  # Called upon connection timeout, cleans up
-  # @param socket [TCPSocket] TCP socket
-  # @return [void]
-  def connect_timeout(socket)
-    @connection_pending = false
-    Core.unwatch(socket)
-    @monitor = nil
-    socket.close
-  end
-end
-
-# ALPN protocol
-module ALPN
-  # returns the ALPN protocol used for the given socket
-  # @return [String, nil]
-  def alpn_protocol
-    secure? && raw_io.alpn_protocol
-  end
-end
-
-# Encapsulates a TCP socket
-class Socket < IO
-  include ClientConnection
-  include ALPN
-
-  # Initializes socket
-  def initialize(socket = nil, opts = {})
-    super(socket, opts)
-    @connected = opts[:connected]
-  end
-
-  # Returns true if socket is connected
-  # @return [Boolean]
-  def connected?
-    @connected
-  end
-
-  # Returns false
-  # @return [false]
-  def secure?
-    false
-  end
-
-  # Sets socket option
-  # @return [void]
-  def setsockopt(*args)
-    @io.setsockopt(*args)
-  end
-end
-
-# Socket with TLS handshake functionality
-class SecureSocket < Socket
-  # Initializes secure socket
-  def initialize(socket = nil, opts = {})
-    super
-    accept_secure_handshake
-  end
-
-  # Returns true
-  # @return [true]
-  def secure?
-    true
-  end
-
-  # accepts secure handshake asynchronously
-  # @return [void]
-  def accept_secure_handshake
-    @pending_secure_handshake = true
-    result = @io.accept_nonblock(exception: false)
-    handle_accept_secure_handshake_result(result)
-  rescue StandardError => e
-    close_on_error(e)
-  end
-
-  # Handles result of secure handshake
-  # @param result [Integer, any] result of call to accept_nonblock
-  # @return [void]
-  def handle_accept_secure_handshake_result(result)
-    case result
-    when :wait_readable
-      @watcher_r.start
-    when :wait_writable
-      @watcher_w.start
-    else
-      @pending_secure_handshake = false
-      @watcher_r.start
-      @watcher_w.stop
-      @callbacks[:handshake]&.(self)
-    end
-  end
-
-  # Overrides read_from_io to accept secure handshake
-  # @return [void]
-  def read_from_io
-    @pending_secure_handshake ? accept_secure_handshake : super
-  end
-end