Improved support for env.request.timeout and env.request.read_timeout.

Author: ioquatix

lib/async/http/faraday/adapter.rb

@@ -119,6 +119,7 @@ def initialize(...)
 					super
 
 					@timeout = @connection_options.delete(:timeout)
+					@read_timeout = @connection_options.delete(:read_timeout)
 
 					if clients = @connection_options.delete(:clients)
 						@clients = clients.call(**@connection_options, &@config_block)
@@ -127,6 +128,12 @@ def initialize(...)
 					end
 				end
 
+				# @attribute [Numeric | Nil] The maximum time to send a request and wait for a response.
+				attr :timeout
+				
+				# @attribute [Numeric | Nil] The maximum time to wait for an individual IO operation.
+				attr :read_timeout
+				
 				# Close all clients.
 				def close
 					# The order of operations here is to avoid a race condition between iterating over clients (#close may yield) and creating new clients.
@@ -181,7 +188,7 @@ def perform_request(env)
 
 						request = ::Protocol::HTTP::Request.new(endpoint.scheme, endpoint.authority, method, endpoint.path, nil, headers, body)
 
-						with_timeout do
+						with_timeout(env.request.timeout || @timeout) do
 							if env.stream_response?
 								response = env.stream_response do |&on_data|
 									response = client.call(request)
@@ -213,7 +220,7 @@ def perform_request(env)
 
 				def with_client(env)
 					Sync do
-						endpoint = Endpoint.new(env.url)
+						endpoint = Endpoint.new(env.url, timeout: @read_timeout)
 
 						if proxy = env.request.proxy
 							proxy_endpoint = Endpoint.new(proxy.uri)
@@ -229,9 +236,9 @@ def with_client(env)
 					end
 				end
 
-				def with_timeout(task: Async::Task.current)
-					if @timeout
-						task.with_timeout(@timeout, ::Faraday::TimeoutError) do
+				def with_timeout(timeout = @timeout, task: Async::Task.current)
+					if timeout
+						task.with_timeout(timeout, ::Faraday::TimeoutError) do
 							yield
 						end
 					else

releases.md

@@ -1,5 +1,16 @@
 # Releases
 
+## Unreleased
+
+### Improved support for `timeout` and `read_timeout`.
+
+Previously, only a per-connection `timeout` was supported, but now:
+
+1. `timeout` can be set per request too.
+2. `read_timeout` can be set per adapter and is assigned to `IO#timeout` if available.
+
+This improves compatibility with existing code that uses `timeout` and `read_timeout`.
+
 ## v0.20.0
 
   - Implement the new response streaming interface, which provides the initial response status code and headers before streaming the response body.

test/async/http/faraday/adapter.rb

@@ -30,6 +30,34 @@ def get_response(url = bound_url, path = "/index", adapter_options: {})
 		connection&.close
 	end
 
+	with "#timeout" do
+		it "can set timeout" do
+			connection = Faraday.new do |builder|
+				builder.adapter :async_http, timeout: 0.05
+			end
+			
+			adapter = connection.builder.app
+			
+			expect(adapter).to have_attributes(
+				timeout: be == 0.05
+			)
+		end
+	end
+	
+	with "#read_timeout" do
+		it "can set read timeout" do
+			connection = Faraday.new do |builder|
+				builder.adapter :async_http, read_timeout: 0.05
+			end
+			
+			adapter = connection.builder.app
+			
+			expect(adapter).to have_attributes(
+				read_timeout: be == 0.05
+			)
+		end
+	end
+	
 	with "a local http server" do
 		include Sus::Fixtures::Async::ReactorContext
 		include Sus::Fixtures::Async::HTTP::ServerContext