polyphony 0.23 → 0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42975a9e638525d2264fbddea88ee0756fb7e7dbc5c0585c033b71a06a27711c
-  data.tar.gz: 2c233b91c02d60e1dc40fbacb1dbade17c591a9ddede854e71dc7b2a840dcfd0
+  metadata.gz: 8a8da629de739b6091367c7220fd4a69dd83d7c78eb6d8c55c67385c8ca3edb2
+  data.tar.gz: 351f78d8b9635b6bc2c9838d652781a66009554287cfb5486c9fe0a0748ed6d6
 SHA512:
-  metadata.gz: 339373f341a10fa68bec7d39588407519c12e17f9b02f774b9179af9b682512c156aa254cac116d4f60d1528e4dae21cfe220e71bf998787c0f1b55c244ef959
-  data.tar.gz: 429a5960bbc3a38d23282ab1a8339b1ae556832fd098e34ae1a63fca36f4bc9f15f8996a715c70ac3363e01ea1858c2cf9de6b9296e90cf7f6a6c8a79f42c48c
+  metadata.gz: 768ed2703dd01653e5c71c2d17799b0c42fd9eb03f382dd3e4d3e4a337f7055d7a68643f479160febd3aa9412a9b66ccf0adf79f1608882ef0d61b625c8f7ed2
+  data.tar.gz: eab163c7ce680640def7fe6971359969202e6cb53238e8006c479e158c9b488bf73a2e575008a94cee1320fcf6899276da85df33d2fb00f97fa8133ad8fc3f06

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.24 2020-01-08
+---------------
+
+* Extract HTTP code into separate polyphony-http gem
+* Cull core, io examples
+* Remove `SIGINT` handler
+
 0.23 2020-01-07
 ---------------
 

data/Gemfile.lock

@@ -1,11 +1,8 @@
 PATH
   remote: .
   specs:
-    polyphony (0.23)
-      http-2 (= 0.10.0)
-      http_parser.rb (= 0.6.0)
-      modulation (~> 0.25)
-      rack
+    polyphony (0.24)
+      modulation (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,7 +11,6 @@ GEM
     builder (3.2.4)
     docile (1.3.2)
     hiredis (0.6.3)
-    http-2 (0.10.0)
     http_parser.rb (0.6.0)
     httparty (0.17.0)
       mime-types (~> 3.0)
@@ -30,10 +26,9 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    modulation (0.34)
+    modulation (1.0)
     multi_xml (0.6.0)
     pg (1.1.3)
-    rack (2.0.8)
     rake (13.0.1)
     rake-compiler (1.0.5)
       rake
@@ -44,13 +39,13 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    websocket (1.2.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   hiredis (= 0.6.3)
+  http_parser.rb (~> 0.6.0)
   httparty (= 0.17.0)
   localhost (= 1.1.4)
   minitest (= 5.11.3)
@@ -60,7 +55,6 @@ DEPENDENCIES
   rake-compiler (= 1.0.5)
   redis (= 4.1.0)
   simplecov (= 0.17.1)
-  websocket (= 1.2.8)
 
 BUNDLED WITH
    2.1.3

data/README.md

@@ -13,9 +13,6 @@ Polyphony makes it possible to use normal Ruby built-in classes like `IO`, and `
 
 ## Features
 
-* **Full-blown, integrated, high-performance HTTP 1 / HTTP 2 / WebSocket server
-  with TLS/SSL termination, automatic ALPN protocol selection, and body
-  streaming**.
 * Co-operative scheduling of concurrent tasks using Ruby fibers.
 * High-performance event reactor for handling I/O events and timers.
 * Natural, sequential programming style that makes it easy to reason about
@@ -25,7 +22,6 @@ Polyphony makes it possible to use normal Ruby built-in classes like `IO`, and `
 * Code can use native networking classes and libraries, growing support for
   third-party gems such as `pg` and `redis`.
 * Use stdlib classes such as `TCPServer`, `TCPSocket` and 
-* HTTP 1 / HTTP 2 client agent with persistent connections.
 * Competitive performance and scalability characteristics, in terms of both
   throughput and memory consumption.
 

data/TODO.md

@@ -1,54 +1,8 @@
-# HTTP Client Agent
+## 0.25 Move Other interface code into separate gem
 
-The concurrency model and the fact that we want to serve the response object on
-receiving headers and let the user lazily read the response body, means we'll
-need to change the API to accept a block:
-
-```ruby
-# current API
-resp = Agent.get('http://acme.org')
-puts resp.body
-
-# proposed API
-Agent.get('http://acme.org') do |resp|
-  puts resp.body
-end
-```
-
-While the block is running, the connection adapter is acquired. Once the block
-is done running, the request (and response) can be discarded. The problem with
-that if we spin up a coprocess from that block we risk all kinds of race
-conditions and weird behaviours.
-
-A compromise might be to allow the two: doing a `get` without providing a block
-will return a response object that already has the body (i.e. the entire
-response has already been received). Doing a `get` with a block will invoke the
-block once headers are received, letting the user's code stream the body:
-
-```ruby
-def request(ctx, &block)
-  ...
-  connection_manager.acquire do |adapter|
-    response = adapter.request(ctx)
-    if block
-      block.(response)
-    else
-      # wait for body
-      response.body
-    end
-    response
-  end
-end
-```
-
-# Roadmap:
-
-## 0.24 Move HTTP code into separate gem
-
-- Pull out HTTP/websocket code, put into new `polyphony-http` gem
 - Pull out redis/postgres code, put into new `polyphony-contrib` gem
 
-## 0.25 Full Rack adapter implementation
+## 0.26 Full Rack adapter implementation
 
 - Work better mechanism supervising multiple coprocesses (`when_done` feels a
   bit hacky)
@@ -56,21 +10,16 @@ end
 - Homogenize HTTP 1 and HTTP 2 headers - upcase ? downcase ?
 - find some demo Rack apps and test with Polyphony
 
-## 0.26 Working Sinatra application
+## 0.27 Working Sinatra application
 
 - app with database access (postgresql)
 - benchmarks!
 
-## 0.27 Support for multi-threading
+## 0.28 Support for multi-threading
 
 - Separate event loop for each thread
 
-## 0.28 Testing
-
-- test thread / thread_pool modules
-- report test coverage
-
-## 0.29 Documentation
+## 0.29 Testing && Docs
 
 ## 0.30 Integration
 

data/docs/README.md

@@ -1,8 +1,8 @@
 # Polyphony - Easy Concurrency for Ruby
 
-> Polyphony \| pəˈlɪf\(ə\)ni \| _Music_ - the style of simultaneously combining a number of parts, each forming an individual melody and harmonizing with each other.
-
-## What is Polyphony
+> Polyphony \| pəˈlɪf\(ə\)ni \|
+> 1. _Music_ the style of simultaneously combining a number of parts, each forming an individual melody and harmonizing with each other.
+> 2. _Programming_ a Ruby gem for concurrent programming focusing on performance and developer happiness.
 
 Polyphony is a library for building concurrent applications in Ruby. Polyphony harnesses the power of [Ruby fibers](https://ruby-doc.org/core-2.5.1/Fiber.html) to provide a cooperative, sequential coprocess-based concurrency model. Under the hood, Polyphony uses [libev](https://github.com/enki/libev) as a high-performance event reactor that provides timers, I/O watchers and other asynchronous event primitives.
 
@@ -10,14 +10,12 @@ Polyphony makes it possible to use normal Ruby built-in classes like `IO`, and `
 
 ## Features
 
-* **Full-blown, integrated, high-performance HTTP 1 / HTTP 2 / WebSocket server with TLS/SSL termination, automatic ALPN protocol selection, and body streaming**.
 * Co-operative scheduling of concurrent tasks using Ruby fibers.
 * High-performance event reactor for handling I/O events and timers.
 * Natural, sequential programming style that makes it easy to reason about concurrent code.
 * Abstractions and constructs for controlling the execution of concurrent code: 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`.
 * Use stdlib classes such as `TCPServer` and `TCPSocket` and `Net::HTTP`.
-* HTTP 1 / HTTP 2 client agent with persistent connections.
 * Competitive performance and scalability characteristics, in terms of both throughput and memory consumption.
 
 ## Prior Art
@@ -35,5 +33,4 @@ To learn more about using Polyphony to build concurrent applications, read the t
 
 ## Contributing to Polyphony
 
-If there's some blocking behavior you'd like to see handled by Polyphony, please let us know by [creating an issue](https://github.com/digital-fabric/polyphony/issues). Our aim is for Polyphony to be a comprehensive solution for writing concurrent Ruby programs.
-
+Issues and pull requests will be gladly accepted. Please use the git repository at https://github.com/digital-fabric/polyphony as your primary point of departure for contributing.

data/examples/core/{genserver.rb → xx-erlang-style-genserver.rb}

@@ -65,14 +65,14 @@ module Map
   end
 end
 
-map_server = GenServer.start(Map, foo: :bar)
+map_server = GenServer.start(Map, {foo: :bar})
 
 puts 'getting value from map server'
 v = map_server.get(:foo)
 puts "value: #{v.inspect}"
 
 puts 'putting value in map server'
-map_server.put!(:foo, 42)
+map_server.put!(:foo, :baz)
 
 puts 'getting value from map server'
 v = map_server.get(:foo)

data/examples/core/{fork.rb → xx-forking.rb}

@@ -13,6 +13,8 @@ pid = Polyphony.fork do
     sleep 1
     puts 'child woke up 1'
   end
+
+  suspend
 end
 
 puts "got child pid #{pid}"

data/examples/core/xx-move_on.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+Exception.__disable_sanitized_backtrace__ = true
+
+puts 'going to sleep...'
+move_on_after(1) do
+  sleep 60
+  puts 'woke up'
+end
+
+puts 'going to sleep...'
+move_on_after(0.5) do
+  t0 = Time.now
+  sleep(60)
+ensure
+  puts 'woke up'
+end
+
+puts 'going to sleep...'
+value = move_on_after(1, with_value: :bar) { sleep 60 }
+puts "got value #{value.inspect}"

data/examples/core/{pulse.rb → xx-recurrent-timer.rb}

@@ -5,7 +5,8 @@ require 'polyphony'
 
 move_on_after(3) do
   puts 'Start...'
-  pulser = pulse(1)
-  puts Time.now while pulser.await
+  every(1) do
+    puts Time.now
+  end
 end
 puts 'done!'

data/examples/core/{resource_cancel.rb → xx-resource_cancel.rb}

@@ -5,7 +5,7 @@ require 'polyphony'
 
 resource_count = 0
 Pool = Polyphony::ResourcePool.new(limit: 3) do
-  :"resource#{resource_count += 1}"
+  +"resource#{resource_count += 1}"
 end
 
 def user(number)
@@ -13,7 +13,6 @@ def user(number)
     Polyphony::CancelScope.new(timeout: 0.2) do |scope|
       scope.on_cancel { puts "#{number} (cancelled)" }
       Pool.acquire do |r|
-        scope.disable
         puts "#{number} #{r.inspect} >"
         sleep(0.1 + rand * 0.2)
         puts "#{number} #{r.inspect} <"

data/examples/core/{spin_error_backtrace.rb → xx-spin_error_backtrace.rb}

@@ -8,8 +8,8 @@ def error(t)
 end
 
 def deferred_error(t)
-  snooze
-  de2(t)
+  puts "deferred_error"
+  defer { de2(t) }
 end
 
 def de2(t)
@@ -28,3 +28,6 @@ spin do
     end.await
   end.await
 end.await
+
+suspend
+suspend

data/examples/io/{echo_client.rb → xx-echo_client.rb}

@@ -2,7 +2,6 @@
 
 require 'bundler/setup'
 require 'polyphony'
-require 'polyphony/extensions/backtrace'
 
 socket = Polyphony::Net.tcp_connect('127.0.0.1', 1234)
 

data/examples/io/{echo_client_from_stdin.rb → xx-echo_client_from_stdin.rb}

@@ -2,7 +2,6 @@
 
 require 'bundler/setup'
 require 'polyphony'
-require 'polyphony/extensions/backtrace'
 
 socket = Polyphony::Net.tcp_connect('127.0.0.1', 1234)
 

data/examples/io/xx-httparty.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+require 'httparty'
+
+timer = spin { throttled_loop(100) { 
+  STDOUT << '.'
+} }
+
+res = HTTParty.get('http://worldtimeapi.org/api/timezone/Europe/Paris')
+puts res
+timer.stop

data/examples/io/{open.rb → xx-open.rb}

@@ -2,7 +2,6 @@
 
 require 'bundler/setup'
 require 'polyphony'
-require 'irb'
 
 stdin = IO.open(STDIN.to_i)
 

data/examples/io/{tcpsocket.rb → xx-tcpsocket.rb}

@@ -2,7 +2,6 @@
 
 require 'bundler/setup'
 require 'polyphony'
-require 'polyphony/extensions/backtrace'
 
 socket = TCPSocket.new('google.com', 80)
 

data/examples/{core → performance}/mem-usage.rb

@@ -24,6 +24,7 @@ def calculate_coprocess_memory_cost(count)
   GC.disable
   rss0 = mem_usage
   count.times { spin { :foo } }
+  snooze
   rss1 = mem_usage
   GC.start
   cost = (rss1 - rss0).to_f / count

data/examples/performance/multi_snooze.rb

@@ -20,6 +20,8 @@ def bm(fibers, iterations)
   puts "#{[fibers, iterations].inspect} count: #{count} #{count / dt.to_f}/s"
 end
 
+GC.disable
+
 bm(1, 1_000_000)
 bm(10, 100_000)
 bm(100, 10_000)

data/examples/performance/snooze.rb

@@ -5,6 +5,8 @@ require 'polyphony'
 
 X = 1_000_000
 
+GC.disable
+
 STDOUT << 'Fiber.yield:      '
 f = Fiber.new do
   loop { Fiber.yield }

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

@@ -18,7 +18,7 @@ class Http::Parser
   end
 end
 
-async def handle_client(socket)
+def handle_client(socket)
   parser = Http::Parser.new
   req = nil
   parser.on_message_complete = proc do |env|
@@ -47,12 +47,12 @@ def handle_request(client, parser)
 end
 
 spin do
-  server = TCPServer.open(1234)
+  server = TCPServer.open('0.0.0.0', 1234)
   puts "listening on port 1234"
 
   loop do
     client = server.accept
-    coproc handle_client(client)
+    spin { handle_client(client) }
   end
 rescue Exception => e
   puts "uncaught exception: #{e.inspect}"
@@ -60,3 +60,5 @@ rescue Exception => e
   exit!
   server.close
 end
+
+suspend