httpx 1.8.0 → 1.8.2

data/lib/httpx/plugins/tracing.rb

@@ -108,11 +108,13 @@ module HTTPX::Plugins
       def initialize(*)
         super
 
-        @init_time = ::Time.now.utc
+        @init_time = nil
       end
 
       def send_request_to_parser(request)
         if connecting?
+          @init_time ||= ::Time.now.utc
+
           # request span timeframe should include the time it took to connect.
           request.init_time ||= @init_time
         end
@@ -123,13 +125,24 @@ module HTTPX::Plugins
       def idling
         super
 
-        # time of initial request(s) is accounted from the moment
-        # the connection is back to :idle, and ready to connect again.
-        @init_time = ::Time.now.utc
+        @init_time = nil
+      end
+
+      def terminate
+        super
+
+        # ensure that connections which go back to the pool reset their init time.
+        @init_time = nil
       end
 
       private
 
+      def connect
+        @init_time ||= ::Time.now.utc
+
+        super
+      end
+
       def ping(request)
         # if a connection is probed for liveness, the request timeframe should include
         # it too.

data/lib/httpx/pool.rb

@@ -173,7 +173,7 @@ module HTTPX
       end
     end
 
-    # :nocov:
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{object_id} " \
         "@max_connections=#{@max_connections} " \
@@ -181,7 +181,7 @@ module HTTPX
         "@pool_timeout=#{@pool_timeout} " \
         "@connections=#{@connections.size}>"
     end
-    # :nocov:
+    # simplecov:enable
 
     private
 

data/lib/httpx/request/body.rb

@@ -4,14 +4,17 @@ module HTTPX
   # Implementation of the HTTP Request body as a delegator which iterates (responds to +each+) payload chunks.
   class Request::Body < SimpleDelegator
     class << self
-      def new(_, options, body: nil, **params)
-        if body.is_a?(self)
+      def new(h, options, body: nil, **params)
+        case body
+        when self
           # request derives its options from body
           body.options = options.merge(params)
-          return body
+          body
+        when nil
+          super(h, options, **params)
+        else
+          super
         end
-
-        super
       end
     end
 
@@ -114,12 +117,12 @@ module HTTPX
       @headers.add("transfer-encoding", "chunked")
     end
 
-    # :nocov:
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{object_id} " \
         "#{unbounded_body? ? "stream" : "@bytesize=#{bytesize}"}>"
     end
-    # :nocov:
+    # simplecov:enable
 
     class << self
       def initialize_body(params)

data/lib/httpx/request.rb

@@ -105,8 +105,8 @@ module HTTPX
 
       @state = :idle
       @connection = @response =
-        @drainer = @peer_address =
-          @informational_status = @on_response_arrived = nil
+        @drainer = @peer_address = @callbacks =
+                     @informational_status = @on_response_arrived = nil
       @ping = @started = false
       @persistent = @options.persistent
       @active_timeouts = []
@@ -115,13 +115,14 @@ module HTTPX
     # dupped initialization
     def initialize_dup(orig)
       super
-      @uri = orig.instance_variable_get(:@uri).dup
       @headers = orig.instance_variable_get(:@headers).dup
       @body = orig.instance_variable_get(:@body).dup
+      @active_timeouts = orig.instance_variable_get(:@active_timeouts).dup
     end
 
     def complete!(response = @response)
       emit(:complete, response)
+      reset_timers(true)
     end
 
     # whether request has been buffered with a ping
@@ -268,21 +269,19 @@ module HTTPX
 
     # consumes and returns the next available chunk of request body that can be sent
     def drain_body
-      return nil if @body.nil?
+      return if @body.nil?
 
       @drainer ||= @body.each
-      chunk = @drainer.next.dup
-
-      emit(:body_chunk, chunk)
-      chunk
+      @drainer.next.dup
     rescue StopIteration
       nil
     rescue StandardError => e
+      # in case an error occurs while emitting body chunks
       @drain_error = e
       nil
     end
 
-    # :nocov:
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{object_id} " \
         "#{@verb} " \
@@ -290,7 +289,7 @@ module HTTPX
         "@headers=#{@headers} " \
         "@body=#{@body}>"
     end
-    # :nocov:
+    # simplecov:enable
 
     # moves on to the +nextstate+ of the request state machine (when all preconditions are met)
     def transition(nextstate)
@@ -299,7 +298,10 @@ module HTTPX
         @body.rewind
         @ping = false
         @response = @drainer = nil
-        @active_timeouts.clear
+
+        # request may be sent to a different connection and will be
+        # reassigned a new set of timers.
+        reset_timers(false)
       when :headers
         return unless @state == :idle
 
@@ -326,7 +328,7 @@ module HTTPX
         return if @state == :expect
 
       end
-      log(level: 3) { "#{@state}] -> #{nextstate}" }
+      log(level: 3) { "#{@state} -> #{nextstate}" }
       @state = nextstate
       emit(@state, self)
       nil
@@ -363,6 +365,19 @@ module HTTPX
 
       @on_response_arrived.call
     end
+
+    private
+
+    def reset_timers(reset_total_request_timers)
+      timers = @active_timeouts
+
+      until (timer = timers.shift).nil?
+        next if !reset_total_request_timers && timer.label == :total_request_timeout
+
+        # cancel active timers.
+        timer.cancel
+      end
+    end
   end
 end
 

data/lib/httpx/resolver/cache/base.rb

@@ -106,14 +106,7 @@ module HTTPX
           name = entry["name"]
           next unless name != hostname
 
-          lookups[name] ||= []
-
-          case family
-          when Socket::AF_INET6
-            lookups[name] << entry
-          when Socket::AF_INET
-            lookups[name].unshift(entry)
-          end
+          _set(name, family, [entry], lookups, hostnames)
         end
       end
 

data/lib/httpx/resolver/https.rb

@@ -126,27 +126,27 @@ module HTTPX
     end
 
     def on_response(request, response)
-      response.raise_for_status
-    rescue StandardError => e
-      hostname = @requests.delete(request)
-      connection = reset_hostname(hostname)
-      emit_resolve_error(connection, connection.peer.host, e)
-      close_or_resolve
-    else
-      # @type var response: HTTPX::Response
-      if response.status.between?(300, 399) && response.headers.key?("location")
-        hostname = @requests[request]
-        connection = @queries[hostname]
-        location_uri = URI(response.headers["location"])
-        location_uri = response.uri.merge(location_uri) if location_uri.relative?
-
-        # we assume that the DNS server URI changed permanently and move on
-        @uri = location_uri
-        send_request(hostname, connection)
-        return
-      end
+      if (e = response.error)
+        hostname = @requests.delete(request)
+        connection = reset_hostname(hostname)
+        emit_resolve_error(connection, connection.peer.host, e)
+        close_or_resolve
+      else
+        # @type var response: HTTPX::Response
+        if response.status.between?(300, 399) && response.headers.key?("location")
+          hostname = @requests[request]
+          connection = @queries[hostname]
+          location_uri = URI(response.headers["location"])
+          location_uri = response.uri.merge(location_uri) if location_uri.relative?
 
-      parse(request, response)
+          # we assume that the DNS server URI changed permanently and move on
+          @uri = location_uri
+          send_request(hostname, connection)
+          return
+        end
+
+        parse(request, response)
+      end
     ensure
       @requests.delete(request)
     end

data/lib/httpx/resolver/native.rb

@@ -75,6 +75,13 @@ module HTTPX
 
     def call
       case @state
+      when :idle, :closed
+        return if @connections.empty?
+
+        transition(:idle) if @state == :closed
+        transition(:open)
+
+        consume if @state == :open
       when :open
         consume
       end
@@ -532,6 +539,10 @@ module HTTPX
         return unless @io.connected?
 
         resolve if @queries.empty? && !@connections.empty?
+
+        # #resolve may have closed the resolver already as part of error handling.
+        # @fiber-switch-guard
+        return unless @io
       when :closed
         return if @state == :closed
 

data/lib/httpx/resolver/resolver.rb

@@ -52,6 +52,10 @@ module HTTPX
 
     alias_method :terminate, :close
 
+    def initial_call
+      call
+    end
+
     def force_close(*args)
       while (connection = @connections.shift)
         connection.force_close(*args)

data/lib/httpx/resolver/system.rb

@@ -23,6 +23,9 @@ module HTTPX
     DONE = 1
     ERROR = 2
 
+    class AddrinfoTimeoutError < StandardError
+    end
+
     class << self
       def multi?
         false
@@ -227,7 +230,7 @@ module HTTPX
         begin
           addrs = if resolve_timeout
 
-            Timeout.timeout(resolve_timeout) do
+            Timeout.timeout(resolve_timeout, AddrinfoTimeoutError) do
               __addrinfo_resolve(hostname, scheme)
             end
           else
@@ -246,7 +249,7 @@ module HTTPX
             end
           end
         rescue StandardError => e
-          if e.is_a?(Timeout::Error)
+          if e.is_a?(AddrinfoTimeoutError)
             timeouts.shift
             retry unless timeouts.empty?
             e = ResolveTimeoutError.new(resolve_timeout, e.message)

data/lib/httpx/response/body.rb

@@ -161,13 +161,13 @@ module HTTPX
                end
     end
 
-    # :nocov:
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{object_id} " \
         "@state=#{@state} " \
         "@length=#{@length}>"
     end
-    # :nocov:
+    # simplecov:enable
 
     # rewinds the response payload buffer.
     def rewind

data/lib/httpx/response.rb

@@ -36,10 +36,10 @@ module HTTPX
     # * HTTPX::Response::Body#read
     # * HTTPX::Response::Body#copy_to
     # * HTTPX::Response::Body#close
-    attr_reader  :body
+    attr_reader :body
 
     # The HTTP protocol version used to fetch the response.
-    attr_reader  :version
+    attr_reader :version
 
     # returns the response body buffered in a string.
     def_delegator :@body, :to_s
@@ -68,7 +68,7 @@ module HTTPX
       @headers = @options.headers_class.new(headers)
       @body = @options.response_body_class.new(self, @options)
       @finished = complete?
-      @content_type = @content_length = nil
+      @callbacks = @content_type = @content_length = nil
     end
 
     # dupped initialization
@@ -141,7 +141,7 @@ module HTTPX
       bodyless? || (@request.verb == "CONNECT" && @status == 200)
     end
 
-    # :nocov:
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{object_id} " \
         "HTTP/#{version} " \
@@ -149,7 +149,7 @@ module HTTPX
         "@headers=#{@headers} " \
         "@body=#{@body.bytesize}>"
     end
-    # :nocov:
+    # simplecov:enable
 
     # returns an instance of HTTPX::HTTPError if the response has a 4xx or 5xx
     # status code, or nothing.
@@ -267,7 +267,6 @@ module HTTPX
   #   response = HTTPX.get("https://some-domain/path") #=> response is HTTPX::Response or HTTPX::ErrorResponse
   #   response.raise_for_status #=> raises if it wraps an error
   class ErrorResponse
-    include Loggable
     extend Forwardable
 
     # the corresponding HTTPX::Request instance.
@@ -290,7 +289,7 @@ module HTTPX
       @response = request.response if request.response.is_a?(Response)
       @error = error
       @options = request.options
-      log_exception(@error)
+      @request.log_exception(@error)
       finish!
     end
 

data/lib/httpx/selector.rb

@@ -41,6 +41,11 @@ module HTTPX
       @selectables.empty? && @timers.empty?
     end
 
+    # first time the registered selectables are added, there's probably work to do.
+    def initial_call
+      @selectables.each(&:initial_call)
+    end
+
     def next_tick
       catch(:jump_tick) do
         timeout = next_timeout
@@ -51,7 +56,7 @@ module HTTPX
 
         begin
           select(timeout) do |c|
-            c.log(level: 2) { "[#{c.state}] selected from selector##{object_id} #{" after #{timeout} secs" unless timeout.nil?}..." }
+            c.log(level: 2) { "[#{c.state}] selected from selector##{object_id}#{" after #{timeout} secs" unless timeout.nil?}..." }
 
             c.call
           end

data/lib/httpx/session.rb

@@ -237,7 +237,7 @@ module HTTPX
 
       return unless response && response.finished?
 
-      log(level: 2) { "response##{response.object_id} fetched" }
+      request.log(level: 2) { "response##{response.object_id} fetched" }
 
       response
     end
@@ -319,9 +319,14 @@ module HTTPX
 
       waiting = false
 
-      responses = requests.each_with_index.map do |request, idx|
+      requests.each do |request|
         send_request(request, selector)
+      end
+
+      # do work first
+      selector.initial_call
 
+      responses = requests.each_with_index.map do |request, idx|
         fetch_response(request, selector, request.options).tap do |response|
           if response.nil?
             pending += 1
@@ -332,6 +337,8 @@ module HTTPX
         end
       end
 
+      log(level: 2) { "waiting to receive #{pending} pending requests..." }
+
       until pending.zero? || selector.empty?
         # loop on selector until at least one response has been received.
         waiting = true
@@ -355,7 +362,8 @@ module HTTPX
         end
       end
 
-      raise Error, "something went wrong, responses not found and requests not resent" unless pending.zero?
+      raise Error, "something went wrong, #{pending} responses not found " \
+                   "and requests not resent" unless pending.zero?
 
       responses
     end

data/lib/httpx/session_extensions.rb

@@ -20,11 +20,11 @@ module HTTPX
     $VERBOSE = original_verbosity
   end
 
-  # :nocov:
+  # simplecov:disable
   if Session.default_options.debug_level > 2
     proxy_session = plugin(:internal_telemetry)
     remove_const(:Session)
     const_set(:Session, proxy_session.class)
   end
-  # :nocov:
+  # simplecov:enable
 end

data/lib/httpx/timers.rb

@@ -62,6 +62,9 @@ module HTTPX
     end
 
     class Timer
+      # simpler helper which allows classification
+      attr_accessor :label
+
       def initialize(interval, callback)
         @interval = interval
         @callback = callback

data/lib/httpx/transcoder/json.rb

@@ -51,7 +51,7 @@ module HTTPX::Transcoder
       method(:json_load)
     end
 
-    # rubocop:disable Style/SingleLineMethods
+    # rubocop:disable-next Style/SingleLineMethods
     if defined?(MultiJson)
       def json_load(*args); MultiJson.load(*args); end
       def json_dump(*args); MultiJson.dump(*args); end
@@ -66,6 +66,5 @@ module HTTPX::Transcoder
       def json_load(*args); ::JSON.parse(*args); end
       def json_dump(*args); ::JSON.generate(*args); end
     end
-    # rubocop:enable Style/SingleLineMethods
   end
 end

data/lib/httpx/transcoder/utils/deflater.rb

@@ -55,7 +55,7 @@ module HTTPX
 
       private
 
-      # rubocop:disable Naming/MemoizedInstanceVariableName
+      # rubocop:disable-next Naming/MemoizedInstanceVariableName
       def buffer_deflate!
         return @buffer if defined?(@buffer)
 
@@ -68,7 +68,6 @@ module HTTPX
 
         @buffer = buffer
       end
-      # rubocop:enable Naming/MemoizedInstanceVariableName
     end
   end
 end

data/lib/httpx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTPX
-  VERSION = "1.8.0"
+  VERSION = "1.8.2"
 end

data/sig/connection/http2.rbs

@@ -16,6 +16,7 @@ module HTTPX
     @max_requests: Integer
     @drains: Hash[Request, String]
     @pings: Array[String]
+    @streams_to_close_after_receive: Array[[HTTP2::Stream, Request, HTTPX::Error]]
     @buffer: Buffer
     @handshake_completed: bool
     @wait_for_handshake: bool
@@ -106,6 +107,8 @@ module HTTPX
 
     def on_pong: (string ping) -> void
 
+    def emit_stream_error: (HTTP2::Stream stream, Request request, StandardError error) -> void
+
     def teardown: (?Request? request) -> void
 
     class Error < ::HTTPX::Error

data/sig/connection.rbs

@@ -32,10 +32,11 @@ module HTTPX
     attr_accessor current_session: Session?
     attr_accessor family: Integer?
 
+    attr_reader read_buffer: Buffer
+    attr_reader write_buffer: Buffer
+
 
     @window_size: Integer
-    @read_buffer: Buffer
-    @write_buffer: Buffer
     @inflight: Integer
     @max_concurrent_requests: Integer?
     @keep_alive_timeout: interval?
@@ -92,6 +93,8 @@ module HTTPX
 
     def call: () -> void
 
+    def initial_call: () -> void
+
     def terminate: () -> void
 
     def close: () -> void
@@ -122,7 +125,7 @@ module HTTPX
 
     def on_error: (HTTPX::TimeoutError | Error | StandardError error, ?Request? request) -> void
 
-    def on_io_error: (IOError error) -> void
+    def on_io_error: (SocketError | IOError | TLSError error) -> void
 
     def on_connect_error: (Exception error) -> void
 
@@ -164,6 +167,8 @@ module HTTPX
 
     def no_more_requests_loop_check: () -> void
 
+    def no_more_requests?: () -> bool
+
     def handle_error: (StandardError error, ?Request? request) -> void
 
     def force_purge: () -> void

data/sig/errors.rbs

@@ -31,9 +31,9 @@ module HTTPX
 
   class RequestTimeoutError < TimeoutError
     attr_reader request: Request
-    attr_reader response: response?
+    attr_reader response: untyped
 
-    def initialize: (Request request, response? response, interval timeout) -> void
+    def initialize: (Request request, untyped response, interval timeout) -> void
   end
 
   class ReadTimeoutError < RequestTimeoutError

data/sig/io/ssl.rbs

@@ -9,6 +9,7 @@ module HTTPX
     @ctx: OpenSSL::SSL::SSLContext
     @verify_hostname: bool
     @sni_hostname: String
+    @session_new_cb: (^(OpenSSL::SSL::Session sess) -> void)?
 
     attr_writer ssl_session: OpenSSL::SSL::Session?
 
@@ -24,5 +25,9 @@ module HTTPX
 
     # :nocov:
     def try_ssl_connect: () -> void
+
+    private
+
+    def init_session_new_cb: () -> void
   end
 end

data/sig/loggable.rbs

@@ -12,10 +12,14 @@ module HTTPX
 
     COLORS: Hash[Symbol, Integer]
 
+    def self.log_identifiers: () -> String
+
     def log: (?level: Integer?, ?color: Symbol?, ?debug_level: Integer, ?debug: _IOLogger?) { () -> String } -> void
 
     def log_exception: (Exception error, ?level: Integer, ?color: Symbol, ?debug_level: Integer, ?debug: _IOLogger?) -> void
 
+    private
+
     def log_redact_headers: (_ToS text) -> String
 
     def log_redact_body: (_ToS text) -> String

data/sig/plugins/auth.rbs

@@ -1,12 +1,16 @@
 module HTTPX
   module Plugins
     module Auth
-      type auth_header_value_type = String | ^(Request request) -> string
+      type auth_header_value_type = String | ^(?Request request, ?bool should_regenerate) -> string
 
       interface _AuthOptions
         def auth_header_value: () -> auth_header_value_type?
 
         def auth_header_type: () -> String?
+
+        def auth_header_expires_at: () -> (^(Request request) -> _ToF?)?
+
+        def auth_header_expires_in: () -> Float?
       end
 
       module InstanceMethods
@@ -14,7 +18,7 @@ module HTTPX
         @auth_header_value_mtx: Thread::Mutex
         @skip_auth_header_value: bool
 
-        def authorization: (?string token, ?auth_header_type: string) ?{ (Request) -> string } -> instance
+        def authorization: (?string token, ?auth_header_type: string) ?{ (?Request, ?bool) -> string } -> instance
 
         def bearer_auth: (?string token) ?{ (Request) -> string } -> instance
 
@@ -24,7 +28,7 @@ module HTTPX
 
         private
 
-        def generate_auth_token: () -> String?
+        def generate_auth_token: (Request & RequestMethods request, bool should_regenerate) -> String?
 
         def dynamic_auth_token?: (auth_header_value_type auth_header_value) -> boolish
       end