async-http 0.94.2 → 0.94.3

data/lib/async/http/proxy.rb

@@ -13,7 +13,10 @@ module Async
 		# Wraps a client, address and headers required to initiate a connectio to a remote host using the CONNECT verb.
 		# Behaves like a TCP endpoint for the purposes of connecting to a remote host.
 		class Proxy
+			# Raised when a CONNECT tunnel through a proxy cannot be established.
 			class ConnectFailure < StandardError
+				# Initialize the failure with the unsuccessful response.
+				# @parameter response [Protocol::HTTP::Response] The failed response from the proxy.
 				def initialize(response)
 					super "Failed to connect: #{response.status}"
 					@response = response
@@ -22,7 +25,12 @@ module Async
 				attr :response
 			end
 			
+			# Extends {Async::HTTP::Client} with proxy capabilities.
 			module Client
+				# Create a proxy instance for the given endpoint.
+				# @parameter endpoint [Endpoint] The target endpoint to tunnel to.
+				# @parameter headers [Hash | Nil] Optional headers to send with the CONNECT request.
+				# @returns [Proxy] A proxy instance for establishing tunnels.
 				def proxy(endpoint, headers = nil)
 					Proxy.new(self, endpoint.authority(false), headers)
 				end
@@ -34,6 +42,10 @@ module Async
 					return self.class.new(proxy.wrap_endpoint(endpoint))
 				end
 				
+				# Create an endpoint that connects via this proxy.
+				# @parameter endpoint [Endpoint] The target endpoint.
+				# @parameter headers [Hash | Nil] Optional headers for the CONNECT request.
+				# @returns [Endpoint] An endpoint that tunnels through the proxy.
 				def proxied_endpoint(endpoint, headers = nil)
 					proxy = self.proxy(endpoint, headers)
 					

data/lib/async/http/server.rb

@@ -12,11 +12,20 @@ require_relative "protocol"
 
 module Async
 	module HTTP
+		# An HTTP server that accepts connections on a specific endpoint and dispatches requests to an application handler.
 		class Server < ::Protocol::HTTP::Middleware
+			# Create a server using a block as the application handler.
+			# @parameter arguments [Array] Arguments to pass to {initialize}.
+			# @parameter options [Hash] Options to pass to {initialize}.
 			def self.for(*arguments, **options, &block)
 				self.new(block, *arguments, **options)
 			end
 			
+			# Initialize the server with an application handler and endpoint.
+			# @parameter app [Protocol::HTTP::Middleware] The Rack-compatible application to serve.
+			# @parameter endpoint [Endpoint] The endpoint to bind to.
+			# @parameter protocol [Protocol] The protocol to use for incoming connections.
+			# @parameter scheme [String] The default scheme to set on requests.
 			def initialize(app, endpoint, protocol: endpoint.protocol, scheme: endpoint.scheme)
 				super(app)
 				
@@ -25,6 +34,7 @@ module Async
 				@scheme = scheme
 			end
 			
+			# @returns [Hash] A JSON-compatible representation of this server.
 			def as_json(...)
 				{
 					endpoint: @endpoint.to_s,
@@ -33,6 +43,7 @@ module Async
 				}
 			end
 			
+			# @returns [String] A JSON string representation of this server.
 			def to_json(...)
 				as_json.to_json(...)
 			end
@@ -41,6 +52,9 @@ module Async
 			attr :protocol
 			attr :scheme
 			
+			# Accept an incoming connection and process requests.
+			# @parameter peer [IO] The connected peer.
+			# @parameter address [Addrinfo] The remote address of the peer.
 			def accept(peer, address, task: Task.current)
 				connection = @protocol.server(peer)
 				

data/lib/async/http/statistics.rb

@@ -9,15 +9,23 @@ require "async/clock"
 
 module Async
 	module HTTP
+		# Tracks response timing statistics including time to first byte and total duration.
 		class Statistics
+			# Start tracking statistics from the current time.
+			# @returns [Statistics] A new statistics instance.
 			def self.start
 				self.new(Clock.now)
 			end
 			
+			# Initialize the statistics tracker.
+			# @parameter start_time [Float] The start time for measuring durations.
 			def initialize(start_time)
 				@start_time = start_time
 			end
 			
+			# Wrap a response body with a statistics-collecting wrapper.
+			# @parameter response [Protocol::HTTP::Response] The response to wrap.
+			# @returns [Protocol::HTTP::Response] The wrapped response.
 			def wrap(response, &block)
 				if response and response.body
 					response.body = Body::Statistics.new(@start_time, response.body, block)
@@ -30,6 +38,10 @@ module Async
 		module Body
 			# Invokes a callback once the body has finished reading.
 			class Statistics < ::Protocol::HTTP::Body::Wrapper
+				# Initialize the statistics body wrapper.
+				# @parameter start_time [Float] The start time for measuring durations.
+				# @parameter body [Protocol::HTTP::Body::Readable] The body to wrap.
+				# @parameter callback [Proc] A callback to invoke when the body is closed.
 				def initialize(start_time, body, callback)
 					super(body)
 					
@@ -48,24 +60,29 @@ module Async
 				
 				attr :sent
 				
+				# @returns [Float | Nil] The total duration from start to close, in seconds.
 				def total_duration
 					if @end_time
 						@end_time - @start_time
 					end
 				end
 				
+				# @returns [Float | Nil] The duration from start until the first chunk was read, in seconds.
 				def first_chunk_duration
 					if @first_chunk_time
 						@first_chunk_time - @start_time
 					end
 				end
 				
+				# Close the body and record the end time.
 				def close(error = nil)
 					complete_statistics(error)
 					
 					super
 				end
 				
+				# Read the next chunk from the body, tracking timing and bytes sent.
+				# @returns [String | Nil] The next chunk of data.
 				def read
 					chunk = super
 					
@@ -78,6 +95,7 @@ module Async
 					return chunk
 				end
 				
+				# @returns [String] A human-readable summary of the statistics.
 				def to_s
 					parts = ["sent #{@sent} bytes"]
 					
@@ -92,6 +110,7 @@ module Async
 					return parts.join("; ")
 				end
 				
+				# @returns [String] A detailed representation including the wrapped body.
 				def inspect
 					"#{super} | \#<#{self.class} #{self.to_s}>"
 				end

data/lib/async/http/version.rb

@@ -3,8 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2017-2026, by Samuel Williams.
 
+# @namespace
 module Async
+	# @namespace
 	module HTTP
-		VERSION = "0.94.2"
+		VERSION = "0.94.3"
 	end
 end

data/lib/async/http.rb

@@ -4,10 +4,7 @@
 # Copyright, 2017-2024, by Samuel Williams.
 
 require_relative "http/version"
-
 require_relative "http/client"
 require_relative "http/server"
-
 require_relative "http/internet"
-
 require_relative "http/endpoint"

data/readme.md

@@ -16,6 +16,10 @@ Please see the [project documentation](https://socketry.github.io/async-http/) f
 
 Please see the [project releases](https://socketry.github.io/async-http/releases/index) for all releases.
 
+### v0.94.3
+
+  - Fix response body leak in HTTP/2 server when stream is reset before `send_response` completes (e.g. client-side gRPC cancellation). The response body's `close` was never called, leaking any resources tied to body lifecycle (such as `rack.response_finished` callbacks and utilization metrics).
+
 ### v0.94.1
 
   - Fix `defer_stop` usage in `HTTP1::Server`, improving server graceful shutdown behavior.
@@ -52,10 +56,6 @@ Please see the [project releases](https://socketry.github.io/async-http/releases
 
   - Add support for HTTP/2 `NO_RFC7540_PRIORITIES`. See <https://www.rfc-editor.org/rfc/rfc9218.html> for more details.
 
-### v0.84.0
-
-  - Minor consistency fixes to `Async::HTTP::Internet` singleton methods.
-
 ## See Also
 
   - [benchmark-http](https://github.com/socketry/benchmark-http) — A benchmarking tool to report on web server concurrency.
@@ -74,6 +74,22 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
 ### Developer Certificate of Origin
 
 In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.94.3
+
+  - Fix response body leak in HTTP/2 server when stream is reset before `send_response` completes (e.g. client-side gRPC cancellation). The response body's `close` was never called, leaking any resources tied to body lifecycle (such as `rack.response_finished` callbacks and utilization metrics).
+
 ## v0.94.1
 
   - Fix `defer_stop` usage in `HTTP1::Server`, improving server graceful shutdown behavior.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-http
 version: !ruby/object:Gem::Version
-  version: 0.94.2
+  version: 0.94.3
 platform: ruby
 authors:
 - Samuel Williams
@@ -277,14 +277,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A HTTP client and server library.
 test_files: []