polyphony 0.17 → 0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16bd848555e9b517c4114a4324fe65d27ed08b2ac3f638a94c10070f99eb1915
-  data.tar.gz: 96dac9a4e8b5fe09f78ad6ffae157f048fdb499fca3c78028145bffdad45cfbd
+  metadata.gz: e79ca0a896fc0b5feffa415e44b9229074d145c2142155caf47f243b6c85078d
+  data.tar.gz: 6aa58f404376be6e6d472e588be4349d6fcaeb3031e5786a0a5ffe0970d9fa5d
 SHA512:
-  metadata.gz: 39dbff6723dfe0e2a9919080d170d16b545081e8f57e8010a7a84402b185c3a7b0dbcb3b11390c854fdeee90f967a8d055d8b4e6adb4c0d4344ac79f7d8a4f94
-  data.tar.gz: cb0a008a4234cab661e8a7e8ed6a70919093d210135c983704e201b043082a8e268ff2d8f11cf755aab64e1118c817ac3287d938282c62d39fe02dd66ef25d19
+  metadata.gz: accbeddc33fd7b1de40f411a421c445bc847e8ee744d98dcd1cf20b0a8fe3fc5c880ca373a020b026a0d68aac9cfc74f179bde2c3cebd1b0733a5adbe2b435b0
+  data.tar.gz: 7549c7ac4528bf4747049fb6c4eecbfe500f6aeed3586f8181bbf21506f8725ebb51c1170e369f15b24c748d59be439a2d076d26de1e5b1a1b6b34ae3e344ade

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+0.19 2019-06-12
+---------------
+
+* Rewrite HTTP server for better concurrency, sequential API
+* Support 204 no-content response in HTTP 1
+* Add optional count parameter to Kernel#throttled_loop for finite looping
+* Implement Fiber#safe_transfer in C
+* Optimize Kernel#next_tick implementation using ev_idle instead of ev_timer
+
+0.18 2019-06-08
+---------------
+
+* Rename Kernel#coproc to Kernel#spin
+* Rewrite Supervisor#spin
+
 0.17 2019-05-24
 ---------------
 

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    polyphony (0.17)
+    polyphony (0.19)
       http-2 (= 0.10.0)
       http_parser.rb (= 0.6.0)
-      modulation (= 0.24)
+      modulation (~> 0.25)
 
 GEM
   remote: https://rubygems.org/
@@ -12,9 +12,16 @@ GEM
     hiredis (0.6.3)
     http-2 (0.10.0)
     http_parser.rb (0.6.0)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
     localhost (1.1.4)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
     minitest (5.11.3)
-    modulation (0.24)
+    modulation (0.25)
+    multi_xml (0.6.0)
     pg (1.1.3)
     rake (12.3.2)
     rake-compiler (1.0.5)
@@ -27,6 +34,7 @@ PLATFORMS
 
 DEPENDENCIES
   hiredis (= 0.6.3)
+  httparty (= 0.17.0)
   localhost (= 1.1.4)
   minitest (= 5.11.3)
   pg (= 1.1.3)

data/README.md

@@ -11,8 +11,8 @@
 > number of parts, each forming an individual melody and harmonizing with each
 > other.
 
-**Note**: Polyphony is designed to work with recent versions of Ruby and
-supports Linux and MacOS only. This software is currently at the alpha stage.
+**Note**: Polyphony is experimental software. It is designed to work with recent
+versions of Ruby (2.5 and newer) and supports Linux and MacOS only.
 
 ## What is Polyphony
 
@@ -41,7 +41,7 @@ takes care of context-switching automatically whenever a blocking call like
   coprocesses, supervisors, cancel scopes, throttling, resource pools etc.
 - Code can use native networking classes and libraries, growing support for
   third-party gems such as `pg` and `redis`.
-- HTTP 1 / HTTP 2 client
+- HTTP 1 / HTTP 2 client agent with persistent connections.
 - Competitive performance and scalability characteristics, in terms of both
   throughput and memory consumption.
 
@@ -70,18 +70,18 @@ The reactor, in turn, may schedule other operations once they can be resumed. In
 that manner, multiple ongoing operations may be processed concurrently.
 
 There are multiple ways to start a concurrent operation, the most common of
-which is `Kernel#coproc`:
+which is `Kernel#spin`:
 
 ```ruby
 require 'polyphony'
 
-coproc do
+spin do
   puts "A going to sleep"
   sleep 1
   puts "A woken up"
 end
 
-coproc do
+spin do
   puts "B going to sleep"
   sleep 1
   puts "B woken up"
@@ -90,7 +90,7 @@ end
 
 In the above example, both `sleep` calls will be executed concurrently, and thus
 the program will take approximately only 1 second to execute. Note the lack of
-any boilerplate relating to concurrency. Each `coproc` block starts a
+any boilerplate relating to concurrency. Each `spin` block starts a
 *coprocess*, and is executed in sequential manner.
 
 > **Coprocesses - the basic unit of concurrency**: In Polyphony, concurrent
@@ -99,8 +99,8 @@ any boilerplate relating to concurrency. Each `coproc` block starts a
 > called, and resumed once that operation has been completed. Coprocesses offer
 > significant advantages over threads - they consume only about 10KB, switching
 > between them is much faster than switching threads, and literally millions of
-> them can be spawned without affecting performance*. Besides, Ruby does not yet
-> allow parallel execution of threads.
+> them can be spinned off without affecting performance*. Besides, Ruby does not
+> yet allow parallel execution of threads (courtesy of the Ruby GVL).
 > 
 > \* *This is a totally unsubstantiated claim which has not been proved in
 > practice*.
@@ -116,7 +116,7 @@ require 'polyphony'
 server = TCPServer.open(1234)
 while client = server.accept
   # coproc starts a new coprocess on a separate fiber
-  coproc {
+  spin {
     while data = client.read rescue nil
       client.write(data)
     end
@@ -129,7 +129,7 @@ This example demonstrates several features of Polyphony:
 - The code uses the native `TCPServer` class from Ruby's stdlib, to setup a TCP
   server. The result of `server.accept` is also a native `TCPSocket` object.
   There are no wrapper classes being used.
-- The only hint of the code being concurrent is the use of `Kernel#coproc`,
+- The only hint of the code being concurrent is the use of `Kernel#spin`,
   which starts a new coprocess on a dedicated fiber. This allows serving
   multiple clients at once. Whenever a blocking call is issued, such as
   `#accept` or `#read`, execution is *yielded* to the event loop, which will
@@ -223,7 +223,7 @@ end
 ### Additional concurrency constructs
 
 In order to facilitate writing concurrent code, Polyphony provides additional
-constructs that make it easier to spawn concurrent tasks and to control them.
+constructs that make it easier to create and control concurrent tasks.
 
 `CancelScope` - an abstraction used to cancel the execution of one or more
 coprocesses or supervisors. It usually works by defining a timeout for the 
@@ -257,7 +257,7 @@ Pool = Polyphony::ResourcePool.new(limit: 5) {
 }
 
 1000.times {
-  coproc {
+  spin {
     Pool.acquire { |db| p db.query('select 1') }
   }
 }
@@ -274,7 +274,7 @@ Pool = Polyphony::ResourcePool.new(limit: 5) {
 }
 
 1000.times {
-  coproc { p Pool.query('select 1') }
+  spin { p Pool.query('select 1') }
 }
 ```
 
@@ -285,9 +285,9 @@ using `Kernel.supervise`:
 
 ```ruby
 supervise { |s|
-  s.spawn { sleep 1 }
-  s.spawn { sleep 2 }
-  s.spawn { sleep 3 }
+  s.spin { sleep 1 }
+  s.spin { sleep 2 }
+  s.spin { sleep 3 }
 }
 puts "done sleeping"
 ```
@@ -313,7 +313,7 @@ server = Net.tcp_listen(1234)
 throttler = throttle(rate: 10) # up to 10 times per second
 
 while client = server.accept
-  coproc {
+  spin {
     throttler.call {
       while data = client.read
         client.write(data)

data/TODO.md

@@ -1,42 +1,26 @@
 # Roadmap:
 
-## 0.17 Implement non-blocking versions of `IO` API using monkey patching
-
-- Don't worry about performance or completeness of behaviour
-- Related global functions such as:
-  - `Kernel#system`
-  - `IO.popen`
-- testing - check conformance to Ruby `IO` API (arguments and return values as
-  described in the Ruby docs)
-
-## 0.18 Working net/http, httparty
-
-- implement `TCPSocket`/`TCPServer` functionality
-- test `socket` classes
-- test `Net::HTTP`
-- test `httparty`
-
-## 0.19 Full Rack adapter implementation
+## 0.20 Full Rack adapter implementation
 
 - follow Rack specification (doesn't have to include stuff like streaming or
   websockets)
 - find some demo Rack apps and test with Polyphony
 
-## 0.20 Working Rails application
+## 0.21 Working Rails application
 
 - app with database access (postgresql)
 - benchmarks!
 
-## 0.21 Support for multi-threading
+## 0.22 Support for multi-threading
 
 - Separate event loop for each thread
 
-## 0.22 Testing
+## 0.23 Testing
 
 - test thread / thread_pool modules
 - report test coverage
 
-## 0.23 Documentation
+## 0.24 Documentation
 
 # DNS
 

data/examples/core/channel_echo.rb

@@ -14,9 +14,9 @@ end
 
 chan1, chan2 = Polyphony::Channel.new, Polyphony::Channel.new
 
-echoer = coproc { echo(chan1, chan2) }
+echoer = spin { echo(chan1, chan2) }
 
-coproc do
+spin do
   puts "start receiver"
   while msg = chan2.receive
     puts msg
@@ -26,7 +26,7 @@ ensure
   puts "receiver stopped"
 end
 
-$main = coproc do
+$main = spin do
   t0 = Time.now
   puts "send hello"
   chan1 << "hello"

data/examples/core/enumerator.rb

@@ -5,7 +5,7 @@ require 'polyphony'
 
 enum = [1,2,3].each
 
-coproc do
+spin do
   while e = enum.next rescue nil
     puts e
     sleep 1

data/examples/core/fork.rb

@@ -8,7 +8,7 @@ puts "parent pid: #{Process.pid}"
 pid = Polyphony.fork do
   puts "child pid: #{Process.pid}"
 
-  coproc do
+  spin do
     puts "child going to sleep 1..."
     sleep 1
     puts "child woke up 1"

data/examples/core/genserver.rb

@@ -5,7 +5,7 @@ require 'polyphony'
 
 class GenServer
   def self.start(receiver, *args)
-    coprocess = coproc do
+    coprocess = spin do
       state = receiver.initial_state(*args)
       loop do
         msg = receive

data/examples/core/lock.rb

@@ -14,6 +14,6 @@ def loop_it(number, lock)
 end
 
 lock = Polyphony::Sync::Mutex.new
-coproc { loop_it(1, lock) }
-coproc { loop_it(2, lock) }
-coproc { loop_it(3, lock) }
+spin { loop_it(1, lock) }
+spin { loop_it(2, lock) }
+spin { loop_it(3, lock) }

data/examples/core/multiple_spawn.rb

@@ -3,13 +3,13 @@
 require 'bundler/setup'
 require 'polyphony'
 
-coproc do
+spin do
   puts "1 >"
   sleep(1)
   puts "1 <"
 end
 
-coproc do
+spin do
   puts "2 >"
   sleep(1)
   puts "2 <"

data/examples/core/nested_async.rb

@@ -3,7 +3,7 @@
 require 'bundler/setup'
 require 'polyphony'
 
-coproc do
+spin do
   puts "going to sleep"
   result = async do
     async do

data/examples/core/nested_multiple_spawn.rb

@@ -3,14 +3,14 @@
 require 'bundler/setup'
 require 'polyphony'
 
-coproc do
-  coproc do
+spin do
+  spin do
     puts "1 >"
     sleep(1)
     puts "1 <"
   end
 
-  coproc do
+  spin do
     puts "2 >"
     sleep(1)
     puts "2 <"

data/examples/core/resource_cancel.rb

@@ -26,7 +26,7 @@ def user(number)
 end
 
 6.times do |x|
-  coproc { user(x) }
+  spin { user(x) }
 end
 
 t0 = Time.now

data/examples/core/sleep_spawn.rb

@@ -3,14 +3,14 @@
 require 'bundler/setup'
 require 'polyphony'
 
-coproc {
+spin {
   10.times { |i|
     sleep 0.1;
     p i
   }
 }
 
-coproc {
+spin {
   puts "going to sleep..."
   sleep 1
   puts "woke up"

data/examples/core/spawn.rb

@@ -9,6 +9,6 @@ def my_sleep(t)
   puts "woke up"
 end
 
-coproc do
+spin do
   async { my_sleep(1) }.await
 end

data/examples/core/spawn_cancel.rb

@@ -3,7 +3,7 @@
 require 'bundler/setup'
 require 'polyphony'
 
-coproc do
+spin do
   puts "going to sleep..."
   cancel_after(1) do
     async {

data/examples/core/spawn_error.rb

@@ -9,11 +9,11 @@ def error(t)
   raise "hello #{t}"
 end
 
-def coproc_with_error
-  coproc { error(2) }
+def spin_with_error
+  spin { error(2) }
 end
 
-coproc do
+spin do
   error(1)
 rescue => e
   e.cleanup_backtrace
@@ -23,6 +23,6 @@ rescue => e
   puts
 end
 
-coproc_with_error
+spin_with_error
 
 puts "done coprocing"

data/examples/core/supervisor.rb

@@ -14,7 +14,7 @@ supervise do |s|
   s.coproc my_sleep(1)
   s.coproc my_sleep(2)
   s.coproc my_sleep(3)
-  s.coproc {
+  s.spin {
     puts "fiber count: #{Polyphony::FiberPool.size}"
   }
 end

data/examples/core/supervisor_with_error.rb

@@ -8,7 +8,7 @@ async def my_sleep(t)
   raise "blah"
 end
 
-coproc do
+spin do
   puts "#{Time.now} going to sleep..."
   supervise do |s|
     s.coproc my_sleep(1)

data/examples/core/supervisor_with_manual_move_on.rb

@@ -12,7 +12,7 @@ end
 puts "#{Time.now} going to sleep..."
 result = supervise do |s|
   fiber = Fiber.current
-  coproc do
+  spin do
     sleep(0.5)
     puts "stopping supervisor..."
     s.stop!