tp2 0.13.3 → 0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eae8332a80f3b55275c7d589d6028adbec69e7d4e8f4d5f55308f009b40dd3b
-  data.tar.gz: aa04bb1e0d287466593df9c0e92a2f557013cc373c994487f43b8f00dfea2f42
+  metadata.gz: '08812ae0e3200972086172f46db095a85dd81ab9f92a19f3545cb7e08425e722'
+  data.tar.gz: 204dcb6bc431cccddcd2a1aee3416235bb495359f99cc0afaa96cd56353d51f9
 SHA512:
-  metadata.gz: e8c9d0709021e4f9b5e7e836496db047a861255ae2a8a363b4b6821d6145f046f1aeb684191bd953f0cb6e40dc984b4fc139d5680c41ef572f140d94e6402384
-  data.tar.gz: 7839bda35a0afae58e26ccf23ab3d31a39eab3528a709c7082462dfd563cbe74bac6cab18d082d22bc5d58956b3cdac18160092f289bd9c31d7aa0362c18c27b
+  metadata.gz: 49f58f9c2e4650816583633323a9f9fd38d5028ca27a3c024694baad38fbd656ec360b6cb6189876e7cb9d0574e8c340d2d71796086135225057e9367ebe7ef7
+  data.tar.gz: 1f9cc001a6613a89b094d07ebeadf884f377840d302080c269de4cb8f635220a18e358efe3a078936acc069479202eb17a7f47b5842fb5a150256891ce7819d0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# Version 0.14 2025-07-08
+
+- Finish new logger
+
+# Version 0.13.4 2025-07-06
+
+- Improve logging for protocol errors, include more info
+
 # Version 0.13.3 2025-07-06
 
 - Update UringMachine

data/TODO.md

@@ -14,6 +14,4 @@
     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/examples/app.rb

@@ -5,7 +5,7 @@ require 'tp2'
 require 'json'
 
 TP2.config do |req|
-  raise 'foo'
+  # raise 'foo'
   body = req.headers.to_json
   req.respond(body, 'Content-Type' => 'application/json')
 end

data/lib/tp2/http1_connection.rb

@@ -5,7 +5,7 @@ require 'stringio'
 
 module TP2
   class HTTP1Connection
-    attr_reader :fd
+    attr_reader :fd, :response_headers
 
     def initialize(machine, fd, opts, &app)
       @machine = machine
@@ -29,7 +29,10 @@ module TP2
     rescue UM::Terminate
       # server is terminated, do nothing
     rescue StandardError => e
-      @logger&.call(e)
+      @logger&.error(
+        message:  'Uncaught error while running connection',
+        error:    e
+      )
     ensure
       @machine.close_async(@fd)
     end
@@ -42,13 +45,24 @@ module TP2
       request = Qeweney::Request.new(headers, self)
       @app.call(request)
       persist_connection?(headers)
-    rescue ProtocolError, SystemCallError => e
-      msg = "Error encountered while serving request: #{e.class} #{e.message}. Abandoning connection..."
-      @logger&.call(msg)
+    rescue ProtocolError => e
+      @logger&.error(
+        message: 'Protocol error, closing connection',
+        error: e
+      )
+      false
+    rescue SystemCallError => e
+      @logger&.error(
+        message: 'I/O error, closing connection',
+        error: e
+      )
       false
     rescue StandardError => e
-      msg = "Internal error while serving request: #{e.class} #{e.message} (#{e.backtrace.inspect}). Abandoning connection..."
-      @logger&.call(msg)
+      @logger&.error(
+        message: 'Internal error while serving request, abandoning connection',
+        error: e
+      )
+
       if request && !@done
         respond(request, 'Internal server error', ':status' => Qeweney::Status::INTERNAL_SERVER_ERROR)
       end
@@ -112,7 +126,7 @@ module TP2
       else
         @machine.send(@fd, formatted_headers, formatted_headers.bytesize, SEND_FLAGS)
       end
-      @logger&.call(request, headers)
+      @logger&.info(request: request, response_headers: headers)
       @done = true
       @response_headers = headers
     end
@@ -151,7 +165,7 @@ module TP2
       @machine.send(@fd, data, data.bytesize, SEND_FLAGS)
       return if @done || !done
 
-      @logger&.call(request, @response_headers)
+      @logger&.info(request: request, response_headers: @response_headers)
       @done = true
     end
 
@@ -163,7 +177,7 @@ module TP2
       @machine.send(@fd, EMPTY_CHUNK, EMPTY_CHUNK_LEN, SEND_FLAGS)
       return if @done
 
-      @logger&.call(request, @response_headers)
+      @logger&.info(request, request, response_headers: @response_headers)
       @done = true
     end
 
@@ -231,7 +245,7 @@ module TP2
         break if line.nil? || line.empty?
 
         m = line.match(RE_HEADER_LINE)
-        raise ProtocolError, 'Invalid header' if !m
+        raise ProtocolError, "Invalid header: #{line[0..2047].inspect}" if !m
 
         headers[m[1].downcase] = m[2]
       end
@@ -244,7 +258,7 @@ module TP2
       return nil if !line
 
       m = line.match(RE_REQUEST_LINE)
-      raise ProtocolError, 'Invalid request line' if !m
+      raise ProtocolError, "Invalid request line: #{line[0..2047].inspect}" if !m
 
       {
         ':method'   => m[1].downcase,

data/lib/tp2/logger.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module TP2
   class Logger
     def initialize(machine, fd = $stdout.fileno, **opts)
@@ -8,56 +10,83 @@ module TP2
       @opts = opts
     end
 
-    # @param o <Qeweney::Request> request
-    # @param h <Hash, nil> response headers
-    def call(o, h = nil)
-      log(format_log_line(o, h))
+    def info(o)
+      call(:INFO, o)
+    end
+
+    def warn(o)
+      call(:WARN, o)
+    end
+
+    def error(o)
+      call(:ERROR, o)
+    end
+
+    private
+
+    # @param level <Symbol> log level
+    # @param o <Hash> hash
+    def call(level, o)
+      emit(make_entry(level, o))
     rescue StandardError => e
+      puts 'Uncaught error while emitting log entry:'
       p e: e
       p e.backtrace
       exit
     end
 
-    private
-
-    def log(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)
+    def emit(entry)
+      @machine.write_async(@fd, "#{entry.to_json}\n")
     end
 
-    def format_log_line(o, h)
-      case o
-      when Exception
-        format_error_log_line(o)
-      when Qeweney::Request
-        format_request_log_line(o, h)
-      when String
-        o
+    def make_entry(level, o)
+      if o[:request]
+        make_request_entry(level, o)
+      elsif o[:error]
+        make_error_entry(level, o)
       else
-        o.to_s
+        make_hash_entry(level, o)
       end
     end
 
-    def format_error_log_line(err)
-      "Error: #{err.inspect}: #{err.backtrace.inspect}"
+    def make_error_entry(level, o)
+      err = o[:error]
+      {
+        level: level.to_s,
+        ts: (t = Time.now; t.to_i),
+        ts_s: t.iso8601
+      }
+      .merge(o)
+      .merge(
+        error: "#{err.class}: #{err.message}",
+        backtrace: err.backtrace
+      )
     end
 
-    def format_request_log_line(request, response_headers)
+    def make_request_entry(level, o)
+      request = o[:request]
       request_headers = request.headers
-      uri = full_uri(request_headers)
-      status = response_headers[':status'] || '200'
-      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']
-      )
+      response_headers = o[:response_headers]
+      {
+        level: level.to_s,
+        ts: (t = Time.now; t.to_i),
+        ts_s: t.iso8601,
+        message: o[:message] || 'HTTP request done',
+        client_ip: request.forwarded_for || '?',
+        http_method: request_headers[':method'].upcase,
+        user_agent: request_headers['user-agent'],
+        uri: full_uri(request_headers),
+        status: response_headers[':status'] || '200'
+      }
+    end
+
+    def make_hash_entry(level, hash)
+      {
+        level: level.to_s,
+        ts: (t = Time.now; t.to_i),
+        ts_s: t.iso8601
+      }
+      .merge(hash)
     end
 
     def full_uri(headers)

data/lib/tp2/server.rb

@@ -17,7 +17,7 @@ module TP2
 
     def self.tp2_app(_machine, opts)
       if opts[:app_location]
-        opts[:logger]&.call("Loading app at #{opts[:app_location]}")
+        opts[:logger]&.info(message: 'Loading web app', location: opts[:app_location])
         require opts[:app_location]
 
         opts.merge!(TP2.config)
@@ -65,7 +65,7 @@ module TP2
         @accept_fibers << @machine.spin { accept_incoming(fd) }
       end
       bind_string = bind_info.map { it.join(':') }.join(', ')
-      @opts[:logger]&.call("Listening on #{bind_string}")
+      @opts[:logger]&.info(message: "Listening on #{bind_string}")
 
       # map fibers
       @connection_fiber_map = {}
@@ -121,7 +121,7 @@ module TP2
     end
 
     def graceful_shutdown
-      @opts[:logger]&.call('Shutting down gracefully...')
+      @opts[:logger]&.info(message: 'Shutting down gracefully...')
 
       # stop listening
       close_all_server_fds

data/lib/tp2/version.rb

@@ -1,3 +1,3 @@
 module TP2
-  VERSION = '0.13.3'
+  VERSION = '0.14'
 end

data/lib/tp2.rb

@@ -19,7 +19,7 @@ module TP2
     "     o\n" +
     "   \\|/    TP2 - a modern web server for Ruby apps\n" +
     "   / \\       \n" +
-    "  /   \\      https://github.com/noteflakes/tp2\n" +
+    "  / x \\      https://github.com/noteflakes/tp2\n" +
     "⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺\n"
   )
 
@@ -37,7 +37,7 @@ module TP2
         machine = opts[:machine] || UM.new
         machine.puts(opts[:banner]) if opts[:banner]
 
-        opts[:logger]&.call("Running TP2 #{TP2::VERSION}, UringMachine #{UM::VERSION}, Ruby #{RUBY_VERSION}")
+        opts[:logger]&.info(message: "Running TP2 #{TP2::VERSION}, UringMachine #{UM::VERSION}, Ruby #{RUBY_VERSION}")
 
         server = Server.new(machine, opts, &app)
 

data/test/test_server.rb

@@ -247,17 +247,37 @@ class ServerTest < Minitest::Test
     assert_equal 'barbaz', body
   end
 
+  class TestLogger
+    attr_reader :entries
+
+    def initialize
+      @entries = []
+    end
+
+    def info(o)
+      @entries << o.merge(level: :INFO)
+    end
+
+    def error(o)
+      @entries << o.merge(level: :ERROR)
+    end
+  end
+
   def test_logging
     skip
     reqs = []
-    @opts[:logger] = ->(req, _h) { reqs << req }
-    @app = ->(req) { req.respond('Hello, world!', {}) }
+    @opts[:logger] = TestLogger.new
+    @app = ->(req) { reqs << 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)
 
+    entries = @opts[:logger].entries
+    assert_equal 1, entries.size
     assert_equal 1, reqs.size
+
+    assert_equal reqs.first, entries.first[:request]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tp2
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: '0.14'
 platform: ruby
 authors:
 - Sharon Rosner