httpx 0.13.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35006c293d6a61a011056400a7934619b869ad32d9287507df8140bc9afd83fb
-  data.tar.gz: 62152c1c7cc0f7f330396f8e5967b4430226ba50466d6c9c829a52d4eb4902f8
+  metadata.gz: abbeaccc55115244f08e7b39aaad174a34dd2e7aeb10b32cdc0563fbefe1b953
+  data.tar.gz: a39fc4e5644b21c1265840011e969c36904756573584cba0f805d568a549ec94
 SHA512:
-  metadata.gz: 3aef9a00cb4861ae3c4bcf32af947d5c66b9e5bdf545e2cdae30733454a3c140704e36f138857868b4c564c59bb95e16ee0fc4a33500e4035a4c872f4f78421e
-  data.tar.gz: a1d55b77708ada85b1ec14575ee441369cbe302d7a13e316d3f91efbf8b64a6b2c8cabaa06329759a07190858f271df88462622a2bcddd598823a7d55de61c28
+  metadata.gz: 82fa475dcd9ef05ebe90f0b3c742c17c33185410a70eb5af730fce393681b7f9f346decf78349614f77b76257550c0e3056e61f3b5d6cd5efdba0149eff235f6
+  data.tar.gz: 64ceb596415b440c99c9df31569fa0ee2f7c94e51787d5e0d84141f1ade0be92e23e2d7011a361c1366b43c4f159525599367009bd4021c358537f11c4605cac

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

@@ -41,7 +41,7 @@ The `:transport_options` are therefore deprecated, and will be moved in a major
 
 ## Improvements
 
-Some internal improvements that allow certainn 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.
+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.
 
@@ -55,4 +55,4 @@ When passing open IO objects for origins (the `:io` option), `httpx` was still t
 
 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.
+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

@@ -2,4 +2,4 @@
 
 ## Bugfixes
 
-Rescue `Errno::EALREADY` on calls to `connect_nonblock(exception: false)` (there are exceptionns after all...).
+Rescue `Errno::EALREADY` on calls to `connect_nonblock(exception: false)` (there are exceptions after all...).

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

@@ -69,7 +69,7 @@ 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
@@ -129,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
@@ -238,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
@@ -413,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)
@@ -443,6 +443,7 @@ module HTTPX
           emit(:misdirected, request)
         else
           response = ErrorResponse.new(request, ex, @options)
+          request.response = response
           request.emit(:response, response)
         end
       end
@@ -451,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
@@ -463,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
@@ -542,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

@@ -272,23 +272,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
+      @buffer << "#{request.verb.to_s.upcase} #{headline_uri(request)} HTTP/#{@version.join(".")}" << CRLF
+      log(color: :yellow) { "<- HEADLINE: #{@buffer.to_s.chomp.inspect}" }
       set_protocol_headers(request)
-      request.headers.each do |field, value|
-        buffer << "#{capitalized(field)}: #{value}" << CRLF
-        log(color: :yellow) { "<- HEADER: #{buffer.chomp}" }
-        @buffer << buffer
-        buffer.clear
-      end
+      join_headers2(request.headers)
       log { "<- " }
       @buffer << CRLF
     end
@@ -302,6 +297,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 = {

data/lib/httpx/connection/http2.rb

@@ -21,14 +21,16 @@ module HTTPX
 
     def initialize(buffer, options)
       @options = Options.new(options)
-      @max_concurrent_requests = @options.max_concurrent_requests || MAX_CONCURRENT_REQUESTS
-      @max_requests = @options.max_requests || 0
+      @settings = @options.http2_settings
       @pending = []
       @streams = {}
       @drains  = {}
       @pings = []
       @buffer = buffer
       @handshake_completed = false
+      @wait_for_handshake = @settings.key?(:wait_for_handshake) ? @settings.delete(:wait_for_handshake) : true
+      @max_concurrent_requests = @options.max_concurrent_requests || MAX_CONCURRENT_REQUESTS
+      @max_requests = @options.max_requests || 0
       init_connection
     end
 
@@ -36,7 +38,11 @@ module HTTPX
       # waiting for WINDOW_UPDATE frames
       return :r if @buffer.full?
 
-      return :w if @connection.state == :closed
+      if @connection.state == :closed
+        return unless @handshake_completed
+
+        return :w
+      end
 
       unless (@connection.state == :connected && @handshake_completed)
         return @buffer.empty? ? :r : :rw
@@ -75,9 +81,13 @@ module HTTPX
     end
 
     def can_buffer_more_requests?
-      @handshake_completed &&
+      if @handshake_completed
         @streams.size < @max_concurrent_requests &&
-        @streams.size < @max_requests
+          @streams.size < @max_requests
+      else
+        !@wait_for_handshake &&
+          @streams.size < @max_concurrent_requests
+      end
     end
 
     def send(request)
@@ -140,12 +150,14 @@ module HTTPX
         join_headers(stream, request) if request.state == :headers
         request.transition(:body)
         join_body(stream, request) if request.state == :body
+        request.transition(:trailers)
+        join_trailers(stream, request) if request.state == :trailers && !request.body.empty?
         request.transition(:done)
       end
     end
 
     def init_connection
-      @connection = HTTP2Next::Client.new(@options.http2_settings)
+      @connection = HTTP2Next::Client.new(@settings)
       @connection.max_streams = @max_requests if @connection.respond_to?(:max_streams=) && @max_requests.positive?
       @connection.on(:frame, &method(:on_frame))
       @connection.on(:frame_sent, &method(:on_frame_sent))
@@ -169,6 +181,7 @@ module HTTPX
     public :reset
 
     def handle_stream(stream, request)
+      request.on(:refuse, &method(:on_stream_refuse).curry(3)[stream, request])
       stream.on(:close, &method(:on_stream_close).curry(3)[stream, request])
       stream.on(:half_close) do
         log(level: 2) { "#{stream.id}: waiting for response..." }
@@ -193,6 +206,18 @@ module HTTPX
       stream.headers(request.headers.each, end_stream: request.empty?)
     end
 
+    def join_trailers(stream, request)
+      unless request.trailers?
+        stream.data("", end_stream: true) if request.callbacks_for?(:trailers)
+        return
+      end
+
+      log(level: 1, color: :yellow) do
+        request.trailers.each.map { |k, v| "#{stream.id}: -> HEADER: #{k}: #{v}" }.join("\n")
+      end
+      stream.headers(request.trailers.each, end_stream: true)
+    end
+
     def join_body(stream, request)
       return if request.empty?
 
@@ -201,13 +226,15 @@ module HTTPX
         next_chunk = request.drain_body
         log(level: 1, color: :green) { "#{stream.id}: -> DATA: #{chunk.bytesize} bytes..." }
         log(level: 2, color: :green) { "#{stream.id}: -> #{chunk.inspect}" }
-        stream.data(chunk, end_stream: !next_chunk)
-        if next_chunk && @buffer.full?
+        stream.data(chunk, end_stream: !(next_chunk || request.trailers? || request.callbacks_for?(:trailers)))
+        if next_chunk && (@buffer.full? || request.body.unbounded_body?)
           @drains[request] = next_chunk
           throw(:buffer_full)
         end
         chunk = next_chunk
       end
+
+      on_stream_refuse(stream, request, request.drain_error) if request.drain_error
     end
 
     ######
@@ -215,6 +242,11 @@ module HTTPX
     ######
 
     def on_stream_headers(stream, request, h)
+      if request.response && request.response.version == "2.0"
+        on_stream_trailers(stream, request, h)
+        return
+      end
+
       log(color: :yellow) do
         h.map { |k, v| "#{stream.id}: <- HEADER: #{k}: #{v}" }.join("\n")
       end
@@ -227,12 +259,24 @@ module HTTPX
       handle(request, stream) if request.expects?
     end
 
+    def on_stream_trailers(stream, request, h)
+      log(color: :yellow) do
+        h.map { |k, v| "#{stream.id}: <- HEADER: #{k}: #{v}" }.join("\n")
+      end
+      request.response.merge_headers(h)
+    end
+
     def on_stream_data(stream, request, data)
       log(level: 1, color: :green) { "#{stream.id}: <- DATA: #{data.bytesize} bytes..." }
       log(level: 2, color: :green) { "#{stream.id}: <- #{data.inspect}" }
       request.response << data
     end
 
+    def on_stream_refuse(stream, request, error)
+      stream.close
+      on_stream_close(stream, request, error)
+    end
+
     def on_stream_close(stream, request, error)
       log(level: 2) { "#{stream.id}: closing stream" }
       @drains.delete(request)