Class: Workhorse::Worker

Inherits:
Object
  • Object
show all
Defined in:
lib/workhorse/worker.rb

Constant Summary collapse

LOG_LEVELS = 
i[fatal error warn info debug].freeze
SHUTDOWN_SIGNALS = 
%w[TERM INT].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(queues: [], pool_size: nil, polling_interval: 5, auto_terminate: true, quiet: true, logger: nil) ⇒ Worker

Instantiates a new worker. The worker is not automatically started.

Parameters:

  • queues (Array) (defaults to: []) —

    The queues you want this worker to process. If an empty array is given, any queues will be processed. Queues need to be specified as a symbol. To also process jobs without a queue, supply ‘nil` within the array.

  • pool_size (Integer) (defaults to: nil) —

    The number of jobs that will be processed simultaneously. If this parameter is not given, it will be set to the number of given queues + 1.

  • polling_interval (Integer) (defaults to: 5) —

    Interval in seconds the database will be polled for new jobs. Set this as high as possible to avoid unnecessary database load Set this as high as possible to avoid unnecessary database load.

  • auto_terminate (Boolean) (defaults to: true) —

    Whether to automatically shut down the worker properly on INT and TERM signals.

  • quiet (Boolean) (defaults to: true) —

    If this is set to ‘false`, the worker will also log to STDOUT.

  • logger (Logger) (defaults to: nil) —

    An optional logger the worker will append to. This can be any instance of ruby’s ‘Logger` but is commonly set to `Rails.logger`.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/workhorse/worker.rb', line 41

def initialize(queues: [], pool_size: nil, polling_interval: 5, auto_terminate: true, quiet: true, logger: nil)
  @queues = queues
  @pool_size = pool_size || queues.size + 1
  @polling_interval = polling_interval
  @auto_terminate = auto_terminate
  @state = :initialized
  @quiet = quiet

  @mutex = Mutex.new
  @pool = Pool.new(@pool_size)
  @poller = Workhorse::Poller.new(self)
  @logger = logger

  fail 'Polling interval must be an integer.' unless @polling_interval.is_a?(Integer)

  check_rails_env if defined?(Rails)
end

Instance Attribute Details

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



11
12
13
 
# File 'lib/workhorse/worker.rb', line 11

def logger
  @logger
end

#mutex ⇒ Object (readonly)

Returns the value of attribute mutex.



10
11
12
 
# File 'lib/workhorse/worker.rb', line 10

def mutex
  @mutex
end

#polling_interval ⇒ Object (readonly)

Returns the value of attribute polling_interval.



9
10
11
 
# File 'lib/workhorse/worker.rb', line 9

def polling_interval
  @polling_interval
end

#pool_size ⇒ Object (readonly)

Returns the value of attribute pool_size.



8
9
10
 
# File 'lib/workhorse/worker.rb', line 8

def pool_size
  @pool_size
end

#queues ⇒ Object (readonly)

Returns the value of attribute queues.



6
7
8
 
# File 'lib/workhorse/worker.rb', line 6

def queues
  @queues
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



7
8
9
 
# File 'lib/workhorse/worker.rb', line 7

def state
  @state
end

Class Method Details

.start_and_wait(*args) ⇒ Object

Instantiates and starts a new worker with the given arguments and then waits for its completion (i.e. an interrupt).



15
16
17
18
19
 
# File 'lib/workhorse/worker.rb', line 15

def self.start_and_wait(*args)
  worker = new(*args)
  worker.start
  worker.wait
end

Instance Method Details

#assert_state!(state) ⇒ Object 



85
86
87
 
# File 'lib/workhorse/worker.rb', line 85

def assert_state!(state)
  fail "Expected worker to be in state #{state} but current state is #{self.state}." unless self.state == state
end

#id ⇒ Object 



67
68
69
 
# File 'lib/workhorse/worker.rb', line 67

def id
  @id ||= "#{Socket.gethostname}.#{Process.pid}.#{SecureRandom.hex(3)}"
end

#idle ⇒ Object 



118
119
120
 
# File 'lib/workhorse/worker.rb', line 118

def idle
  @pool.idle
end

#log(text, level = :info) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/workhorse/worker.rb', line 59

def log(text, level = :info)
  text = "[Job worker #{id}] #{text}"
  puts text unless @quiet
  return unless logger
  fail "Log level #{level} is not available. Available are #{LOG_LEVELS.inspect}." unless LOG_LEVELS.include?(level)
  logger.send(level, text.strip)
end

#perform(db_job) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/workhorse/worker.rb', line 122

def perform(db_job)
  mutex.synchronize do
    assert_state! :running
    log "Posting job #{db_job.id} to thread pool"

    @pool.post do
      begin
        Workhorse::Performer.new(db_job, self).perform
      rescue => e
        log %(#{e.message}\n#{e.backtrace.join("\n")}), :error
      end
    end
  end
end

#shutdown ⇒ Object

Shuts down worker and DB poller. Jobs currently beeing processed are properly finished before this method returns. Subsequent calls to this method are ignored.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/workhorse/worker.rb', line 92

def shutdown
  # This is safe to be checked outside of the mutex as 'shutdown' is the
  # final state this worker can be in.
  return if @state == :shutdown

  mutex.synchronize do
    assert_state! :running

    log 'Shutting down'
    @state = :shutdown

    @poller.shutdown
    @pool.shutdown
    log 'Shut down'
  end
end

#start ⇒ Object

Starts the worker. This call is not blocking - call #wait for this purpose.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/workhorse/worker.rb', line 73

def start
  mutex.synchronize do
    assert_state! :initialized
    log 'Starting up'
    @state = :running
    @poller.start
    log 'Started up'

    trap_termination if @auto_terminate
  end
end

#wait ⇒ Object

Waits until the worker is shut down. This only happens if shutdown gets called - either by another thread or by enabling ‘auto_terminate` and receiving a respective signal. Use this method to let worker run undefinitely.



113
114
115
116
 
# File 'lib/workhorse/worker.rb', line 113

def wait
  @poller.wait
  @pool.wait
end