Merge pull request #197 from 907th/http_timeouts_part2

Rework of timeout errors (part 2): add support for new write_timeout option to all adapters + fix integration tests duplication

Author: rogerleite

lib/httpi/adapter/curb.rb

@@ -72,7 +72,8 @@ def setup_client
       def basic_setup
         @client.url = @request.url.to_s
         @client.proxy_url = @request.proxy.to_s if @request.proxy
-        @client.timeout_ms = @request.read_timeout * 1000 if @request.read_timeout
+        read_or_write_timeout = @request.read_timeout || @request.write_timeout
+        @client.timeout_ms = read_or_write_timeout * 1000 if read_or_write_timeout
         @client.connect_timeout_ms = @request.open_timeout * 1000 if @request.open_timeout
         @client.headers = @request.headers.to_hash
         @client.verbose = false

lib/httpi/adapter/em_http.rb

@@ -71,7 +71,8 @@ def _request
       def connection_options
         options = {}
 
-        options[:inactivity_timeout] = @request.read_timeout if @request.read_timeout
+        read_or_write_timeout = @request.read_timeout || @request.write_timeout
+        options[:inactivity_timeout] = read_or_write_timeout if read_or_write_timeout
         options[:connect_timeout] = @request.open_timeout if @request.open_timeout
 
         options[:proxy] = proxy_options if @request.proxy

lib/httpi/adapter/excon.rb

@@ -58,6 +58,7 @@ def client_opts
         opts[:user], opts[:password] = *@request.auth.credentials if @request.auth.basic?
         opts[:connect_timeout] = @request.open_timeout if @request.open_timeout
         opts[:read_timeout]    = @request.read_timeout if @request.read_timeout
+        opts[:write_timeout]   = @request.write_timeout if @request.write_timeout
         opts[:response_block]  = @request.on_body if @request.on_body
         opts[:proxy]           = @request.proxy if @request.proxy
 

lib/httpi/adapter/http.rb

@@ -76,6 +76,7 @@ def create_client
         timeouts = {}
         timeouts[:connect] = @request.open_timeout if @request.open_timeout
         timeouts[:read] = @request.read_timeout if @request.read_timeout
+        timeouts[:write] = @request.write_timeout if @request.write_timeout
         client = client.timeout(timeouts) if timeouts.any?
 
         client.headers(@request.headers)

lib/httpi/adapter/httpclient.rb

@@ -45,6 +45,7 @@ def basic_setup
         @client.proxy = @request.proxy if @request.proxy
         @client.connect_timeout = @request.open_timeout if @request.open_timeout
         @client.receive_timeout = @request.read_timeout if @request.read_timeout
+        @client.send_timeout = @request.write_timeout if @request.write_timeout
       end
 
       def setup_auth

lib/httpi/adapter/net_http.rb

@@ -155,6 +155,13 @@ def setup_client
         @client.use_ssl = @request.ssl?
         @client.open_timeout = @request.open_timeout if @request.open_timeout
         @client.read_timeout = @request.read_timeout if @request.read_timeout
+        if @request.write_timeout
+          if @client.respond_to?(:write_timeout=) # Expected to appear in Ruby 2.6
+            @client.write_timeout = @request.write_timeout
+          else
+            raise NotSupportedError, "Net::HTTP supports write_timeout starting from Ruby 2.6"
+          end
+        end
       end
 
       def setup_ssl_auth

lib/httpi/adapter/net_http_persistent.rb

@@ -32,6 +32,7 @@ def setup_client
 
         @client.open_timeout = @request.open_timeout if @request.open_timeout
         @client.read_timeout = @request.read_timeout if @request.read_timeout
+        raise NotSupportedError, "Net::HTTP::Persistent does not support write_timeout" if @request.write_timeout
       end
 
       def thread_key

lib/httpi/request.rb

@@ -11,7 +11,7 @@ module HTTPI
   class Request
 
     # Available attribute writers.
-    ATTRIBUTES = [:url, :proxy, :headers, :body, :open_timeout, :read_timeout, :follow_redirect, :redirect_limit, :query]
+    ATTRIBUTES = [:url, :proxy, :headers, :body, :open_timeout, :read_timeout, :write_timeout, :follow_redirect, :redirect_limit, :query]
 
     # Accepts a Hash of +args+ to mass assign attributes and authentication credentials.
     def initialize(args = {})
@@ -90,7 +90,7 @@ def set_cookies(object_or_array)
       headers["Cookie"] = cookies if cookies
     end
 
-    attr_accessor :open_timeout, :read_timeout
+    attr_accessor :open_timeout, :read_timeout, :write_timeout
     attr_reader :body
 
     # Sets a body request given a String or a Hash.

spec/httpi/adapter/curb_spec.rb

@@ -152,12 +152,19 @@
           adapter.request(:get)
         end
 
-        it "is set if specified" do
+        it "is set if specified read_timeout" do
           request.read_timeout = 30
           curb.expects(:timeout_ms=).with(30_000)
 
           adapter.request(:get)
         end
+
+        it "is set if specified write_timeout" do
+          request.write_timeout = 30
+          curb.expects(:timeout_ms=).with(30_000)
+
+          adapter.request(:get)
+        end
       end
 
       describe "connect_timeout_ms" do

spec/httpi/adapter/em_http_spec.rb

@@ -118,7 +118,7 @@
       end
 
       describe "receive_timeout" do
-        it "is passed as a connection option" do
+        it "is passed as a connection option (when read_timeout specified)" do
           request.read_timeout = 60
 
           url = "http://example.com:80"
@@ -128,6 +128,17 @@
 
           adapter
         end
+
+        it "is passed as a connection option (when write_timeout specified)" do
+          request.write_timeout = 60
+
+          url = "http://example.com:80"
+          connection_options = { inactivity_timeout: 60 }
+
+          EventMachine::HttpRequest.expects(:new).with(url, connection_options)
+
+          adapter
+        end
       end
 
       describe "set_auth" do