Module: Resque

Extended by:
Forwardable, Resque
Includes:
Helpers
Included in:
Resque
Defined in:
lib/resque.rb,
lib/resque/job.rb,
lib/resque/stat.rb,
lib/resque/errors.rb,
lib/resque/plugin.rb,
lib/resque/server.rb,
lib/resque/worker.rb,
lib/resque/failure.rb,
lib/resque/helpers.rb,
lib/resque/logging.rb,
lib/resque/version.rb,
lib/resque/failure/base.rb,
lib/resque/failure/redis.rb,
lib/resque/failure/airbrake.rb,
lib/resque/failure/multiple.rb,
lib/resque/server/test_helper.rb,
lib/resque/failure/redis_multi_queue.rb,
lib/resque/log_formatters/quiet_formatter.rb,
lib/resque/log_formatters/verbose_formatter.rb,
lib/resque/log_formatters/very_verbose_formatter.rb

Defined Under Namespace

Modules: Failure, Helpers, Logging, Plugin, Stat, TestHelper Classes: DirtyExit, Job, NoClassError, NoQueueError, PruneDeadWorkerDirtyExit, QuietFormatter, Server, TermException, VerboseFormatter, VeryVerboseFormatter, Worker

Constant Summary collapse

DEFAULT_HEARTBEAT_INTERVAL = 
60
DEFAULT_PRUNE_INTERVAL = 
DEFAULT_HEARTBEAT_INTERVAL * 5
Version = 
VERSION = '1.26.0'

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#heartbeat_interval ⇒ Object 



159
160
161
 
# File 'lib/resque.rb', line 159

def heartbeat_interval
  @heartbeat_interval || DEFAULT_HEARTBEAT_INTERVAL
end

#inline ⇒ Object Also known as: inline?

Returns the value of attribute inline.



240
241
242
 
# File 'lib/resque.rb', line 240

def inline
  @inline
end

#logger ⇒ Object

Set or retrieve the current logger object



153
154
155
 
# File 'lib/resque.rb', line 153

def logger
  @logger
end

#prune_interval ⇒ Object 



164
165
166
 
# File 'lib/resque.rb', line 164

def prune_interval
  @prune_interval || DEFAULT_PRUNE_INTERVAL
end

Instance Method Details

#after_fork(&block) ⇒ Object

The ‘after_fork` hook will be run in the child process and is passed the current job. Any changes you make, therefore, will only live as long as the job currently being processed.

Call with a block to register a hook. Call with no arguments to return all registered hooks.



205
206
207
 
# File 'lib/resque.rb', line 205

def after_fork(&block)
  block ? register_hook(:after_fork, block) : hooks(:after_fork)
end

#after_fork=(block) ⇒ Object

Register an after_fork proc.



210
211
212
 
# File 'lib/resque.rb', line 210

def after_fork=(block)
  register_hook(:after_fork, block)
end

#after_pause(&block) ⇒ Object

The ‘after_pause` hook will be run in the parent process after the worker has paused (via SIGCONT).



227
228
229
 
# File 'lib/resque.rb', line 227

def after_pause(&block)
  block ? register_hook(:after_pause, block) : hooks(:after_pause)
end

#after_pause=(block) ⇒ Object

Register an after_pause proc.



232
233
234
 
# File 'lib/resque.rb', line 232

def after_pause=(block)
  register_hook(:after_pause, block)
end

#before_first_fork(&block) ⇒ Object

The ‘before_first_fork` hook will be run in the parent process only once, before forking to run the first job. Be careful- any changes you make will be permanent for the lifespan of the worker.

Call with a block to register a hook. Call with no arguments to return all registered hooks.



175
176
177
 
# File 'lib/resque.rb', line 175

def before_first_fork(&block)
  block ? register_hook(:before_first_fork, block) : hooks(:before_first_fork)
end

#before_first_fork=(block) ⇒ Object

Register a before_first_fork proc.



180
181
182
 
# File 'lib/resque.rb', line 180

def before_first_fork=(block)
  register_hook(:before_first_fork, block)
end

#before_fork(&block) ⇒ Object

The ‘before_fork` hook will be run in the parent process before every job, so be careful- any changes you make will be permanent for the lifespan of the worker.

Call with a block to register a hook. Call with no arguments to return all registered hooks.



190
191
192
 
# File 'lib/resque.rb', line 190

def before_fork(&block)
  block ? register_hook(:before_fork, block) : hooks(:before_fork)
end

#before_fork=(block) ⇒ Object

Register a before_fork proc.



195
196
197
 
# File 'lib/resque.rb', line 195

def before_fork=(block)
  register_hook(:before_fork, block)
end

#before_pause(&block) ⇒ Object

The ‘before_pause` hook will be run in the parent process before the worker has paused processing (via #pause_processing or SIGUSR2).



216
217
218
 
# File 'lib/resque.rb', line 216

def before_pause(&block)
  block ? register_hook(:before_pause, block) : hooks(:before_pause)
end

#before_pause=(block) ⇒ Object

Register a before_pause proc.



221
222
223
 
# File 'lib/resque.rb', line 221

def before_pause=(block)
  register_hook(:before_pause, block)
end

#classify(dashed_word) ⇒ Object

Given a word with dashes, returns a camel cased version of it.

classify(‘job-name’) # => ‘JobName’



56
57
58
 
# File 'lib/resque.rb', line 56

def classify(dashed_word)
  dashed_word.split('-').each { |part| part[0] = part[0].chr.upcase }.join
end

#constantize(camel_cased_word) ⇒ Object

Tries to find a constant with the name specified in the argument string:

constantize(“Module”) # => Module constantize(“Test::Unit”) # => Test::Unit

The name is assumed to be the one of a top-level constant, no matter whether it starts with “::” or not. No lexical context is taken into account:

C = ‘outside’ module M

C = 'inside'
C # => 'inside'
constantize("C") # => 'outside', same as ::C

end

NameError is raised when the constant is unknown.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/resque.rb', line 77

def constantize(camel_cased_word)
  camel_cased_word = camel_cased_word.to_s

  if camel_cased_word.include?('-')
    camel_cased_word = classify(camel_cased_word)
  end

  names = camel_cased_word.split('::')
  names.shift if names.empty? || names.first.empty?

  constant = Object
  names.each do |name|
    args = Module.method(:const_get).arity != 1 ? [false] : []

    if constant.const_defined?(name, *args)
      constant = constant.const_get(name)
    else
      constant = constant.const_missing(name)
    end
  end
  constant
end

#decode(object) ⇒ Object

Given a string, returns a Ruby object.



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/resque.rb', line 39

def decode(object)
  return unless object

  begin
    if MultiJson.respond_to?(:dump) && MultiJson.respond_to?(:load)
      MultiJson.load object
    else
      MultiJson.decode object
    end
  rescue ::MultiJson::DecodeError => e
    raise Helpers::DecodeException, e.message, e.backtrace
  end
end

#dequeue(klass, *args) ⇒ Object

This method can be used to conveniently remove a job from a queue. It assumes the class you’re passing it is a real Ruby class (not a string or reference) which either:

a) has a @queue ivar set
b) responds to `queue`

If either of those conditions are met, it will use the value obtained from performing one of the above operations to determine the queue.

If no queue can be inferred this method will raise a ‘Resque::NoQueueError`

If no args are given, this method will dequeue all jobs matching the provided class. See ‘Resque::Job.destroy` for more information.

Returns the number of jobs destroyed.

Example:

# Removes all jobs of class `UpdateNetworkGraph`
Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph)

# Removes all jobs of class `UpdateNetworkGraph` with matching args.
Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph, 'repo:135325')

This method is considered part of the ‘stable` API.



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/resque.rb', line 407

def dequeue(klass, *args)
  # Perform before_dequeue hooks. Don't perform dequeue if any hook returns false
  before_hooks = Plugin.before_dequeue_hooks(klass).collect do |hook|
    klass.send(hook, *args)
  end
  return if before_hooks.any? { |result| result == false }

  destroyed = Job.destroy(queue_from_class(klass), klass, *args)

  Plugin.after_dequeue_hooks(klass).each do |hook|
    klass.send(hook, *args)
  end

  destroyed
end

#encode(object) ⇒ Object

Given a Ruby object, returns a string suitable for storage in a queue.



30
31
32
33
34
35
36
 
# File 'lib/resque.rb', line 30

def encode(object)
  if MultiJson.respond_to?(:dump) && MultiJson.respond_to?(:load)
    MultiJson.dump object
  else
    MultiJson.encode object
  end
end

#enqueue(klass, *args) ⇒ Object

This method can be used to conveniently add a job to a queue. It assumes the class you’re passing it is a real Ruby class (not a string or reference) which either:

a) has a @queue ivar set
b) responds to `queue`

If either of those conditions are met, it will use the value obtained from performing one of the above operations to determine the queue.

If no queue can be inferred this method will raise a ‘Resque::NoQueueError`

Returns true if the job was queued, nil if the job was rejected by a before_enqueue hook.

This method is considered part of the ‘stable` API.



351
352
353
 
# File 'lib/resque.rb', line 351

def enqueue(klass, *args)
  enqueue_to(queue_from_class(klass), klass, *args)
end

#enqueue_to(queue, klass, *args) ⇒ Object

Just like ‘enqueue` but allows you to specify the queue you want to use. Runs hooks.

‘queue` should be the String name of the queue you’re targeting.

Returns true if the job was queued, nil if the job was rejected by a before_enqueue hook.

This method is considered part of the ‘stable` API.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/resque.rb', line 364

def enqueue_to(queue, klass, *args)
  # Perform before_enqueue hooks. Don't perform enqueue if any hook returns false
  before_hooks = Plugin.before_enqueue_hooks(klass).collect do |hook|
    klass.send(hook, *args)
  end
  return nil if before_hooks.any? { |result| result == false }

  Job.create(queue, klass, *args)

  Plugin.after_enqueue_hooks(klass).each do |hook|
    klass.send(hook, *args)
  end

  return true
end

#info ⇒ Object

Returns a hash, similar to redis-rb’s #info, of interesting stats.



483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/resque.rb', line 483

def info
  return {
    :pending   => queue_sizes.inject(0) { |sum, (queue_name, queue_size)| sum + queue_size },
    :processed => Stat[:processed],
    :queues    => queues.size,
    :workers   => workers.size.to_i,
    :working   => working.size,
    :failed    => Resque.redis.llen(:failed).to_i,
    :servers   => [redis_id],
    :environment  => ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
  }
end

#keys ⇒ Object

Returns an array of all known Resque keys in Redis. Redis’ KEYS operation is O(N) for the keyspace, so be careful - this can be slow for big databases.



498
499
500
501
502
 
# File 'lib/resque.rb', line 498

def keys
  redis.keys("*").map do |key|
    key.sub("#{redis.namespace}:", '')
  end
end

#list_range(key, start = 0, count = 1) ⇒ Object

Does the dirty work of fetching a range of items from a Redis list and converting them into Ruby objects.



301
302
303
304
305
306
307
308
309
 
# File 'lib/resque.rb', line 301

def list_range(key, start = 0, count = 1)
  if count == 1
    decode redis.lindex(key, start)
  else
    Array(redis.lrange(key, start, start+count-1)).map do |item|
      decode item
    end
  end
end

#peek(queue, start = 0, count = 1) ⇒ Object

Returns an array of items currently queued. Queue name should be a string.

start and count should be integer and can be used for pagination. start is the item to begin, count is how many items to return.

To get the 3rd page of a 30 item, paginatied list one would use:

Resque.peek('my_list', 59, 30)



295
296
297
 
# File 'lib/resque.rb', line 295

def peek(queue, start = 0, count = 1)
  list_range("queue:#{queue}", start, count)
end

#pop(queue) ⇒ Object

Pops a job off a queue. Queue name should be a string.

Returns a Ruby object.



277
278
279
 
# File 'lib/resque.rb', line 277

def pop(queue)
  decode redis.lpop("queue:#{queue}")
end

#push(queue, item) ⇒ Object

Pushes a job onto a queue. Queue name should be a string and the item should be any JSON-able Ruby object.

Resque works generally expect the ‘item` to be a hash with the following keys:

class - The String name of the job to run.
 args - An Array of arguments to pass the job. Usually passed
        via `class.to_class.perform(*args)`.

Example

Resque.push('archive', :class => 'Archive', :args => [ 35, 'tar' ])

Returns nothing



266
267
268
269
270
271
272
 
# File 'lib/resque.rb', line 266

def push(queue, item)
  encoded = encode(item)
  redis.pipelined do
    watch_queue(queue)
    redis.rpush "queue:#{queue}", encoded
  end
end

#queue_from_class(klass) ⇒ Object

Given a class, try to extrapolate an appropriate queue based on a class instance variable or ‘queue` method.



425
426
427
428
 
# File 'lib/resque.rb', line 425

def queue_from_class(klass)
  klass.instance_variable_get(:@queue) ||
    (klass.respond_to?(:queue) and klass.queue)
end

#queue_sizes ⇒ Object

Returns a hash, mapping queue names to queue sizes



505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/resque.rb', line 505

def queue_sizes
  queue_names = queues

  sizes = redis.pipelined do
    queue_names.each do |name|
      redis.llen("queue:#{name}")
    end
  end

  Hash[queue_names.zip(sizes)]
end

#queues ⇒ Object

Returns an array of all known Resque queues as strings.



312
313
314
 
# File 'lib/resque.rb', line 312

def queues
  Array(redis.smembers(:queues))
end

#redis ⇒ Object

Returns the current Redis connection. If none has been created, will create a new one.



135
136
137
138
139
 
# File 'lib/resque.rb', line 135

def redis
  return @redis if @redis
  self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379"
  self.redis
end

#redis=(server) ⇒ Object

Accepts:

1. A 'hostname:port' String
2. A 'hostname:port:db' String (to select the Redis db)
3. A 'hostname:port/namespace' String (to set the Redis namespace)
4. A Redis URL String 'redis://host:port'
5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
   or `Redis::Namespace`.
6. An Hash of a redis connection {:host => 'localhost', :port => 6379, :db => 0}



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/resque.rb', line 110

def redis=(server)
  case server
  when String
    if server =~ /redis\:\/\//
      redis = Redis.connect(:url => server, :thread_safe => true)
    else
      server, namespace = server.split('/', 2)
      host, port, db = server.split(':')
      redis = Redis.new(:host => host, :port => port,
        :thread_safe => true, :db => db)
    end
    namespace ||= :resque

    @redis = Redis::Namespace.new(namespace, :redis => redis)
  when Redis::Namespace
    @redis = server
  when Hash
    @redis = Redis::Namespace.new(:resque, :redis => Redis.new(server))
  else
    @redis = Redis::Namespace.new(:resque, :redis => server)
  end
end

#redis_id ⇒ Object 



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/resque.rb', line 141

def redis_id
  # support 1.x versions of redis-rb
  if redis.respond_to?(:server)
    redis.server
  elsif redis.respond_to?(:nodes) # distributed
    redis.nodes.map { |n| n.id }.join(', ')
  else
    redis.client.id
  end
end

#remove_queue(queue) ⇒ Object

Given a queue name, completely deletes the queue.



317
318
319
320
321
322
 
# File 'lib/resque.rb', line 317

def remove_queue(queue)
  redis.pipelined do
    redis.srem(:queues, queue.to_s)
    redis.del("queue:#{queue}")
  end
end

#remove_worker(worker_id) ⇒ Object

A shortcut to unregister_worker useful for command line tool



473
474
475
476
 
# File 'lib/resque.rb', line 473

def remove_worker(worker_id)
  worker = Resque::Worker.find(worker_id)
  worker.unregister_worker
end

#reserve(queue) ⇒ Object

This method will return a ‘Resque::Job` object or a non-true value depending on whether a job can be obtained. You should pass it the precise name of a queue: case matters.

This method is considered part of the ‘stable` API.



435
436
437
 
# File 'lib/resque.rb', line 435

def reserve(queue)
  Job.reserve(queue)
end

#sample_queues(sample_size = 1000) ⇒ Object

Returns a hash, mapping queue names to (up to ‘sample_size`) samples of jobs in that queue



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/resque.rb', line 518

def sample_queues(sample_size = 1000)
  queue_names = queues

  samples = redis.pipelined do
    queue_names.each do |name|
      key = "queue:#{name}"
      redis.llen(key)
      redis.lrange(key, 0, sample_size - 1)
    end
  end

  hash = {}

  queue_names.zip(samples.each_slice(2).to_a) do |queue_name, (queue_size, serialized_samples)|
    samples = serialized_samples.map do |serialized_sample|
      Job.decode(serialized_sample)
    end

    hash[queue_name] = {
      :size => queue_size,
      :samples => samples
    }
  end

  hash
end

#size(queue) ⇒ Object

Returns an integer representing the size of a queue. Queue name should be a string.



283
284
285
 
# File 'lib/resque.rb', line 283

def size(queue)
  redis.llen("queue:#{queue}").to_i
end

#to_s ⇒ Object 



236
237
238
 
# File 'lib/resque.rb', line 236

def to_s
  "Resque Client connected to #{redis_id}"
end

#validate(klass, queue = nil) ⇒ Object

Validates if the given klass could be a valid Resque job

If no queue can be inferred this method will raise a ‘Resque::NoQueueError`

If given klass is nil this method will raise a ‘Resque::NoClassError`



444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/resque.rb', line 444

def validate(klass, queue = nil)
  queue ||= queue_from_class(klass)

  if !queue
    raise NoQueueError.new("Jobs must be placed onto a queue. No queue could be inferred for class #{klass}")
  end

  if klass.to_s.empty?
    raise NoClassError.new("Jobs must be given a class.")
  end
end

#watch_queue(queue) ⇒ Object

Used internally to keep track of which queues we’ve created. Don’t call this directly.



326
327
328
 
# File 'lib/resque.rb', line 326

def watch_queue(queue)
  redis.sadd(:queues, queue.to_s)
end

#workers ⇒ Object

A shortcut to Worker.all



462
463
464
 
# File 'lib/resque.rb', line 462

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



467
468
469
 
# File 'lib/resque.rb', line 467

def working
  Worker.working
end