tipi 0.39 → 0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c5ce4798e1961ca59798b75bafe158570e777661f6fc8667169553df3cd3f4
-  data.tar.gz: 405bfa3526efaad394d34840764dc131230a366574cfc52b63344a6d5cdfe6dd
+  metadata.gz: 3e78bf3b20c7ec6704c26869694cf69e389ae1c0c2f2e44c82d0104d2ecaded9
+  data.tar.gz: dac8b0014cbc3a6ee5b146f3645bd38f3d55b21d5c17d969eecaa62c1e8b9306
 SHA512:
-  metadata.gz: 754bd35136e4e004e6bd782eb2060d933b2439c437a9c2a966529e0465c42096b97fa08b1dae04b7a3c8aa0c77c367fd5395d215cca73fd7cf1aa80c297b3178
-  data.tar.gz: 24425d798c076ad43b4fa45b641a90a5e801dfe35acd6217e8a8fc97ea546f18457fc9a8653e47f7bd5f696da885ef86db8db36385dcaa79ccbcf9d42d64081c
+  metadata.gz: fa53cedcd271ba9dbc37821315d27bf14b1eac17451c912eb3dcaa3ceae3b0b738f5d10678cf390f0534edd9d352008e71dec95c46566cad513e3b2d783ea000
+  data.tar.gz: 3cf95c22b05c8eaebdf646963d930977ddb010c3ca9174f081cee674e315f5ac672059b31f833ec337c78e3ec43770f72f6bba145ad00e2bd8c1ed8d0acb2174

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.40 2021-06-24
+
+- Implement serving static files using splice_chunks (nice performance boost for
+  files bigger than 1M)
+- Call shutdown before closing socket
+- Fix examples (thanks @timhatch!)
+
 ## 0.39 2021-06-20
 
 - More work on DF server

data/Gemfile.lock

@@ -1,22 +1,38 @@
 PATH
   remote: .
   specs:
-    tipi (0.39)
+    tipi (0.40)
+      acme-client (~> 2.0.8)
       http-2 (~> 0.10.0)
       http_parser.rb (~> 0.6.0)
       msgpack (~> 1.4.2)
-      polyphony (~> 0.55.0)
-      qeweney (~> 0.9.1)
+      polyphony (~> 0.57.0)
+      qeweney (~> 0.10.0)
       rack (>= 2.0.8, < 2.3.0)
       websocket (~> 1.2.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    acme-client (2.0.8)
+      faraday (>= 0.17, < 2.0.0)
     ansi (1.5.0)
     builder (3.2.4)
     docile (1.3.2)
     escape_utils (1.2.1)
+    faraday (1.4.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     http-2 (0.10.2)
     http_parser.rb (0.6.0)
     json (2.3.1)
@@ -28,12 +44,14 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     msgpack (1.4.2)
-    polyphony (0.55.0)
-    qeweney (0.9.1)
+    multipart-post (2.1.1)
+    polyphony (0.57.0)
+    qeweney (0.10)
       escape_utils (~> 1.2.1)
     rack (2.2.3)
     rake (12.3.3)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.4)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)

data/df/server.rb

@@ -13,7 +13,10 @@ FileUtils.cd(__dir__)
 service = DigitalFabric::Service.new(token: 'foobar')
 executive = DigitalFabric::Executive.new(service, { host: 'executive.realiteq.net' })
 
-spin_loop(interval: 60) { GC.start }
+GC.disable
+Thread.current.backend.idle_gc_period = 60
+
+# spin_loop(interval: 60) { GC.start }
 
 class Polyphony::BaseException
   attr_reader :caller_backtrace
@@ -51,7 +54,12 @@ https_listener = spin do
   cert = certificates.shift
   puts "Certificate expires: #{cert.not_after.inspect}"
   ctx.add_certificate(cert, private_key, certificates)
-  # ctx = Localhost::Authority.fetch.server_context
+  ctx.ciphers = 'ECDH+aRSA'
+
+  # TODO: further limit ciphers
+  # ref: https://github.com/socketry/falcon/blob/3ec805b3ceda0a764a2c5eb68cde33897b6a35ff/lib/falcon/environments/tls.rb
+  # ref: https://github.com/socketry/falcon/blob/3ec805b3ceda0a764a2c5eb68cde33897b6a35ff/lib/falcon/tls.rb
+
   opts = {
     reuse_addr:     true,
     dont_linger:    true,
@@ -61,21 +69,28 @@ https_listener = spin do
 
   puts 'Listening for HTTPS on localhost:10443'
   server = Polyphony::Net.tcp_listen('0.0.0.0', 10443, opts)
-  server.accept_loop do |client|
+  loop do
+    client = server.accept
     spin do
       service.incr_connection_count
       Tipi.client_loop(client, opts) { |req| service.http_request(req) }
+    rescue Exception => e
+      puts "Exception: #{e.inspect}"
+      puts e.backtrace.join("\n")
     ensure
       service.decr_connection_count
     end
+  rescue Polyphony::BaseException
+    raise
+  rescue OpenSSL::SSL::SSLError, SystemCallError => e
+    puts "HTTPS accept error: #{e.inspect}"
   rescue Exception => e
-    puts "HTTPS accept_loop error: #{e.inspect}"
+    puts "HTTPS accept error: #{e.inspect}"
     puts e.backtrace.join("\n")
   end
 end
 
 UNIX_SOCKET_PATH = '/tmp/df.sock'
-
 unix_listener = spin do
   puts "Listening on #{UNIX_SOCKET_PATH}"
   FileUtils.rm(UNIX_SOCKET_PATH) if File.exists?(UNIX_SOCKET_PATH)

data/examples/automatic_certificate.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tipi'
+require 'openssl'
+require 'acme-client'
+
+# ::Exception.__disable_sanitized_backtrace__ = true
+
+class CertificateManager
+  def initialize(store:, challenge_handler:)
+    @store = store
+    @challenge_handler = challenge_handler
+    @workers = {}
+    @contexts = {}
+  end
+
+  def [](name)
+    worker = worker_for_name(name)
+    p worker: worker
+  
+    worker << Fiber.current
+    # cancel_after(30) { receive }
+    receive.tap { |ctx| p got_ctx: ctx }
+  rescue Exception => e
+    p e
+    puts e.backtrace.join("\n")
+    nil
+  end
+  
+  def worker_for_name(name)
+    @workers[name] ||= spin { worker_loop(name) }
+  end
+  
+  def worker_loop(name)
+    while (client = receive)
+      puts "get request for #{name} from #{client.inspect}"
+      ctx = get_context(name)
+      client << ctx rescue nil
+    end
+  end
+
+  def get_context(name)
+    @contexts[name] ||= setup_context(name)
+  end
+
+  CERTIFICATE_REGEXP = /(-----BEGIN CERTIFICATE-----\n[^-]+-----END CERTIFICATE-----\n)/.freeze
+
+  def setup_context(name)
+    certificate = get_certificate(name)
+    ctx = OpenSSL::SSL::SSLContext.new
+    chain = certificate.scan(CERTIFICATE_REGEXP).map { |p|  OpenSSL::X509::Certificate.new(p.first) }
+    cert = chain.shift
+    puts "Certificate expires: #{cert.not_after.inspect}"
+    ctx.add_certificate(cert, private_key, chain)
+    Polyphony::Net.setup_alpn(ctx, Tipi::ALPN_PROTOCOLS)
+    ctx
+  end
+  
+  def get_certificate(name)
+    @store[name] ||= provision_certificate(name)
+  end
+
+  def private_key
+    @private_key ||= OpenSSL::PKey::RSA.new(4096)
+  end
+
+  ACME_DIRECTORY = 'https://acme-staging-v02.api.letsencrypt.org/directory'
+
+  def acme_client
+    @acme_client ||= setup_acme_client
+  end
+
+  def setup_acme_client
+    client = Acme::Client.new(
+      private_key: private_key,
+      directory: ACME_DIRECTORY
+    )
+    p client: client
+    account = client.new_account(
+      contact: 'mailto:info@noteflakes.com',
+      terms_of_service_agreed: true
+    )
+    p account: account.kid
+    client
+  end
+
+  def provision_certificate(name)
+    order = acme_client.new_order(identifiers: [name])
+    p order: true
+    authorization = order.authorizations.first
+    p authorization: authorization
+    challenge = authorization.http
+    p challenge: challenge
+  
+    @challenge_handler.add(challenge)
+    challenge.request_validation
+    p challenge_status: challenge.status
+    while challenge.status == 'pending'
+      sleep(1)
+      challenge.reload
+      p challenge_status: challenge.status
+    end
+  
+    csr = Acme::Client::CertificateRequest.new(private_key: @private_key, subject: { common_name: name })
+    p csr: csr
+    order.finalize(csr: csr)
+    p order_status: order.status
+    while order.status == 'processing'
+      sleep(1)
+      order.reload
+      p order_status: order.status
+    end
+    order.certificate.tap { |c| p certificate: c } # => PEM-formatted certificate
+  end
+end
+
+class AcmeHTTPChallengeHandler
+  def initialize
+    @challenges = {}
+  end
+
+  def add(challenge)
+    path = "/.well-known/acme-challenge/#{challenge.token}"
+    @challenges[path] = challenge
+  end
+
+  def call(req)
+    # handle incoming request
+    challenge = @challenges[req.path]
+    return req.respond(nil, ':status' => 400) unless challenge
+
+    req.respond(challenge.file_content, 'content-type' => challenge.content_type)
+    @challenges.delete(req.path)
+  end
+end
+
+challenge_handler = AcmeHTTPChallengeHandler.new
+certificate_manager = CertificateManager.new(
+  store: {},
+  challenge_handler: challenge_handler
+)
+
+http_handler = Tipi.route do |r|
+  r.on('/.well-known/acme-challenge') { challenge_handler.call(r) }
+  r.default { r.redirect "https://#{r.host}#{r.path}" }
+end
+
+https_handler = ->(r) { r.respond('Hello, world!') }
+
+http_listener = spin do
+  opts = {
+    reuse_addr:  true,
+    dont_linger: true,
+  }
+  puts 'Listening for HTTP on localhost:10080'
+  Tipi.serve('0.0.0.0', 10080, opts, &http_handler)
+end
+
+https_listener = spin do
+  ctx = OpenSSL::SSL::SSLContext.new
+  ctx.servername_cb = proc { |_, name| p name: name; certificate_manager[name] }
+  opts = {
+    reuse_addr:     true,
+    dont_linger:    true,
+    secure_context: ctx,
+    alpn_protocols: Tipi::ALPN_PROTOCOLS
+  }
+
+  puts 'Listening for HTTPS on localhost:10443'
+  server = Polyphony::Net.tcp_listen('0.0.0.0', 10443, opts)
+  server.accept_loop do |client|
+    spin do
+      service.incr_connection_count
+      Tipi.client_loop(client, opts) { |req| service.http_request(req) }
+    ensure
+      service.decr_connection_count
+    end
+  rescue Exception => e
+    puts "HTTPS accept_loop error: #{e.inspect}"
+    puts e.backtrace.join("\n")
+  end
+end
+
+begin
+  Fiber.await(http_listener, https_listener)
+rescue Interrupt
+  puts "Got SIGINT, terminating"
+rescue Exception => e
+  puts '*' * 40
+  p e
+  puts e.backtrace.join("\n")
+end

data/examples/http_server_forked.rb

@@ -11,11 +11,13 @@ opts = {
   dont_linger: true
 }
 
+server = Tipi.listen('0.0.0.0', 1234, opts)
+
 child_pids = []
 8.times do
   pid = Polyphony.fork do
     puts "forked pid: #{Process.pid}"
-    Tipi.serve('0.0.0.0', 1234, opts) do |req|
+    server.each do |req|
       req.respond("Hello world! from pid: #{Process.pid}\n")
     end
   rescue Interrupt

data/examples/http_server_routes.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tipi'
+
+opts = {
+  reuse_addr:  true,
+  dont_linger: true
+}
+
+puts "pid: #{Process.pid}"
+puts 'Listening on port 4411...'
+
+app = Tipi.route do |req|
+  req.on 'stream' do
+    req.send_headers('Foo' => 'Bar')
+    sleep 1
+    req.send_chunk("foo\n")
+    sleep 1
+    req.send_chunk("bar\n")
+    req.finish
+  end
+  req.default do
+    req.respond("Hello world!\n")
+  end
+end
+
+trap('INT') { exit! }
+Tipi.serve('0.0.0.0', 4411, opts, &app)

data/examples/http_server_static.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tipi'
+require 'fileutils'
+
+opts = {
+  reuse_addr:  true,
+  dont_linger: true
+}
+
+puts "pid: #{Process.pid}"
+puts 'Listening on port 4411...'
+
+root_path = FileUtils.pwd
+
+trap('INT') { exit! }
+
+app = Tipi.route do |req|
+  req.on('normal') do
+    path = File.join(root_path, req.route_relative_path)
+    if File.file?(path)
+      req.serve_file(path)
+    else
+      req.respond(nil, ':status' => Qeweney::Status::NOT_FOUND)
+    end
+  end
+  req.on('spliced') do
+    path = File.join(root_path, req.route_relative_path)
+    if File.file?(path)
+      req.serve_file(path, respond_from_io: true)
+    else
+      req.respond(nil, ':status' => Qeweney::Status::NOT_FOUND)
+    end
+  end
+end
+
+Tipi.serve('0.0.0.0', 4411, opts, &app)

data/examples/websocket_demo.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/inline'
-
-gemfile do
-  source 'https://rubygems.org'
-  gem 'polyphony', '~> 0.44'
-  gem 'tipi', '~> 0.31'
-end
-
+require 'bundler/setup'
+require 'tipi'
 require 'tipi/websocket'
 
 class WebsocketClient

data/examples/ws_page.html

@@ -6,7 +6,7 @@
 <body>
   <script>
     var connect = function () {
-      var exampleSocket = new WebSocket("wss://dev.realiteq.net/");
+      var exampleSocket = new WebSocket("ws://localhost:4411/");
 
       exampleSocket.onopen = function (event) {
         document.querySelector('#status').innerText = 'connected';
@@ -30,4 +30,4 @@
   <h1 id="status">disconnected</h1>
   <h1 id="msg"></h1>
 </body>
-</html>
+</html>

data/lib/tipi.rb

@@ -4,6 +4,12 @@ require 'polyphony'
 require_relative './tipi/http1_adapter'
 require_relative './tipi/http2_adapter'
 require_relative './tipi/configuration'
+require_relative './tipi/response_extensions'
+require 'qeweney/request'
+
+class Qeweney::Request
+  include Tipi::ResponseExtensions
+end
 
 module Tipi
   ALPN_PROTOCOLS = %w[h2 http/1.1].freeze

data/lib/tipi/http1_adapter.rb

@@ -50,6 +50,8 @@ module Tipi
       # release references to various objects
       @requests_head = @requests_tail = nil
       @parser = nil
+      @splicing_pipe = nil
+      @conn.shutdown if @conn.respond_to?(:shutdown) rescue nil
       @conn.close
     end
     
@@ -217,7 +219,25 @@ module Tipi
         @conn.write(formatted_headers)
       end
     end
+
+    def respond_from_io(request, io, headers, chunk_size = 2**14)
+      consume_request(request) if @parsing
+
+      formatted_headers = format_headers(headers, true, true)
+      request.tx_incr(formatted_headers.bytesize)
       
+      # assume chunked encoding
+      Thread.current.backend.splice_chunks(
+        io,
+        @conn,
+        formatted_headers,
+        "0\r\n\r\n",
+        ->(len) { "#{len.to_s(16)}\r\n" },
+        "\r\n",
+        16384    
+      )
+    end
+
     # Sends response headers. If empty_response is truthy, the response status
     # code will default to 204, otherwise to 200.
     # @param request [Qeweney::Request] HTTP request
@@ -248,6 +268,20 @@ module Tipi
       @conn.write(data)
     end
     
+    def send_chunk_from_io(request, io, r, w, chunk_size)
+      len = w.splice(io, chunk_size)
+      if len > 0
+        Thread.current.backend.chain(
+          [:write, @conn, "#{len.to_s(16)}\r\n"],
+          [:splice, r, @conn, len],
+          [:write, @conn, "\r\n"]
+        )
+      else
+        @conn.write("0\r\n\r\n")
+      end
+      len
+    end
+
     # Finishes the response to the current request. If no headers were sent,
     # default headers are sent using #send_headers.
     # @return [void]
@@ -257,6 +291,7 @@ module Tipi
     end
     
     def close
+      @conn.shutdown if @conn.respond_to?(:shutdown) rescue nil
       @conn.close
     end
     
@@ -303,7 +338,7 @@ module Tipi
       if chunked
         +"HTTP/1.1 #{status}\r\nTransfer-Encoding: chunked\r\n"
       else
-        +"HTTP/1.1 #{status}\r\nContent-Length: #{body.bytesize}\r\n"
+        +"HTTP/1.1 #{status}\r\nContent-Length: #{body.is_a?(String) ? body.bytesize : body.to_i}\r\n"
       end
     end
 

data/lib/tipi/http2_adapter.rb

@@ -87,10 +87,12 @@ module Tipi
     def finalize_client_loop
       @interface = nil
       @streams.each_key(&:stop)
+      @conn.shutdown if @conn.respond_to?(:shutdown) rescue nil
       @conn.close
     end
     
     def close
+      @conn.shutdown if @conn.respond_to?(:shutdown) rescue nil
       @conn.close
     end
 

data/lib/tipi/http2_stream.rb

@@ -123,9 +123,23 @@ module Tipi
       headers[':status'] = headers[':status'].to_s
       with_transfer_count(request) do
         @stream.headers(transform_headers(headers))
+        @headers_sent = true
         @stream.data(chunk || '')
       end
-      @headers_sent = true
+    rescue HTTP2::Error::StreamClosed
+      # ignore
+    end
+
+    def respond_from_io(request, io, headers, chunk_size = 2**16)
+      headers[':status'] ||= Qeweney::Status::OK
+      headers[':status'] = headers[':status'].to_s
+      with_transfer_count(request) do
+        @stream.headers(transform_headers(headers))
+        @headers_sent = true
+        while (chunk = io.read(chunk_size))
+          @stream.data(chunk)
+        end
+      end
     rescue HTTP2::Error::StreamClosed
       # ignore
     end

data/lib/tipi/response_extensions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'qeweney/request'
+
+module Tipi
+  module ResponseExtensions
+    SPLICE_CHUNKS_SIZE_THRESHOLD = 2**20
+
+    def serve_io(io, opts)
+      if !opts[:stat] || opts[:stat].size >= SPLICE_CHUNKS_SIZE_THRESHOLD
+        @adapter.respond_from_io(self, io, opts[:headers])
+      else  
+        respond(io.read, opts[:headers] || {})
+      end
+    end
+  end
+end

data/lib/tipi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tipi
-  VERSION = '0.39'
+  VERSION = '0.40'
 end

data/tipi.gemspec

@@ -19,13 +19,14 @@ Gem::Specification.new do |s|
 
   s.executables   = ['tipi']
 
-  s.add_runtime_dependency      'polyphony',          '~>0.55.0'
-  s.add_runtime_dependency      'qeweney',            '~>0.9.1'
+  s.add_runtime_dependency      'polyphony',          '~>0.57.0'
+  s.add_runtime_dependency      'qeweney',            '~>0.10.0'
   
   s.add_runtime_dependency      'http_parser.rb',     '~>0.6.0'
   s.add_runtime_dependency      'http-2',             '~>0.10.0'
   s.add_runtime_dependency      'rack',               '>=2.0.8', '<2.3.0'
   s.add_runtime_dependency      'websocket',          '~>1.2.8'
+  s.add_runtime_dependency      'acme-client',        '~>2.0.8'
 
   # for digital fabric
   s.add_runtime_dependency      'msgpack',            '~>1.4.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tipi
 version: !ruby/object:Gem::Version
-  version: '0.39'
+  version: '0.40'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polyphony
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.57.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.57.0
 - !ruby/object:Gem::Dependency
   name: qeweney
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: acme-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.8
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +229,7 @@ files:
 - docs/README.md
 - docs/tipi-logo.png
 - e
+- examples/automatic_certificate.rb
 - examples/cuba.ru
 - examples/hanami-api.ru
 - examples/hello.ru
@@ -224,7 +239,9 @@ files:
 - examples/http_server_forked.rb
 - examples/http_server_form.rb
 - examples/http_server_graceful.rb
+- examples/http_server_routes.rb
 - examples/http_server_simple.rb
+- examples/http_server_static.rb
 - examples/http_server_throttled.rb
 - examples/http_server_throttled_accept.rb
 - examples/http_server_timeout.rb
@@ -259,6 +276,7 @@ files:
 - lib/tipi/http2_adapter.rb
 - lib/tipi/http2_stream.rb
 - lib/tipi/rack_adapter.rb
+- lib/tipi/response_extensions.rb
 - lib/tipi/version.rb
 - lib/tipi/websocket.rb
 - test/coverage.rb