Module: Resque

Extended by:
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/version.rb,
lib/resque/failure/base.rb,
lib/resque/failure/redis.rb,
lib/resque/failure/hoptoad.rb,
lib/resque/failure/multiple.rb,
lib/resque/server/test_helper.rb

Defined Under Namespace

Modules: Failure, Helpers, Plugin, Stat, TestHelper Classes: DirtyExit, Job, NoClassError, NoQueueError, Server, Worker

Constant Summary collapse

Version = 
VERSION = '1.16.0'

Instance Method Summary collapse

Methods included from Helpers

#classify, #constantize, #decode, #encode

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 set the hook. Call with no arguments to return the hook.



109
110
111
 
# File 'lib/resque.rb', line 109

def after_fork(&block)
  block ? (@after_fork = block) : @after_fork
end

#after_fork=(after_fork) ⇒ Object

Set the after_fork proc.



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

def after_fork=(after_fork)
  @after_fork = after_fork
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 set the hook. Call with no arguments to return the hook.



78
79
80
 
# File 'lib/resque.rb', line 78

def before_first_fork(&block)
  block ? (@before_first_fork = block) : @before_first_fork
end

#before_first_fork=(before_first_fork) ⇒ Object

Set a proc that will be called in the parent process before the worker forks for the first time.



84
85
86
 
# File 'lib/resque.rb', line 84

def before_first_fork=(before_first_fork)
  @before_first_fork = before_first_fork
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 set the hook. Call with no arguments to return the hook.



94
95
96
 
# File 'lib/resque.rb', line 94

def before_fork(&block)
  block ? (@before_fork = block) : @before_fork
end

#before_fork=(before_fork) ⇒ Object

Set the before_fork proc.



99
100
101
 
# File 'lib/resque.rb', line 99

def before_fork=(before_fork)
  @before_fork = before_fork
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.



265
266
267
 
# File 'lib/resque.rb', line 265

def dequeue(klass, *args)
  Job.destroy(queue_from_class(klass), klass, *args)
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`

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



230
231
232
233
234
235
236
 
# File 'lib/resque.rb', line 230

def enqueue(klass, *args)
  Job.create(queue_from_class(klass), klass, *args)

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

#info ⇒ Object

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



329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/resque.rb', line 329

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    => Stat[:failed],
    :servers   => [redis_id],
    :environment  => ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
  }
end

#inline=(inline) ⇒ Object 



130
131
132
 
# File 'lib/resque.rb', line 130

def inline=(inline)
  @inline = inline
end

#inline? ⇒ Boolean Also known as: inline

If ‘inline’ is true Resque will call #perform method inline without queuing it into Redis and without any Resque callbacks. The ‘inline’ is false Resque jobs will be put in queue regularly.

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/resque.rb', line 125

def inline?
  @inline
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.



344
345
346
347
348
 
# File 'lib/resque.rb', line 344

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.



185
186
187
188
189
190
191
192
193
 
# File 'lib/resque.rb', line 185

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)



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

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.



161
162
163
 
# File 'lib/resque.rb', line 161

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



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

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

#queue_from_class(klass) ⇒ Object

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



271
272
273
274
 
# File 'lib/resque.rb', line 271

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.



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

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

#redis ⇒ Object

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



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

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



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/resque.rb', line 33

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 



62
63
64
65
66
67
68
69
 
# File 'lib/resque.rb', line 62

def redis_id
  # support 1.x versions of redis-rb
  if redis.respond_to?(:server)
    redis.server
  else
    redis.client.id
  end
end

#remove_queue(queue) ⇒ Object

Given a queue name, completely deletes the queue.



201
202
203
204
 
# File 'lib/resque.rb', line 201

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

#remove_worker(worker_id) ⇒ Object

A shortcut to unregister_worker useful for command line tool



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

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.



281
282
283
 
# File 'lib/resque.rb', line 281

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.



167
168
169
 
# File 'lib/resque.rb', line 167

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

#to_s ⇒ Object 



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

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`



290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/resque.rb', line 290

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.



208
209
210
 
# File 'lib/resque.rb', line 208

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

#workers ⇒ Object

A shortcut to Worker.all



308
309
310
 
# File 'lib/resque.rb', line 308

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



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

def working
  Worker.working
end