httpx 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e80b08847467e6ba67e57afef2787c2c617167624ae510e255dd23998b25210e
-  data.tar.gz: b11ea8d914872689bc1710680c9962b0362c3bf28b62f6e7209f7e2a54a34674
+  metadata.gz: 99138c8286fb426f6bd70a62357cbaf1b54f3ceb030f1ff3c78c9e2bffd8e75a
+  data.tar.gz: 59a28cbadff4830ed047eba007b5f71455b5a8d6aa3e111cfb5897b82b1350fa
 SHA512:
-  metadata.gz: 3fc7994fd3b460e267bce129fdcf6536d844fd5dd9695833c4075028cf128fe954c599ee96eacdf722756c6615c703c96f2df44628e34cd1964fee9f3f92e5e9
-  data.tar.gz: 04c4ad1bcf05a3ee96de206a05c294f29f90fa0698fb094b982027cb09db8969a99bd7a324af23dcec18d227fe9708947211fc31ae9e4cddfb4b4360df94aa99
+  metadata.gz: 78b08826c993b9a2c5d1164a2bf6c7bb4123cb9599a1ddc44bd38b827c91da73abf4fee18ae39d67f9370834b3a8d04eb32999cf2c68f9fe654a0605e6d7ca5b
+  data.tar.gz: 6b22a1e473abc7967314785f6fb517bf5d663d87951a7a2cba5855913a348b95dc50e2fddaa801fbcf25aef96b4d7d9b4e4d0dda8388696c0b628ba0c5dd7c1b

data/doc/release_notes/1_2_6.md

@@ -0,0 +1,13 @@
+# 1.2.6
+
+## Improvements
+
+* `native` resolver: when timing out on DNS query for an alias, retry the DNS query for the alias (instead of the original hostname).
+
+## Bugfixes
+
+* `faraday` adapter: set `env` options on the request object, so they are available in the request object when yielded.
+* `follow_redirects` plugin: remove body-related headers (`content-length`, `content-type`) on POST-to-GET redirects.
+* `follow_redirects` plugin: maintain verb (and body) of original request when the response status code is 307.
+* `native` resolver: when timing out on TCP-based name resolution, downgrade to UDP before retrying.
+* `rate_limiter` plugin: do not try fetching the retry-after of error responses.

data/doc/release_notes/1_3_0.md

@@ -0,0 +1,18 @@
+# 1.3.0
+
+## Dependencies
+
+`http-2` v1.0.0 is replacing `http-2-next` as the HTTP/2 parser.
+
+`http-2-next` was forked from `http-2` 5 years ago; its improvements have been merged back to `http-2` recently though, so `http-2-next` willl therefore no longer be maintained.
+
+## Improvements
+
+Request-specific options (`:params`, `:form`, `:json` and `:xml`) are now separately kept by the request, which allows them to share `HTTPX::Options`, and reduce the number of copying / allocations.
+
+This means that `HTTPX::Options` will throw an error if you initialize an object which such keys; this should not happen, as this class is considered internal and you should not be using it directly.
+
+## Fixes
+
+* support for the `datadog` gem v2.0.0 in its adapter has been unblocked, now that the gem has been released.
+* loading the `:cookies` plugin was making the `Session#build_request` private.

data/lib/httpx/adapters/datadog.rb

@@ -142,7 +142,7 @@ module Datadog::Tracing
             @configuration ||= Datadog.configuration.tracing[:httpx, @request.uri.host]
           end
 
-          if Gem::Version.new(DATADOG_VERSION::STRING) >= Gem::Version.new("2.0.0.beta1")
+          if Gem::Version.new(DATADOG_VERSION::STRING) >= Gem::Version.new("2.0.0")
             def propagate_trace_http(digest, headers)
               Datadog::Tracing::Contrib::HTTP.inject(digest, headers)
             end

data/lib/httpx/adapters/faraday.rb

@@ -61,6 +61,7 @@ module Faraday
           request_options = {
             headers: env.request_headers,
             body: env.body,
+            **options_from_env(env),
           }
           [meth.to_s.upcase, env.url, request_options]
         end

data/lib/httpx/adapters/webmock.rb

@@ -47,7 +47,7 @@ module WebMock
         end
 
         def build_error_response(request, exception)
-          HTTPX::ErrorResponse.new(request, exception, request.options)
+          HTTPX::ErrorResponse.new(request, exception)
         end
       end
 

data/lib/httpx/connection/http1.rb

@@ -15,7 +15,7 @@ module HTTPX
     attr_accessor :max_concurrent_requests
 
     def initialize(buffer, options)
-      @options = Options.new(options)
+      @options = options
       @max_concurrent_requests = @options.max_concurrent_requests || MAX_REQUESTS
       @max_requests = @options.max_requests
       @parser = Parser::HTTP1.new(self)
@@ -146,7 +146,7 @@ module HTTPX
 
       response << chunk
     rescue StandardError => e
-      error_response = ErrorResponse.new(request, e, request.options)
+      error_response = ErrorResponse.new(request, e)
       request.response = error_response
       dispatch
     end
@@ -387,6 +387,7 @@ module HTTPX
     UPCASED = {
       "www-authenticate" => "WWW-Authenticate",
       "http2-settings" => "HTTP2-Settings",
+      "content-md5" => "Content-MD5",
     }.freeze
 
     def capitalized(field)

data/lib/httpx/connection/http2.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require "securerandom"
-require "http/2/next"
+require "http/2"
 
 module HTTPX
   class Connection::HTTP2
     include Callbacks
     include Loggable
 
-    MAX_CONCURRENT_REQUESTS = HTTP2Next::DEFAULT_MAX_CONCURRENT_STREAMS
+    MAX_CONCURRENT_REQUESTS = ::HTTP2::DEFAULT_MAX_CONCURRENT_STREAMS
 
     class Error < Error
       def initialize(id, code)
@@ -25,7 +25,7 @@ module HTTPX
     attr_reader :streams, :pending
 
     def initialize(buffer, options)
-      @options = Options.new(options)
+      @options = options
       @settings = @options.http2_settings
       @pending = []
       @streams = {}
@@ -111,7 +111,7 @@ module HTTPX
       end
       handle(request, stream)
       true
-    rescue HTTP2Next::Error::StreamLimitExceeded
+    rescue ::HTTP2::Error::StreamLimitExceeded
       @pending.unshift(request)
     end
 
@@ -168,7 +168,7 @@ module HTTPX
     end
 
     def init_connection
-      @connection = HTTP2Next::Client.new(@settings)
+      @connection = ::HTTP2::Client.new(@settings)
       @connection.on(:frame, &method(:on_frame))
       @connection.on(:frame_sent, &method(:on_frame_sent))
       @connection.on(:frame_received, &method(:on_frame_received))
@@ -309,7 +309,7 @@ module HTTPX
       if error
         ex = Error.new(stream.id, error)
         ex.set_backtrace(caller)
-        response = ErrorResponse.new(request, ex, request.options)
+        response = ErrorResponse.new(request, ex)
         request.response = response
         emit(:response, request, response)
       else

data/lib/httpx/connection.rb

@@ -48,6 +48,8 @@ module HTTPX
     attr_accessor :family
 
     def initialize(uri, options)
+      @origins = [uri.origin]
+      @origin = Utils.to_uri(uri.origin)
       @options = Options.new(options)
       @type = initialize_type(uri, @options)
       @origins = [uri.origin]
@@ -337,7 +339,7 @@ module HTTPX
           #
           loop do
             siz = @io.read(@window_size, @read_buffer)
-            log(level: 3, color: :cyan) { "IO READ: #{siz} bytes..." }
+            log(level: 3, color: :cyan) { "IO READ: #{siz} bytes... (wsize: #{@window_size}, rbuffer: #{@read_buffer.bytesize})" }
             unless siz
               ex = EOFError.new("descriptor closed")
               ex.set_backtrace(caller)
@@ -504,7 +506,7 @@ module HTTPX
         when MisdirectedRequestError
           emit(:misdirected, request)
         else
-          response = ErrorResponse.new(request, ex, @options)
+          response = ErrorResponse.new(request, ex)
           request.response = response
           request.emit(:response, response)
         end
@@ -530,7 +532,7 @@ module HTTPX
       connecting? && callbacks_for?(:connect_error) ? emit(:connect_error, error) : handle_error(error)
       @state = :closed
       emit(:close)
-    rescue TLSError, HTTP2Next::Error::ProtocolError, HTTP2Next::Error::HandshakeError => e
+    rescue TLSError, ::HTTP2::Error::ProtocolError, ::HTTP2::Error::HandshakeError => e
       # connect errors, exit gracefully
       handle_error(e)
       connecting? && callbacks_for?(:connect_error) ? emit(:connect_error, e) : handle_error(e)
@@ -626,7 +628,11 @@ module HTTPX
           end
         end
       when "unix"
-        UNIX.new(@origin, addrs, @options)
+        path = Array(addrs).first
+
+        path = String(path) if path
+
+        UNIX.new(@origin, path, @options)
       else
         raise Error, "unsupported transport (#{@type})"
       end
@@ -653,7 +659,7 @@ module HTTPX
     def handle_error(error)
       parser.handle_error(error) if @parser && parser.respond_to?(:handle_error)
       while (request = @pending.shift)
-        response = ErrorResponse.new(request, error, request.options)
+        response = ErrorResponse.new(request, error)
         request.response = response
         request.emit(:response, response)
       end

data/lib/httpx/io/tcp.rb

@@ -17,7 +17,7 @@ module HTTPX
       @state = :idle
       @addresses = []
       @hostname = origin.host
-      @options = Options.new(options)
+      @options = options
       @fallback_protocol = @options.fallback_protocol
       @port = origin.port
       @interests = :w

data/lib/httpx/io/unix.rb

@@ -8,11 +8,11 @@ module HTTPX
 
     alias_method :host, :path
 
-    def initialize(origin, addresses, options)
+    def initialize(origin, path, options)
       @addresses = []
       @hostname = origin.host
       @state = :idle
-      @options = Options.new(options)
+      @options = options
       @fallback_protocol = @options.fallback_protocol
       if @options.io
         @io = case @options.io
@@ -26,8 +26,10 @@ module HTTPX
         @path = @io.path
         @keep_open = true
         @state = :connected
+      elsif path
+        @path = path
       else
-        @path = addresses.first
+        raise Error, "No path given where to store the socket"
       end
       @io ||= build_socket
     end

data/lib/httpx/options.rb

@@ -91,7 +91,7 @@ module HTTPX
     # :debug :: an object which log messages are written to (must respond to <tt><<</tt>)
     # :debug_level :: the log level of messages (can be 1, 2, or 3).
     # :ssl :: a hash of options which can be set as params of OpenSSL::SSL::SSLContext (see HTTPX::IO::SSL)
-    # :http2_settings :: a hash of options to be passed to a HTTP2Next::Connection (ex: <tt>{ max_concurrent_streams: 2 }</tt>)
+    # :http2_settings :: a hash of options to be passed to a HTTP2::Connection (ex: <tt>{ max_concurrent_streams: 2 }</tt>)
     # :fallback_protocol :: version of HTTP protocol to use by default in the absence of protocol negotiation
     #                       like ALPN (defaults to <tt>"http/1.1"</tt>)
     # :supported_compression_formats :: list of compressions supported by the transcoder layer (defaults to <tt>%w[gzip deflate]</tt>).
@@ -124,10 +124,6 @@ module HTTPX
     # :base_path :: path to prefix given relative paths with (ex: "/v2")
     # :max_concurrent_requests :: max number of requests which can be set concurrently
     # :max_requests :: max number of requests which can be made on socket before it reconnects.
-    # :params :: hash or array of key-values which will be encoded and set in the query string of request uris.
-    # :form :: hash of array of key-values which will be form-or-multipart-encoded in requests body payload.
-    # :json :: hash of array of key-values which will be JSON-encoded in requests body payload.
-    # :xml :: Nokogiri XML nodes which will be encoded in requests body payload.
     #
     # This list of options are enhanced with each loaded plugin, see the plugin docs for details.
     def initialize(options = {})
@@ -216,7 +212,7 @@ module HTTPX
     end
 
     %i[
-      params form json xml body ssl http2_settings
+      ssl http2_settings
       request_class response_class headers_class request_body_class
       response_body_class connection_class options_class
       io fallback_protocol debug debug_level resolver_class resolver_options
@@ -228,7 +224,7 @@ module HTTPX
       OUT
     end
 
-    REQUEST_BODY_IVARS = %i[@headers @params @form @xml @json @body].freeze
+    REQUEST_BODY_IVARS = %i[@headers].freeze
 
     def ==(other)
       super || options_equals?(other)

data/lib/httpx/parser/http1.rb

@@ -75,6 +75,7 @@ module HTTPX
         buffer = @buffer
 
         while (idx = buffer.index("\n"))
+          # @type var line: String
           line = buffer.byteslice(0..idx)
           raise Error, "wrong header format" if line.start_with?("\s", "\t")
 
@@ -101,9 +102,11 @@ module HTTPX
           separator_index = line.index(":")
           raise Error, "wrong header format" unless separator_index
 
+          # @type var key: String
           key = line.byteslice(0..(separator_index - 1))
 
           key.rstrip! # was lstripped previously!
+          # @type var value: String
           value = line.byteslice((separator_index + 1)..-1)
           value.strip!
           raise Error, "wrong header format" if value.nil?
@@ -118,6 +121,7 @@ module HTTPX
             @observer.on_data(chunk)
           end
         elsif @content_length
+          # @type var data: String
           data = @buffer.byteslice(0, @content_length)
           @buffer = @buffer.byteslice(@content_length..-1) || "".b
           @content_length -= data.bytesize

data/lib/httpx/plugins/aws_sigv4.rb

@@ -160,7 +160,7 @@ module HTTPX
           with(sigv4_signer: Signer.new(**options))
         end
 
-        def build_request(*, _)
+        def build_request(*)
           request = super
 
           return request if request.headers.key?("authorization")

data/lib/httpx/plugins/cookies.rb

@@ -40,6 +40,12 @@ module HTTPX
           end
         end
 
+        def build_request(*)
+          request = super
+          request.headers.set_cookie(request.options.cookies[request.uri])
+          request
+        end
+
         private
 
         def on_response(_request, response)
@@ -52,12 +58,6 @@ module HTTPX
 
           super
         end
-
-        def build_request(*, _)
-          request = super
-          request.headers.set_cookie(request.options.cookies[request.uri])
-          request
-        end
       end
 
       module HeadersMethods

data/lib/httpx/plugins/follow_redirects.rb

@@ -16,6 +16,7 @@ module HTTPX
     module FollowRedirects
       MAX_REDIRECTS = 3
       REDIRECT_STATUS = (300..399).freeze
+      REQUEST_BODY_HEADERS = %w[transfer-encoding content-encoding content-type content-length content-language content-md5 trailer].freeze
 
       using URIExtensions
 
@@ -60,7 +61,6 @@ module HTTPX
           return response unless REDIRECT_STATUS.include?(response.status) && response.headers.key?("location")
           return response unless max_redirects.positive?
 
-          # build redirect request
           redirect_uri = __get_location_from_response(response)
 
           if options.redirect_on
@@ -68,25 +68,43 @@ module HTTPX
             return response unless redirect_allowed
           end
 
+          # build redirect request
+          request_body = redirect_request.body
+          redirect_method = "GET"
+          redirect_params = {}
+
           if response.status == 305 && options.respond_to?(:proxy)
+            request_body.rewind
             # The requested resource MUST be accessed through the proxy given by
             # the Location field. The Location field gives the URI of the proxy.
-            retry_options = options.merge(headers: redirect_request.headers,
-                                          proxy: { uri: redirect_uri },
-                                          body: redirect_request.body,
-                                          max_redirects: max_redirects - 1)
+            redirect_options = options.merge(headers: redirect_request.headers,
+                                             proxy: { uri: redirect_uri },
+                                             max_redirects: max_redirects - 1)
+
+            redirect_params[:body] = request_body
             redirect_uri = redirect_request.uri
-            options = retry_options
+            options = redirect_options
           else
             redirect_headers = redirect_request_headers(redirect_request.uri, redirect_uri, request.headers, options)
+            redirect_opts = Hash[options]
+            redirect_params[:max_redirects] = max_redirects - 1
+
+            unless request_body.empty?
+              if response.status == 307
+                # The method and the body of the original request are reused to perform the redirected request.
+                redirect_method = redirect_request.verb
+                request_body.rewind
+                redirect_params[:body] = request_body
+              else
+                # redirects are **ALWAYS** GET, so remove body-related headers
+                REQUEST_BODY_HEADERS.each do |h|
+                  redirect_headers.delete(h)
+                end
+                redirect_params[:body] = nil
+              end
+            end
 
-            # redirects are **ALWAYS** GET
-            retry_opts = Hash[options].merge(
-              headers: redirect_headers.to_h,
-              body: redirect_request.body,
-              max_redirects: max_redirects - 1
-            )
-            retry_options = options.class.new(retry_opts)
+            options = options.class.new(redirect_opts.merge(headers: redirect_headers.to_h))
           end
 
           redirect_uri = Utils.to_uri(redirect_uri)
@@ -96,26 +114,26 @@ module HTTPX
              redirect_uri.scheme == "http"
             error = InsecureRedirectError.new(redirect_uri.to_s)
             error.set_backtrace(caller)
-            return ErrorResponse.new(request, error, options)
+            return ErrorResponse.new(request, error)
           end
 
-          retry_request = build_request("GET", redirect_uri, retry_options)
+          retry_request = build_request(redirect_method, redirect_uri, redirect_params, options)
 
           request.redirect_request = retry_request
 
-          retry_after = response.headers["retry-after"]
+          redirect_after = response.headers["retry-after"]
 
-          if retry_after
+          if redirect_after
             # Servers send the "Retry-After" header field to indicate how long the
             # user agent ought to wait before making a follow-up request.
             # When sent with any 3xx (Redirection) response, Retry-After indicates
             # the minimum time that the user agent is asked to wait before issuing
             # the redirected request.
             #
-            retry_after = Utils.parse_retry_after(retry_after)
+            redirect_after = Utils.parse_retry_after(redirect_after)
 
-            log { "redirecting after #{retry_after} secs..." }
-            pool.after(retry_after) do
+            log { "redirecting after #{redirect_after} secs..." }
+            pool.after(redirect_after) do
               send_request(retry_request, connections, options)
             end
           else
@@ -125,19 +143,21 @@ module HTTPX
         end
 
         def redirect_request_headers(original_uri, redirect_uri, headers, options)
+          headers = headers.dup
+
           return headers if options.allow_auth_to_other_origins
 
           return headers unless headers.key?("authorization")
 
-          unless original_uri.origin == redirect_uri.origin
-            headers = headers.dup
-            headers.delete("authorization")
-          end
+          return headers if original_uri.origin == redirect_uri.origin
+
+          headers.delete("authorization")
 
           headers
         end
 
         def __get_location_from_response(response)
+          # @type var location_uri: http_uri
           location_uri = URI(response.headers["location"])
           location_uri = response.uri.merge(location_uri) if location_uri.relative?
           location_uri

data/lib/httpx/plugins/grpc.rb

@@ -110,10 +110,10 @@ module HTTPX
       end
 
       module RequestBodyMethods
-        def initialize(headers, _)
+        def initialize(*, **)
           super
 
-          if (compression = headers["grpc-encoding"])
+          if (compression = @headers["grpc-encoding"])
             deflater_body = self.class.initialize_deflater_body(@body, compression)
             @body = Transcoder::GRPCEncoding.encode(deflater_body || @body, compressed: !deflater_body.nil?)
           else
@@ -124,6 +124,7 @@ module HTTPX
 
       module InstanceMethods
         def with_channel_credentials(ca_path, key = nil, cert = nil, **ssl_opts)
+          # @type var ssl_params: ::Hash[::Symbol, untyped]
           ssl_params = {
             **ssl_opts,
             ca_file: ca_path,

data/lib/httpx/plugins/h2c.rb

@@ -39,7 +39,7 @@ module HTTPX
           upgrade_request.headers.add("connection", "upgrade")
           upgrade_request.headers.add("connection", "http2-settings")
           upgrade_request.headers["upgrade"] = "h2c"
-          upgrade_request.headers["http2-settings"] = HTTP2Next::Client.settings_header(upgrade_request.options.http2_settings)
+          upgrade_request.headers["http2-settings"] = ::HTTP2::Client.settings_header(upgrade_request.options.http2_settings)
 
           super(upgrade_request, *remainder)
         end

data/lib/httpx/plugins/oauth.rb

@@ -155,7 +155,7 @@ module HTTPX
           with(oauth_session: oauth_session.merge(access_token: access_token, refresh_token: refresh_token))
         end
 
-        def build_request(*, _)
+        def build_request(*)
           request = super
 
           return request if request.headers.key?("authorization")

data/lib/httpx/plugins/proxy/http.rb

@@ -163,8 +163,8 @@ module HTTPX
         end
 
         class ConnectRequest < Request
-          def initialize(uri, _options)
-            super("CONNECT", uri, {})
+          def initialize(uri, options)
+            super("CONNECT", uri, options)
             @headers.delete("accept")
           end
 

data/lib/httpx/plugins/proxy/socks4.rb

@@ -89,7 +89,7 @@ module HTTPX
 
           def initialize(buffer, options)
             @buffer = buffer
-            @options = Options.new(options)
+            @options = options
           end
 
           def close; end

data/lib/httpx/plugins/proxy/socks5.rb

@@ -141,7 +141,7 @@ module HTTPX
 
           def initialize(buffer, options)
             @buffer = buffer
-            @options = Options.new(options)
+            @options = options
           end
 
           def close; end

data/lib/httpx/plugins/rate_limiter.rb

@@ -39,6 +39,8 @@ module HTTPX
         # the redirected request.
         #
         def retry_after_rate_limit(_, response)
+          return unless response.is_a?(Response)
+
           retry_after = response.headers["retry-after"]
 
           return unless retry_after

data/lib/httpx/plugins/ssrf_filter.rb

@@ -100,7 +100,7 @@ module HTTPX
 
             error = ServerSideRequestForgeryError.new("#{request.uri} URI scheme not allowed")
             error.set_backtrace(caller)
-            response = ErrorResponse.new(request, error, request.options)
+            response = ErrorResponse.new(request, error)
             request.emit(:response, response)
             response
           end