tipi 0.41 → 0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a83c181c05d8d8c8de50f236feab65b800b1bd266c2f0a4d4696d4853ac39fd
-  data.tar.gz: d9a84fc9f72c3a5565f587e35fb4ed206c83c863fbb0b4b470449919a687463b
+  metadata.gz: e174ac4f391f2a5d8a6bc023c8dbe800cb28c7c6ab6ce0f5b30a5a741adfbba3
+  data.tar.gz: 20f4e08c4295e43b4e530005894573170d11488e33ffdb7bd7ac863ea9b24d10
 SHA512:
-  metadata.gz: e9c13f387c3431888d9d43c88d5bd00831c4e2e8976bf8ae4e1acc479b8d50fa888cd58af0fc433da2dab8e3ea09b99ca0adbdcc61abc71457a805c26aa03687
-  data.tar.gz: df01a54c7c46928c67da321cfc830d8f33e8af7fa8197cd5930f3de73838efd4849d51b10af35b1a5297f7f484b296ff2ed6146dbb8d66476bf0b714f1dbfd68
+  metadata.gz: 44824970035774527e456959c6e8249bd697696ef942e2229b4fc9faa192ab2433c7e78f714af3ac98a4d21fc1e764de718ecd41c9e1374a9d06ab090230ab2f
+  data.tar.gz: 46549f1ae238fc25fe878bb59258da44757ed05e84177f113a40f00d962f43947d9bbd44f78f1e97be386001d34fadfba8679a5d0a6c647f4dca618769a8116d

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}}
@@ -23,5 +23,7 @@ jobs:
       run: |
         gem install bundler
         POLYPHONY_USE_LIBEV=1 bundle install
+    - name: Show Linux kernel version
+      run: uname -r
     - name: Run tests
       run:  bundle exec rake test

data/.gitignore

@@ -55,5 +55,7 @@ build-iPhoneSimulator/
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
 log
+log.*
 
-lib/tipi_ext*
+lib/tipi_ext*
+examples/certificate_store.db

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## 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
+- Add support for parsing HTTP/1 from callable source
+- Introduce full_service API for automatic HTTPS
+- Introduce automatic SSL certificate provisioning
+- Improve handling of exceptions
+- Various fixes to DF service and agent pxoy
+- Fix upgrading to HTTP2 with a request body
+- Switch to new HTTP/1 parser
+
 ## 0.41 2021-07-26
 
 - Fix Rack adapter (#11)

data/Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec
+
+# 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,64 +1,82 @@
+PATH
+  remote: ../ever
+  specs:
+    ever (0.1)
+
+PATH
+  remote: ../h1p
+  specs:
+    h1p (0.2)
+
+PATH
+  remote: ../polyphony
+  specs:
+    polyphony (0.73.1)
+
+PATH
+  remote: ../qeweney
+  specs:
+    qeweney (0.16)
+      escape_utils (~> 1.2.1)
+
 PATH
   remote: .
   specs:
-    tipi (0.41)
+    tipi (0.46)
       acme-client (~> 2.0.8)
-      http-2 (~> 0.10.0)
-      http_parser.rb (~> 0.6.0)
+      ever (~> 0.1)
+      extralite (~> 1.2)
+      h1p (~> 0.2)
+      http-2 (~> 0.11)
+      localhost (~> 1.1.4)
       msgpack (~> 1.4.2)
-      polyphony (~> 0.64)
-      qeweney (~> 0.11)
+      polyphony (~> 0.71)
+      qeweney (~> 0.14)
       rack (>= 2.0.8, < 2.3.0)
       websocket (~> 1.2.8)
 
 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)
-    faraday (1.5.1)
+    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)
-      multipart-post (>= 1.2, < 3)
+      faraday-rack (~> 1.0)
+      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)
-    http-2 (0.10.2)
-    http_parser.rb (0.6.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    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)
-    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)
-    polyphony (0.64)
-    qeweney (0.11)
-      escape_utils (~> 1.2.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)
@@ -72,13 +90,15 @@ PLATFORMS
 
 DEPENDENCIES
   cuba (~> 3.9.3)
-  localhost (~> 1.1.4)
+  ever!
+  h1p!
+  memory_profiler (~> 1.0.0)
   minitest (~> 5.11.3)
-  minitest-reporters (~> 1.4.2)
-  rake (~> 12.3.3)
-  rake-compiler (= 1.1.1)
+  polyphony!
+  qeweney!
+  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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+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
+  headers = nil
+  parser.on_headers_complete = proc do |h|
+    headers = h
+    headers[':method'] = parser.http_method
+    headers[':path'] = parser.request_url
+  end
+  parser.on_message_complete = proc { done = true }
+
+  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
+  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)
+  STDOUT << "tipi parser: "
+  require_relative '../lib/tipi_ext'
+  i, o = IO.pipe
+  reader = proc { |len| i.readpartial(len) }
+  parser = Tipi::HTTP1Parser.new(reader)
+
+  elapsed, allocated = measure_time_and_allocs do
+    iterations.times do
+      o << HTTP_REQUEST
+      headers = parser.parse_headers
+    end
+  end
+  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 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)
+
+benchmark_tipi_http1_parser(x)

data/bin/benchmark

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'polyphony'
+
+def parse_latency(latency)
+  m = latency.match(/^([\d\.]+)(us|ms|s)$/)
+  return nil unless m
+
+  value = m[1].to_f
+  case m[2]
+  when 's' then value
+  when 'ms' then value / 1000
+  when 'us' then value / 1000000
+  end
+end
+
+def parse_wrk_results(results)
+  lines = results.lines
+  latencies = lines[3].strip.split(/\s+/)
+  throughput = lines[6].strip.split(/\s+/)
+
+  {
+    latency_avg:  parse_latency(latencies[1]),
+    latency_max:  parse_latency(latencies[3]),
+    rate:         throughput[1].to_f
+  }
+end
+
+def run_wrk(duration: 10, threads: 2, connections: 10, url: )
+  `wrk -d#{duration} -t#{threads} -c#{connections} #{url}`
+end
+
+[8, 64, 256, 512].each do |c|
+  puts "connections: #{c}"
+  p parse_wrk_results(run_wrk(duration: 10, threads: 4, connections: c, url: "http://localhost:10080/"))
+end

data/bin/h1pd

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -e
+rake compile
+ruby test/test_http1_parser.rb
+ruby benchmarks/bm_http1_parser.rb

data/bin/tipi

@@ -1,26 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'polyphony'
-require File.expand_path('../lib/tipi/configuration', __dir__)
+require 'tipi/cli'
 
-config = {}
-#config[:forked] = 4
+trap('SIGINT') { exit }
 
-puts DATA.read
-puts
-
-configuration_manager = spin { Tipi::Configuration.supervise_config }
-
-configuration_manager << config
-configuration_manager.await
-
-__END__
-
-          ooo
-       oo
-     o
-   \|/
-   / \   Tipi - A better web server for a better world
-  /___\
-  
+Tipi::CLI.start

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)
@@ -17,7 +19,7 @@ rescue Interrupt
 rescue SystemExit
   # ignore
 rescue Exception => e
-  log("Uncaught exception", error: e, backtrace: e.backtrace)
+  log("Uncaught exception", error: e, source: e.source_fiber, raising: e.raising_fiber, backtrace: e.backtrace)
 ensure
   log('DF server stopped')
 end