tipi 0.43 → 0.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7a42c93f436a24b74aef2fc9de54d7f01b587ec42b2897d0b0c24a9090776d8
-  data.tar.gz: 1fa532504e9c79d620306b4ddfbd01bf1d1dc39b563ec2a2c3cfec9cb00a1b64
+  metadata.gz: e6abb7798a69adc36e18dda822f7ff025f9f9e286eba50ccaf3905a74f29ef32
+  data.tar.gz: 41ee73bf589d2d4bd764aa58cb71e43477bc52caae708bd05ae4ae6372275415
 SHA512:
-  metadata.gz: 93282cde73eca46289cf212e76c90e7390dcd9e48e8594bd756d5f59ae3bc5fed41e61d216c85cca9c9d2c8fca1061ee0159f8cc0ca575fe0b7149a21b1edc24
-  data.tar.gz: 6fd1dc4de05351d0b7da91a7344798145f31659f4663f451355222ce63bb8504fb123c562199820b4f217bc14d064bb529fcc0c9ea495863856bd79f073a491b
+  metadata.gz: b23c0bfe27b9e6ff203508ab1a24ecbf10d954996ce9af2045a7d427ccec5746e9ef9df146353e4c134a56c12c4f2518141b46fe342123613c3da713a086a90f
+  data.tar.gz: a2f0fdc533ab39a23dad733535a9371a44a5809485c04114d0e054f4cb4bcb47b0cb27a266d5d58a7e01b8db06daf79a3aa944151de50e61da33f824e4651e43

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ciconia

data/.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [2.6, 2.7]
+        ruby: [2.6, 2.7, 3.0]
 
     name: >-
       ${{matrix.os}}, ${{matrix.ruby}}
@@ -25,7 +25,5 @@ jobs:
         POLYPHONY_USE_LIBEV=1 bundle install
     - name: Show Linux kernel version
       run: uname -r
-    - name: Compile C-extension
-      run: bundle exec rake compile
     - name: Run tests
       run:  bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.45 2021-10-25
+
+- Remove `http_parser.rb` dependency (#14) - thanks @SwagDevOps
+- Use `argv` argument in `Tipi.opts_from_argv` (#13) - thanks @SwagDevOps
+- Ignore `ArgumentError` in `#parse_headers`
+
+## 0.44 2021-09-29
+
+- Implement compatibility mode for HTTP/1 (WIP)
+- Add option parsing for CLI tool
+- Implement supervisor-controller-worker model in CLI tool
+
 ## 0.43 2021-08-20
 
 - Extract HTTP/1 parser into a separate gem:

data/Gemfile

@@ -1,7 +1,9 @@
 source 'https://rubygems.org'
 
 gemspec
-%w{polyphony qeweney h1p}.each do |dep|
+
+# for local development
+%w{polyphony ever qeweney h1p}.each do |dep|
   dir = "../#{dep}"
   gem(dep, path: dir) if File.directory?(dir)
 end

data/Gemfile.lock

@@ -1,3 +1,8 @@
+PATH
+  remote: ../ever
+  specs:
+    ever (0.1)
+
 PATH
   remote: ../h1p
   specs:
@@ -6,7 +11,7 @@ PATH
 PATH
   remote: ../polyphony
   specs:
-    polyphony (0.70)
+    polyphony (0.71)
 
 PATH
   remote: ../qeweney
@@ -17,14 +22,15 @@ PATH
 PATH
   remote: .
   specs:
-    tipi (0.43)
+    tipi (0.45)
       acme-client (~> 2.0.8)
+      ever (~> 0.1)
       extralite (~> 1.2)
       h1p (~> 0.2)
       http-2 (~> 0.11)
       localhost (~> 1.1.4)
       msgpack (~> 1.4.2)
-      polyphony (~> 0.69)
+      polyphony (~> 0.71)
       qeweney (~> 0.14)
       rack (>= 2.0.8, < 2.3.0)
       websocket (~> 1.2.8)
@@ -32,14 +38,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    acme-client (2.0.8)
+    acme-client (2.0.9)
       faraday (>= 0.17, < 2.0.0)
     cuba (3.9.3)
       rack (>= 1.6.0)
     docile (1.4.0)
     escape_utils (1.2.1)
-    extralite (1.3)
-    faraday (1.7.0)
+    extralite (1.4)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -60,7 +66,7 @@ GEM
     faraday-rack (1.0.0)
     http-2 (0.11.0)
     json (2.5.1)
-    localhost (1.1.8)
+    localhost (1.1.9)
     memory_profiler (1.0.0)
     minitest (5.11.3)
     msgpack (1.4.2)
@@ -80,6 +86,7 @@ PLATFORMS
 
 DEPENDENCIES
   cuba (~> 3.9.3)
+  ever!
   h1p!
   memory_profiler (~> 1.0.0)
   minitest (~> 5.11.3)

data/README.md

@@ -3,27 +3,203 @@
 # Tipi - the All-in-one Web Server for Ruby Apps
 
 [![Gem Version](https://badge.fury.io/rb/tipi.svg)](http://rubygems.org/gems/tipi)
-[![Modulation Test](https://github.com/digital-fabric/tipi/workflows/Tests/badge.svg)](https://github.com/digital-fabric/tipi/actions?query=workflow%3ATests)
+[![Tipi Test](https://github.com/digital-fabric/tipi/workflows/Tests/badge.svg)](https://github.com/digital-fabric/tipi/actions?query=workflow%3ATests)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/digital-fabric/tipi/blob/master/LICENSE)
 
 ## What is Tipi?
 
 Tipi is an integrated, feature-complete HTTP/S server for Ruby applications.
-Tipi is built on Polyphony, a robust, high-performance library for building
-highly-concurrent applications in Ruby. Tipi can be used to serve any Rack
-application or set of static files directly without having to employ a
-reverse-proxy such as Nginx.
+Tipi is built on top of
+[Polyphony](https://github.com/digital-fabric/polyphony), a robust,
+high-performance library for building highly-concurrent applications in Ruby.
+Tipi can be used to serve any Rack application or set of static files directly
+without having to employ a reverse-proxy such as Nginx.
 
 ## Features
 
 * High-performance, highly concurrent web server based on
   [Polyphony](https://github.com/digital-fabric/polyphony)
-* Full support for HTTP, HTTP/2, WebSocket protocols
+* Full support for HTTP/1, HTTP/2, WebSocket protocols
 * Built-in SSL termination for secure, encrypted connections
-* Automatic ALPN protocol selection
+* **Automatic SSL certificates** using ACME providers such as Let's Encrypt (WIP)
+* Automatic ALPN protocol selection for serving HTTP/2
 * Request and response body streaming for efficient downloads and uploads
 * Full support for Rack-based apps
 
+## Benchmarks
+
+> Caveat emptor: the following results were obtained with an ad-hoc, manual
+> process. I am not really familiar with the servers I compared Tipi against,
+> and I ran them in their default configuration (apart from setting the number
+> of workers). Take these results with a bunch of salt.
+
+<img src="bm.png" style="width: 480px">
+
+| |Tipi|Puma|Falcon|Unicorn|
+|-|---:|---:|-----:|------:|
+|HTTP/1.1|138629|34573|40714|7438|
+|HTTPS/2|56762|n/a|34226|n/a|
+
+### Methodology
+
+- All servers ran the same "Hello world" [Rack
+  application](https://github.com/digital-fabric/tipi/blob/master/examples/hello.ru)
+- Each server was run with 4 forked worker processes:
+  - Tipi: `tipi -w4 -flocalhost:10080:10443 examples/hello.ru`
+  - [Puma](https://github.com/puma/puma): `puma -w 4 examples/hello.ru`
+  - [Falcon](https://github.com/socketry/falcon/): `falcon -n 4 -b http://localhost:9292/ -c examples/hello.ru`
+  - [Unicorn](https://yhbt.net/unicorn/): `unicorn -c u.conf examples/hello.ru`
+    with the configuration file containing the directive `worker_processes 4`
+- The benchmark results were obtained using `wrk -d60 -t4 -c64 <url>`
+- All servers were run on Ruby 2.7.2p137
+- Machine specs: i5-8350U@1.7GHzx8 CPU, 8GB of RAM, running Linux kernel version 5.13.7
+- Puma does not support HTTP/2.
+- As far as I could tell Unicorn does not support SSL termination.
+
+## Running Tipi
+
+To run Tipi, run the included `tipi` command. Alternatively you can add tipi as
+a dependency to your Gemfile, then run `bundle exec tipi`. By default 
+
+Tipi can be used to drive Rack apps or alternatively any app using the
+[Qeweney](https://github.com/digital-fabric/qeweney) request-response interface.
+
+### Running Rack apps
+
+Use the `tipi` command to start your app:
+
+```bash
+$ bundle exec tipi myapp.ru
+```
+
+### Running Qeweney apps
+
+```bash
+$ bundle exec tipi myapp.rb
+```
+
+The app script file should define an `app` method that returns a proc/lambda
+taking a single `Qeweney::Request` argument. Here's an example:
+
+```ruby
+# frozen_string_literal: true
+
+def app
+  ->(req) { req.respond('Hello, world!', 'Content-Type' => 'text/plain') }
+end
+```
+
+## Setting server listening options
+
+By default, Tipi serves plain HTTP on port 1234, but you can easily change that
+by providing command line options as follows:
+
+### HTTP
+
+To listen for plain HTTP, use the `-l`/`--listen` option and specify a port
+number:
+
+```bash
+$ bundle exec tipi -l9292 myapp.ru
+```
+
+### HTTPS
+
+To listen for HTTPS connections, use the `-s`/`--secure` option and specify a
+host name and a port:
+
+```bash
+$ bundle exec tipi -sexample.com:9292 myapp.ru
+```
+
+### Full service listening
+
+The Tipi full service listens for both HTTP and HTTPS and supports automatic
+certificate provisioning. To use the full service, use the `-f`/`--full` option,
+and specify the domain name, the HTTP port, and the HTTPS port, e.g.:
+
+```bash
+$ bundle exec tipi -fmysite.org:10080:10443 myapp.ru
+
+#If serving multiple domains, you can use * as place holder
+$ bundle exec tipi -f*:10080:10443 myapp.ru
+```
+
+If `localhost` is specified as the domain, Tipi will automatically generate a
+localhost certificate.
+
+## Concurrency settings
+
+By default, the `tipi` command starts a single controller and uses
+[Polyphony](https://github.com/digital-fabric/polyphony) to run each connection
+on its own fiber. This means that you will have a single process running on a
+single thread (on a single CPU core). In order to parallelize your app and
+employ multiple CPU cores, you can tell Tipi to fork multiple worker processes
+to run your app. The number of workers is controlled using the `-w`/`--workers`
+option:
+
+```bash
+# fork 4 worker processes
+$ bundle exec tipi -w4 myapp.ru
+```
+
+You can also set Tipi to spawn multiple threads in each worker when in
+compatibility mode (see below.)
+
+## Compatibility mode
+
+> Note: compatibility mode is still being developed, and currently only supports
+> HTTP/1 connections.
+
+In some apps, using Polyphony is not possible, due to incompatibilities between
+it and other third-party dependencies. In order to be able to run these apps,
+Tipi provides a compatibility mode that does not use Polyphony for concurrency,
+but instead uses a thread-per-connection concurrency model. You can also fork
+multiple workers, each running multiple threads, if so desired. Note that the
+concurrency level is the maximum number workers multiplied by the number of
+threads per worker:
+
+```
+concurrency = worker_count * threads_per_worker
+```
+
+To run Tipi in compatibility mode, use the `-c`/`--compatibility` option, e.g.:
+
+```bash
+# 4 workers * 8 threads = 32 max concurrency
+$ bundle exec tipi -c -w4 -t8 myapp.ru
+```
+
+## Worker process supervision
+
+Tipi employs a supervisor-controller-worker process supervision model, which
+minimizes the memory consumption of forked workers, and which facilitates
+graceful reloading after updating the application code.
+
+This supervision model is made of three levels:
+
+- Supervisor - Starts and stops the controller process
+- Controller - loads the application code and forks workers
+- Worker - listens for connections, handles incoming requests
+
+(If the worker count is 1, the Controller and Worker roles are merged into a
+single process.)
+
+This model allows Tipi to fork workers after loading the app code, and use a
+much simpler way to perform graceful restarts:
+
+- The supervisor starts a new controller process (which may fork one or more
+  worker processes).
+- Sleep for a certain amount of time (currently 1 second.)
+- Stop the old controller process.
+- Each worker process is gracefully stopped and allowed to finish all pending
+  requests, then shutdown all open connections.
+  
+## Performing a graceful restart
+
+A graceful restart performed by sending `SIGUSR2` to the supervisor process.
+
 ## Documentation
 
-Documentation for Tipi is coming soon...
+Documentation for Tipi's API is coming soon...
+

data/Rakefile

@@ -3,13 +3,7 @@
 require "bundler/gem_tasks"
 require "rake/clean"
 
-require "rake/extensiontask"
-Rake::ExtensionTask.new("tipi_ext") do |ext|
-  ext.ext_dir = "ext/tipi"
-end
-
-task :recompile => [:clean, :compile]
-task :default => [:compile, :test]
+task :default => [:test]
 
 task :test do
   exec 'ruby test/run.rb'

data/benchmarks/bm_http1_parser.rb

@@ -26,7 +26,7 @@ end
 def benchmark_other_http1_parser(iterations)
   STDOUT << "http_parser.rb: "
   require 'http_parser.rb'
-  
+
   i, o = IO.pipe
   parser = Http::Parser.new
   done = false

data/df/agent.rb

@@ -30,7 +30,7 @@ class SampleAgent < DigitalFabric::Agent
       do_some_activity
       req.send_chunk({ id: @id, time: Time.now.to_i }.to_json)
     end
-  
+
     req.finish
   rescue Polyphony::Terminate
     req.respond(' * shutting down *') if Fiber.current.graceful_shutdown?

data/df/sample_agent.rb

@@ -46,7 +46,7 @@ class SampleAgent < DigitalFabric::Agent
         true
       ))
     end
-  
+
   end
 
   def ws_request(req)
@@ -82,7 +82,7 @@ class SampleAgent < DigitalFabric::Agent
       true
     ))
   end
-  
+
 end
 
 agent = SampleAgent.new('127.0.0.1', 4411, { path: '/agent' })

data/df/server_utils.rb

@@ -68,7 +68,7 @@ def listen_https
     cert = certificates.shift
     log "SSL Certificate expires: #{cert.not_after.inspect}"
     ctx.add_certificate(cert, private_key, certificates)
-    ctx.ciphers = 'ECDH+aRSA'
+    # ctx.ciphers = 'ECDH+aRSA'
     ctx.max_version = OpenSSL::SSL::TLS1_3_VERSION
     ctx.min_version = OpenSSL::SSL::SSL3_VERSION
     ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE

data/examples/hello.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+def app
+  ->(req) { req.respond('Hello, world!', 'Content-Type' => 'text/plain') }
+end

data/examples/http_server.js

@@ -12,7 +12,7 @@ const server = http.createServer((req, res) => {
   //   request_url: req.url,
   //   headers: req.headers
   // };
-  
+
   // res.writeHead(200, { 'Content-Type': 'application/json' });
   // res.end(JSON.stringify(requestCopy));
 

data/examples/http_server_graceful.rb

@@ -24,4 +24,4 @@ puts "pid: #{Process.pid}"
 puts 'Send HUP to stop gracefully'
 puts 'Listening on port 1234...'
 
-suspend
+suspend

data/examples/https_server.rb

@@ -10,27 +10,50 @@ authority = Localhost::Authority.fetch
 opts = {
   reuse_addr:     true,
   dont_linger:    true,
-  secure_context: authority.server_context
 }
 
 puts "pid: #{Process.pid}"
 puts 'Listening on port 1234...'
-Tipi.serve('0.0.0.0', 1234, opts) do |req|
-  p path: req.path
-  if req.path == '/stream'
-    req.send_headers('Foo' => 'Bar')
-    sleep 0.5
-    req.send_chunk("foo\n")
-    sleep 0.5
-    req.send_chunk("bar\n", done: true)
-  elsif req.path == '/upload'
-    body = req.read
-    req.respond("Body: #{body.inspect} (#{body.bytesize} bytes)")
-  else
-    req.respond("Hello world!\n")
+
+ctx = authority.server_context
+server = Polyphony::Net.tcp_listen('0.0.0.0', 1234, opts)
+loop do
+  socket = server.accept
+  client = OpenSSL::SSL::SSLSocket.new(socket, ctx)
+  client.sync_close = true
+  spin do
+    state = {}
+    accept_thread = Thread.new do
+      puts "call client accept"
+      client.accept
+      state[:result] = :ok
+    rescue Exception => e
+      puts error: e
+      state[:result] = e
+    end
+    "wait for accept thread"
+    accept_thread.join
+    "accept thread done"
+    if state[:result].is_a?(Exception)
+      puts "Exception in SSL handshake: #{state[:result].inspect}"
+      next
+    end
+    Tipi.client_loop(client, opts) do |req|
+      p path: req.path
+      if req.path == '/stream'
+        req.send_headers('Foo' => 'Bar')
+        sleep 0.5
+        req.send_chunk("foo\n")
+        sleep 0.5
+        req.send_chunk("bar\n", done: true)
+      elsif req.path == '/upload'
+        body = req.read
+        req.respond("Body: #{body.inspect} (#{body.bytesize} bytes)")
+      else
+        req.respond("Hello world!\n")
+      end
+    end
+  ensure
+    client ? client.close : socket.close
   end
-  # req.send_headers
-  # req.send_chunk("Method: #{req.method}\n")
-  # req.send_chunk("Path: #{req.path}\n")
-  # req.send_chunk("Query: #{req.query.inspect}\n", done: true)
 end

data/examples/rack_server_forked.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tipi'
+
+app_path = ARGV.first || File.expand_path('./config.ru', __dir__)
+unless File.file?(app_path)
+  STDERR.puts "Please provide rack config file (there are some in the examples directory.)"
+  exit!
+end
+
+app = Tipi::RackAdapter.load(app_path)
+opts = { reuse_addr: true, dont_linger: true }
+
+server = Tipi.listen('0.0.0.0', 1234, opts)
+puts 'listening on port 1234'
+
+child_pids = []
+4.times do
+  child_pids << Polyphony.fork do
+    puts "forked pid: #{Process.pid}"
+    server.each(&app)
+  end
+end
+
+child_pids.each { |pid| Thread.current.backend.waitpid(pid) }

data/examples/rack_server_https_forked.rb

@@ -25,4 +25,4 @@ child_pids = []
   end
 end
 
-child_pids.each { |pid| Thread.current.backend.waitpid(pid) }
+child_pids.each { |pid| Thread.current.backend.waitpid(pid) }

data/examples/websocket_demo.rb

@@ -26,7 +26,7 @@ class WebsocketClient
   def receive
     parsed = @reader.next
     return parsed if parsed
-    
+
     @socket.read_loop do |data|
       @reader << data
       parsed = @reader.next