Add connection tracing.

Author: samuel-williams-shopify

config/sus.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
+
+ENV["TRACES_BACKEND"] ||= "traces/backend/test"
+require "traces"
 
 require "covered/sus"
 include Covered::Sus

config/traces.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+def prepare
+	require "traces/provider/protocol/http1/connection"
+end

examples/http1/client.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 $LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)
 

fuzz/request/script.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 require "socket"
 require_relative "../../lib/protocol/http1"

gems.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 source "https://rubygems.org"
 

lib/protocol/http1/body/chunked.rb

@@ -116,7 +116,16 @@ def read
 
 				# @returns [String] a human-readable representation of the body.
 				def inspect
-					"\#<#{self.class} #{@length} bytes read in #{@count} chunks>"
+					"\#<#{self.class} #{@length} bytes read in #{@count} chunks, #{@finished ? 'finished' : 'reading'}>"
+				end
+				
+				# @returns [Hash] JSON representation for tracing and debugging.
+				def as_json(...)
+					super.merge(
+						count: @count,
+						finished: @finished,
+						state: @connection ? "open" : "closed"
+					)
 				end
 
 				private

lib/protocol/http1/body/fixed.rb

@@ -74,7 +74,15 @@ def read
 
 				# @returns [String] a human-readable representation of the body.
 				def inspect
-					"\#<#{self.class} length=#{@length} remaining=#{@remaining} state=#{@connection ? 'open' : 'closed'}>"
+					"#<#{self.class} #{@length} bytes, #{@remaining} remaining, #{empty? ? 'finished' : 'reading'}>"
+				end
+				
+				# @returns [Hash] JSON representation for tracing and debugging.
+				def as_json(...)
+					super.merge(
+						remaining: @remaining,
+						state: @connection ? "open" : "closed"
+					)
 				end
 			end
 		end

lib/protocol/http1/body/remainder.rb

@@ -60,7 +60,15 @@ def read
 
 				# @returns [String] a human-readable representation of the body.
 				def inspect
-					"\#<#{self.class} state=#{@connection ? 'open' : 'closed'}>"
+					"#<#{self.class} #{@block_size} byte blocks, #{empty? ? 'finished' : 'reading'}>"
+				end
+				
+				# @returns [Hash] JSON representation for tracing and debugging.
+				def as_json(...)
+					super.merge(
+						block_size: @block_size,
+						state: @connection ? "open" : "closed"
+					)
 				end
 			end
 		end

lib/protocol/http1/connection.rb

@@ -274,7 +274,9 @@ def write_request(authority, method, target, version, headers)
 			# @parameter status [Integer] the HTTP status code.
 			# @parameter headers [Hash] the HTTP headers.
 			# @parameter reason [String] the reason phrase, defaults to the standard reason phrase for the status code.
-			def write_response(version, status, headers, reason = Reason::DESCRIPTIONS[status])
+			def write_response(version, status, headers, reason = nil)
+				reason ||= Reason::DESCRIPTIONS[status]
+				
 				unless @state == :open or @state == :half_closed_remote
 					raise ProtocolError, "Cannot write response in state: #{@state}!"
 				end
@@ -292,7 +294,9 @@ def write_response(version, status, headers, reason = Reason::DESCRIPTIONS[statu
 			# @parameter headers [Hash] the HTTP headers.
 			# @parameter reason [String] the reason phrase, defaults to the standard reason phrase for the status code.
 			# @raises [ProtocolError] if the connection is not in the open or half-closed remote state.
-			def write_interim_response(version, status, headers, reason = Reason::DESCRIPTIONS[status])
+			def write_interim_response(version, status, headers, reason = nil)
+				reason ||= Reason::DESCRIPTIONS[status]
+				
 				unless @state == :open or @state == :half_closed_remote
 					raise ProtocolError, "Cannot write interim response in state: #{@state}!"
 				end

lib/traces/provider/protocol/http1.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "http1/connection"