httpx 0.12.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5770fadc8d4604ccb0fb274c7fc157802315f68c749a83973ee5596fee8effb1
-  data.tar.gz: 4f24cca053093be31636405dcb740f5c6b2599197d9ebdfb90cbf127e86a5ffc
+  metadata.gz: fbedc26fba4c0d9a8e0543b437ada103b42bbd89d537a50546590adb2f004d04
+  data.tar.gz: 6645eeb893ed1f07a8e7c7c86db73c0ff2d49f01c63e52888d7da868b925bcdc
 SHA512:
-  metadata.gz: 48fe64207a82e2b8db91b73cc6252ff48ea624e57dcbcbfa30e5f6986e1936e61bbdc83cece34c470dd6e318f41845a306a57e2b5c8710084444b6193786a1eb
-  data.tar.gz: 70b43fc624a8452187a730e39f55d9e92d16438babbd76aa2346c5b3dd0c2cad7f8e5e787f7c4ab1917c52ed750c7656f2f6c5e92a2ec0fce9cc0a76e5994d1e
+  metadata.gz: 1ea37e203901dbae07960c12023cbeb2b3ee62ea461a265ab3dff8687b8874e33cf3bf0bbf62df30243030ce9420317bf635e5df1102cfa9a8503ec09949ca3c
+  data.tar.gz: 3515498ac93ca1ef5f165754e8caa95dbddf8aebe079b0efbf8d5a7a78a778d76a4812e4beeddc723dd6fb81dafa4a47c7ae9cb2463834ebd5cf7812ef30a45c

data/doc/release_notes/0_10_1.md

@@ -26,7 +26,7 @@ From now on, both headers and the responnse payload will also appear, so expecte
 ## Bugfixes
 
 * HTTP/2 and HTTP/1.1 exhausted connections now get properly migrated into a new connection;
-* HTTP/2 421 responses will now correctly migrate the connection and pendign requests to HTTP/1.1 (a hanging loop was being caused);
+* HTTP/2 421 responses will now correctly migrate the connection and pending requests to HTTP/1.1 (a hanging loop was being caused);
 * HTTP/2 connection failed with a GOAWAY settings timeout will now return error responses (instead of hanging indefinitely);
 * Non-IP proxy name-resolving errors will now move on to the next available proxy in the list (instead of hanging indefinitely);
 * Non-IP DNS resolve errors for `native` and `https` variants will now return the appropriate error response (instead of hanging indefinitely);

data/doc/release_notes/0_13_0.md

@@ -0,0 +1,58 @@
+# 0.13.0
+
+## Features
+
+### Upgrade plugin
+
+A new plugin, `:upgrade`, is now available. This plugin allows one to "hook" on HTTP/1.1's protocol upgrade mechanism (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Protocol_upgrade_mechanism), which is the mechanism that browsers use to initiate websockets (there is an example of how to use `httpx` to start a websocket client connection [in the tests](https://gitlab.com/honeyryderchuck/httpx/-/blob/master/test/support/requests/plugins/upgrade.rb))
+
+You can read more about the `:upgrade` plugin in the [wiki](https://honeyryderchuck.gitlab.io/httpx/wiki/Connection-Upgrade).
+
+It's the basis of two plugins:
+
+#### `:h2c`
+
+This plugin was been rewritten on top of the `:upgrade` plugin, and handles upgrading a plaintext (non-"https") HTTP/1.1 connection, into an HTTP/2 connection.
+
+https://honeyryderchuck.gitlab.io/httpx/wiki/Connection-Upgrade#h2c
+
+#### `:upgrade/h2`
+
+This plugin handles when a server responds to a request with an `Upgrade: h2` header, does the following requests to the same origin via HTTP/2 prior knowledge (bypassing the necessity for ALPN negotiation, which is the whole point of the feature).
+
+https://honeyryderchuck.gitlab.io/httpx/wiki/Connection-Upgrade#h2
+
+### `:addresses` option
+
+The `:addresses` option is now available. You can use it to pass a list of IPs to connect to:
+
+```ruby
+# will not resolve example.com, and instead connect to one of the IPs passed.
+HTTPX.get("http://example.com", addresses: %w[172.5.3.1 172.5.3.2]))
+```
+
+You should also use it to connect to HTTP servers bound to a UNIX socket, in which case you'll have to provide a path:
+
+```ruby
+HTTPX.get("http://example.com", addresses: %w[/path/to/usocket]))
+```
+
+The `:transport_options` are therefore deprecated, and will be moved in a major version.
+
+## Improvements
+
+Some internal improvements that allow certain plugins not to "leak" globally, such as the `:compression` plugin, which used to enable compression for all the `httpx` sessions from the same process. It doesn't anymore.
+
+Using exceptionless nonblocking connect calls in the supported rubies.
+
+Removed unneeded APIs around the Options object (`with_` methods, or the defined options list).
+
+## Bugfixes
+
+HTTP/1.1 persistent connections were closing after each request after the max requests was reached. It's fixed, and the new connection will also be persistent.
+
+When passing open IO objects for origins (the `:io` option), `httpx` was still trying to resolve the origin's domain. This not only didn't make sense, it broke if the domain is unresolvable. It has been fixed.
+
+Fixed usage of `:io` option when passed an "authority/io" hash.
+
+Fixing some issues around trying to connnect to the next available IPAddress when the previous one was unreachable or ETIMEDOUT.

data/doc/release_notes/0_13_1.md

@@ -0,0 +1,5 @@
+# 0.13.1
+
+## Bugfixes
+
+Rescue `Errno::EALREADY` on calls to `connect_nonblock(exception: false)` (there are exceptions after all...).

data/doc/release_notes/0_13_2.md

@@ -0,0 +1,9 @@
+# 0.13.1
+
+## Improvements
+
+`UDPSocket#sendmsg_nonblock` is now used in the native resolver.
+
+## Bugfixes
+
+Usage in Windows was buggy, resulting in `Errno::EINVAL` during DNS resolving, when using the native resolver. This was due to a discrepancy between `recvfrom` behaviour in WS Sockets and Linux Sockets. This was fixed by making we the UDP socket never tries to receive before a DNS query has been actually sent.

data/doc/release_notes/0_14_0.md

@@ -0,0 +1,79 @@
+# 0.14.0
+
+## Features
+
+### GRPC plugin
+
+A new plugin, `:grpc`, is now available. This plugin provides a simple DSL to build GRPC services and performing calls using `httpx` under the hood.
+
+Example:
+
+```ruby
+require "httpx"
+
+grpc = HTTPX.plugin(:grpc)
+helloworld_stub = grpc.build_stub("localhost:4545")
+helloworld_svc = helloworld_stub.rpc(:SayHello, HelloRequest, HelloReply)
+result = helloworld_svc.say_hello(HelloRequest.new(name: "Jack")) #=> HelloReply: "Hello Jack"
+```
+
+You can read more about the `:grpc` plugin in the [wiki](https://honeyryderchuck.gitlab.io/httpx/wiki/GRPC).
+
+### :origin
+
+A new `:origin` option is available. You can use it for setting a base URL for subsequent relative paths on that session:
+
+```ruby
+HTTPX.get("/httpbin/get") #=> HTTPX::Error: invalid URI: /httpbin/get
+
+httpbin = HTTPX.with(origin: "https://nghttp2.org")
+httpbin.get("/httpbin/get") #=> #<Response:5420 HTTP/2.0 @status=200 ....
+```
+
+**Note!** The origin is **not** for setting base paths, i.e. if you pass it a relative path, it'll be filtered out in subsequent requests (`HTTPX.with(origin: "https://nghttp2.org/httpbin")` will still use only `"https://nghttp2.org"`).
+
+## Improvements
+
+* setting an unexpected option will now raise an `HTTPX::Error` with an helpful message, instead of a confusing `NoMethodError`:
+
+```ruby
+HTTPX.with(foo: "bar") 
+# before
+#=> NoMethodError
+# after
+#=> HTTPX::Error: unknown option: foo
+
+```
+
+* `HTTPX::Options#def_option` (which can be used for setting custom plugin options) can now be passed a full body string (where the argument is `value`), although it still support the block form. This is the recommended approach, as the block form is based on `define_method`, which would make clients unusable inside ractors.
+
+* Added support for `:wait_for_handshake` under the `http2_settings` option (`false` by default). HTTP/2 connections complete the protocol handshake before requests are sent. When this option is `true`, requests get send in the initial payload, before the HTTP/2 connection is fully acknowledged.
+
+*  441716a5ac0f7707211ebe0048f568cf0b759c3f: The `:stream` plugin has been improved to start streaming the real response as methods are called (instead of a completely separate synchronous one, which is definitely not good):
+
+```ruby
+session = HTTPX.plugin(:stream)
+response = session.get(build_uri("/stream/3"), stream: true)
+
+# before
+response.status # this could block indefinitely, if the request truly streams infinitely.
+
+# after
+response.status # sends the request, and starts streaming the response until status is available.
+response.each {|chunk|...} # and now you can start yielding the chunks...
+```
+
+
+## Bugfixes
+
+* fixed usage of the `:multipart` if `pathname` isn't loaded.
+* fixed HTTP/2 trailers.
+* fixed connection merges with the same origin, which was causing them to be duplicated and breaking further usage. (#125)
+* fixed repeated session callbacks on a connection, by ensure they're set only once.
+* fixed calculation of `content-length` for streaming or chunked compressed requests.
+
+
+## Chore
+
+* using ruby base container images in CI instead.
+* using truffleruby official container image.

data/doc/release_notes/0_14_1.md

@@ -0,0 +1,7 @@
+# 0.14.0
+
+
+## Bugfixes
+
+* fixed: HTTP/2-specific headers were being reused on insecure redirects, thereby creating an invalid request (#128);
+* fixed: multipart request parts weren't using explicity set `:content_type`, instead using file mime type or "text/plain";

data/lib/httpx.rb

@@ -12,12 +12,11 @@ require "httpx/callbacks"
 require "httpx/loggable"
 require "httpx/registry"
 require "httpx/transcoder"
-require "httpx/options"
-require "httpx/timeout"
 require "httpx/pool"
 require "httpx/headers"
 require "httpx/request"
 require "httpx/response"
+require "httpx/options"
 require "httpx/chainable"
 
 # Top-Level Namespace

data/lib/httpx/callbacks.rb

@@ -6,19 +6,28 @@ module HTTPX
       callbacks(type) << action
     end
 
-    def once(event, &block)
-      on(event) do |*args, &callback|
+    def once(type, &block)
+      on(type) do |*args, &callback|
         block.call(*args, &callback)
         :delete
       end
     end
 
+    def only(type, &block)
+      callbacks(type).clear
+      on(type, &block)
+    end
+
     def emit(type, *args)
-      callbacks(type).delete_if { |pr| pr[*args] == :delete }
+      callbacks(type).delete_if { |pr| :delete == pr[*args] } # rubocop:disable Style/YodaCondition
     end
 
     protected
 
+    def callbacks_for?(type)
+      @callbacks.key?(type) && !@callbacks[type].empty?
+    end
+
     def callbacks(type = nil)
       return @callbacks unless type
 

data/lib/httpx/chainable.rb

@@ -17,12 +17,12 @@ module HTTPX
     # :nocov:
     def timeout(**args)
       warn ":#{__method__} is deprecated, use :with_timeout instead"
-      branch(default_options.with(timeout: args))
+      with(timeout: args)
     end
 
     def headers(headers)
       warn ":#{__method__} is deprecated, use :with_headers instead"
-      branch(default_options.with(headers: headers))
+      with(headers: headers)
     end
     # :nocov:
 

data/lib/httpx/connection.rb

@@ -69,8 +69,10 @@ module HTTPX
       end
 
       @inflight = 0
-      @keep_alive_timeout = options.timeout.keep_alive_timeout
+      @keep_alive_timeout = options.timeout[:keep_alive_timeout]
       @keep_alive_timer = nil
+
+      self.addresses = options.addresses if options.addresses
     end
 
     # this is a semi-private method, to be used by the resolver
@@ -105,6 +107,8 @@ module HTTPX
 
       return false if exhausted?
 
+      return false unless connection.addresses
+
       !(@io.addresses & connection.addresses).empty? && @options == connection.options
     end
 
@@ -125,7 +129,7 @@ module HTTPX
     end
 
     def merge(connection)
-      @origins += connection.instance_variable_get(:@origins)
+      @origins |= connection.instance_variable_get(:@origins)
       connection.purge_pending do |req|
         send(req)
       end
@@ -234,9 +238,9 @@ module HTTPX
     def timeout
       return @timeout if defined?(@timeout)
 
-      return @options.timeout.connect_timeout if @state == :idle
+      return @options.timeout[:connect_timeout] if @state == :idle
 
-      @options.timeout.operation_timeout
+      @options.timeout[:operation_timeout]
     end
 
     private
@@ -409,7 +413,7 @@ module HTTPX
         emit(:exhausted)
       end
       parser.on(:origin) do |origin|
-        @origins << origin
+        @origins |= [origin]
       end
       parser.on(:close) do |force|
         transition(:closing)
@@ -439,6 +443,7 @@ module HTTPX
           emit(:misdirected, request)
         else
           response = ErrorResponse.new(request, ex, @options)
+          request.response = response
           request.emit(:response, response)
         end
       end
@@ -447,7 +452,7 @@ module HTTPX
     def transition(nextstate)
       case nextstate
       when :idle
-        @timeout = @current_timeout = @options.timeout.connect_timeout
+        @timeout = @current_timeout = @options.timeout[:connect_timeout]
 
       when :open
         return if @state == :closed
@@ -459,7 +464,7 @@ module HTTPX
 
         send_pending
 
-        @timeout = @current_timeout = @options.timeout.operation_timeout
+        @timeout = @current_timeout = @options.timeout[:operation_timeout]
         emit(:open)
       when :closing
         return unless @state == :open
@@ -472,26 +477,15 @@ module HTTPX
           remove_instance_variable(:@total_timeout)
         end
 
-        @io.close if @io
-        @read_buffer.clear
-        if @keep_alive_timer
-          @keep_alive_timer.cancel
-          remove_instance_variable(:@keep_alive_timer)
-        end
-
-        remove_instance_variable(:@timeout) if defined?(@timeout)
+        purge_after_closed
       when :already_open
         nextstate = :open
         send_pending
       end
       @state = nextstate
-    rescue Errno::EHOSTUNREACH
-      # at this point, all addresses from the IO object have failed
-      reset
-      emit(:unreachable)
-      throw(:jump_tick)
     rescue Errno::ECONNREFUSED,
            Errno::EADDRNOTAVAIL,
+           Errno::EHOSTUNREACH,
            TLSError => e
       # connect errors, exit gracefully
       handle_error(e)
@@ -499,6 +493,17 @@ module HTTPX
       emit(:close)
     end
 
+    def purge_after_closed
+      @io.close if @io
+      @read_buffer.clear
+      if @keep_alive_timer
+        @keep_alive_timer.cancel
+        remove_instance_variable(:@keep_alive_timer)
+      end
+
+      remove_instance_variable(:@timeout) if defined?(@timeout)
+    end
+
     def handle_response
       @inflight -= 1
       return unless @inflight.zero?
@@ -538,12 +543,14 @@ module HTTPX
     def handle_error(error)
       parser.handle_error(error) if @parser && parser.respond_to?(:handle_error)
       while (request = @pending.shift)
-        request.emit(:response, ErrorResponse.new(request, error, @options))
+        response = ErrorResponse.new(request, error, @options)
+        request.response = response
+        request.emit(:response, response)
       end
     end
 
     def total_timeout
-      total = @options.timeout.total_timeout
+      total = @options.timeout[:total_timeout]
 
       return unless total
 

data/lib/httpx/connection/http1.rb

@@ -10,7 +10,7 @@ module HTTPX
     MAX_REQUESTS = 100
     CRLF = "\r\n"
 
-    attr_reader :pending
+    attr_reader :pending, :requests
 
     def initialize(buffer, options)
       @options = Options.new(options)
@@ -69,7 +69,6 @@ module HTTPX
 
       return if @requests.include?(request)
 
-      request.once(:headers, &method(:set_protocol_headers))
       @requests << request
       @pipelining = true if @requests.size > 1
     end
@@ -236,6 +235,8 @@ module HTTPX
 
     def disable_pipelining
       return if @requests.empty?
+      # do not disable pipelining if already set to 1 request at a time
+      return if @max_concurrent_requests == 1
 
       @requests.each do |r|
         r.transition(:idle)
@@ -253,12 +254,15 @@ module HTTPX
     end
 
     def set_protocol_headers(request)
-      request.headers["host"] ||= request.authority
-      request.headers["connection"] ||= request.options.persistent ? "keep-alive" : "close"
       if !request.headers.key?("content-length") &&
          request.body.bytesize == Float::INFINITY
         request.chunk!
       end
+
+      {
+        "host" => (request.headers["host"] || request.authority),
+        "connection" => (request.headers["connection"] || (request.options.persistent ? "keep-alive" : "close")),
+      }
     end
 
     def headline_uri(request)
@@ -271,22 +275,18 @@ module HTTPX
         join_headers(request) if request.state == :headers
         request.transition(:body)
         join_body(request) if request.state == :body
+        request.transition(:trailers)
+        # HTTP/1.1 trailers should only work for chunked encoding
+        join_trailers(request) if request.body.chunked? && request.state == :trailers
         request.transition(:done)
       end
     end
 
     def join_headers(request)
-      buffer = +""
-      buffer << "#{request.verb.to_s.upcase} #{headline_uri(request)} HTTP/#{@version.join(".")}" << CRLF
-      log(color: :yellow) { "<- HEADLINE: #{buffer.chomp.inspect}" }
-      @buffer << buffer
-      buffer.clear
-      request.headers.each do |field, value|
-        buffer << "#{capitalized(field)}: #{value}" << CRLF
-        log(color: :yellow) { "<- HEADER: #{buffer.chomp}" }
-        @buffer << buffer
-        buffer.clear
-      end
+      @buffer << "#{request.verb.to_s.upcase} #{headline_uri(request)} HTTP/#{@version.join(".")}" << CRLF
+      log(color: :yellow) { "<- HEADLINE: #{@buffer.to_s.chomp.inspect}" }
+      extra_headers = set_protocol_headers(request)
+      join_headers2(request.headers.each(extra_headers))
       log { "<- " }
       @buffer << CRLF
     end
@@ -300,6 +300,26 @@ module HTTPX
         @buffer << chunk
         throw(:buffer_full, request) if @buffer.full?
       end
+
+      raise request.drain_error if request.drain_error
+    end
+
+    def join_trailers(request)
+      return unless request.trailers? && request.callbacks_for?(:trailers)
+
+      join_headers2(request.trailers)
+      log { "<- " }
+      @buffer << CRLF
+    end
+
+    def join_headers2(headers)
+      buffer = "".b
+      headers.each do |field, value|
+        buffer << "#{capitalized(field)}: #{value}" << CRLF
+        log(color: :yellow) { "<- HEADER: #{buffer.chomp}" }
+        @buffer << buffer
+        buffer.clear
+      end
     end
 
     UPCASED = {