tipi 0.42 → 0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82155f4b86223d3fb32dc8c314abfeb75fda951747e63832ed5c15bc3b1f43cc
-  data.tar.gz: 721b98fb8d330d1bc38f8f236f82ddd909235d31f5875c1b4f89895e4e3926da
+  metadata.gz: f49829928be9cc9f944b9749c4092da37f99f42c34b9b07e2e16bceccf0f6e02
+  data.tar.gz: fcdc73b07ec3ad3ad6bb06832b135ca8179c3d1d2939d8065d5b10217edab55c
 SHA512:
-  metadata.gz: 10389779975234d90c968626b4f9d6b168491f9a32ecf1be71683c37cf11f58f1bac52a36478691e72328236a16d309a8462104bda556772e25cebe52b2b0d53
-  data.tar.gz: 99db2c15278cdfc286ffad05f266f5d62eec6a3bb1363f8dfa4c302549a308a691496ee60ec085ede59e3b594533e8e196bbca144878e5a6dccf2ecfc962151c
+  metadata.gz: cfba22e88c1bff8f23c828e86274148f5ef895262f2258afb1c30743c67b4e7ff0493b40334dddccc20c418d4dbb3462e68e01a397030681adb4bd1c130d3ab2
+  data.tar.gz: 0765f9c44a88f00d5e45f0d168ade5ae7649682bf61134142ce531603857cbb9c1180dde0f101b69a07d4e57688a47522ab86cb87178074fbcf7d84d949ee40f

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,30 @@
+## 0.47 2202-02-03
+
+- Update H1P dependency
+
+## 0.46 2022-02-01
+
+- Allow setting valid hosts
+- Change interface of Qeweney apps to use #run (#15)
+- Close server listener before terminating connections
+
+## 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:
+  [H1P](https://github.com/digital-fabric/h1p)
+
 ## 0.42 2021-08-16
 
 - HTTP/1 parser:  disable UTF-8 parsing for all but header values

data/Gemfile

@@ -1,7 +1,9 @@
 source 'https://rubygems.org'
 
 gemspec
-%w{polyphony qeweney}.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,24 +1,36 @@
+PATH
+  remote: ../ever
+  specs:
+    ever (0.1)
+
+PATH
+  remote: ../h1p
+  specs:
+    h1p (0.3)
+
 PATH
   remote: ../polyphony
   specs:
-    polyphony (0.69)
+    polyphony (0.74)
 
 PATH
   remote: ../qeweney
   specs:
-    qeweney (0.14)
+    qeweney (0.16)
       escape_utils (~> 1.2.1)
 
 PATH
   remote: .
   specs:
-    tipi (0.42)
+    tipi (0.47)
       acme-client (~> 2.0.8)
+      ever (~> 0.1)
       extralite (~> 1.2)
+      h1p (~> 0.3)
       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)
@@ -26,51 +38,45 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    acme-client (2.0.8)
+    acme-client (2.0.9)
       faraday (>= 0.17, < 2.0.0)
-    ansi (1.5.0)
-    builder (3.2.4)
     cuba (3.9.3)
       rack (>= 1.6.0)
     docile (1.4.0)
     escape_utils (1.2.1)
-    extralite (1.2)
-    faraday (1.7.0)
+    extralite (1.11)
+    faraday (1.9.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
     http-2 (0.11.0)
-    http_parser.rb (0.7.0)
     json (2.5.1)
-    localhost (1.1.8)
+    localhost (1.1.9)
+    memory_profiler (1.0.0)
     minitest (5.11.3)
-    minitest-reporters (1.4.3)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    msgpack (1.4.2)
+    msgpack (1.4.4)
     multipart-post (2.1.1)
     rack (2.2.3)
-    rake (12.3.3)
-    rake-compiler (1.1.1)
-      rake
-    ruby-progressbar (1.11.0)
+    rake (13.0.6)
     ruby2_keywords (0.0.5)
     simplecov (0.17.1)
       docile (~> 1.1)
@@ -84,15 +90,15 @@ PLATFORMS
 
 DEPENDENCIES
   cuba (~> 3.9.3)
-  http_parser.rb (= 0.7.0)
+  ever!
+  h1p!
+  memory_profiler (~> 1.0.0)
   minitest (~> 5.11.3)
-  minitest-reporters (~> 1.4.2)
   polyphony!
   qeweney!
-  rake (~> 12.3.3)
-  rake-compiler (= 1.1.1)
+  rake (~> 13.0.6)
   simplecov (~> 0.17.1)
   tipi!
 
 BUNDLED WITH
-   2.1.4
+   2.3.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

@@ -4,10 +4,29 @@ require 'bundler/setup'
 
 HTTP_REQUEST = "GET /foo HTTP/1.1\r\nHost: example.com\r\nAccept: */*\r\n\r\n"
 
+def measure_time_and_allocs
+  4.times { GC.start }
+  GC.disable
+
+  t0 = Time.now
+  a0 = object_count
+  yield
+  t1 = Time.now
+  a1 = object_count
+  [t1 - t0, a1 - a0]
+ensure
+  GC.enable
+end
+
+def object_count
+  count = ObjectSpace.count_objects
+  count[:TOTAL] - count[:FREE]
+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
@@ -16,21 +35,20 @@ def benchmark_other_http1_parser(iterations)
     headers = h
     headers[':method'] = parser.http_method
     headers[':path'] = parser.request_url
-    headers[':protocol'] = parser.http_version
   end
   parser.on_message_complete = proc { done = true }
 
-  t0 = Time.now
-  iterations.times do
-    o << HTTP_REQUEST
-    done = false
-    while !done
-      msg = i.readpartial(4096)
-      parser << msg
+  elapsed, allocated = measure_time_and_allocs do
+    iterations.times do
+      o << HTTP_REQUEST
+      done = false
+      while !done
+        msg = i.readpartial(4096)
+        parser << msg
+      end
     end
   end
-  t1 = Time.now
-  puts "#{iterations / (t1 - t0)} ips"
+  puts(format('elapsed: %f, allocated: %d (%f/req), rate: %f ips', elapsed, allocated, allocated.to_f / iterations, iterations / elapsed))
 end
 
 def benchmark_tipi_http1_parser(iterations)
@@ -40,22 +58,28 @@ def benchmark_tipi_http1_parser(iterations)
   reader = proc { |len| i.readpartial(len) }
   parser = Tipi::HTTP1Parser.new(reader)
 
-  t0 = Time.now
-  iterations.times do
-    o << HTTP_REQUEST
-    headers = parser.parse_headers
+  elapsed, allocated = measure_time_and_allocs do
+    iterations.times do
+      o << HTTP_REQUEST
+      headers = parser.parse_headers
+    end
   end
-  t1 = Time.now
-  puts "#{iterations / (t1 - t0)} ips"
+  puts(format('elapsed: %f, allocated: %d (%f/req), rate: %f ips', elapsed, allocated, allocated.to_f / iterations, iterations / elapsed))
 end
 
 def fork_benchmark(method, iterations)
-  pid = fork { send(method, iterations) }
+  pid = fork do
+    send(method, iterations)
+  rescue Exception => e
+    p e
+    p e.backtrace
+    exit!
+  end
   Process.wait(pid)
 end
 
 x = 500000
-fork_benchmark(:benchmark_other_http1_parser, x)
-fork_benchmark(:benchmark_tipi_http1_parser, x)
+# fork_benchmark(:benchmark_other_http1_parser, x)
+# fork_benchmark(:benchmark_tipi_http1_parser, x)
 
-# benchmark_tipi_http1_parser(x)
+benchmark_tipi_http1_parser(x)

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.rb

@@ -8,6 +8,8 @@ listeners = [
   listen_unix
 ]
 
+spin_loop(interval: 60) { GC.compact } if GC.respond_to?(:compact)
+
 begin
   log('Starting DF server')
   Fiber.await(*listeners)

data/df/server_utils.rb

@@ -64,17 +64,14 @@ def listen_https
     c = IO.read('../../reality/ssl/cacert.pem')
     certificates = c.scan(CERTIFICATE_REGEXP).map { |p|  OpenSSL::X509::Certificate.new(p.first) }
     ctx = OpenSSL::SSL::SSLContext.new
+    ctx.security_level = 0
     cert = certificates.shift
     log "SSL Certificate expires: #{cert.not_after.inspect}"
     ctx.add_certificate(cert, private_key, certificates)
-    ctx.ciphers = 'ECDH+aRSA'
-    ctx.send(
-      :set_minmax_proto_version,
-      OpenSSL::SSL::SSL3_VERSION,
-      OpenSSL::SSL::TLS1_3_VERSION
-    )
-    # ctx.min_version = OpenSSL::SSL::SSL3_VERSION #OpenSSL::SSL::TLS1_VERSION
-    # ctx.max_version = OpenSSL::SSL::TLS1_3_VERSION
+    # 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
 
     # TODO: further limit ciphers
     # ref: https://github.com/socketry/falcon/blob/3ec805b3ceda0a764a2c5eb68cde33897b6a35ff/lib/falcon/environments/tls.rb
@@ -91,10 +88,10 @@ def listen_https
     server = Polyphony::Net.tcp_listen('0.0.0.0', 10443, opts)
     id = 0
     loop do
-      log('Before HTTPS server.accept')
-      client = server.accept
-      log('After HTTPS server.accept')
-      log('Accept HTTPS client connection', client: client)
+      client = server.accept rescue nil
+      next unless client
+
+      # log('Accept HTTPS client connection', client: client)
       spin("https#{id += 1}") do
         @service.incr_connection_count
         Tipi.client_loop(client, opts) { |req| @service.http_request(req) }
@@ -104,12 +101,12 @@ def listen_https
         # log("Done with HTTP connection", client: client)
         @service.decr_connection_count
       end
-    rescue OpenSSL::SSL::SSLError, SystemCallError, TypeError => e
-      log('HTTPS accept error', error: e)
+    # rescue OpenSSL::SSL::SSLError, SystemCallError, TypeError => e
+    #   log('HTTPS accept error', error: e)
     rescue Polyphony::BaseException
       raise
     rescue Exception => e
-      log 'HTTPS accept (unknown) error', error: e, backtrace: e.backtrace
+      log 'HTTPS listener error: ', error: e, backtrace: e.backtrace
     end
   end
 end

data/examples/hello.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+run { |req|
+  req.respond('Hello, world!')
+}

data/examples/hello.ru

@@ -2,8 +2,8 @@
 
 run lambda { |env|
   [
-        200,
-        {"Content-Type" => "text/plain"},
-        ["Hello, world!"]
+    200,
+    {"Content-Type" => "text/plain"},
+    ["Hello, world!"]
   ]
 }

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