faraday-retry 2.1.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b88675fec154db2d70b835b98124879b77dbcd283b898fea74fe88c1a75a4b
-  data.tar.gz: 57eefe94dd39d192dff652e90cfadda2ce06d244a3a20e849dd9f3df6a88ffb4
+  metadata.gz: 76aff4f986315a337600432e6d2458f4080004755f37583ac413bf454713602c
+  data.tar.gz: fe612cfa054e9f293d533404759734672284f92258f43a17fb9febbb455f5b61
 SHA512:
-  metadata.gz: de85932e530b33168b83399f0135fd862071c10318faaaef324935c3e51bc1914dd9361c68a5c2a6d3a4fc81e9f0193b928a4fe65c2dbc34826998573465af86
-  data.tar.gz: f5e12ca382154fac0fbff872f9f906a62c0a990b06226363c701fa52d05ee927d23b0358f005e6de974e7fad938944beb2621413419b48a5d43b29e4b3180af8
+  metadata.gz: 11f9e7f0a270962bcc25ab31690fa8c14dc0fb461a74b8a7db94d7d719e48679590f12b554e37da579ea57824dc35fc13fc6820e4772b4de08b269e88924202f
+  data.tar.gz: 305559acfa19db8b994f2dc8e2e734f31fd1fdbe255b82eb3612ce5630d0c9b325ad46621892675a4e7fa6b85f99329fa0af635923619d650b69ce5a837689e5

data/CHANGELOG.md

@@ -1,14 +1,24 @@
 # Changelog
 
-## v2.1.1 (2023-02-17)
+## Unreleased
 
-### Changed
+_nothing yet_
 
-* Support for custom RateLimit headers. [PR #13](https://github.com/lostisland/faraday-retry/pull/13). Thanks, [@brookemckim]!
+## v2.2.1 (2024-04-15)
+
+* Avoid deprecation warning about ::UploadIO constant when used without faraday-multipart gem [PR #37](https://github.com/lostisland/faraday-retry/pull/37) [@iMacTia]
+* Documentation update [PR #30](https://github.com/lostisland/faraday-retry/pull/30) [@olleolleolle]
+* Documentation update [PR #32](https://github.com/lostisland/faraday-retry/pull/32) Thanks, [@Drowze]!
+
+## v2.2.0 (2023-06-01)
 
-## v2.1.0 (2023-02-17)
+* Support new `header_parser_block` option. [PR #28](https://github.com/lostisland/faraday-retry/pull/28). Thanks, [@zavan]!
+
+## v2.1.0 (2023-03-03)
+
+* Support for custom RateLimit headers. [PR #13](https://github.com/lostisland/faraday-retry/pull/13). Thanks, [@brookemckim]!
 
-Invalid release, use v2.1.1.
+v2.1.1 (2023-02-17) is a spurious not-released version that you may have seen mentioned in this CHANGELOG.
 
 ## v2.0.0 (2022-06-08)
 
@@ -33,3 +43,7 @@ This release consists of the same middleware that was previously bundled with Fa
 
 [@maxprokopiev]: https://github.com/maxprokopiev
 [@brookemckim]: https://github.com/brookemckim
+[@zavan]: https://github.com/zavan
+[@Drowze]: https://github.com/Drowze
+[@olleolleolle]: https://github.com/olleolleolle
+[@iMacTia]: https://github.com/iMacTia

data/README.md

@@ -75,7 +75,7 @@ retry_options = {
 #### Specify which exceptions should trigger a retry
 
 You can provide an `exceptions` option with a list of exceptions that will replace
-the default list of network-related exceptions: `Errno::ETIMEDOUT`, `Timeout::Error`, `Faraday::TimeoutError`.
+the default exceptions: `Errno::ETIMEDOUT`, `Timeout::Error`, `Faraday::TimeoutError`, `Faraday::Error::RetriableResponse`.
 This can be particularly useful when combined with the [RaiseError][raise_error] middleware.
 
 ```ruby
@@ -84,6 +84,14 @@ retry_options = {
 }
 ```
 
+If you want to inherit default exceptions, do it this way.
+
+```ruby
+retry_options = {
+  exceptions: Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ResourceNotFound, Faraday::UnauthorizedError]
+}
+```
+
 #### Specify on which response statuses to retry
 
 By default the `Retry` middleware will only retry the request if one of the expected exceptions arise.
@@ -111,13 +119,14 @@ retry_options = {
 }
 ```
 
-If you are working with an API which does not comply with the Rate Limit RFC you can specify custom headers to be used for retry and reset.
+If you are working with an API which does not comply with the Rate Limit RFC you can specify custom headers to be used for retry and reset, as well as a block to parse the headers:
 
 ```ruby
 retry_options = {
   retry_statuses: [429],
   rate_limit_retry_header: 'x-rate-limit-retry-after',
-  rate_limit_reset_header: 'x-rate-limit-reset'
+  rate_limit_reset_header: 'x-rate-limit-reset',
+  header_parser_block: ->(value) { Time.at(value.to_i).utc - Time.now.utc }
 }
 ```
 
@@ -140,13 +149,11 @@ retry_options = {
 
 ### Call a block on every retry
 
-You can specify a proc object through the `retry_block` option that will be called before every
-retry, before  There are many different applications for this feature, spacing from instrumentation to monitoring.
-
+You can specify a proc object through the `retry_block` option that will be called before every retry.
+There are many different applications for this feature, ranging from instrumentation to monitoring.
 
 The block is passed keyword arguments with contextual information: Request environment, middleware options, current number of retries, exception, and amount of time we will wait before retrying. (retry_block is called before the wait time happens)
 
-
 For example, you might want to keep track of the response statuses:
 
 ```ruby
@@ -156,6 +163,27 @@ retry_options = {
 }
 ```
 
+### Call a block after retries have been exhausted
+
+You can specify a lambda object through the `exhausted_retries_block` option that will be called after all retries are exhausted.
+This block will be called once.
+
+The block is passed keyword arguments with contextual information and passed your data:
+* Request environment,
+* exception,
+* middleware options
+* and your data.
+
+In a lambda you can pass any logic for further work.
+
+For example, you might want to update user by request query.
+
+```ruby
+retry_options = {
+  exhausted_retries_block: -> (user_id:, env:, exception:, options:) { User.find_by!(id: user_id).do_admin! }
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -176,4 +204,4 @@ Bug reports and pull requests are welcome on [GitHub](https://github.com/lostisl
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-[raise_error]:  https://lostisland.github.io/faraday/middleware/raise-error
+[raise_error]:  https://lostisland.github.io/faraday/#/middleware/included/raising-errors

data/lib/faraday/retry/middleware.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'retryable'
+
 module Faraday
   module Retry
     # This class provides the main implementation for your middleware.
@@ -15,6 +17,8 @@ module Faraday
     #   (see "retry" middleware: https://github.com/lostisland/faraday/blob/main/lib/faraday/request/retry.rb#L142).
     #   IMPORTANT: Remember to call `@app.call(env)` or `super` to not interrupt the middleware chain!
     class Middleware < Faraday::Middleware
+      include Retryable
+
       DEFAULT_EXCEPTIONS = [
         Errno::ETIMEDOUT, 'Timeout::Error',
         Faraday::TimeoutError, Faraday::RetriableResponse
@@ -27,7 +31,8 @@ module Faraday
                                            :backoff_factor, :exceptions,
                                            :methods, :retry_if, :retry_block,
                                            :retry_statuses, :rate_limit_retry_header,
-                                           :rate_limit_reset_header)
+                                           :rate_limit_reset_header, :header_parser_block,
+                                           :exhausted_retries_block)
 
         DEFAULT_CHECK = ->(_env, _exception) { false }
 
@@ -78,6 +83,10 @@ module Faraday
         def retry_statuses
           Array(self[:retry_statuses] ||= [])
         end
+
+        def exhausted_retries_block
+          self[:exhausted_retries_block] ||= proc {}
+        end
       end
 
       # @param app [#call]
@@ -95,8 +104,8 @@ module Faraday
       #   'Timeout::Error', Faraday::TimeoutError, Faraday::RetriableResponse])
       #   The list of exceptions to handle. Exceptions can be given as
       #   Class, Module, or String.
-      # @option options [Array] :methods (the idempotent HTTP methods
-      #   in IDEMPOTENT_METHODS) A list of HTTP methods to retry without
+      # @option options [Array<Symbol>] :methods (the idempotent HTTP methods
+      #   in IDEMPOTENT_METHODS) A list of HTTP methods, as symbols, to retry without
       #   calling retry_if. Pass an empty Array to call retry_if
       #   for all exceptions.
       # @option options [Block] :retry_if (false) block that will receive
@@ -120,6 +129,17 @@ module Faraday
       #   codes or a single Integer value that determines whether to raise
       #   a Faraday::RetriableResponse exception based on the HTTP status code
       #   of an HTTP response.
+      # @option options [Block] :header_parser_block block that will receive
+      #   the the value of the retry header and should return the number of
+      #   seconds to wait before retrying the request. This is useful if the
+      #   value of the header is not a number of seconds or a RFC 2822 formatted date.
+      # @option options [Block] :exhausted_retries_block block will receive
+      #   when all attempts are exhausted. The block will be yielded keyword arguments:
+      #     * env [Faraday::Env]: Request environment
+      #     * exception [Exception]: exception that triggered the retry,
+      #       will be the synthetic `Faraday::RetriableResponse` if the
+      #       retry was triggered by something other than an exception.
+      #     * options [Faraday::Options]: middleware options
       def initialize(app, options = nil)
         super(app)
         @options = Options.from(options)
@@ -143,32 +163,14 @@ module Faraday
       def call(env)
         retries = @options.max
         request_body = env[:body]
-        begin
+
+        with_retries(env: env, options: @options, retries: retries, body: request_body, errmatch: @errmatch) do
           # after failure env[:body] is set to the response body
           env[:body] = request_body
+
           @app.call(env).tap do |resp|
             raise Faraday::RetriableResponse.new(nil, resp) if @options.retry_statuses.include?(resp.status)
           end
-        rescue @errmatch => e
-          if retries.positive? && retry_request?(env, e)
-            retries -= 1
-            rewind_files(request_body)
-            if (sleep_amount = calculate_sleep_amount(retries + 1, env))
-              @options.retry_block.call(
-                env: env,
-                options: @options,
-                retry_count: @options.max - (retries + 1),
-                exception: e,
-                will_retry_in: sleep_amount
-              )
-              sleep sleep_amount
-              retry
-            end
-          end
-
-          raise unless e.is_a?(Faraday::RetriableResponse)
-
-          e.response
         end
       end
 
@@ -205,11 +207,11 @@ module Faraday
       end
 
       def rewind_files(body)
-        return unless defined?(UploadIO)
+        return unless defined?(Faraday::UploadIO)
         return unless body.is_a?(Hash)
 
         body.each do |_, value|
-          value.rewind if value.is_a?(UploadIO)
+          value.rewind if value.is_a?(Faraday::UploadIO)
         end
       end
 
@@ -244,12 +246,16 @@ module Faraday
 
         retry_after_value = env[:response_headers][header]
 
-        # Try to parse date from the header value
-        begin
-          datetime = DateTime.rfc2822(retry_after_value)
-          datetime.to_time - Time.now.utc
-        rescue ArgumentError
-          retry_after_value.to_f
+        if @options.header_parser_block
+          @options.header_parser_block.call(retry_after_value)
+        else
+          # Try to parse date from the header value
+          begin
+            datetime = DateTime.rfc2822(retry_after_value)
+            datetime.to_time - Time.now.utc
+          rescue ArgumentError
+            retry_after_value.to_f
+          end
         end
       end
     end

data/lib/faraday/retry/retryable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Faraday
+  # Adds the ability to retry a request based on settings and errors that have occurred.
+  module Retryable
+    def with_retries(env:, options:, retries:, body:, errmatch:)
+      yield
+    rescue errmatch => e
+      exhausted_retries(options, env, e) if retries_zero?(retries, env, e)
+
+      if retries.positive? && retry_request?(env, e)
+        retries -= 1
+        rewind_files(body)
+        if (sleep_amount = calculate_sleep_amount(retries + 1, env))
+          options.retry_block.call(
+            env: env,
+            options: options,
+            retry_count: options.max - (retries + 1),
+            exception: e,
+            will_retry_in: sleep_amount
+          )
+          sleep sleep_amount
+          retry
+        end
+      end
+
+      raise unless e.is_a?(Faraday::RetriableResponse)
+
+      e.response
+    end
+
+    private
+
+    def retries_zero?(retries, env, exception)
+      retries.zero? && retry_request?(env, exception)
+    end
+
+    def exhausted_retries(options, env, exception)
+      options.exhausted_retries_block.call(
+        env: env,
+        exception: exception,
+        options: options
+      )
+    end
+  end
+end

data/lib/faraday/retry/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Retry
-    VERSION = '2.1.0'
+    VERSION = '2.3.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-retry
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Mattia Giuffrida
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -151,17 +151,18 @@ files:
 - lib/faraday/retriable_response.rb
 - lib/faraday/retry.rb
 - lib/faraday/retry/middleware.rb
+- lib/faraday/retry/retryable.rb
 - lib/faraday/retry/version.rb
 homepage: https://github.com/lostisland/faraday-retry
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/lostisland/faraday-retry/issues
-  changelog_uri: https://github.com/lostisland/faraday-retry/blob/v2.1.0/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.1.0
+  changelog_uri: https://github.com/lostisland/faraday-retry/blob/v2.3.1/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.3.1
   homepage_uri: https://github.com/lostisland/faraday-retry
   source_code_uri: https://github.com/lostisland/faraday-retry
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Catches exceptions and retries each request a limited number of times
 test_files: []