httpx 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e5ee54988be76a44ae512da359d83c502f8a43073f244a116a8fdc45fa7b87d
-  data.tar.gz: e3c08652a8d08eadbd1ef14b20005f93ff4131a712f8234c3eab94c7fce07167
+  metadata.gz: 8803154870d8bd0f45f67ce543072fcc42d789400ca0c9251d3ea99f5f214562
+  data.tar.gz: 87024f70caa91f93711b6a185a8e3dc7b8987d695472abd13a5a4cb92243d37c
 SHA512:
-  metadata.gz: 58f16e523d23215d89a8c873a5ce12491b52726073c334c4d9800e17e40dca8111ad43ab2467c37939a19bebbaa000c8db144fdbba87cc3d22cb699687df6699
-  data.tar.gz: 64dd9bb70af4173339019b62fa9f54fdf3f22c4bf593b51fb3de624844ac8a599a51b49cae10623aee8b8cff24af4dee69e39bedfec7da3d1ae229d733632e9c
+  metadata.gz: ba28ac993c5b17d4d13db24240214a40cfbae5eac5fad40e6420e42725356a289ee33fcb02492bc382d2c26ce93a0696acf7f5f8d64ddf430136ee829f717b70
+  data.tar.gz: 93c174e3d210681f1c76127f7a3a69adf43d8a5b3c31432ae0b6e08abd96ca7d189399081efeed710f8c43566e3290931d04b2c38df7de0251508933b2fca129

data/doc/release_notes/1_2_2.md

@@ -0,0 +1,10 @@
+# 1.2.2
+
+## Bugfixes
+
+* only raise "unknown option" error when option is not supported, not anymore when error happens in the setup of a support option.
+* usage of `HTTPX::Session#wrap` within a thread with other sessions using the `:persistent` plugin won't inadvertedly terminate its open connections.
+* terminate connections on `IOError` (`SocketError` does not cover them).
+* terminate connections on HTTP/2 protocol and handshake errors, which happen during establishment or termination of a HTTP/2 connection (they were being previously kept around, although they'd irrecoverable).
+* `:oauth` plugin: fixing check preventing the OAuth metadata server integration path to be exercised.
+* fix instantiation of the options headers object with the wrong headers class.

data/doc/release_notes/1_2_3.md

@@ -0,0 +1,16 @@
+# 1.2.3
+
+## Improvements
+
+* `:retries` plugin: allow `:max_retries` set to 0 (allows for a soft disable of retries when using the faraday adapter).
+
+## Bugfixes
+
+* `:oauth` plugin: fix for default auth method being ignored when setting grant type and scope as options only.
+*  ensure happy eyeballs-initiated cloned connections also set session callbacks (caused issues when server would respond with a 421 response, an event requiring a valid internal callback).
+*  native resolver cleanly transitions from tcp to udp after truncated DNS query (causing issues on follow-up CNAME resolution).
+* elapsing timeouts now guard against mutation of callbacks while looping (prevents skipping callbacks in situations where a previous one would remove itself from the collection).
+
+## Chore
+
+* datadog adapter: do not call `.lazy` on options (avoids deprecation warning, to be removed in ddtrace 2.0)

data/lib/httpx/adapters/datadog.rb

@@ -169,14 +169,14 @@ module Datadog::Tracing
                   "httpx"
                 )
               end
-              o.lazy
+              o.lazy unless Gem::Version.new(DDTrace::VERSION::STRING) >= Gem::Version.new("1.13.0")
             end
           else
             option :service_name do |o|
               o.default do
                 ENV.fetch("DD_TRACE_HTTPX_SERVICE_NAME", "httpx")
               end
-              o.lazy
+              o.lazy unless Gem::Version.new(DDTrace::VERSION::STRING) >= Gem::Version.new("1.13.0")
             end
           end
 

data/lib/httpx/connection.rb

@@ -522,14 +522,15 @@ module HTTPX
            Errno::ENETUNREACH,
            Errno::EPIPE,
            Errno::ENOENT,
-           SocketError => e
+           SocketError,
+           IOError => e
       # connect errors, exit gracefully
       error = ConnectionError.new(e.message)
       error.set_backtrace(e.backtrace)
       connecting? && callbacks_for?(:connect_error) ? emit(:connect_error, error) : handle_error(error)
       @state = :closed
       emit(:close)
-    rescue TLSError => e
+    rescue TLSError, HTTP2Next::Error::ProtocolError, HTTP2Next::Error::HandshakeError => e
       # connect errors, exit gracefully
       handle_error(e)
       connecting? && callbacks_for?(:connect_error) ? emit(:connect_error, e) : handle_error(e)

data/lib/httpx/io/tcp.rb

@@ -78,7 +78,8 @@ module HTTPX
     rescue Errno::ECONNREFUSED,
            Errno::EADDRNOTAVAIL,
            Errno::EHOSTUNREACH,
-           SocketError => e
+           SocketError,
+           IOError => e
       raise e if @ip_index <= 0
 
       log { "failed connecting to #{@ip} (#{e.message}), trying next..." }

data/lib/httpx/options.rb

@@ -47,13 +47,13 @@ module HTTPX
         write_timeout: WRITE_TIMEOUT,
         request_timeout: REQUEST_TIMEOUT,
       },
+      :headers_class => Class.new(Headers),
       :headers => {},
       :window_size => WINDOW_SIZE,
       :buffer_size => BUFFER_SIZE,
       :body_threshold_size => MAX_BODY_THRESHOLD_SIZE,
       :request_class => Class.new(Request),
       :response_class => Class.new(Response),
-      :headers_class => Class.new(Headers),
       :request_body_class => Class.new(Request::Body),
       :response_body_class => Class.new(Response::Body),
       :connection_class => Class.new(Connection),
@@ -154,7 +154,7 @@ module HTTPX
     end
 
     def option_headers(value)
-      Headers.new(value)
+      headers_class.new(value)
     end
 
     def option_timeout(value)
@@ -342,12 +342,11 @@ module HTTPX
       defaults.each do |k, v|
         next if v.nil?
 
-        begin
-          value = __send__(:"option_#{k}", v)
-          instance_variable_set(:"@#{k}", value)
-        rescue NoMethodError
-          raise Error, "unknown option: #{k}"
-        end
+        option_method_name = :"option_#{k}"
+        raise Error, "unknown option: #{k}" unless respond_to?(option_method_name)
+
+        value = __send__(option_method_name, v)
+        instance_variable_set(:"@#{k}", value)
       end
     end
   end

data/lib/httpx/plugins/oauth.rb

@@ -16,7 +16,7 @@ module HTTPX
       SUPPORTED_AUTH_METHODS = %w[client_secret_basic client_secret_post].freeze
 
       class OAuthSession
-        attr_reader :token_endpoint_auth_method, :grant_type, :client_id, :client_secret, :access_token, :refresh_token, :scope
+        attr_reader :grant_type, :client_id, :client_secret, :access_token, :refresh_token, :scope
 
         def initialize(
           issuer:,
@@ -28,7 +28,7 @@ module HTTPX
           token_endpoint: nil,
           response_type: nil,
           grant_type: nil,
-          token_endpoint_auth_method: "client_secret_basic"
+          token_endpoint_auth_method: nil
         )
           @issuer = URI(issuer)
           @client_id = client_id
@@ -43,10 +43,10 @@ module HTTPX
           end
           @access_token = access_token
           @refresh_token = refresh_token
-          @token_endpoint_auth_method = String(token_endpoint_auth_method)
+          @token_endpoint_auth_method = String(token_endpoint_auth_method) if token_endpoint_auth_method
           @grant_type = grant_type || (@refresh_token ? "refresh_token" : "client_credentials")
 
-          unless SUPPORTED_AUTH_METHODS.include?(@token_endpoint_auth_method)
+          unless @token_endpoint_auth_method.nil? || SUPPORTED_AUTH_METHODS.include?(@token_endpoint_auth_method)
             raise Error, "#{@token_endpoint_auth_method} is not a supported auth method"
           end
 
@@ -59,10 +59,14 @@ module HTTPX
           @token_endpoint || "#{@issuer}/token"
         end
 
+        def token_endpoint_auth_method
+          @token_endpoint_auth_method || "client_secret_basic"
+        end
+
         def load(http)
-          return unless @token_endpoint && @token_endpoint_auth_method && @grant_type && @scope
+          return if @grant_type && @scope
 
-          metadata = http.get("#{issuer}/.well-known/oauth-authorization-server").raise_for_status.json
+          metadata = http.get("#{@issuer}/.well-known/oauth-authorization-server").raise_for_status.json
 
           @token_endpoint = metadata["token_endpoint"]
           @scope = metadata["scopes_supported"]
@@ -70,6 +74,7 @@ module HTTPX
           @token_endpoint_auth_method = Array(metadata["token_endpoint_auth_methods_supported"]).find do |am|
             SUPPORTED_AUTH_METHODS.include?(am)
           end
+          nil
         end
 
         def merge(other)
@@ -122,11 +127,11 @@ module HTTPX
 
           # auth
           case oauth_session.token_endpoint_auth_method
-          when "client_secret_basic"
-            headers["authorization"] = Authentication::Basic.new(oauth_session.client_id, oauth_session.client_secret).authenticate
           when "client_secret_post"
             form_post["client_id"] = oauth_session.client_id
             form_post["client_secret"] = oauth_session.client_secret
+          when "client_secret_basic"
+            headers["authorization"] = Authentication::Basic.new(oauth_session.client_id, oauth_session.client_secret).authenticate
           end
 
           case grant_type

data/lib/httpx/plugins/retries.rb

@@ -58,7 +58,7 @@ module HTTPX
 
         def option_max_retries(value)
           num = Integer(value)
-          raise TypeError, ":max_retries must be positive" unless num.positive?
+          raise TypeError, ":max_retries must be positive" unless num >= 0
 
           num
         end

data/lib/httpx/pool.rb

@@ -19,6 +19,17 @@ module HTTPX
       @connections = []
     end
 
+    def wrap
+      connections = @connections
+      @connections = []
+
+      begin
+        yield self
+      ensure
+        @connections.unshift(*connections)
+      end
+    end
+
     def empty?
       @connections.empty?
     end
@@ -168,6 +179,7 @@ module HTTPX
       connection.once(:connect_error) do |err|
         if new_connection.connecting?
           new_connection.merge(connection)
+          connection.emit(:cloned, new_connection)
           connection.force_reset
         else
           connection.__send__(:handle_error, err)
@@ -184,6 +196,7 @@ module HTTPX
         if connection.connecting?
           # main connection has the requests
           connection.merge(new_connection)
+          new_connection.emit(:cloned, connection)
           new_connection.force_reset
         else
           new_connection.__send__(:handle_error, err)

data/lib/httpx/request.rb

@@ -61,7 +61,7 @@ module HTTPX
         @uri = origin.merge("#{base_path}#{@uri}")
       end
 
-      @headers = @options.headers_class.new(@options.headers)
+      @headers = @options.headers.dup
       @headers["user-agent"] ||= USER_AGENT
       @headers["accept"]     ||= "*/*"
 

data/lib/httpx/resolver/native.rb

@@ -187,10 +187,10 @@ module HTTPX
             next unless @large_packet.full?
 
             parse(@large_packet.to_s)
-
             @socket_type = @resolver_options.fetch(:socket_type, :udp)
             @large_packet = nil
-            transition(:closed)
+            transition(:idle)
+            transition(:open)
             return
           else
             size = @read_buffer[0, 2].unpack1("n")

data/lib/httpx/response.rb

@@ -7,10 +7,18 @@ require "fileutils"
 require "forwardable"
 
 module HTTPX
-  # Defines a HTTP response is handled internally, with a few properties exposed as attributes,
-  # implements (indirectly, via the +body+) the IO write protocol to internally buffer payloads,
-  # implements the IO reader protocol in order for users to buffer/stream it, acts as an enumerable
+  # Defines a HTTP response is handled internally, with a few properties exposed as attributes.
+  #
+  # It delegates the following methods to the corresponding HTTPX::Request:
+  #
+  # * HTTPX::Request#uri
+  # * HTTPX::Request#peer_address
+  #
+  # It implements (indirectly, via the +body+) the IO write protocol to internally buffer payloads.
+  #
+  # It implements the IO reader protocol in order for users to buffer/stream it, acts as an enumerable
   # (of payload chunks).
+  #
   class Response
     extend Forwardable
     include Callbacks
@@ -21,7 +29,13 @@ module HTTPX
     # an HTTPX::Headers object containing the response HTTP headers.
     attr_reader :headers
 
-    # a HTTPX::Response::Body object wrapping the response body.
+    # a HTTPX::Response::Body object wrapping the response body. The following methods are delegated to it:
+    #
+    # * HTTPX::Response::Body#to_s
+    # * HTTPX::Response::Body#to_str
+    # * HTTPX::Response::Body#read
+    # * HTTPX::Response::Body#copy_to
+    # * HTTPX::Response::Body#close
     attr_reader  :body
 
     # The HTTP protocol version used to fetch the response.

data/lib/httpx/session.rb

@@ -28,13 +28,15 @@ module HTTPX
     #     http.get("https://wikipedia.com")
     #   end # wikipedia connection closes here
     def wrap
-      begin
-        prev_persistent = @persistent
-        @persistent = true
-        yield self
-      ensure
-        @persistent = prev_persistent
-        close unless @persistent
+      prev_persistent = @persistent
+      @persistent = true
+      pool.wrap do
+        begin
+          yield self
+        ensure
+          @persistent = prev_persistent
+          close unless @persistent
+        end
       end
     end
 
@@ -136,7 +138,7 @@ module HTTPX
 
     # sets the callbacks on the +connection+ required to process certain specific
     # connection lifecycle events which deal with request rerouting.
-    def set_connection_callbacks(connection, connections, options)
+    def set_connection_callbacks(connection, connections, options, cloned: false)
       connection.only(:misdirected) do |misdirected_request|
         other_connection = connection.create_idle(ssl: { alpn_protocols: %w[http/1.1] })
         other_connection.merge(connection)
@@ -152,6 +154,10 @@ module HTTPX
         other_connection = build_altsvc_connection(connection, connections, alt_origin, origin, alt_params, options)
         connections << other_connection if other_connection
       end
+      connection.only(:cloned) do |cloned_conn|
+        set_connection_callbacks(cloned_conn, connections, options, cloned: true)
+        connections << cloned_conn
+      end unless cloned
     end
 
     # returns an HTTPX::Connection for the negotiated Alternative Service (or none).

data/lib/httpx/timers.rb

@@ -97,7 +97,10 @@ module HTTPX
       def elapse(elapsed)
         @interval -= elapsed
 
-        @callbacks.each(&:call) if @interval <= 0
+        if @interval <= 0
+          cb = @callbacks.dup
+          cb.each(&:call)
+        end
 
         @interval
       end

data/lib/httpx/version.rb

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

data/sig/plugins/oauth.rbs

@@ -15,8 +15,6 @@ module HTTPX
       SUPPORTED_AUTH_METHODS: ::Array[token_auth_method]
 
       class OAuthSession
-        attr_reader token_endpoint_auth_method: token_auth_method
-
         attr_reader grant_type: grant_type
 
         attr_reader client_id: String
@@ -33,6 +31,8 @@ module HTTPX
 
         def token_endpoint: () -> String
 
+        def token_endpoint_auth_method: () -> token_auth_method
+
         def load: (Session http) -> void
 
         def merge: (instance | Hash[untyped, untyped] other) -> instance

data/sig/pool.rbs

@@ -7,6 +7,8 @@ module HTTPX
     @selector: Selector
     @connections: Array[Connection]
 
+    def wrap: () { (instance) -> void } -> void
+
     def empty?: () -> void
 
     def next_tick: () -> void

data/sig/session.rbs

@@ -31,7 +31,7 @@ module HTTPX
 
     def send_request: (Request request, Array[Connection] connections, ?Options options) -> void
 
-    def set_connection_callbacks: (Connection connection, Array[Connection] connections, Options options) -> void
+    def set_connection_callbacks: (Connection connection, Array[Connection] connections, Options options, ?cloned: bool) -> void
 
     def set_request_callbacks: (Request request) -> void
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-13 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2-next
@@ -139,6 +139,8 @@ extra_rdoc_files:
 - doc/release_notes/1_1_5.md
 - doc/release_notes/1_2_0.md
 - doc/release_notes/1_2_1.md
+- doc/release_notes/1_2_2.md
+- doc/release_notes/1_2_3.md
 files:
 - LICENSE.txt
 - README.md
@@ -249,6 +251,8 @@ files:
 - doc/release_notes/1_1_5.md
 - doc/release_notes/1_2_0.md
 - doc/release_notes/1_2_1.md
+- doc/release_notes/1_2_2.md
+- doc/release_notes/1_2_3.md
 - lib/httpx.rb
 - lib/httpx/adapters/datadog.rb
 - lib/httpx/adapters/faraday.rb