httpx 0.17.0 → 0.18.0

data/lib/httpx/resolver/https.rb

@@ -24,7 +24,9 @@ module HTTPX
       record_types: RECORD_TYPES.keys,
     }.freeze
 
-    def_delegators :@resolver_connection, :connecting?, :to_io, :call, :close
+    def_delegators :@resolver_connection, :state, :connecting?, :to_io, :call, :close
+
+    attr_writer :pool
 
     def initialize(options)
       @options = Options.new(options)
@@ -63,15 +65,11 @@ module HTTPX
 
     private
 
-    def pool
-      Thread.current[:httpx_connection_pool] ||= Pool.new
-    end
-
     def resolver_connection
-      @resolver_connection ||= pool.find_connection(@uri, @options) || begin
+      @resolver_connection ||= @pool.find_connection(@uri, @options) || begin
         @building_connection = true
         connection = @options.connection_class.new("ssl", @uri, @options.merge(ssl: { alpn_protocols: %w[h2] }))
-        pool.init_connection(connection, @options)
+        @pool.init_connection(connection, @options)
         emit_addresses(connection, @uri_addresses)
         @building_connection = false
         connection

data/lib/httpx/resolver/native.rb

@@ -47,6 +47,8 @@ module HTTPX
 
     def_delegator :@connections, :empty?
 
+    attr_reader :state
+
     def initialize(options)
       @options = Options.new(options)
       @ns_index = 0
@@ -120,7 +122,7 @@ module HTTPX
     def timeout
       return if @connections.empty?
 
-      @start_timeout = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @start_timeout = Utils.now
       hosts = @queries.keys
       @timeouts.values_at(*hosts).reject(&:empty?).map(&:first).min
     end
@@ -140,7 +142,7 @@ module HTTPX
     def do_retry
       return if @queries.empty?
 
-      loop_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @start_timeout
+      loop_time = Utils.elapsed_time(@start_timeout)
       connections = []
       queries = {}
       while (query = @queries.shift)

data/lib/httpx/resolver/system.rb

@@ -12,6 +12,8 @@ module HTTPX
                      Resolv::DNS::EncodeError,
                      Resolv::DNS::DecodeError].freeze
 
+    attr_reader :state
+
     def initialize(options)
       @options = Options.new(options)
       @resolver_options = @options.resolver_options

data/lib/httpx/resolver.rb

@@ -26,14 +26,14 @@ module HTTPX
     module_function
 
     def cached_lookup(hostname)
-      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      now = Utils.now
       @lookup_mutex.synchronize do
         lookup(hostname, now)
       end
     end
 
     def cached_lookup_set(hostname, entries)
-      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      now = Utils.now
       entries.each do |entry|
         entry["TTL"] += now
       end

data/lib/httpx/response.rb

@@ -57,17 +57,23 @@ module HTTPX
     # :nocov:
     def inspect
       "#<Response:#{object_id} "\
-      "HTTP/#{version} " \
-      "@status=#{@status} " \
-      "@headers=#{@headers} " \
-      "@body=#{@body.bytesize}>"
+        "HTTP/#{version} " \
+        "@status=#{@status} " \
+        "@headers=#{@headers} " \
+        "@body=#{@body.bytesize}>"
     end
     # :nocov:
 
-    def raise_for_status
+    def error
       return if @status < 400
 
-      raise HTTPError, self
+      HTTPError.new(self)
+    end
+
+    def raise_for_status
+      return self unless (err = error)
+
+      raise err
     end
 
     def json(options = nil)
@@ -211,18 +217,20 @@ module HTTPX
       end
 
       def ==(other)
-        if other.respond_to?(:read)
-          _with_same_buffer_pos { FileUtils.compare_stream(@buffer, other) }
-        else
-          to_s == other.to_s
+        object_id == other.object_id || begin
+          if other.respond_to?(:read)
+            _with_same_buffer_pos { FileUtils.compare_stream(@buffer, other) }
+          else
+            to_s == other.to_s
+          end
         end
       end
 
       # :nocov:
       def inspect
         "#<HTTPX::Response::Body:#{object_id} " \
-        "@state=#{@state} " \
-        "@length=#{@length}>"
+          "@state=#{@state} " \
+          "@length=#{@length}>"
       end
       # :nocov:
 
@@ -311,17 +319,18 @@ module HTTPX
     end
 
     def status
+      warn ":#{__method__} is deprecated, use :error.message instead"
       @error.message
     end
 
     if Exception.method_defined?(:full_message)
       def to_s
-        @error.full_message
+        @error.full_message(highlight: false)
       end
     else
       def to_s
         "#{@error.message} (#{@error.class})\n" \
-        "#{@error.backtrace.join("\n") if @error.backtrace}"
+          "#{@error.backtrace.join("\n") if @error.backtrace}"
       end
     end
 

data/lib/httpx/selector.rb

@@ -2,20 +2,6 @@
 
 require "io/wait"
 
-module IOExtensions
-  refine IO do
-    # provides a fallback for rubies where IO#wait isn't implemented,
-    # but IO#wait_readable and IO#wait_writable are.
-    def wait(timeout = nil, _mode = :read_write)
-      r, w = IO.select([self], [self], nil, timeout)
-
-      return unless r || w
-
-      self
-    end
-  end
-end
-
 class HTTPX::Selector
   READABLE = %i[rw r].freeze
   WRITABLE = %i[rw w].freeze
@@ -23,7 +9,7 @@ class HTTPX::Selector
   private_constant :READABLE
   private_constant :WRITABLE
 
-  using IOExtensions unless IO.method_defined?(:wait) && IO.instance_method(:wait).arity == 2
+  using HTTPX::IOExtensions
 
   def initialize
     @selectables = []
@@ -58,11 +44,13 @@ class HTTPX::Selector
           selectables = @selectables
           @selectables = []
 
-          selectables.each do |io|
+          selectables.delete_if do |io|
             interests = io.interests
 
             (r ||= []) << io if READABLE.include?(interests)
             (w ||= []) << io if WRITABLE.include?(interests)
+
+            io.state == :closed
           end
 
           if @selectables.empty?
@@ -70,7 +58,7 @@ class HTTPX::Selector
 
             # do not run event loop if there's nothing to wait on.
             # this might happen if connect failed and connection was unregistered.
-            return if (!r || r.empty?) && (!w || w.empty?)
+            return if (!r || r.empty?) && (!w || w.empty?) && !selectables.empty?
 
             break
           else

data/lib/httpx/session.rb

@@ -11,7 +11,7 @@ module HTTPX
       @options = self.class.default_options.merge(options)
       @responses = {}
       @persistent = @options.persistent
-      wrap(&blk) if block_given?
+      wrap(&blk) if blk
     end
 
     def wrap
@@ -21,6 +21,7 @@ module HTTPX
         yield self
       ensure
         @persistent = prev_persistent
+        close unless @persistent
       end
     end
 
@@ -226,7 +227,11 @@ module HTTPX
         end
         responses
       ensure
-        close(connections) unless @persistent
+        if @persistent
+          pool.deactivate(connections)
+        else
+          close(connections)
+        end
       end
     end
 

data/lib/httpx/session2.rb

@@ -7,7 +7,7 @@ module HTTPX
       @options = self.class.default_options.merge(options)
       @responses = {}
       @persistent = @options.persistent
-      wrap(&blk) if block_given?
+      wrap(&blk) if blk
     end
 
     def wrap

data/lib/httpx/timers.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module HTTPX
+  class Timers
+    def initialize
+      @intervals = []
+    end
+
+    def after(interval_in_secs, &blk)
+      return unless interval_in_secs
+
+      # I'm assuming here that most requests will have the same
+      # request timeout, as in most cases they share common set of
+      # options. A user setting different request timeouts for 100s of
+      # requests will already have a hard time dealing with that.
+      unless (interval = @intervals.find { |t| t == interval_in_secs })
+        interval = Interval.new(interval_in_secs)
+        @intervals << interval
+        @intervals.sort!
+      end
+
+      interval << blk
+    end
+
+    def wait_interval
+      return if @intervals.empty?
+
+      @next_interval_at = Utils.now
+
+      @intervals.first.interval
+    end
+
+    def fire(error = nil)
+      raise error if error && error.timeout != @intervals.first
+      return if @intervals.empty? || !@next_interval_at
+
+      elapsed_time = Utils.elapsed_time(@next_interval_at)
+
+      @intervals.delete_if { |interval| interval.elapse(elapsed_time) <= 0 }
+    end
+
+    def cancel
+      @intervals.clear
+    end
+
+    class Interval
+      include Comparable
+
+      attr_reader :interval
+
+      def initialize(interval)
+        @interval = interval
+        @callbacks = []
+      end
+
+      def <=>(other)
+        @interval <=> other.interval
+      end
+
+      def ==(other)
+        return @interval == other if other.is_a?(Numeric)
+
+        @interval == other.to_f # rubocop:disable Lint/FloatComparison
+      end
+
+      def to_f
+        @interval
+      end
+
+      def <<(callback)
+        @callbacks << callback
+      end
+
+      def elapse(elapsed)
+        @interval -= elapsed
+
+        @callbacks.each(&:call) if @interval <= 0
+
+        @interval
+      end
+    end
+    private_constant :Interval
+  end
+end

data/lib/httpx/transcoder/body.rb

@@ -9,6 +9,7 @@ module HTTPX::Transcoder
     module_function
 
     class Encoder
+      using HTTPX::ArrayExtensions
       extend Forwardable
 
       def_delegator :@raw, :to_s
@@ -21,7 +22,7 @@ module HTTPX::Transcoder
         if @raw.respond_to?(:bytesize)
           @raw.bytesize
         elsif @raw.respond_to?(:to_ary)
-          @raw.map(&:bytesize).reduce(0, :+)
+          @raw.sum(&:bytesize)
         elsif @raw.respond_to?(:size)
           @raw.size || Float::INFINITY
         elsif @raw.respond_to?(:length)

data/lib/httpx/transcoder/form.rb

@@ -50,7 +50,7 @@ module HTTPX::Transcoder
     def decode(response)
       content_type = response.content_type.mime_type
 
-      raise Error, "invalid form mime type (#{content_type})" unless content_type == "application/x-www-form-urlencoded"
+      raise HTTPX::Error, "invalid form mime type (#{content_type})" unless content_type == "application/x-www-form-urlencoded"
 
       Decoder
     end

data/lib/httpx/transcoder/json.rb

@@ -35,7 +35,7 @@ module HTTPX::Transcoder
     def decode(response)
       content_type = response.content_type.mime_type
 
-      raise Error, "invalid json mime type (#{content_type})" unless JSON_REGEX.match?(content_type)
+      raise HTTPX::Error, "invalid json mime type (#{content_type})" unless JSON_REGEX.match?(content_type)
 
       ::JSON.method(:parse)
     end

data/lib/httpx/utils.rb

@@ -6,6 +6,14 @@ module HTTPX
 
     module_function
 
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def elapsed_time(monotonic_timestamp)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC) - monotonic_timestamp
+    end
+
     # The value of this field can be either an HTTP-date or a number of
     # seconds to delay after the response is received.
     def parse_retry_after(retry_after)

data/lib/httpx/version.rb

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

data/lib/httpx.rb

@@ -13,6 +13,7 @@ require "httpx/callbacks"
 require "httpx/loggable"
 require "httpx/registry"
 require "httpx/transcoder"
+require "httpx/timers"
 require "httpx/pool"
 require "httpx/headers"
 require "httpx/request"

data/sig/chainable.rbs

@@ -32,6 +32,7 @@ module HTTPX
               | (:stream, ?options) -> Plugins::sessionStream
               | (:aws_sigv4, ?options) -> Plugins::awsSigV4Session
               | (:grpc, ?options) -> Plugins::grpcSession
+              | (:response_cache, ?options) -> Plugins::sessionResponseCache
               | (Symbol | Module, ?options) { (Class) -> void } -> Session
               | (Symbol | Module, ?options) -> Session
 

data/sig/connection.rbs

@@ -25,7 +25,15 @@ module HTTPX
     attr_reader state: Symbol
     attr_reader pending: Array[Request]
     attr_reader options: Options
-    attr_writer timers: untyped # Timers::Timer
+    attr_writer timers: Timers
+
+    @origins: Array[URI::Generic]
+    @window_size: Integer
+    @read_buffer: Buffer
+    @write_buffer: Buffer
+    @inflight: Integer
+    @keep_alive_timeout: Numeric?
+    @total_timeout: Numeric?
 
     def addresses: () -> Array[ipaddr]?
 
@@ -62,6 +70,7 @@ module HTTPX
 
     def timeout: () -> Numeric?
 
+    def deactivate: () -> void
     private
 
     def initialize: (String, URI::Generic, options) -> untyped
@@ -76,6 +85,8 @@ module HTTPX
 
     def parser: () -> _Parser
 
+    def send_request_to_parser: (Request request) -> void
+
     def build_parser: () -> _Parser
                     | (String) -> _Parser
 
@@ -83,15 +94,10 @@ module HTTPX
 
     def transition: (Symbol) -> void
 
-    def handle_response: () -> void
-
     def on_error: (HTTPX::TimeoutError | Error | StandardError) -> void
 
     def handle_error: (StandardError) -> void
 
-    def total_timeout: () -> untyped?
-    # def total_timeout: () -> Timers::Timer?
-    #
     def purge_after_closed: () -> void
   end
 end

data/sig/plugins/aws_sdk_authentication.rbs

@@ -1,25 +1,43 @@
 module HTTPX
   module Plugins
     module AwsSdkAuthentication
+      class Configuration
+        attr_reader profile: String?
+
+        private
+
+        def initialize: (String? profile) -> void
+      end
+
       class Credentials
+        @aws_credentials: untyped
+
         include _SigV4Credentials
 
         private
-        
+
         def initialize: (untyped aws_credentials) -> untyped
       end
 
+      interface _AwsSdkOptions
+        def aws_profile: () -> String?
+      end
+
       def self.load_dependencies: (singleton(Session)) -> void
 
       def self.configure: (singleton(Session)) -> void
 
-      def self.extra_options: (Options) -> (Options)
+      def self.extra_options: (Options) -> (Options & _AwsSdkOptions)
+
+      def self.credentials: (String? profile) -> Credentials
+
+      def self.region: (String? profile) -> String
 
       module InstanceMethods
-        def aws_sdk_authentication: (**untyped) -> instance
+        def aws_sdk_authentication: (?credentials: Credentials, ?region: String, **untyped) -> instance
       end
     end
 
-    type sessionAwsSdkAuthentication = Session & AwsSdkAuthentication::InstanceMethods
+    type sessionAwsSdkAuthentication = awsSigV4Session & AwsSdkAuthentication::InstanceMethods
   end
 end

data/sig/plugins/response_cache.rbs

@@ -0,0 +1,35 @@
+module HTTPX
+  module Plugins
+    module ResponseCache
+      CACHEABLE_VERBS: Array[Symbol]
+
+      def self?.cacheable_request?: (Request request) -> bool
+      def self?.cacheable_response?: (response response) -> bool
+      def self?.cached_response?: (response response) -> bool
+
+      class Store
+        @store: Hash[URI::Generic, Response]
+
+        def lookup: (URI::Generic uri) -> Response?
+
+        def cached?: (URI::Generic uri) -> bool
+
+        def cache: (URI::Generic uri, Response response) -> void
+
+        def prepare: (Request request) -> void
+      end
+
+      module InstanceMethods
+        @response_cache: Store
+
+        def clear_response_cache: () -> void
+      end
+
+      module ResponseMethods
+        def copy_from_cached: (Response other) -> void
+      end
+    end
+
+    type sessionResponseCache = Session & ResponseCache::InstanceMethods
+  end
+end

data/sig/plugins/retries.rbs

@@ -4,6 +4,7 @@ module HTTPX
       MAX_RETRIES: Integer
       IDEMPOTENT_METHODS: Array[verb]
       RETRYABLE_ERRORS: Array[singleton(StandardError)]
+      DEFAULT_JITTER: ^(Numeric) -> Numeric
 
       interface _RetryCallback
         def call: (response) -> bool?
@@ -12,6 +13,8 @@ module HTTPX
       interface _RetriesOptions
         def retry_after: () -> Numeric?
 
+        def retry_jitter: () -> ^(Numeric) -> Numeric
+
         def max_retries: () -> Integer?
 
         def retry_change_requests: () -> boolish

data/sig/pool.rbs

@@ -10,6 +10,8 @@ module HTTPX
 
     def find_connection: (generic_uri, Options) -> Connection?
 
+    def deactivate: (*Array[Connection]) -> void
+
     private
 
     def initialize: () -> untyped
@@ -26,6 +28,10 @@ module HTTPX
 
     def unregister_connection: (Connection) -> void
 
+    def select_connection: (resolver | Connection connection) -> void
+
+    def deselect_connection: (resolver | Connection connection) -> void
+
     def coalesce_connections: (Connection, Connection) -> void
 
     def next_timeout: () -> Numeric?

data/sig/resolver/native.rbs

@@ -5,8 +5,6 @@ module HTTPX
       include ResolverMixin
       include _ToIO
 
-      type state = :idle | :open | :closed
-
       DEFAULTS: Hash[Symbol, untyped]
       DNS_PORT: Integer
 
@@ -21,7 +19,8 @@ module HTTPX
       @queries: Hash[String, Connection]
       @read_buffer: String
       @write_buffer: Buffer
-      @state: state
+
+      attr_reader state: Symbol
 
       def closed?: () -> bool
 
@@ -58,7 +57,7 @@ module HTTPX
 
       def build_socket: () -> void
 
-      def transition: (state nextstate) -> void
+      def transition: (Symbol nextstate) -> void
 
       def handle_error: (NativeResolveError | StandardError) -> void
     end

data/sig/resolver/system.rbs

@@ -5,6 +5,8 @@ module HTTPX
 
       RESOLV_ERRORS: Array[singleton(StandardError)] # ResolvError
 
+      attr_reader state: Symbol
+
       def closed?: () -> true
 
       def empty?: () -> true

data/sig/response.rbs

@@ -1,6 +1,8 @@
 module HTTPX
   interface _Response
-    def raise_for_status: () -> void
+    def raise_for_status: () -> self
+
+    def error: () -> StandardError?
   end
 
   class Response
@@ -89,7 +91,6 @@ module HTTPX
     @options: Options
 
     attr_reader request: Request
-    attr_reader error: Exception
 
     def status: () -> (Integer | _ToS)
 

data/sig/timers.rbs

@@ -0,0 +1,32 @@
+module HTTPX
+  class Timers
+    @interval: Array[Interval]
+
+    def after: (Numeric interval_in_secs) { () -> void } -> void
+
+    def wait_interval: () -> Numeric?
+
+    def fire: (?StandardError error) -> void
+
+    def cancel: () -> void
+
+    private
+
+    def initialize: () -> void
+
+    class Interval
+      include Comparable
+
+      attr_reader interval: Numeric
+
+      def to_f: () -> Float
+
+      def <<: (^() -> void) -> void
+
+      def elapse: (Numeric elapsed) -> Numeric
+      private
+
+      def initialize: (Numeric interval) -> void
+    end
+  end
+end