tp2 0.11.3 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecbdd5f3235d547f97643c111afbdb42c0b069f43d832ad6b3ee4f316104b2f7
-  data.tar.gz: 00eccb47e2b984880081e3b38bf1839cdfd0849bd8840e54efeaa04f264d5587
+  metadata.gz: e3f8224d39ef6a0c94d38882aa4fbde1692de6e777803060eb5adc96e56f3504
+  data.tar.gz: 572011895d001d3f132416ad669191fc75291d7c0b0c01fbf5dce619da6bf22c
 SHA512:
-  metadata.gz: f69b124309ee1582c3197c2fead077e01d7b5782985ca86caae097bbe70fb0d7ca7d6cb2d85f174a7676e1a048476092aac39292183a52fbeef10eea70b29a18
-  data.tar.gz: 7f3f7c6c883e04f884ecefee2b4e3d58bf90f56ae21419dff78f897f16b7f2cb019af513ef96680d8969276ee54c0e67f636d3f828ddb966456c361527cb1222
+  metadata.gz: 8faf10f9c9da6ef061c3203cd4795d0d9fa01a2ecf7ce788abd89fbdc251a126f760c08424e41b4a5e0a7f10c2ecd7a64b56b152b441049637a9a6ac3f34db4b
+  data.tar.gz: 111856fa3064194dc93a98c197adeb9c512c232bc8ca4aea73b9f24542a866360f086cb2c1ba94cee068df3bb8967fdb565104b58604a7c8c3555f6184f07700

data/.rubocop.yml

@@ -0,0 +1,196 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  RubyInterpreters:
+    - ruby
+  Exclude:
+    - "**/*.gemspec"
+    - "test/**/*.rb"
+    - "examples/**/*.rb"
+    - "Gemfile*"
+# Style/LambdaCall:
+#   Enabled: false
+# Style/ModuleFunction:
+#   Enabled: false
+# Style/RegexpLiteral:
+#   Enabled: false
+
+# Naming/MemoizedInstanceVariableName:
+#   Enabled: false
+
+# Style/Alias:
+#   EnforcedStyle: prefer_alias_method
+
+# Style/SpecialGlobalVars:
+#   Enabled: false
+
+# Style/ClassAndModuleChildren:
+#   Enabled: false
+
+# Metrics/AbcSize:
+#   Enabled: false
+
+# Style/MixinUsage:
+#   Enabled: false
+
+# Style/MultilineBlockChain:
+#   Enabled: false
+
+# Lint/RescueException:
+#   Enabled: false
+
+# Lint/InheritException:
+#   Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+# Style/TrivialAccessors:
+#   Enabled: false
+
+# Lint/MissingSuper:
+#   Enabled: false
+
+# Style/GlobalVars:
+#   Exclude:
+#     - lib/polyphony/auto_run.rb
+#     - lib/polyphony/extensions/core.rb
+#     - examples/**/*.rb
+
+Layout/HashAlignment:
+  Enabled: false
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+# Naming/AccessorMethodName:
+#   Exclude:
+#     - lib/polyphony/extensions/fiber.rb
+#     - examples/**/*.rb
+
+# Naming/MethodName:
+#   Exclude:
+#     - test/test_signal.rb
+
+# Lint/SuppressedException:
+#   Exclude:
+#     - examples/**/*.rb
+
+Metrics/MethodLength:
+  Max: 14
+#   Exclude:
+#     - lib/polyphony/extensions/io.rb
+#     - lib/polyphony/extensions/fiber.rb
+#     - lib/polyphony/extensions/thread.rb
+#     - lib/polyphony/adapters/open3.rb
+#     - test/**/*.rb
+#     - examples/**/*.rb
+
+# Metrics/ModuleLength:
+#   Exclude:
+#     - lib/polyphony/core/global_api.rb
+#     - examples/**/*.rb
+
+# Metrics/ClassLength:
+#   Exclude:
+#     - lib/polyphony/extensions/io.rb
+#     - lib/polyphony/extensions/fiber.rb
+#     - lib/polyphony/extensions/object.rb
+#     - lib/polyphony/extensions/thread.rb
+#     - test/**/*.rb
+#     - examples/**/*.rb
+
+# Metrics/CyclomaticComplexity:
+#   Exclude:
+#     - lib/polyphony/extensions/fiber.rb
+
+# Metrics/PerceivedComplexity:
+#   Exclude:
+#     - lib/polyphony/extensions/fiber.rb
+
+# Style/RegexpLiteral:
+#   Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+# Style/Documentation:
+#   Exclude:
+#     - test/**/*.rb
+#     - examples/**/*.rb
+#     - lib/polyphony/adapters/**/*.rb
+
+# Style/FormatString:
+#   Exclude:
+#     - test/**/*.rb
+#     - examples/**/*.rb
+
+# Style/FormatStringToken:
+#   Exclude:
+#     - test/**/*.rb
+#     - examples/**/*.rb
+
+Naming/MethodParameterName:
+  Enabled: false
+
+# Security/MarshalLoad:
+#   Exclude:
+#     - examples/**/*.rb
+
+# Lint/ShadowedArgument:
+#   Exclude:
+#     - lib/polyphony/extensions/fiber.rb
+
+# Style/HashEachMethods:
+#   Enabled: true
+
+# Style/HashTransformKeys:
+#   Enabled: true
+
+# Style/HashTransformValues:
+#   Enabled: true
+
+# Layout/EmptyLinesAroundAttributeAccessor:
+#   Enabled: true
+
+# Layout/SpaceAroundMethodCallOperator:
+#   Enabled: true
+
+# Lint/DeprecatedOpenSSLConstant:
+#   Enabled: true
+
+# Lint/MixedRegexpCaptureTypes:
+#   Enabled: true
+
+# Lint/RaiseException:
+#   Enabled: true
+
+# Lint/StructNewOverride:
+#   Enabled: true
+
+Style/NegatedIf:
+  Enabled: false
+# Style/NegatedWhile:
+#   Enabled: false
+
+# Style/CombinableLoops:
+#   Enabled: false
+
+# Style/InfiniteLoop:
+#   Enabled: false
+
+# Style/RedundantReturn:
+#   Enabled: false
+
+# Style/ExponentialNotation:
+#   Enabled: true
+
+# Style/RedundantRegexpCharacterClass:
+#   Enabled: true
+
+# Style/RedundantRegexpEscape:
+#   Enabled: true
+
+# Style/SlicingWithRange:
+#   Enabled: true
+
+# Style/RaiseArgs:
+#   Exclude:
+#     - lib/polyphony/extensions/fiber.rb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Version 0.12 2025-06-24
+
+- Make logging pluggable
+
 # Version 0.11.3 2025-06-16
 
 - Rename HTTP1Adapter to HTTP1Connection

data/TODO.md

@@ -1,8 +1,6 @@
 - Add failing tests for request bombs (requests with lots of bytes)
-
-- add test for `ProtocolError` handling
-
-- Add limits for:
+- Add test for `ProtocolError` handling
+- Add limits with tests for:
   - total request size (pre body)
   - line size
   - request method size
@@ -15,3 +13,7 @@
 
     HEADER_RE = /^\s([^\s^\:]{1, #{MAX_HEADER_KEY_BYTES}}).../
     ```
+
+- Benchmark parsing with UM::Stream (current approach), against parsing with strscan
+
+- Add pluggable logging. Move default logging format outside and pass a callable.

data/bin/tp2

@@ -1,46 +1,47 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "tp2"
-require "optparse"
+require 'tp2'
+require 'optparse'
 
 opts = {
   banner: true,
-  log: true
+  logger: true
 }
 
 parser = OptionParser.new do |o|
-  o.banner = "Usage: tp2 [options]"
+  o.banner = 'Usage: tp2 [options]'
 
-  o.on("-c", "--config CONFIG_FILE", String, "TP2 config file to use (default: app.rb)") {
+  o.on('-c', '--config CONFIG_FILE', String, 'TP2 config file to use (default: app.rb)') do
     opts[:app_type] = :tp2
     opts[:app_location] = it
-  }
-  o.on("-r", "--rack RACK_FILE", String, "Rack config file to use (default: config.ru)") {
+  end
+  o.on('-r', '--rack RACK_FILE', String, 'Rack config file to use (default: config.ru)') do
     opts[:app_type] = :rack
     opts[:app_location] = it
-  }
-  o.on("-d", "--dir PATH", String, "Static files at path") {
+  end
+  o.on('-d', '--dir PATH', String, 'Static files at path') do
     opts[:app_type] = :static
     opts[:app_location] = it
-  }
+  end
 
-  o.on("-b", "--bind BIND", String, "Bind address (default: http://0.0.0.0:1234). You can specify this flag multiple times to bind to multiple addresses.") {
+  o.on('-b', '--bind BIND', String,
+       'Bind address (default: http://0.0.0.0:1234). You can specify this flag multiple times to bind to multiple addresses.') do
     opts[:bind] ||= []
     opts[:bind] << it
-  }
+  end
 
-  o.on("-s", "--silent", "Silent mode") {
+  o.on('-s', '--silent', 'Silent mode') do
     opts[:banner] = nil
-    opts[:log] = nil
-  }
+    opts[:logger] = nil
+  end
 
-  o.on("-h", "--help", "Show this help message") do
+  o.on('-h', '--help', 'Show this help message') do
     puts o
     exit
   end
 
-  o.on("-v", "--version", "Show version") do
+  o.on('-v', '--version', 'Show version') do
     puts "TP2 version #{TP2::VERSION}"
     exit
   end
@@ -59,7 +60,7 @@ opts[:location] = ARGV.shift || '.'
 def check_app_file(opts, fn, type)
   fn = File.join(opts[:location], fn)
   return false if !File.file?(fn)
-  
+
   opts[:app_type] = type
   opts[:app_location] = File.expand_path(fn)
 end

data/lib/tp2/http1_connection.rb

@@ -20,7 +20,7 @@ module TP2
     end
 
     def run
-      while true
+      loop do
         @done = nil
         @response_headers = nil
         persist = serve_request
@@ -28,9 +28,8 @@ module TP2
       end
     rescue UM::Terminate, SystemCallError
       # we're done, we don't care about broken socket
-    rescue StandardError
-      @opts[:log]&.log("Unhandled exception #{e.class}: #{e.message}, closing connection")
-      @opts[:log]&.log(e.backtrace.join("\n"))
+    rescue StandardError => e
+      @opts[:logger]&.call(e, nil)
     ensure
       @machine.close_async(@fd)
     end
@@ -45,7 +44,7 @@ module TP2
       persist_connection?(headers)
     rescue ProtocolError
       # TODO: add hook for testing protocol errors
-      return false
+      false
     end
 
     def get_body(req)
@@ -60,7 +59,7 @@ module TP2
       read(1 << 20, nil, false)
     end
 
-    def get_body_chunk(req, buffered_only = false)
+    def get_body_chunk(req, _buffered_only = false)
       headers = req.headers
       content_length = headers['content-length']
       if content_length
@@ -105,7 +104,7 @@ module TP2
       else
         @machine.send(@fd, formatted_headers, formatted_headers.bytesize, SEND_FLAGS)
       end
-      log(request, headers) if @opts[:log]
+      @opts[:logger]&.call(request, headers)
       @done = true
       @response_headers = headers
     end
@@ -120,7 +119,6 @@ module TP2
     def send_headers(request, headers, empty_response: false, chunked: true)
       formatted_headers = format_headers(headers, !empty_response, http1_1?(request) && chunked)
       request.tx_incr(formatted_headers.bytesize)
-      #
       @machine.send(@fd, formatted_headers, formatted_headers.bytesize, SEND_FLAGS)
       @response_headers = headers
     end
@@ -143,10 +141,10 @@ module TP2
 
       request.tx_incr(data.bytesize)
       @machine.send(@fd, data, data.bytesize, SEND_FLAGS)
-      if done && !@done
-        log(request, @response_headers) if @opts[:log]
-        @done = true
-      end
+      return if @done || !done
+
+      @opts[:logger]&.call(request, @response_headers)
+      @done = true
     end
 
     # Finishes the response to the current request. If no headers were sent,
@@ -155,10 +153,10 @@ module TP2
     def finish(request)
       request.tx_incr(EMPTY_CHUNK_LEN)
       @machine.send(@fd, EMPTY_CHUNK, EMPTY_CHUNK_LEN, SEND_FLAGS)
-      if !@done
-        log(request, @response_headers) if @opts[:log]
-        @done = true
-      end
+      return if @done
+
+      @opts[:logger]&.call(request, @response_headers)
+      @done = true
     end
 
     def respond_with_static_file(req, path, opts, cache_headers)
@@ -170,17 +168,17 @@ module TP2
         opts[:headers] = cache_headers
       end
 
-      maxlen = opts[:max_len] || 65536
+      maxlen = opts[:max_len] || 65_536
       buf = String.new(capacity: maxlen)
       headers_sent = nil
-      while true
+      loop do
         res = @machine.read(fd, buf, maxlen, 0)
         if res < maxlen && !headers_sent
           return respond(req, buf, opts[:headers])
         elsif res == 0
           return finish(req)
         end
-        
+
         if !headers_sent
           send_headers(req, opts[:headers])
           headers_sent = true
@@ -199,34 +197,8 @@ module TP2
 
     private
 
-    def log(request, response_headers)
-      return if !@opts[:log]
-      
-      request_headers = request.headers
-      uri = full_uri(request_headers)
-
-      str = format(
-        "%<client_ip>s %<method>s %<uri>s %<status>s %<tx>d",
-        client_ip:  request.forwarded_for || '?',
-        method:     request_headers[':method'].upcase,
-        uri:        uri,
-        status:     @status,
-        tx:         request_headers[':tx']
-      )
-      @opts[:log].log(str)
-    end
-
-    def full_uri(headers)
-      format(
-        "%s://%s%s",
-        headers['x_forwarded_proto'] || 'http',
-        headers['host'],
-        headers[':path']
-      )
-    end
-
-    RE_REQUEST_LINE = /^([a-z]+)\s+([^\s]+)\s+(http\/[0-9\.]{1,3})/i.freeze
-    RE_HEADER_LINE = /^([a-z0-9\-]+)\:\s+(.+)/i.freeze
+    RE_REQUEST_LINE = %r{^([a-z]+)\s+([^\s]+)\s+(http/[0-9.]{1,3})}i
+    RE_HEADER_LINE = /^([a-z0-9-]+):\s+(.+)/i
     MAX_REQUEST_LINE_LEN = 1 << 14 # 16KB
     MAX_HEADER_LINE_LEN = 1 << 10 # 1KB
     MAX_CHUNK_SIZE_LEN = 16
@@ -236,11 +208,9 @@ module TP2
 
     def persist_connection?(headers)
       connection = headers['connection']&.downcase
-      if headers[':protocol'] == 'http/1.1'
-        return connection != 'close'
-      else
-        return connection && connection != 'close'
-      end
+      return connection != 'close' if headers[':protocol'] == 'http/1.1'
+
+      connection && connection != 'close'
     end
 
     def parse_headers
@@ -248,7 +218,7 @@ module TP2
       headers = get_request_line(buf)
       return nil if !headers
 
-      while true
+      loop do
         line = @stream.get_line(buf, MAX_HEADER_LINE_LEN)
         break if line.nil? || line.empty?
 
@@ -276,7 +246,7 @@ module TP2
     end
 
     def get_body_chunked_encoding(headers)
-      buf = String.new(capacity: 65536)
+      buf = String.new(capacity: 65_536)
       while read_chunk(headers, buf)
       end
 
@@ -285,9 +255,7 @@ module TP2
 
     def read(len, buf = nil, raise_on_eof = true)
       str = @stream.get_string(buf, len)
-      if !str && raise_on_eof
-        raise ProtocolError, 'Missing data'
-      end
+      raise ProtocolError, 'Missing data' if !str && raise_on_eof
 
       str
     end
@@ -314,7 +282,7 @@ module TP2
       request.headers[':protocol'] == 'http/1.1'
     end
 
-    INTERNAL_HEADER_REGEXP = /^:/.freeze
+    INTERNAL_HEADER_REGEXP = /^:/
 
     # Formats response headers into an array. If empty_response is true(thy),
     # the response status code will default to 204, otherwise to 200.

data/lib/tp2/logger.rb

@@ -2,15 +2,52 @@
 
 module TP2
   class Logger
-    def initialize(machine, fd = STDOUT.fileno, **opts)
+    def initialize(machine, fd = $stdout.fileno, **opts)
       @machine = machine
       @fd = fd
       @opts = opts
     end
 
     def log(str)
-      str = format("%s %s\n", Time.now.strftime('%Y-%m-%d %H:%M:%S.%3N'), str)
+      str = format(
+        "%<stamp>s %<msg>s\n",
+        stamp:  Time.now.strftime('%Y-%m-%d %H:%M:%S.%3N'),
+        msg:    str
+      )
       @machine.write_async(@fd, str)
     end
+
+    def call(request, _response_headers)
+      if request.is_a?(Exception)
+        e = request
+        log("Error: #{e.inspect}: #{e.backtrace.inspect}")
+        return
+      end
+
+      log(format_request_log_line(request))
+    end
+
+    def format_request_log_line(request)
+      request_headers = request.headers
+      uri = full_uri(request_headers)
+
+      format(
+        '%<client_ip>s %<method>s %<uri>s %<status>s %<tx>d',
+        client_ip:  request.forwarded_for || '?',
+        method:     request_headers[':method'].upcase,
+        uri:        uri,
+        status:     @status,
+        tx:         request_headers[':tx']
+      )
+    end
+
+    def full_uri(headers)
+      format(
+        '%<scheme>s://%<host>s%<path>s',
+        scheme: headers['x_forwarded_proto'] || 'http',
+        host:   headers['host'],
+        path:   headers[':path']
+      )
+    end
   end
 end

data/lib/tp2/version.rb

@@ -1,3 +1,3 @@
 module TP2
-  VERSION = '0.11.3'
+  VERSION = '0.12'
 end

data/lib/tp2.rb

@@ -22,7 +22,7 @@ module TP2
     "  /   \\      https://github.com/noteflakes/tp2\n" +
     "⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺\n"
   )
-  
+
   class << self
     def run(opts = nil, &app)
       if @in_run
@@ -37,7 +37,7 @@ module TP2
         machine = UM.new
 
         machine.puts(TP2::BANNER) if opts[:banner]
-        opts[:log] = opts[:log] && TP2::Logger.new(machine, **opts)
+        opts[:logger] = opts[:logger] && TP2::Logger.new(machine, **opts)
 
         server = Server.new(machine, opts, &app)
 
@@ -50,7 +50,7 @@ module TP2
 
     def config(opts = nil, &app)
       return @config if !opts && !app
-        
+
       @config = opts || {}
       @config[:app] = app if app
     end
@@ -66,7 +66,7 @@ module TP2
     # waits for signal from queue, then terminates given fiber
     # to be done
     def watch_for_int_signal(machine, queue, fiber)
-      sig = machine.shift(queue)
+      machine.shift(queue)
       machine.schedule(fiber, UM::Terminate.new)
     end
   end

data/test/helper.rb

@@ -6,6 +6,12 @@ require 'tp2'
 
 require_relative './coverage' if ENV['COVERAGE']
 
+class String
+  def crlf_lines
+    chomp.gsub("\n", "\r\n").chomp
+  end
+end
+
 module Kernel
   def capture_exception
     yield

data/test/test_http1_adapter.rb

@@ -2,12 +2,6 @@
 
 require_relative './helper'
 
-class String
-  def crlf_lines
-    chomp.gsub("\n", "\r\n").chomp
-  end
-end
-
 class HTTP1ConnectionTest < Minitest::Test
   def make_socket_pair
     port = 10000 + rand(30000)

data/test/test_server.rb

@@ -25,19 +25,25 @@ class ServerTest < Minitest::Test
   def setup
     @machine = UM.new
     @port = 10000 + rand(30000)
-    @server = TP2::Server.new(@machine, { bind: "127.0.0.1:#{@port}" }) { @app&.call(it) }
-    @f_server = @machine.spin do
-      @server.run
-    rescue STOP
-    ensure
-      @server_done = true
-    end
+    @opts = { bind: "127.0.0.1:#{@port}" }
+    @server = TP2::Server.new(@machine, @opts) { @app&.call(it) }
+    @f_server = @machine.spin { run_server }
 
+    # let server spin and listen to incoming connections
     @machine.sleep(0.01)
+
     @client_fd = @machine.socket(UM::AF_INET, UM::SOCK_STREAM, 0, 0)
     @machine.connect(@client_fd, '127.0.0.1', @port)
   end
 
+  def run_server
+    @server.run
+  rescue STOP
+    # ignore
+  ensure
+    @server_done = true
+  end
+
   def teardown
     @machine.close(@client_fd) rescue nil
     @machine.schedule(@f_server, STOP.new)
@@ -240,4 +246,17 @@ class ServerTest < Minitest::Test
     body = @bodies.shift
     assert_equal 'barbaz', body
   end
+
+  def test_logging
+    reqs = []
+    @opts[:logger] = ->(req, _h) { reqs << req }
+    @app = ->(req) { req.respond('Hello, world!', {}) }
+
+    write_http_request "GET / HTTP/1.0\r\n\r\n"
+    response = read_client_side
+    expected = "HTTP/1.1 200\r\nContent-Length: 13\r\n\r\nHello, world!"
+    assert_equal(expected, response)
+
+    assert_equal 1, reqs.size
+  end
 end

data/tp2.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 3.4'
   s.executables   = ['tp2']
 
-  s.add_dependency 'uringmachine',    '~> 0.14'
+  s.add_dependency 'uringmachine',    '~> 0.15'
   s.add_dependency 'qeweney',         '~> 0.21'
   s.add_dependency 'rack',            '~> 3.1.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tp2
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: '0.12'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: qeweney
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +60,7 @@ extra_rdoc_files:
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md