Class: ZendeskAPI::Middleware::Request::Retry

Inherits:
Faraday::Middleware
  • Object
show all
Defined in:
lib/zendesk_api/middleware/request/retry.rb

Overview

Faraday middleware to handle HTTP Status 429 (rate limiting) / 503 (maintenance)

Constant Summary collapse

DEFAULT_RETRY_AFTER = 
10
DEFAULT_ERROR_CODES = 
[429, 503]

Instance Method Summary collapse

Constructor Details

#initialize(app, options = {}) ⇒ Retry

Returns a new instance of Retry.



12
13
14
15
16
17
 
# File 'lib/zendesk_api/middleware/request/retry.rb', line 12

def initialize(app, options = {})
  super(app)
  @logger = options[:logger]
  @error_codes = options.key?(:retry_codes) && options[:retry_codes] ? options[:retry_codes] : DEFAULT_ERROR_CODES
  @retry_on_exception = options.key?(:retry_on_exception) && options[:retry_on_exception] ? options[:retry_on_exception] : false
end

Instance Method Details

#call(env) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/zendesk_api/middleware/request/retry.rb', line 19

def call(env)
  original_env = env.dup
  exception_happened = false
  if @retry_on_exception
    begin
      response = @app.call(env)
    rescue StandardError => e
      exception_happened = true
    end
  else
    response = @app.call(env)
  end

  if exception_happened || @error_codes.include?(response.env[:status])

    if exception_happened
      seconds_left = DEFAULT_RETRY_AFTER.to_i
      @logger.warn "An exception happened, waiting #{seconds_left} seconds... #{e}" if @logger
    else
      seconds_left = (response.env[:response_headers][:retry_after] || DEFAULT_RETRY_AFTER).to_i
    end

    @logger.warn "You have been rate limited. Retrying in #{seconds_left} seconds..." if @logger

    seconds_left.times do |i|
      sleep 1
      time_left = seconds_left - i
      @logger.warn "#{time_left}..." if time_left > 0 && time_left % 5 == 0 && @logger
    end

    @logger.warn "" if @logger

    @app.call(original_env)
  else
    response
  end
end