Module: Resque

Extended by:
Forwardable, Resque
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, QuietFormatter, Server, TermException, VerboseFormatter, VeryVerboseFormatter, Worker

Constant Summary collapse

Version = 
VERSION = '1.25.1'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#after_pause(&block) ⇒ Object

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



173
174
175
 
# File 'lib/resque.rb', line 173

def after_pause(&block)
  block ? register_hook(:after_pause, block) : hooks(:after_pause)
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).



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

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

#inline ⇒ Object Also known as: inline?

Returns the value of attribute inline.



184
185
186
 
# File 'lib/resque.rb', line 184

def inline
  @inline
end

#logger ⇒ Object

Set or retrieve the current logger object



114
115
116
 
# File 'lib/resque.rb', line 114

def logger
  @logger
end

Class Method Details

.config ⇒ Object 



58
59
60
 
# File 'lib/resque.rb', line 58

def self.config
  @config ||= Config.new
end

.config=(options = {}) ⇒ Object 



54
55
56
 
# File 'lib/resque.rb', line 54

def self.config=(options = {})
  @config = Config.new(options)
end

.configure {|config| ... } ⇒ Object

Yields:



62
63
64
 
# File 'lib/resque.rb', line 62

def self.configure
  yield config
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.



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

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

#after_fork=(block) ⇒ Object

Register an after_fork proc.



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

def after_fork=(block)
  register_hook(:after_fork, 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.



123
124
125
 
# File 'lib/resque.rb', line 123

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.



128
129
130
 
# File 'lib/resque.rb', line 128

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.



138
139
140
 
# File 'lib/resque.rb', line 138

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

#before_fork=(block) ⇒ Object

Register a before_fork proc.



143
144
145
 
# File 'lib/resque.rb', line 143

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

#decode(object) ⇒ Object

Given a string, returns a Ruby object.



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

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.



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/resque.rb', line 350

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.



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

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.



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

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.



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/resque.rb', line 307

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.



426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/resque.rb', line 426

def info
  return {
    :pending   => queues.inject(0) { |m,k| m + size(k) },
    :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.



441
442
443
444
445
 
# File 'lib/resque.rb', line 441

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.



244
245
246
247
248
249
250
251
252
 
# File 'lib/resque.rb', line 244

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)



238
239
240
 
# File 'lib/resque.rb', line 238

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.



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

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



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

def push(queue, item)
  redis.pipelined do
    watch_queue(queue)
    redis.rpush "queue:#{queue}", encode(item)
  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.



368
369
370
371
 
# File 'lib/resque.rb', line 368

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

#queues ⇒ Object

Returns an array of all known Resque queues as strings.



255
256
257
 
# File 'lib/resque.rb', line 255

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

#redis ⇒ Object

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



96
97
98
99
100
 
# File 'lib/resque.rb', line 96

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`.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/resque.rb', line 73

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
  else
    @redis = Redis::Namespace.new(:resque, :redis => server)
  end
end

#redis_id ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/resque.rb', line 102

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.



260
261
262
263
264
265
 
# File 'lib/resque.rb', line 260

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



416
417
418
419
 
# File 'lib/resque.rb', line 416

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.



378
379
380
 
# File 'lib/resque.rb', line 378

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

#size(queue) ⇒ Object

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



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

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

#to_s ⇒ Object 



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

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`



387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/resque.rb', line 387

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

  if !queue
    raise NoQueueError.new("Jobs must be placed onto a queue.")
  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.



269
270
271
 
# File 'lib/resque.rb', line 269

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

#workers ⇒ Object

A shortcut to Worker.all



405
406
407
 
# File 'lib/resque.rb', line 405

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



410
411
412
 
# File 'lib/resque.rb', line 410

def working
  Worker.working
end