client-api-builder 0.8.0 → 0.10.0

data/lib/client_api_builder/router.rb

@@ -6,6 +6,9 @@ require 'json'
 
 module ClientApiBuilder
   module Router
+    # Status codes accepted when a route lists no expected_response_codes
+    SUCCESS_CODE = /\A2\d\d\z/
+
     def self.included(base)
       base.extend InheritanceHelper::Methods
       base.extend ClassMethods
@@ -60,7 +63,10 @@ module ClientApiBuilder
           query_params: {},
           response_procs: {},
           max_retries: 1,
-          sleep: 0.05
+          sleep: 0.05,
+          backoff: 1,
+          max_sleep: nil,
+          jitter: false
         }.freeze
       end
 
@@ -127,14 +133,27 @@ module ClientApiBuilder
         add_value_to_class_method(:default_options, connection_options: connection_options)
       end
 
-      def configure_retries(max_retries, sleep_time_between_retries_in_seconds = 0.05)
+      # max_retries is the total number of attempts. The sleep before retry n is
+      # sleep * backoff**(n - 1), capped at max_sleep when given. jitter randomly
+      # shortens each sleep: true by up to all of it, a number (0..1) by up to that fraction.
+      def configure_retries(max_retries, sleep_time_between_retries_in_seconds = 0.05,
+                            backoff: 1, max_sleep: nil, jitter: false)
         add_value_to_class_method(
           :default_options,
           max_retries: max_retries,
-          sleep: sleep_time_between_retries_in_seconds
+          sleep: sleep_time_between_retries_in_seconds,
+          backoff: backoff,
+          max_sleep: max_sleep,
+          jitter: jitter
         )
       end
 
+      # configure_retries with a sleep that starts at initial and doubles (by default)
+      # after each failed attempt, never exceeding max
+      def configure_exponential_retries(attempts:, initial: 0.1, max: 10, multiplier: 2, jitter: false)
+        configure_retries(attempts, initial, backoff: multiplier, max_sleep: max, jitter: jitter)
+      end
+
       # add a query param to all requests
       def query_param(name, value = nil, &block)
         query_params = deep_dup_hash(default_options[:query_params])
@@ -562,8 +581,10 @@ module ClientApiBuilder
       url
     end
 
+    # Checks the status code rather than the response class, so any response object with a
+    # Net::HTTPResponse-style string code works (e.g. from a non-Net::HTTP transport)
     def expected_response_code!(response, expected_response_codes, _options)
-      return if expected_response_codes.empty? && response.is_a?(Net::HTTPSuccess)
+      return if expected_response_codes.empty? && SUCCESS_CODE.match?(response.code.to_s)
       return if expected_response_codes.include?(response.code)
 
       raise(::ClientApiBuilder::UnexpectedResponse.new("unexpected response code #{response.code}", response))
@@ -635,7 +656,20 @@ module ClientApiBuilder
     end
 
     def get_retry_request_sleep_time(_exception, options)
-      options[:sleep] || self.class.default_options[:sleep] || 0.05
+      sleep_time = options[:sleep] || self.class.default_options[:sleep] || 0.05
+      backoff = options[:backoff] || self.class.default_options[:backoff] || 1
+      sleep_time *= backoff**(@request_attempts - 1)
+      max_sleep = options[:max_sleep] || self.class.default_options[:max_sleep]
+      sleep_time = [sleep_time, max_sleep].min if max_sleep
+      apply_retry_jitter(sleep_time, options.fetch(:jitter) { self.class.default_options[:jitter] })
+    end
+
+    # shortens sleep_time by a random amount: up to all of it for true, up to that fraction for a number
+    def apply_retry_jitter(sleep_time, jitter)
+      return sleep_time unless jitter
+
+      jitter = 1 if jitter == true
+      sleep_time * (1 - (jitter * rand))
     end
 
     def get_retry_request_max_retries(options)
@@ -657,7 +691,7 @@ module ClientApiBuilder
     def retry_request?(exception, _options)
       case exception
       when Net::OpenTimeout, Net::ReadTimeout, Errno::ECONNRESET,
-           Errno::ECONNREFUSED, Errno::ETIMEDOUT, SocketError, EOFError
+           Errno::ECONNREFUSED, Errno::ETIMEDOUT, SocketError, EOFError, ::ClientApiBuilder::RetryableError
         true
       else
         false

data/lib/client_api_builder/section.rb

@@ -10,6 +10,11 @@ module ClientApiBuilder
     module ClassMethods
       SECTION_NAME = /\A[a-z_][a-z0-9_]*\z/i
 
+      # Section router classes by name, including inherited sections
+      def section_routers
+        {}.freeze
+      end
+
       # Defines <name>_router (the section's NestedRouter class) and <name> (its router for a
       # client instance) with closures, so anonymous client classes and any option values work.
       # inherit: opts the section into root client settings (see NestedRouter.inherit_from_root);
@@ -31,6 +36,7 @@ module ClientApiBuilder
         kls.class_eval(&block) if block
 
         define_singleton_method(:"#{name}_router") { kls }
+        add_value_to_class_method(:section_routers, name.to_sym => kls)
         define_section_accessor(name, nested_router_options)
       end
 

data/lib/client_api_builder/version.rb

@@ -2,5 +2,5 @@
 
 module ClientApiBuilder
   # Gem version, bumped by release-please
-  VERSION = '0.8.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: client-api-builder
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Doug Youch
@@ -40,6 +40,19 @@ files:
 - lib/client-api-builder.rb
 - lib/client_api_builder/active_support_log_subscriber.rb
 - lib/client_api_builder/active_support_notifications.rb
+- lib/client_api_builder/connection_pools.rb
+- lib/client_api_builder/connection_pools/connection.rb
+- lib/client_api_builder/connection_pools/pool.rb
+- lib/client_api_builder/connection_pools/pool_set.rb
+- lib/client_api_builder/connection_pools/settings.rb
+- lib/client_api_builder/http2.rb
+- lib/client_api_builder/http2/connection.rb
+- lib/client_api_builder/http2/connection_set.rb
+- lib/client_api_builder/http2/exchange.rb
+- lib/client_api_builder/http2/request_headers.rb
+- lib/client_api_builder/http2/response_body.rb
+- lib/client_api_builder/http2/response_builder.rb
+- lib/client_api_builder/http2/tls_socket.rb
 - lib/client_api_builder/nested_router.rb
 - lib/client_api_builder/net_http_request.rb
 - lib/client_api_builder/query_params.rb