httpx 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3df88a59256b85aacf9d98578c965626b3bfa4611695ae21a707252df71cb0a
-  data.tar.gz: f1616869724c217272d0dc165130548edc8ca35eadd97ab42d5a17012a0019d6
+  metadata.gz: 7aff2acc77577cb1243c30a63766f404755131c2f1b19162b9b6ba13c49d61f8
+  data.tar.gz: 6297b0857edce0f5d93a0272c2b5e891257969c36cbf0c34c6a7ca6e4a5ced67
 SHA512:
-  metadata.gz: b4ca8efc0a1ffe3dec2d2d6ee345bcb58bc2eec9e4c5b4fe951a889041be8eeaeb4b005d9771f0e712f161dad69f8de25d07d520c3e0cd17ae1574f53fadace1
-  data.tar.gz: 509c48d74aafb520e3142c5f9b2356e2f36bf9d649eb723ca07a2863077057ab12ae2e17dbf61f13149eac4f80201252dad9b46cb904f5664b8910b62a868c1d
+  metadata.gz: 94da91dd14a8318e8f0a0199214f97c008b927c7b8d9f602f045434bbd375b4446c767ed805e424d826c3dc48e90a8a0fded192858d32763c4c38033e0107cae
+  data.tar.gz: 657cefe9a977ca56dddda02bbdb07a94b4a8f158193e5f0d695c254bdbcafd95ffccd29641d38958d16468a81fd236f4d95ef4487c335cf7e079fb29b8d456ba

data/README.md

@@ -136,7 +136,7 @@ The test suite runs against [httpbin proxied over nghttp2](https://nghttp2.org/h
 
 All Rubies greater or equal to 2.7, and always latest JRuby and Truffleruby.
 
-**Note**: This gem is tested against all latest patch versions, i.e. if you're using 3.2.0 and you experience some issue, please test it against 3.2.$latest before creating an issue.
+**Note**: This gem is tested against all latest patch versions, i.e. if you're using 3.3.0 and you experience some issue, please test it against 3.3.$latest before creating an issue.
 
 ## Resources
 |               |                                                        |

data/doc/release_notes/1_1_1.md

@@ -2,13 +2,13 @@
 
 ## improvements
 
-* (Re-)enabling default retries in DNS name queries; this had been disabled as a result of revamping timouts, and resulted in queries only being sent once, which is very little for UDP-related traffic, and breaks if using DNs rate-limiting software. Retries the query just once, for now.
+* (Re-)enabling default retries in DNS name queries; this had been disabled as a result of revamping timeouts, and resulted in queries only being sent once, which is very little for UDP-related traffic, and breaks if using DNs rate-limiting software. Retries the query just once, for now.
 
 ## bugfixes
 
 * reset timers when adding new intervals, as these may be added as a result on after-select connection handling, and must wait for the next tick cycle (before the patch, they were triggering too soon).
 * fixed "on close" callback leak on connection reuse, which caused linear performance regression in benchmarks performing one request per connection.
-* fixed hanging connection whan an HTTP/1.1 emitted a "connection: close" header but the server would not emit one (it closes the connection now).
+* fixed hanging connection when an HTTP/1.1 emitted a "connection: close" header but the server would not emit one (it closes the connection now).
 * fixed recursive dns cached lookups which may have already expired, and created nil entries in the returned address list.
 * dns system resolver is now able to retry on failure.
 

data/doc/release_notes/1_2_0.md

@@ -4,7 +4,7 @@
 
 ### `:ssrf_filter` plugin
 
-The `:ssrf_filter` p plugin prevents server-side request forgery attacks, by blocking requests to the internal network. This is useful when the URLs used to perform requests aren’t under the developer control (such as when they are inserted via a web application form).
+The `:ssrf_filter` plugin prevents server-side request forgery attacks, by blocking requests to the internal network. This is useful when the URLs used to perform requests aren’t under the developer control (such as when they are inserted via a web application form).
 
 ```ruby
 http = HTTPX.plugin(:ssrf_filter)
@@ -31,7 +31,7 @@ More info under https://honeyryderchuck.gitlab.io/httpx/wiki/Callbacks
 This option allows passing a callback which, when returning `false`, can interrupt the redirect loop.
 
 ```ruby
-http = HTTPX.plugin(:follow_redirects).with(redirect_on: ->(location_uri) { BLACKLIST_HOSTS.include?(location_uri.host) ]
+http = HTTPX.plugin(:follow_redirects).with(redirect_on: ->(location_uri) { BLACKLIST_HOSTS.include?(location_uri.host) })
 ```
 
 ### `:close_on_handshake_timeout` timeout

data/doc/release_notes/1_2_1.md

@@ -0,0 +1,6 @@
+# 1.2.1
+
+## Bugfixes
+
+* DoH resolver: try resolving other candidates on "domain not found" error (same behaviour as with native resolver).
+* Allow HTTP/2 connections to exit cleanly when TLS session gets corrupted and termination handshake can't be performed.

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/lib/httpx/buffer.rb

@@ -3,6 +3,14 @@
 require "forwardable"
 
 module HTTPX
+  # Internal class to abstract a string buffer, by wrapping a string and providing the
+  # minimum possible API and functionality required.
+  #
+  #     buffer = Buffer.new(640)
+  #     buffer.full? #=> false
+  #     buffer << "aa"
+  #     buffer.capacity #=> 638
+  #
   class Buffer
     extend Forwardable
 

data/lib/httpx/chainable.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module HTTPX
+  # Session mixin, implements most of the APIs that the users call.
+  # delegates to a default session when extended.
   module Chainable
     %w[head get post put delete trace options connect patch].each do |meth|
       class_eval(<<-MOD, __FILE__, __LINE__ + 1)
@@ -10,6 +12,7 @@ module HTTPX
       MOD
     end
 
+    # delegates to the default session (see HTTPX::Session#request).
     def request(*args, **options)
       branch(default_options).request(*args, **options)
     end
@@ -18,10 +21,12 @@ module HTTPX
       with(headers: { "accept" => String(type) })
     end
 
+    # delegates to the default session (see HTTPX::Session#wrap).
     def wrap(&blk)
       branch(default_options).wrap(&blk)
     end
 
+    # returns a new instance loaded with the +pl+ plugin and +options+.
     def plugin(pl, options = nil, &blk)
       klass = is_a?(S) ? self.class : Session
       klass = Class.new(klass)
@@ -29,16 +34,19 @@ module HTTPX
       klass.plugin(pl, options, &blk).new
     end
 
+    # returns a new instance loaded with +options+.
     def with(options, &blk)
       branch(default_options.merge(options), &blk)
     end
 
     private
 
+    # returns default instance of HTTPX::Options.
     def default_options
       @options || Session.default_options
     end
 
+    # returns a default instance of HTTPX::Session.
     def branch(options, &blk)
       return self.class.new(options, &blk) if is_a?(S)
 

data/lib/httpx/connection.rb

@@ -228,11 +228,7 @@ module HTTPX
       return if @state == :closing || @state == :closed
 
       transition(:closing)
-      unless @write_buffer.empty?
-        # handshakes, try sending
-        consume
-        @write_buffer.clear
-      end
+
       transition(:closed)
     end
 
@@ -526,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)
@@ -566,6 +563,15 @@ module HTTPX
       when :closing
         return unless @state == :idle || @state == :open
 
+        unless @write_buffer.empty?
+          # preset state before handshake, as error callbacks
+          # may take it back here.
+          @state = nextstate
+          # handshakes, try sending
+          consume
+          @write_buffer.clear
+          return
+        end
       when :closed
         return unless @state == :closing
         return unless @write_buffer.empty?
@@ -700,7 +706,7 @@ module HTTPX
         interval = @timers.after(timeout, callback)
 
         Array(finish_events).each do |event|
-          # clean up reques timeouts if the connection errors out
+          # clean up request timeouts if the connection errors out
           request.once(event) do
             if @intervals.include?(interval)
               interval.delete(callback)

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),
@@ -99,7 +99,7 @@ module HTTPX
     # :compress_request_body :: whether to auto-decompress response body (defaults to <tt>true</tt>)
     # :timeout :: hash of timeout configurations (supports <tt>:connect_timeout</tt>, <tt>:settings_timeout</tt>,
     #             <tt>:operation_timeout</tt>, <tt>:keep_alive_timeout</tt>,  <tt>:read_timeout</tt>,  <tt>:write_timeout</tt>
-    #            and <tt>:request_timeout</tt>
+    #             and <tt>:request_timeout</tt>
     # :headers :: hash of HTTP headers (ex: <tt>{ "x-custom-foo" => "bar" }</tt>)
     # :window_size :: number of bytes to read from a socket
     # :buffer_size :: internal read and write buffer size in bytes
@@ -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

@@ -60,9 +60,9 @@ module HTTPX
         end
 
         def load(http)
-          return unless @token_endpoint && @token_endpoint_auth_method && @grant_type && @scope
+          return if @token_endpoint_auth_method && @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 +70,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)

data/lib/httpx/plugins/proxy.rb

@@ -246,8 +246,8 @@ module HTTPX
           return super unless @options.proxy
 
           @state = :open
-          transition(:closing)
-          transition(:closed)
+
+          super
           emit(:close)
         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

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/https.rb

@@ -138,9 +138,14 @@ module HTTPX
         # Indicates no such domain was found.
 
         host = @requests.delete(request)
-        connection = reset_hostname(host)
+        connection = reset_hostname(host, reset_candidates: false)
 
-        emit_resolve_error(connection)
+        unless @queries.value?(connection)
+          emit_resolve_error(connection)
+          return
+        end
+
+        resolve
       when :dns_error
         host = @requests.delete(request)
         connection = reset_hostname(host)

data/lib/httpx/response/body.rb

@@ -166,6 +166,7 @@ module HTTPX
 
     private
 
+    # prepares inflaters for the advertised encodings in "content-encoding" header.
     def initialize_inflaters
       @inflaters = nil
 
@@ -187,6 +188,7 @@ module HTTPX
       end
     end
 
+    # passes the +chunk+ through all inflaters to decode it.
     def decode_chunk(chunk)
       @inflaters.reverse_each do |inflater|
         chunk = inflater.call(chunk)
@@ -195,6 +197,7 @@ module HTTPX
       chunk
     end
 
+    # tries transitioning the body STM to the +nextstate+.
     def transition(nextstate)
       case nextstate
       when :open

data/lib/httpx/response.rb

@@ -70,9 +70,10 @@ module HTTPX
       @body.write(data)
     end
 
-    # returns the response mime type, as per what's declared in the content-type header.
+    # returns the HTTPX::ContentType for the response, as per what's declared in the content-type header.
     #
-    #   response.content_type #=> "text/plain"
+    #   response.content_type #=> #<HTTPX::ContentType:xxx @header_value="text/plain">
+    #   response.content_type.mime_type #=> "text/plain"
     def content_type
       @content_type ||= ContentType.new(@headers["content-type"])
     end

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
 

data/lib/httpx/version.rb

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2-next
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
 description: A client library for making HTTP requests from Ruby.
 email:
 - cardoso_tiago@hotmail.com
@@ -138,6 +138,8 @@ extra_rdoc_files:
 - doc/release_notes/1_1_4.md
 - 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
 files:
 - LICENSE.txt
 - README.md
@@ -247,6 +249,8 @@ files:
 - doc/release_notes/1_1_4.md
 - 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
 - lib/httpx.rb
 - lib/httpx/adapters/datadog.rb
 - lib/httpx/adapters/faraday.rb