retry_block takes keyword arguments, and has a new one for will_retry_in seconds

Author: jrochkind

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v2.0
+
+### Changed
+
+* retry_block now takes keyword arguments instead of positional (backwards incompatible)
+
+### Added
+
+* retry_block has additional `will_retry_in` argument with upcoming delay before retry in seconds.
+
 ## v1.0
 
 Initial release.

README.md

@@ -127,15 +127,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 }
 }
 ```
 

lib/faraday/retry/middleware.rb

@@ -105,8 +105,17 @@ def retry_statuses
       #   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
+      #     * retries_remaining [Integer]: how many more possible retries are
+      #       remaining
+      #     * 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
@@ -145,7 +154,13 @@ def call(env)
             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,
+                retries_remaining: retries,
+                exception: e,
+                will_retry_in: sleep_amount
+              )
               sleep sleep_amount
               retry
             end

spec/faraday/retry/middleware_spec.rb

@@ -87,13 +87,21 @@
     end
 
     context 'and retry_block is set' do
-      let(:options) { [{ retry_block: ->(env, options, retries, exc) { retry_block_calls << [env, options, retries, exc] } }] }
+      let(:options) { [{ retry_block: ->(**kwargs) { retry_block_calls << kwargs } }] }
       let(:retry_block_calls) { [] }
       let(:retry_block_times_called) { retry_block_calls.size }
 
       it 'calls retry block for each retry' do
         expect(retry_block_times_called).to eq(2)
       end
+
+      it "has appropriate args to retry_block" do
+        expect(retry_block_calls.first[:exception]).to be_kind_of(Errno::ETIMEDOUT)
+        expect(retry_block_calls.first[:options]).to be_kind_of(Faraday::Options)
+        expect(retry_block_calls.first[:env]).to be_kind_of(Faraday::Env)
+        expect(retry_block_calls.first[:will_retry_in]).to be_kind_of(Float)
+        expect(retry_block_calls.first[:retries_remaining]).to eq 1
+      end
     end
   end
 
@@ -263,7 +271,7 @@
       context 'and retry_block is set' do
         let(:options) do
           [{
-            retry_block: ->(env, options, retries, exc) { retry_block_calls << [env, options, retries, exc] },
+            retry_block: ->(**kwargs) { retry_block_calls << kwargs },
             max: 2,
             max_interval: 5,
             retry_statuses: 504