123456789_123456789_123456789_123456789_123456789_

Class: Bundler::Retry

Relationships & Source Files
Inherits: Object
Defined in: lib/bundler/retry.rb

Overview

General purpose class for retrying code that may fail

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name, exceptions = nil, retries = self.class.default_retries, opts = {}) ⇒ Retry

[ GitHub ] 

  


# File 'lib/bundler/retry.rb', line 24



def initialize(name, exceptions = nil, retries = self.class.default_retries, opts = {})
  @name = name
  @retries = retries
  @exceptions = Array(exceptions) || []
  @total_runs = @retries + 1 # will run once, then upto attempts.times
  @base_delay = opts[:base_delay] || self.class.default_base_delay
  @max_delay = opts[:max_delay] || 60.0
  @jitter = opts[:jitter] || 0.5
end


  







Class Attribute Details



  

    .default_base_delay   (rw)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 9



attr_accessor :default_base_delay


  







Class Method Details



  

    .attempts  
  



  

    

Alias for .default_attempts.


  



  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 14



alias_method :attempts, :default_attempts


  








  

    .default_attempts  
    Also known as: .attempts
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 11



def default_attempts
  default_retries + 1
end


  








  

    .default_retries  
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 16



def default_retries
  Bundler.settings[:retry]
end


  







Instance Attribute Details



  

    #current_run   (rw)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 6



attr_accessor :name, :total_runs, :current_run


  








  

    #keep_trying?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 82



def keep_trying?
  return true  if current_run.zero?
  return false if last_attempt?
  true if @failed
end


  








  

    #last_attempt?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 88



def last_attempt?
  current_run >= total_runs
end


  








  

    #name   (rw)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 6



attr_accessor :name, :total_runs, :current_run


  








  

    #total_runs   (rw)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 6



attr_accessor :name, :total_runs, :current_run


  







Instance Method Details



  

    #attempt(&block)  
    Also known as: #attempts
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 34



def attempt(&block)
  @current_run = 0
  @failed      = false
  @error       = nil
  run(&block) while keep_trying?
  @result
end


  








  

    #attempts(&block)  
  



  

    

Alias for #attempt.


  



  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 41



alias_method :attempts, :attempt


  








  

    #backoff_sleep   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 67



def backoff_sleep
  # Exponential backoff: delay = base_delay * 2^(attempt - 1)
  # Add jitter to prevent thundering herd: random value between 0 and jitter seconds
  delay = @base_delay * (2**(@current_run - 1))
  delay = [@max_delay, delay].min
  jitter_amount = rand * @jitter
  total_delay = delay + jitter_amount
  Bundler.ui.debug "Sleeping for #{total_delay.round(2)} seconds before retry"
  sleep(total_delay)
end


  








  

    #fail_attempt(e)   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 53



def fail_attempt(e)
  @failed = true
  if last_attempt? || @exceptions.any? {|k| e.is_a?(k) }
    Bundler.ui.info "" unless Bundler.ui.debug?
    raise e
  end
  if name
    Bundler.ui.info "" unless Bundler.ui.debug? # Add new line in case dots preceded this
    Bundler.ui.warn "Retrying #{name} due to error (#{current_run.next}/#{total_runs}): #{e.class} #{e.message}", true
  end
  backoff_sleep if @base_delay > 0
  true
end


  








  

    #run(&block)   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 45



def run(&block)
  @failed = false
  @current_run += 1
  @result = block.call
rescue StandardError => e
  fail_attempt(e)
end


  








  

    #sleep(duration)   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/retry.rb', line 78



def sleep(duration)
  Kernel.sleep(duration)
end