faraday-retry 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2693714c55f145be183aac73aced8352a5683031372eee3211298a207c591997
-  data.tar.gz: a4f3b4c56224c2091bdbe5ff7b44f3f1c93438293bd9027c1441cf0287b42a01
+  metadata.gz: b07a16fd11fb4fcc1041260ad3e7341f40762eef86984f23ee5785c1c15b4334
+  data.tar.gz: 3551328efd8212c9f2079ce2e4b2b192271bfccc3c4df337f921f9403fefd742
 SHA512:
-  metadata.gz: 86639f396dba9b1dd87a7879408e08f8fdc894a9949bfde95ca070190b7e195f0de07c31b96f8af18bfee03bd92be6744c90e63b1f4491c242f38f8bb1661fab
-  data.tar.gz: aca22dc17015c52f898519b49428140ef5835627f85510e3bd23091e706a3405917a11829e652b0eaca33c73861342bb372e780f363dc867c9328c370776bcd1
+  metadata.gz: c0a0b3718c1085d8c43f350ab4d82a21b508d215fc1caa59751d2552ee2598dc9281a5a21589d9cf08bad4a4b68925d6d6e27c592fe38fc3a40d6d2a606e0ce1
+  data.tar.gz: 891a2994edb8f81ea829710faa26b87056206be42d12092ce6c7250bb7cebaaaf1cd4363ce0f4d36307d12f1ecaa9a15385418bec80a2cab390b3f245f96ae54

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## v2.0.0 (2022-06-08)
+
+### Changed
+
+* `retry_block` now takes keyword arguments instead of positional (backwards incompatible)
+* `retry_block`'s `retry_count` argument now counts up from 0, instead of old `retries_remaining`
+
+### Added
+
+* Support for the `RateLimit-Reset` header. [PR #9](https://github.com/lostisland/faraday-retry/pull/9). Thanks, [@maxprokopiev]!
+* `retry_block` has additional `will_retry_in` argument with upcoming delay before retry in seconds.
+
 ## v1.0
 
 Initial release.
@@ -8,3 +20,5 @@ This release consists of the same middleware that was previously bundled with Fa
 ### Fixed
 
 *  Retry middleware `retry_block` is not called if retry will not happen due to `max_interval`, https://github.com/lostisland/faraday/pull/1350
+
+[@maxprokopiev]: https://github.com/maxprokopiev

data/README.md

@@ -96,11 +96,14 @@ retry_options = {
 }
 ```
 
-#### Automatically handle the `Retry-After` header
+#### Automatically handle the `Retry-After` and `RateLimit-Reset` headers
 
-Some APIs, like the [Slack API](https://api.slack.com/docs/rate-limits), will inform you when you reach their API limits by replying with a response status code of `429` and a response header of `Retry-After` containing a time in seconds. You should then only retry querying after the amount of time provided by the `Retry-After` header, otherwise you won't get a response.
+Some APIs, like the [Slack API](https://api.slack.com/docs/rate-limits), will inform you when you reach their API limits by replying with a response status code of `429`
+and a response header of `Retry-After` containing a time in seconds. You should then only retry querying after the amount of time provided by the `Retry-After` header,
+otherwise you won't get a response. Other APIs communicate their rate limits via the [RateLimit-xxx](https://tools.ietf.org/id/draft-polli-ratelimit-headers-00.html#rfc.section.3.3) headers
+where `RateLimit-Reset` behaves similarly to the `Retry-After`.
 
-You can automatically handle this and have Faraday pause and retry for the right amount of time by including the `429` status code in the retry statuses list:
+You can automatically handle both headers and have Faraday pause and retry for the right amount of time by including the `429` status code in the retry statuses list:
 
 ```ruby
 retry_options = {
@@ -127,15 +130,19 @@ retry_options = {
 
 ### Call a block on every retry
 
-You can specify a block through the `retry_block` option that will be called before every retry.
-There are many different applications for this feature, spacing from instrumentation to monitoring.
-Request environment, middleware options, current number of retries and the exception is passed to the block as parameters.
+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.
+
+
+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
 response_statuses = []
 retry_options = {
-  retry_block: -> (env, options, retries, exc) { response_statuses << env.status }
+  retry_block: -> (env:, options:, retries_remaining:, exception:, will_retry_in:) { response_statuses << env.status }
 }
 ```
 
@@ -147,8 +154,9 @@ Then, run `bin/test` to run the tests.
 
 To install this gem onto your local machine, run `rake build`.
 
-To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
-See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+### Releasing a new version
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2", and change the _Unreleased_ heading in `CHANGELOG.md` to a heading like "0.0.2 (2022-01-01)", and then use GitHub Releases to author a release. A GitHub Actions workflow then publishes a new gem to [RubyGems.org](https://rubygems.org/gems/faraday-retry).
 
 ## Contributing
 

data/lib/faraday/retry/middleware.rb

@@ -105,8 +105,16 @@ module Faraday
       #   if the exception produced is non-recoverable or if the
       #   the HTTP method called is not idempotent.
       # @option options [Block] :retry_block block that is executed before
-      #   every retry. Request environment, middleware options, current number
-      #   of retries and the exception is passed to the block as parameters.
+      #   every retry. The block will be yielded keyword arguments:
+      #     * env [Faraday::Env]: Request environment
+      #     * options [Faraday::Options]: middleware options
+      #     * retry_count [Integer]: how many retries have already occured (starts at 0)
+      #     * exception [Exception]: exception that triggered the retry,
+      #       will be the synthetic `Faraday::RetriableResponse` if the
+      #       retry was triggered by something other than an exception.
+      #     * will_retry_in [Float]: retry_block is called *before* the retry
+      #       delay, actual retry will happen in will_retry_in number of
+      #       seconds.
       # @option options [Array] :retry_statuses Array of Integer HTTP status
       #   codes or a single Integer value that determines whether to raise
       #   a Faraday::RetriableResponse exception based on the HTTP status code
@@ -118,7 +126,7 @@ module Faraday
       end
 
       def calculate_sleep_amount(retries, env)
-        retry_after = calculate_retry_after(env)
+        retry_after = [calculate_retry_after(env), calculate_rate_limit_reset(env)].compact.max
         retry_interval = calculate_retry_interval(retries)
 
         return if retry_after && retry_after > @options.max_interval
@@ -145,7 +153,13 @@ module Faraday
             retries -= 1
             rewind_files(request_body)
             if (sleep_amount = calculate_sleep_amount(retries + 1, env))
-              @options.retry_block.call(env, @options, retries, e)
+              @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
@@ -198,21 +212,16 @@ module Faraday
         end
       end
 
+      # RFC for RateLimit Header Fields for HTTP:
+      # https://tools.ietf.org/id/draft-polli-ratelimit-headers-00.html#rfc.section.3.3
+      def calculate_rate_limit_reset(env)
+        parse_retry_header(env, 'RateLimit-Reset')
+      end
+
       # MDN spec for Retry-After header:
       # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
       def calculate_retry_after(env)
-        response_headers = env[:response_headers]
-        return unless response_headers
-
-        retry_after_value = env[:response_headers]['Retry-After']
-
-        # 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
+        parse_retry_header(env, 'Retry-After')
       end
 
       def calculate_retry_interval(retries)
@@ -225,6 +234,21 @@ module Faraday
 
         current_interval + random_interval
       end
+
+      def parse_retry_header(env, header)
+        response_headers = env[:response_headers]
+        return unless response_headers
+
+        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
+        end
+      end
     end
   end
 end

data/lib/faraday/retry/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Retry
-    VERSION = '1.0.1'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-retry
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -157,11 +157,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/lostisland/faraday-retry/issues
-  changelog_uri: https://github.com/lostisland/faraday-retry/blob/v1.0.1/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/1.0.1
+  changelog_uri: https://github.com/lostisland/faraday-retry/blob/v2.0.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.0.0
   homepage_uri: https://github.com/lostisland/faraday-retry
   source_code_uri: https://github.com/lostisland/faraday-retry
-  wiki_uri: https://github.com/lostisland/faraday-retry/wiki
 post_install_message: 
 rdoc_options: []
 require_paths: