httpx 1.1.4 → 1.2.0

data/lib/httpx/session.rb

@@ -8,7 +8,6 @@ module HTTPX
   class Session
     include Loggable
     include Chainable
-    include Callbacks
 
     EMPTY_HASH = {}.freeze
 
@@ -85,33 +84,7 @@ module HTTPX
       options = @options.merge(options) unless options.is_a?(Options)
       request = rklass.new(verb, uri, options)
       request.persistent = @persistent
-      request.on(:response, &method(:on_response).curry(2)[request])
-      request.on(:promise, &method(:on_promise))
-
-      request.on(:headers) do
-        emit(:request_started, request)
-      end
-      request.on(:body_chunk) do |chunk|
-        emit(:request_body_chunk, request, chunk)
-      end
-      request.on(:done) do
-        emit(:request_completed, request)
-      end
-
-      request.on(:response_started) do |res|
-        if res.is_a?(Response)
-          emit(:response_started, request, res)
-          res.on(:chunk_received) do |chunk|
-            emit(:response_body_chunk, request, res, chunk)
-          end
-        else
-          emit(:request_error, request, res.error)
-        end
-      end
-      request.on(:response) do |res|
-        emit(:response_completed, request, res)
-      end
-
+      set_request_callbacks(request)
       request
     end
 
@@ -143,7 +116,7 @@ module HTTPX
     def find_connection(request, connections, options)
       uri = request.uri
 
-      connection = pool.find_connection(uri, options) || build_connection(uri, options)
+      connection = pool.find_connection(uri, options) || init_connection(uri, options)
       unless connections.nil? || connections.include?(connection)
         connections << connection
         set_connection_callbacks(connection, connections, options)
@@ -179,15 +152,6 @@ module HTTPX
         other_connection = build_altsvc_connection(connection, connections, alt_origin, origin, alt_params, options)
         connections << other_connection if other_connection
       end
-      connection.only(:exhausted) do
-        other_connection = connection.create_idle
-        other_connection.merge(connection)
-        catch(:coalesced) do
-          pool.init_connection(other_connection, options)
-        end
-        set_connection_callbacks(other_connection, connections, options)
-        connections << other_connection
-      end
     end
 
     # returns an HTTPX::Connection for the negotiated Alternative Service (or none).
@@ -202,24 +166,19 @@ module HTTPX
 
       alt_options = options.merge(ssl: options.ssl.merge(hostname: URI(origin).host))
 
-      connection = pool.find_connection(alt_origin, alt_options) || build_connection(alt_origin, alt_options)
+      connection = pool.find_connection(alt_origin, alt_options) || init_connection(alt_origin, alt_options)
+
       # advertised altsvc is the same origin being used, ignore
       return if connection == existing_connection
 
+      connection.extend(AltSvc::ConnectionMixin) unless connection.is_a?(AltSvc::ConnectionMixin)
+
       set_connection_callbacks(connection, connections, alt_options)
 
       log(level: 1) { "#{origin} alt-svc: #{alt_origin}" }
 
-      # get uninitialized requests
-      # incidentally, all requests will be re-routed to the first
-      # advertised alt-svc, which incidentally follows the spec.
-      existing_connection.purge_pending do |request|
-        request.origin == origin &&
-          request.state == :idle &&
-          !request.headers.key?("alt-used")
-      end
-
       connection.merge(existing_connection)
+      existing_connection.terminate
       connection
     rescue UnsupportedSchemeError
       altsvc["noop"] = true
@@ -250,30 +209,13 @@ module HTTPX
       requests
     end
 
-    # returns a new HTTPX::Connection object for the given +uri+ and set of +options+.
-    def build_connection(uri, options)
-      type = options.transport || begin
-        case uri.scheme
-        when "http"
-          "tcp"
-        when "https"
-          "ssl"
-        else
-          raise UnsupportedSchemeError, "#{uri}: #{uri.scheme}: unsupported URI scheme"
-        end
-      end
-      init_connection(type, uri, options)
+    def set_request_callbacks(request)
+      request.on(:response, &method(:on_response).curry(2)[request])
+      request.on(:promise, &method(:on_promise))
     end
 
-    def init_connection(type, uri, options)
-      connection = options.connection_class.new(type, uri, options)
-      connection.on(:open) do
-        emit(:connection_opened, connection.origin, connection.io.socket)
-        # only run close callback if it opened
-      end
-      connection.on(:close) do
-        emit(:connection_closed, connection.origin, connection.io.socket) if connection.used?
-      end
+    def init_connection(uri, options)
+      connection = options.connection_class.new(uri, options)
       catch(:coalesced) do
         pool.init_connection(connection, options)
         connection
@@ -369,19 +311,8 @@ module HTTPX
           extend(pl::ClassMethods) if defined?(pl::ClassMethods)
 
           opts = @default_options
-          opts.request_class.__send__(:include, pl::RequestMethods) if defined?(pl::RequestMethods)
-          opts.request_class.extend(pl::RequestClassMethods) if defined?(pl::RequestClassMethods)
-          opts.response_class.__send__(:include, pl::ResponseMethods) if defined?(pl::ResponseMethods)
-          opts.response_class.extend(pl::ResponseClassMethods) if defined?(pl::ResponseClassMethods)
-          opts.headers_class.__send__(:include, pl::HeadersMethods) if defined?(pl::HeadersMethods)
-          opts.headers_class.extend(pl::HeadersClassMethods) if defined?(pl::HeadersClassMethods)
-          opts.request_body_class.__send__(:include, pl::RequestBodyMethods) if defined?(pl::RequestBodyMethods)
-          opts.request_body_class.extend(pl::RequestBodyClassMethods) if defined?(pl::RequestBodyClassMethods)
-          opts.response_body_class.__send__(:include, pl::ResponseBodyMethods) if defined?(pl::ResponseBodyMethods)
-          opts.response_body_class.extend(pl::ResponseBodyClassMethods) if defined?(pl::ResponseBodyClassMethods)
-          opts.connection_class.__send__(:include, pl::ConnectionMethods) if defined?(pl::ConnectionMethods)
+          opts.extend_with_plugin_classes(pl)
           if defined?(pl::OptionsMethods)
-            opts.options_class.__send__(:include, pl::OptionsMethods)
 
             (pl::OptionsMethods.instance_methods - Object.instance_methods).each do |meth|
               opts.options_class.method_added(meth)

data/lib/httpx/timers.rb

@@ -81,16 +81,9 @@ module HTTPX
         @callbacks << callback
       end
 
-      if RUBY_ENGINE == "jruby" && JRUBY_VERSION < "9.4.5.0"
-        # https://github.com/jruby/jruby/issues/7976
-        def delete(callback)
-          @callbacks.delete(callback)
-        end
-      else
-        def delete(callback)
-          @callbacks.delete(callback)
-          @on_empty.call if @callbacks.empty?
-        end
+      def delete(callback)
+        @callbacks.delete(callback)
+        @on_empty.call if @callbacks.empty?
       end
 
       def no_callbacks?

data/lib/httpx/transcoder.rb

@@ -5,7 +5,7 @@ module HTTPX
     module_function
 
     def normalize_keys(key, value, cond = nil, &block)
-      if (cond && cond.call(value))
+      if cond && cond.call(value)
         block.call(key.to_s, value)
       elsif value.respond_to?(:to_ary)
         if value.empty?

data/lib/httpx/version.rb

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

data/sig/altsvc.rbs

@@ -0,0 +1,33 @@
+module HTTPX
+  module AltSvc
+    module ConnectionMixin
+
+      def send: (Request request) -> void
+
+      def match?: (URI::Generic uri, Options options) -> bool
+
+      private
+
+      def match_altsvcs?: (URI::Generic uri) -> bool
+
+      def match_altsvc_options?: (URI::Generic uri, Options options) -> bool
+    end
+
+    type altsvc_params = Hash[String, untyped]
+
+    def self?.cached_altsvc: (String origin) -> Array[altsvc_params]
+
+    def self?.cached_altsvc_set: (String origin, altsvc_params) -> void
+
+    def self?.lookup: (String origin, Integer | Float ttl) -> Array[altsvc_params]
+
+    def self?.emit: (Request request, response response) { (http_uri alt_origin, String origin, altsvc_params alt_params) -> void } -> void
+
+    def self?.parse: (String altsvc) { (http_uri alt_origin, altsvc_params alt_params) -> void } -> void
+                   | (String altsvc) -> Enumerable[[http_uri, altsvc_params]]
+
+    def self?.parse_altsvc_scheme: (String alt_proto) -> String?
+
+    def self.parse_altsvc_origin: (string alt_proto, String alt_origin) -> http_uri?
+  end
+end

data/sig/chainable.rbs

@@ -34,6 +34,7 @@ module HTTPX
               | (:response_cache, ?options) -> Plugins::sessionResponseCache
               | (:circuit_breaker, ?options) -> Plugins::sessionCircuitBreaker
               | (:oauth, ?options) -> Plugins::sessionOAuth
+              | (:callbacks, ?options) -> Plugins::sessionCallbacks
               | (Symbol | Module, ?options) { (Class) -> void } -> Session
               | (Symbol | Module, ?options) -> Session
 

data/sig/connection/http1.rbs

@@ -10,8 +10,9 @@ module HTTPX
     attr_reader pending: Array[Request]
     attr_reader requests: Array[Request]
 
+    attr_accessor max_concurrent_requests: Integer
+
     @options: Options
-    @max_concurrent_requests: Integer
     @max_requests: Integer
     @parser: Parser::HTTP1
     @buffer: Buffer

data/sig/connection.rbs

@@ -44,25 +44,23 @@ module HTTPX
 
     def addresses: () -> Array[ipaddr]?
 
-    def addresses=: (Array[ipaddr]) -> void
+    def addresses=: (Array[ipaddr] addresses) -> void
+
+    def send: (Request request) -> void
 
     def match?: (URI::Generic uri, Options options) -> bool
 
     def expired?: () -> boolish
 
-    def mergeable?: (Connection) -> bool
+    def mergeable?: (Connection connection) -> bool
 
-    def coalescable?: (Connection) -> bool
+    def coalescable?: (Connection connection) -> bool
 
     def create_idle: (?Hash[Symbol, untyped] options) -> Connection
 
-    def merge: (Connection) -> void
-
-    def purge_pending: () { (Request) -> void } -> void
-
-    def match_altsvcs?: (URI::Generic uri) -> bool
+    def merge: (Connection connection) -> void
 
-    def match_altsvc_options?: (URI::Generic uri, Options options) -> bool
+    def purge_pending: () { (Request request) -> void } -> void
 
     def connecting?: () -> bool
 
@@ -74,12 +72,12 @@ module HTTPX
 
     def call: () -> void
 
+    def terminate: () -> void
+
     def close: () -> void
 
     def reset: () -> void
 
-    def send: (Request) -> void
-
     def timeout: () -> Numeric?
 
     def idling: () -> void
@@ -94,7 +92,9 @@ module HTTPX
 
     private
 
-    def initialize: (io_type, URI::Generic, options) -> untyped
+    def initialize: (URI::Generic uri, options) -> void
+
+    def initialize_type: (URI::Generic uri, options) -> io_type
 
     def connect: () -> void
 
@@ -112,15 +112,15 @@ module HTTPX
 
     def set_parser_callbacks: (HTTP1 | HTTP2 parser) -> void
 
-    def transition: (Symbol) -> void
+    def transition: (Symbol nextstate) -> void
 
-    def handle_transition: (Symbol) -> void
+    def handle_transition: (Symbol nextstate) -> void
 
     def build_socket: (?Array[ipaddr]? addrs) -> (TCP | SSL | UNIX)
 
-    def on_error: (HTTPX::TimeoutError | Error | StandardError) -> void
+    def on_error: (HTTPX::TimeoutError | Error | StandardError error) -> void
 
-    def handle_error: (StandardError) -> void
+    def handle_error: (StandardError error) -> void
 
     def purge_after_closed: () -> void
 

data/sig/options.rbs

@@ -9,9 +9,11 @@ module HTTPX
     OPERATION_TIMEOUT: Integer
     KEEP_ALIVE_TIMEOUT: Integer
     SETTINGS_TIMEOUT: Integer
+    CLOSE_HANDSHAKE_TIMEOUT: Integer
     DEFAULT_OPTIONS: Hash[Symbol, untyped]
+    REQUEST_BODY_IVARS: Array[Symbol]
 
-    type timeout_type = :connect_timeout | :settings_timeout | :operation_timeout | :keep_alive_timeout | :read_timeout | :write_timeout | :request_timeout
+    type timeout_type = :connect_timeout | :settings_timeout | :close_handshake_timeout | :operation_timeout | :keep_alive_timeout | :read_timeout | :write_timeout | :request_timeout
     type timeout = Hash[timeout_type, Numeric?]
 
     def self.new: (?options) -> instance
@@ -120,10 +122,16 @@ module HTTPX
     # ip_families
     attr_reader ip_families: Array[ip_family]
 
-    def ==: (untyped other) -> bool
+    def ==: (Options other) -> bool
+
+    def options_equals?: (Options other, ?Array[Symbol] ignore_ivars) -> bool
+
     def merge: (_ToHash[Symbol, untyped] other) -> instance
+
     def to_hash: () -> Hash[Symbol, untyped]
 
+    def extend_with_plugin_classes: (Module pl) -> void
+
     private
 
     REQUEST_IVARS: Array[Symbol]

data/sig/plugins/callbacks.rbs

@@ -0,0 +1,38 @@
+module HTTPX
+  module Plugins
+    module Callbacks
+      class CallbackError < Exception
+      end
+
+      module InstanceMethods
+        include HTTPX::Callbacks
+
+        type socket = TCPSocket | SSLSocket | UNIXSocket
+
+        def on_connection_opened: () { (http_uri origin, socket sock) -> void } -> self
+
+        def on_connection_closed: () { (http_uri origin) -> void } -> self
+
+        def on_request_error: () { (Request request, StandardError error) -> void } -> self
+
+        def on_request_started: () { (Request request) -> void } -> self
+
+        def on_request_body_chunk: () { (Request request, String chunk) -> void } -> self
+
+        def on_request_completed: () { (Request request) -> void } -> self
+
+        def on_response_started: () { (Request request, Response response) -> void } -> self
+
+        def on_response_body_chunk: () { (Request request, Response response, String chunk) -> void } -> self
+
+        def on_response_completed: () { (Request request, response response) -> void } -> self
+
+        private
+
+        def emit_or_callback_error: (*untyped) -> void
+      end
+    end
+
+    type sessionCallbacks = Session & Callbacks::InstanceMethods
+  end
+end

data/sig/plugins/cookies.rbs

@@ -5,6 +5,8 @@ module HTTPX
 
       interface _CookieOptions
         def cookies: () -> Jar?
+
+        def merge_cookie_in_jar: (Array[String] cookies, Jar jar) -> void
       end
 
       def self.extra_options: (Options) -> (Options & _CookieOptions)

data/sig/plugins/follow_redirects.rbs

@@ -12,6 +12,8 @@ module HTTPX
         def follow_insecure_redirects: () -> bool?
 
         def allow_auth_to_other_origins: () -> bool?
+
+        def redirect_on: (http_uri) -> bool?
       end
 
       def self.extra_options: (Options) -> (Options & _FollowRedirectsOptions)

data/sig/plugins/proxy/socks4.rbs

@@ -1,5 +1,6 @@
 module HTTPX
-  Socks4Error: singleton(Error)
+  class Socks4Error < HTTPProxyError
+  end
 
   module Plugins
     module Proxy

data/sig/plugins/proxy/socks5.rbs

@@ -1,5 +1,6 @@
 module HTTPX
-  Socks5Error: singleton(Error)
+  class Socks5Error < HTTPProxyError
+  end
 
   module Plugins
     module Proxy

data/sig/plugins/proxy.rbs

@@ -1,5 +1,8 @@
 module HTTPX
-  class HTTPProxyError < Error
+  class HTTPProxyError < ConnectionError
+  end
+
+  class ProxySSL < SSL
   end
 
   module Plugins
@@ -36,6 +39,13 @@ module HTTPX
 
       module InstanceMethods
         @__proxy_uris: Array[generic_uri]
+
+        private
+
+        def proxy_error?: (Request request, response) -> bool
+      end
+
+      module ConnectionMethods
       end
     end
 

data/sig/plugins/stream.rbs

@@ -1,26 +1,4 @@
 module HTTPX
-  class StreamResponse
-    include _ToS
-
-    @request: Request & RequestMethods
-    @session: sessionStream
-    @on_chunk: ^(String) -> void | nil
-
-    def each: () { (String) -> void } -> void
-            | () -> Enumerable[String]
-
-    def each_line: () { (String) -> void } -> void
-                 | () -> Enumerable[String]
-
-    def on_chunk: (string) -> void
-
-    def initialize: (Request, Session) -> void
-
-    private
-
-    def response: () -> response
-  end
-
   module Plugins
     module Stream
       module InstanceMethods
@@ -42,4 +20,28 @@ module HTTPX
 
     type sessionStream = Session & Stream::InstanceMethods
   end
+
+  class StreamResponse
+    include _ToS
+
+    type streamRequest = Request & Plugins::Stream::RequestMethods
+
+    @request: streamRequest
+    @session: Plugins::sessionStream
+    @on_chunk: ^(String) -> void | nil
+
+    def each: () { (String) -> void } -> void
+            | () -> Enumerable[String]
+
+    def each_line: () { (String) -> void } -> void
+                 | () -> Enumerable[String]
+
+    def on_chunk: (string) -> void
+
+    def initialize: (streamRequest, Plugins::sessionStream) -> void
+
+    private
+
+    def response: () -> response
+  end
 end

data/sig/pool.rbs

@@ -6,8 +6,6 @@ module HTTPX
     @timers: Timers
     @selector: Selector
     @connections: Array[Connection]
-    @eden_connections: Array[Connection]
-    @connected_connections: Integer
 
     def empty?: () -> void
 
@@ -37,7 +35,7 @@ module HTTPX
 
     def register_connection: (Connection) -> void
 
-    def unregister_connection: (Connection) -> void
+    def unregister_connection: (Connection, ?bool cleanup) -> void
 
     def select_connection: (Selector::selectable) -> void
 

data/sig/resolver/resolver.rbs

@@ -14,6 +14,8 @@ module HTTPX
 
       def close: () -> void
 
+      alias terminate close
+
       def closed?: () -> bool
 
       def empty?: () -> bool
@@ -22,7 +24,7 @@ module HTTPX
 
       private
 
-      def emit_resolved_connection: (Connection connection, Array[IPAddr] addresses) -> void
+      def emit_resolved_connection: (Connection connection, Array[IPAddr] addresses, bool early_resolve) -> void
 
       def initialize: (ip_family? family, options options) -> void
 

data/sig/session.rbs

@@ -33,7 +33,9 @@ module HTTPX
 
     def set_connection_callbacks: (Connection connection, Array[Connection] connections, Options options) -> void
 
-    def build_altsvc_connection: (Connection existing_connection, Array[Connection] connections, URI::Generic alt_origin, String origin, Hash[String, String] alt_params, Options options) -> Connection?
+    def set_request_callbacks: (Request request) -> void
+
+    def build_altsvc_connection: (Connection existing_connection, Array[Connection] connections, URI::Generic alt_origin, String origin, Hash[String, String] alt_params, Options options) -> (Connection & AltSvc::ConnectionMixin)?
 
     def build_requests: (verb, uri, options) -> Array[Request]
                       | (Array[[verb, uri, options]], options) -> Array[Request]
@@ -41,9 +43,7 @@ module HTTPX
                       | (verb, _Each[[uri, options]], Options) -> Array[Request]
                       | (verb, _Each[uri], options) -> Array[Request]
 
-    def build_connection: (URI::HTTP | URI::HTTP uri, Options options) -> Connection
-
-    def init_connection: (String type, URI::HTTP | URI::HTTP uri, Options options) -> Connection
+    def init_connection: (URI::HTTP | URI::HTTP uri, Options options) -> Connection
 
     def send_requests: (*Request) -> Array[response]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2-next
@@ -136,6 +136,8 @@ extra_rdoc_files:
 - doc/release_notes/1_1_2.md
 - doc/release_notes/1_1_3.md
 - doc/release_notes/1_1_4.md
+- doc/release_notes/1_1_5.md
+- doc/release_notes/1_2_0.md
 files:
 - LICENSE.txt
 - README.md
@@ -243,6 +245,8 @@ files:
 - doc/release_notes/1_1_2.md
 - doc/release_notes/1_1_3.md
 - doc/release_notes/1_1_4.md
+- doc/release_notes/1_1_5.md
+- doc/release_notes/1_2_0.md
 - lib/httpx.rb
 - lib/httpx/adapters/datadog.rb
 - lib/httpx/adapters/faraday.rb
@@ -277,6 +281,7 @@ files:
 - lib/httpx/plugins/aws_sigv4.rb
 - lib/httpx/plugins/basic_auth.rb
 - lib/httpx/plugins/brotli.rb
+- lib/httpx/plugins/callbacks.rb
 - lib/httpx/plugins/circuit_breaker.rb
 - lib/httpx/plugins/circuit_breaker/circuit.rb
 - lib/httpx/plugins/circuit_breaker/circuit_store.rb
@@ -307,6 +312,7 @@ files:
 - lib/httpx/plugins/response_cache/file_store.rb
 - lib/httpx/plugins/response_cache/store.rb
 - lib/httpx/plugins/retries.rb
+- lib/httpx/plugins/ssrf_filter.rb
 - lib/httpx/plugins/stream.rb
 - lib/httpx/plugins/upgrade.rb
 - lib/httpx/plugins/upgrade/h2.rb
@@ -348,6 +354,7 @@ files:
 - lib/httpx/transcoder/xml.rb
 - lib/httpx/utils.rb
 - lib/httpx/version.rb
+- sig/altsvc.rbs
 - sig/buffer.rbs
 - sig/callbacks.rbs
 - sig/chainable.rbs
@@ -375,6 +382,7 @@ files:
 - sig/plugins/aws_sigv4.rbs
 - sig/plugins/basic_auth.rbs
 - sig/plugins/brotli.rbs
+- sig/plugins/callbacks.rbs
 - sig/plugins/circuit_breaker.rbs
 - sig/plugins/compression.rbs
 - sig/plugins/cookies.rbs
@@ -435,8 +443,8 @@ licenses:
 - Apache 2.0
 metadata:
   bug_tracker_uri: https://gitlab.com/os85/httpx/issues
-  changelog_uri: https://os85.gitlab.io/httpx/#release-notes
-  documentation_uri: https://os85.gitlab.io/httpx/rdoc/
+  changelog_uri: https://honeyryderchuck.gitlab.io/httpx/#release-notes
+  documentation_uri: https://honeyryderchuck.gitlab.io/httpx/rdoc/
   source_code_uri: https://gitlab.com/os85/httpx
   homepage_uri: https://honeyryderchuck.gitlab.io/httpx/
   rubygems_mfa_required: 'true'