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/mongo.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, QueueError, Server, Worker

Constant Summary collapse

Version = 
VERSION = '1.12.5'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers

#classify, #constantize, #decode, #encode

Instance Attribute Details

#bypass_queues ⇒ Object

Returns the value of attribute bypass_queues.



26
27
28
 
# File 'lib/resque.rb', line 26

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



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

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

#after_fork=(after_fork) ⇒ Object

Set the after_fork proc.



132
133
134
 
# File 'lib/resque.rb', line 132

def after_fork=(after_fork)
  @after_fork = after_fork
end

#allows_delayed_jobs(klass) ⇒ Object 



145
146
147
148
 
# File 'lib/resque.rb', line 145

def allows_delayed_jobs(klass)
  klass.instance_variable_get(:@delayed_jobs) ||
    (klass.respond_to?(:delayed_jobs) and klass.delayed_jobs)
end

#allows_unique_jobs(klass) ⇒ Object 



140
141
142
143
 
# File 'lib/resque.rb', line 140

def allows_unique_jobs(klass)
  klass.instance_variable_get(:@unique_jobs) ||
    (klass.respond_to?(:unique_jobs) and klass.unique_jobs)
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.



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

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.



102
103
104
 
# File 'lib/resque.rb', line 102

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.



112
113
114
 
# File 'lib/resque.rb', line 112

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

#before_fork=(before_fork) ⇒ Object

Set the before_fork proc.



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

def before_fork=(before_fork)
  @before_fork = before_fork
end

#delayed_size(queue) ⇒ Object 



197
198
199
200
201
202
203
 
# File 'lib/resque.rb', line 197

def delayed_size(queue)
  if queue_allows_delayed queue
    mongo[queue].find({'delay_until' => { '$gt' => Time.new}}).count
  else
    mongo[queue].count
  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.



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

def dequeue(klass, *args)
  Job.destroy(queue_from_class(klass), klass, *args)
end

#drop ⇒ Object 



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

def drop
  mongo.collections.each{ |collection| collection.drop unless collection.name =~ /^system./ }
  @mongo = nil
end

#enable_delay(queue) ⇒ Object 



154
155
156
157
158
159
 
# File 'lib/resque.rb', line 154

def enable_delay(queue)
  unless queue_allows_delayed queue
    @delay_allowed << queue 
    mongo_stats.update({:stat => 'Delayable Queues'}, { '$addToSet' => { 'value' => queue}}, { :upsert => true})
  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`

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



276
277
278
279
280
281
282
 
# File 'lib/resque.rb', line 276

def enqueue(klass, *args)
  if @bypass_queues
    klass.send(:perform, *args)
  else
    Job.create(queue_from_class(klass), klass, *args)
  end
end

#info ⇒ Object

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



358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/resque.rb', line 358

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

#initialize_mongo ⇒ Object 



70
71
72
73
74
75
 
# File 'lib/resque.rb', line 70

def initialize_mongo
  mongo_workers.create_index :worker
  mongo_stats.create_index :stat
  delay_allowed = mongo_stats.find_one({ :stat => 'Delayable Queues'}, { :fields => ['value']})
  @delay_allowed = delay_allowed['value'].map{ |queue| queue.to_sym} if delay_allowed    
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.



373
374
375
 
# File 'lib/resque.rb', line 373

def keys
  names = mongo.collection_names
end

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

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/resque.rb', line 228

def list_range(key, start = 0, count = 1, mode = :ready)
  query = { }
  sort = []
  if queue_allows_delayed(key)
    if mode == :ready
      query['delay_until'] = { '$not' => { '$gt' => Time.new}}
    elsif mode == :delayed
      query['delay_until'] = { '$gt' => Time.new}
    elsif mode == :delayed_sorted
      query['delay_until'] = { '$gt' => Time.new}
      sort << ['delay_until', 1]
    elsif mode == :all_sorted
      query = {}
      sort << ['delay_until', 1]
    end
  end
  items = mongo[key].find(query, { :limit => count, :skip => start, :sort => sort}).to_a.map{ |i| i}
  count > 1 ? items : items.first
end

#mongo ⇒ Object

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



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

def mongo
  return @mongo if @mongo
  self.mongo = 'localhost:27017/resque'
  self.mongo
end

#mongo=(server) ⇒ Object 



31
32
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 31

def mongo=(server)
  if server.is_a? String
    opts = server.split(':')
    host = opts[0]
    if opts[1] =~ /\//
      opts = opts[1].split('/')
      port = opts[0]
      queuedb = opts[1]
    else
      port = opts[1]
    end
    conn = Mongo::Connection.new host, port
  elsif server.is_a? Hash
    conn = Mongo::Connection.new(options[:server], options[:port], options)
    queuedb = options[:queuedb] || 'resque'
  elsif server.is_a? Mongo::Connection
    conn = server
  end
  queuedb ||= 'resque'
  @mongo = conn.db queuedb    
  initialize_mongo
end

#mongo? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/resque.rb', line 66

def mongo?
  return @mongo
end

#mongo_db=(db) ⇒ Object 



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

def mongo_db=(db)
    mongo.conn.db = db
end

#mongo_failures ⇒ Object 



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

def mongo_failures
  mongo['resque.failures']
end

#mongo_stats ⇒ Object 



81
82
83
 
# File 'lib/resque.rb', line 81

def mongo_stats
  mongo['resque.metrics']
end

#mongo_workers ⇒ Object 



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

def mongo_workers
  mongo['resque.workers']
end

#peek(queue, start = 0, count = 1, mode = :ready) ⇒ 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)



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

def peek(queue, start = 0, count = 1, mode = :ready)
  list_range(queue, start, count, mode)
end

#pop(queue) ⇒ Object

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

Returns a Ruby object.



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/resque.rb', line 179

def pop(queue)
  query = { }
  if queue_allows_delayed queue
    query['delay_until'] = { '$not' => { '$gt' => Time.new}}
  end
  #sorting will result in significant performance penalties for large queues, you have been warned.
  item = mongo[queue].find_and_modify(:query => query, :remove => true, :sort => [[:_id, :asc]] )
rescue Mongo::OperationFailure => e
  return nil if e.message =~ /No matching object/
  raise e
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.



167
168
169
170
171
172
173
174
 
# File 'lib/resque.rb', line 167

def push(queue, item)
  item[:resque_enqueue_timestamp] = Time.now
  if item[:unique]
    mongo[queue].update({'_id' => item[:_id]}, item, { :upsert => true})
  else
    mongo[queue] << item
  end
end

#queue_allows_delayed(queue) ⇒ Object 



150
151
152
 
# File 'lib/resque.rb', line 150

def queue_allows_delayed(queue)
  @delay_allowed.include?(queue.to_sym) || @delay_allowed.include?(queue.to_s)
end

#queue_from_class(klass) ⇒ Object

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



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

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.



249
250
251
252
 
# File 'lib/resque.rb', line 249

def queues    
  names = mongo.collection_names
  names.delete_if{ |name| name =~ /system./ || name =~ /resque\./ }  
end

#ready_size(queue) ⇒ Object 



205
206
207
208
209
210
211
 
# File 'lib/resque.rb', line 205

def ready_size(queue)
  if queue_allows_delayed queue
    mongo[queue].find({'delay_until' =>  { '$not' => { '$gt' => Time.new}}}).count
  else
    mongo[queue].count
  end
end

#remove_queue(queue) ⇒ Object

Given a queue name, completely deletes the queue.



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

def remove_queue(queue)
  mongo[queue].drop
end

#remove_worker(worker_id) ⇒ Object

A shortcut to unregister_worker useful for command line tool



348
349
350
351
 
# File 'lib/resque.rb', line 348

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.



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

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.



193
194
195
 
# File 'lib/resque.rb', line 193

def size(queue) 
  mongo[queue].count
end

#to_s ⇒ Object 



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

def to_s
  "Resque Client connected to #{mongo.connection.host}:#{mongo.connection.port}/#{mongo.name}"
end

#workers ⇒ Object

A shortcut to Worker.all



337
338
339
 
# File 'lib/resque.rb', line 337

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



342
343
344
 
# File 'lib/resque.rb', line 342

def working
  Worker.working
end