123456789_123456789_123456789_123456789_123456789_

Class: Bundler::Worker

Relationships & Source Files
Namespace Children
Exceptions:
WrappedException
Inherits: Object
Defined in: lib/bundler/worker.rb

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(size, name, func) ⇒ Worker

Creates a worker pool of specified size

Parameters:

  • size (Integer) —

    Size of pool

  • name (String) —

    name the name of the worker

  • func (Proc) —

    job to run in inside the worker pool

[ GitHub ] 

  


# File 'lib/bundler/worker.rb', line 22



def initialize(size, name, func)
  @name = name
  @request_queue = Thread::Queue.new
  @response_queue = Thread::Queue.new
  @func = func
  @size = size
  @threads = nil
  @previous_interrupt_handler = nil
end


  







Instance Attribute Details



  

    #name  ⇒ String  (readonly)
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    

    the name of the worker
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 15



attr_reader :name


  







Instance Method Details



  

    #abort_threads   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 80



def abort_threads
  Bundler.ui.debug("\n#{caller.join("\n")}")
  @threads.each(&:exit)
  exit 1
end


  








  

    #add_interrupt_handler   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 107



def add_interrupt_handler
  @previous_interrupt_handler = trap("INT") { abort_threads }
end


  








  

    #apply_func(obj, i)   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 61



def apply_func(obj, i)
  @func.call(obj, i)
rescue Exception => e # rubocop:disable Lint/RescueException
  WrappedException.new(e)
end


  








  

    #create_threads   (private)
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 86



def create_threads
  creation_errors = []

  @threads = Array.new(@size) do |i|
    Thread.start { process_queue(i) }.tap do |thread|
      thread.name = "#{name} Worker ##{i}" if thread.respond_to?(:name=)
    end
  rescue ThreadError => e
    creation_errors << e
    nil
  end.compact

  add_interrupt_handler unless @threads.empty?

  return if creation_errors.empty?

  message = "Failed to create threads for the #{name} worker: #{creation_errors.map(&:to_s).uniq.join(", ")}"
  raise ThreadCreationError, message if @threads.empty?
  Bundler.ui.info message
end


  








  

    #deq  
  



  

    

Retrieves results of job function being executed in worker pool


  



  [ GitHub ]


  

  


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



def deq
  result = @response_queue.deq
  raise result.exception if result.is_a?(WrappedException)
  result
end


  








  

    #enq(obj)  
  



  

    

Enqueue a request to be executed in the worker pool


  





  
Parameters:


    
  
  • 
    obj
    (String)
—    
    

    mostly it is name of spec that should be downloaded
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 35



def enq(obj)
  create_threads unless @threads
  @request_queue.enq obj
end


  








  

    #process_queue(i)   (private)
  

  [ GitHub ]


  

  


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



def process_queue(i)
  loop do
    obj = @request_queue.deq
    break if obj.equal? POISON
    @response_queue.enq apply_func(obj, i)
  end
end


  








  

    #remove_interrupt_handler   (private)
  

  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 111



def remove_interrupt_handler
  return unless @previous_interrupt_handler

  trap "INT", @previous_interrupt_handler
end


  








  

    #stop  
  

  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 47



def stop
  stop_threads
end


  








  

    #stop_threads   (private)
  



  

    

Stop the worker threads by sending a poison object down the request queue so as worker threads after retrieving it, shut themselves down


  



  [ GitHub ]


  

  


# File 'lib/bundler/worker.rb', line 69



def stop_threads
  return unless @threads

  @threads.each { @request_queue.enq POISON }
  @threads.each(&:join)

  remove_interrupt_handler

  @threads = nil
end