Class: Faraday::Request::Retry

Inherits:
Middleware show all
Defined in:
lib/faraday/request/retry.rb

Overview

Catches exceptions and retries each request a limited number of times.

By default, it retries 2 times and handles only timeout exceptions. It can be configured with an arbitrary number of retries, a list of exceptions to handle, a retry interval, a percentage of randomness to add to the retry interval, and a backoff factor.

Examples

Faraday.new do |conn|
  conn.request :retry, max: 2, interval: 0.05,
                       interval_randomness: 0.5, backoff_factor: 2,
                       exceptions: [CustomException, 'Timeout::Error']
  conn.adapter ...
end

This example will result in a first interval that is random between 0.05 and 0.075 and a second interval that is random between 0.1 and 0.15

Defined Under Namespace

Classes: Options

Constant Summary collapse

DEFAULT_EXCEPTIONS =
[Errno::ETIMEDOUT, 'Timeout::Error', Error::TimeoutError, Faraday::Error::RetriableResponse].freeze
IDEMPOTENT_METHODS =
[:delete, :get, :head, :options, :put]

Instance Method Summary collapse

Methods inherited from Middleware

dependency, inherited, loaded?, new

Methods included from MiddlewareRegistry

#fetch_middleware, #load_middleware, #lookup_middleware, #middleware_mutex, #register_middleware

Constructor Details

#initialize(app, options = nil) ⇒ Retry

Public: Initialize middleware

Options: max - Maximum number of retries (default: 2) interval - Pause in seconds between retries (default: 0) interval_randomness - The maximum random interval amount expressed

as a float between 0 and 1 to use in addition to the
interval. (default: 0)

max_interval - An upper limit for the interval (default: Float::MAX) backoff_factor - The amount to multiple each successive retry's

interval amount by in order to provide backoff
(default: 1)

exceptions - The list of exceptions to handle. Exceptions can be

given as Class, Module, or String. (default:
[Errno::ETIMEDOUT, 'Timeout::Error',
Error::TimeoutError, Faraday::Error::RetriableResponse])

methods - A list of HTTP methods to retry without calling retry_if. Pass

an empty Array to call retry_if for all exceptions.
(defaults to the idempotent HTTP methods in IDEMPOTENT_METHODS)

retry_if - block that will receive the env object and the exception raised

and should decide if the code should retry still the action or
not independent of the retry count. This would be useful
if the exception produced is non-recoverable or if the
the HTTP method called is not idempotent.
(defaults to return false)

retry_block - block that is executed after every retry. Request environment, middleware options,

current number of retries and the exception is passed to the block as parameters.

110
111
112
113
114
# File 'lib/faraday/request/retry.rb', line 110

def initialize(app, options = nil)
  super(app)
  @options = Options.from(options)
  @errmatch = build_exception_matcher(@options.exceptions)
end

Instance Method Details

#build_exception_matcher(exceptions) ⇒ Object

Private: construct an exception matcher object.

An exception matcher for the rescue clause can usually be any object that responds to `===`, but for Ruby 1.8 it has to be a Class or Module.


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/faraday/request/retry.rb', line 156

def build_exception_matcher(exceptions)
  matcher = Module.new
  (class << matcher; self; end).class_eval do
    define_method(:===) do |error|
      exceptions.any? do |ex|
        if ex.is_a? Module
          error.is_a? ex
        else
          error.class.to_s == ex.to_s
        end
      end
    end
  end
  matcher
end

#calculate_sleep_amount(retries, env) ⇒ Object


116
117
118
119
120
121
122
123
# File 'lib/faraday/request/retry.rb', line 116

def calculate_sleep_amount(retries, env)
  retry_after     = calculate_retry_after(env)
  retry_interval  = calculate_retry_interval(retries)

  return if retry_after && retry_after > @options.max_interval

  retry_after && retry_after >= retry_interval ? retry_after : retry_interval
end

#call(env) ⇒ Object


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/faraday/request/retry.rb', line 125

def call(env)
  retries = @options.max
  request_body = env[:body]
  begin
    env[:body] = request_body # after failure env[:body] is set to the response body
    @app.call(env).tap do |resp|
      raise Faraday::Error::RetriableResponse.new(nil, resp) if @options.retry_statuses.include?(resp.status)
    end
  rescue @errmatch => exception
    if retries > 0 && retry_request?(env, exception)
      retries -= 1
      rewind_files(request_body)
      @options.retry_block.call(env, @options, retries, exception)
      if (sleep_amount = calculate_sleep_amount(retries + 1, env))
        sleep sleep_amount
        retry
      end
    end

    if exception.is_a?(Faraday::Error::RetriableResponse)
      exception.response
    else
      raise
    end
  end
end