excon 0.103.0 → 0.105.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c1759dde8542ab4e6147d2c51ce7e674d4fdd46b48f0aed3a77ed823917d336
-  data.tar.gz: 5c4c66737d283ed9d4d186cd46809c5c2fd0fc346c06564140b39a131fdfb44f
+  metadata.gz: bf1521a5cb2831330da53ba05456633a8219047e6a0d0f7892b32c8d49a074c0
+  data.tar.gz: 242837bbe9feba5985fc5fbe969a8d22cc9ab36bc4bd80479377d1a9596e2d05
 SHA512:
-  metadata.gz: 803189e9d2dc991e48114c4f5ec7071ff04e4ea3f88d6872b3bcfe066cda38055c98b44cad83e5b9edabb677684b75c1a673c232303826a87857ba214c75cf6b
-  data.tar.gz: cab31317bdbc12398a33ce0b4a385584ca5c3e1cd2be2b201fb5e7ac0161b330e235d0ecd489fa304356367ab98fc868cc610d3afaf12bd3b4636ea182cda92e
+  metadata.gz: ba2f9e23944c16efbbc8edb7515af65629b1d763b7e20bea60180d4c8e995ec3829b3152c48308f760c2ac79e39851de069046b614bc6c725f3e2210f4d9d77f
+  data.tar.gz: e399f1c89cf8fa3eb1f03f2ff8430272d0db3ebc95c9d9cd23362cd46c0b6d7a4515ffd181aaf8d51fa3b0218915bc762e42090c8c5048d7f9750d23cf21039b

data/README.md

@@ -179,6 +179,10 @@ connection.request(:read_timeout => 360)
 # set longer write_timeout (default is 60 seconds)
 connection.request(:write_timeout => 360)
 
+# set a request timeout in seconds (default is no timeout).
+# the timeout may be an integer or a float to support sub-second granularity (e.g., 1, 60, 0.005 and 3.5).
+connection.request(:timeout => 0.1) # timeout if the entire request takes longer than 100 milliseconds
+
 # Enable the socket option TCP_NODELAY on the underlying socket.
 #
 # This can improve response time when sending frequent short
@@ -192,10 +196,20 @@ connection = Excon.new('http://geemus.com/', :connect_timeout => 360)
 # opt-out of nonblocking operations for performance and/or as a workaround
 connection = Excon.new('http://geemus.com/', :nonblock => false)
 
+# DEPRECATED in favour of `resolv_resolver` (see below)
 # set up desired dns_timeouts for resolving addresses (default is set by Resolv)
 # it accepts an integer or an array of integers for retrying with different timeouts
 # see Resolv::DNS#timeouts for more details (https://ruby-doc.org/3.2.2/stdlibs/resolv/Resolv/DNS.html#method-i-timeouts-3D)
 connection = Excon.new('http://geemus.com/', :dns_timeouts => 3)
+
+# set a custom resolver for Resolv
+# you can use custom nameservers and timeouts
+# `timeouts` accepts an integer or an array of integers for retrying with different timeouts
+# see Resolv::DNS#timeouts for more details (https://ruby-doc.org/3.2.2/stdlibs/resolv/Resolv/DNS.html#method-i-timeouts-3D)
+dns_resolver = Resolv::DNS.new(nameserver: ['127.0.0.1'])
+dns_resolver.timeouts = 3
+resolver = Resolv.new([Resolv::Hosts.new, dns_resolver])
+connection = Excon.new('http://geemus.com', :resolv_resolver => resolver)
 ```
 
 ## Chunked Requests

data/lib/excon/connection.rb

@@ -230,6 +230,13 @@ module Excon
     def request(params={}, &block)
       # @data has defaults, merge in new params to override
       datum = @data.merge(params)
+
+      # Set the deadline for the current request in order to determine when we have run out of time.
+      # Only set when a request timeout has been defined.
+      if datum[:timeout]
+        datum[:deadline] = Process.clock_gettime(Process::CLOCK_MONOTONIC) + datum[:timeout]
+      end
+
       datum[:headers] = @data[:headers].merge(datum[:headers] || {})
 
       validate_params(:request, params, datum[:middlewares])

data/lib/excon/constants.rb

@@ -59,8 +59,10 @@ module Excon
     :query,
     :read_timeout,
     :request_block,
+    :resolv_resolver,
     :response_block,
     :stubs,
+    :timeout,
     :user,
     :versions,
     :write_timeout
@@ -162,6 +164,7 @@ module Excon
     :omit_default_port   => false,
     :persistent          => false,
     :read_timeout        => 60,
+    :resolv_resolver     => nil,
     :retry_errors        => DEFAULT_RETRY_ERRORS,
     :retry_limit         => DEFAULT_RETRY_LIMIT,
     :ssl_verify_peer     => true,
@@ -169,6 +172,7 @@ module Excon
     :stubs               => :global,
     :tcp_nodelay         => false,
     :thread_safe_sockets => true,
+    :timeout             => nil,
     :uri_parser          => URI,
     :versions            => VERSIONS,
     :write_timeout       => 60

data/lib/excon/socket.rb

@@ -25,6 +25,13 @@ module Excon
     else # Ruby <= 2.0
       [Errno::EAGAIN, Errno::EWOULDBLOCK, IO::WaitWritable]
     end
+    # Maps a socket operation to a timeout property.
+    OPERATION_TO_TIMEOUT = {
+      :connect_read => :connect_timeout,
+      :connect_write => :connect_timeout,
+      :read => :read_timeout,
+      :write => :write_timeout
+    }.freeze
 
     def params
       Excon.display_warning('Excon::Socket#params is deprecated use Excon::Socket#data instead.')
@@ -121,9 +128,16 @@ module Excon
         family = @data[:proxy][:family]
       end
 
-      dns_resolver = Resolv::DNS.new
-      dns_resolver.timeouts = @data[:dns_timeouts]
-      resolver = Resolv.new([Resolv::Hosts.new, dns_resolver])
+      resolver = @data[:resolv_resolver] || Resolv.new
+
+      # Deprecated
+      if @data[:dns_timeouts]
+        Excon.display_warning('dns_timeouts is deprecated, use resolv_resolver instead.')
+        dns_resolver = Resolv::DNS.new
+        dns_resolver.timeouts = @data[:dns_timeouts]
+        resolver = Resolv.new([Resolv::Hosts.new, dns_resolver])  
+      end
+
       resolver.each_address(hostname) do |ip|
         # already succeeded on previous addrinfo
         if @socket
@@ -297,17 +311,33 @@ module Excon
     end
 
     def select_with_timeout(socket, type)
+      timeout_kind = type
+      timeout = @data[OPERATION_TO_TIMEOUT[type]]
+
+      # Check whether the request has a timeout configured.
+      if @data.include?(:deadline)
+        request_timeout = request_time_remaining
+
+        # If the time remaining until the request times out is less than the timeout for the type of select,
+        # use the time remaining as the timeout instead.
+        if request_timeout < timeout
+          timeout_kind = :request
+          timeout = request_timeout
+        end
+      end
+
       select = case type
       when :connect_read
-        IO.select([socket], nil, nil, @data[:connect_timeout])
+        IO.select([socket], nil, nil, timeout)
       when :connect_write
-        IO.select(nil, [socket], nil, @data[:connect_timeout])
+        IO.select(nil, [socket], nil, timeout)
       when :read
-        IO.select([socket], nil, nil, @data[:read_timeout])
+        IO.select([socket], nil, nil, timeout)
       when :write
-        IO.select(nil, [socket], nil, @data[:write_timeout])
+        IO.select(nil, [socket], nil, timeout)
       end
-      select || raise(Excon::Errors::Timeout.new("#{type} timeout reached"))
+
+      select || raise(Excon::Errors::Timeout.new("#{timeout_kind} timeout reached"))
     end
 
     def unpacked_sockaddr
@@ -317,5 +347,16 @@ module Excon
         raise
       end
     end
+
+    # Returns the remaining time in seconds until we reach the deadline for the request timeout.
+    # Raises an exception if we have exceeded the request timeout's deadline.
+    def request_time_remaining
+      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      deadline = @data[:deadline]
+      
+      raise(Excon::Errors::Timeout.new('request timeout reached')) if now >= deadline
+
+      deadline - now
+    end
   end
 end

data/lib/excon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Excon
-  VERSION = '0.103.0'
+  VERSION = '0.105.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.103.0
+  version: 0.105.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec