Module: Resque

Extended by:
Forwardable, Resque
Includes:
Helpers
Included in:
Resque
Defined in:
lib/resque/web_runner.rb,
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/railtie.rb,
lib/resque/version.rb,
lib/resque/data_store.rb,
lib/resque/failure/base.rb,
lib/resque/failure/redis.rb,
lib/resque/server_helper.rb,
lib/resque/failure/airbrake.rb,
lib/resque/failure/multiple.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

Overview

only used with bin/resque-web https://github.com/resque/resque/pull/1780

Defined Under Namespace

Modules: Failure, Helpers, Logging, Plugin, ServerHelper, Stat Classes: DataStore, DirtyExit, Job, NoClassError, NoQueueError, PruneDeadWorkerDirtyExit, QuietFormatter, Railtie, Server, TermException, ThreadSignal, VerboseFormatter, VeryVerboseFormatter, WebRunner, Worker

Constant Summary collapse

DEFAULT_HEARTBEAT_INTERVAL = 
60
DEFAULT_PRUNE_INTERVAL = 
DEFAULT_HEARTBEAT_INTERVAL * 5
MultiJson =

multi_json renamed it's top-level constant from MultiJson to MultiJSON, keeping MultiJson as a deprecated alias until v2.0. Reference whichever name the installed version exposes so we stay compatible with future versions of multi_json

defined?(::MultiJSON) ? ::MultiJSON : ::MultiJson
VERSION = 
'3.1.0'
WINDOWS = 
!!(RUBY_PLATFORM =~ /(mingw|bccwin|wince|mswin32)/i)
JRUBY = 
!!(RbConfig::CONFIG["RUBY_INSTALL_NAME"] =~ /^jruby/i)

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#enqueue_front ⇒ Object 



227
228
229
230
231
232
233
 
# File 'lib/resque.rb', line 227

def enqueue_front
  if defined? @enqueue_front
    @enqueue_front
  else
    @enqueue_front = false
  end
end

#heartbeat_interval ⇒ Object 



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

def heartbeat_interval
  if defined? @heartbeat_interval
    @heartbeat_interval
  else
    DEFAULT_HEARTBEAT_INTERVAL
  end
end

#inline ⇒ Object Also known as: inline?

Returns the value of attribute inline.



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

def inline
  @inline
end

#logger ⇒ Object

Set or retrieve the current logger object



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

def logger
  @logger
end

#prune_interval ⇒ Object 



214
215
216
217
218
219
220
 
# File 'lib/resque.rb', line 214

def prune_interval
  if defined? @prune_interval
    @prune_interval
  else
    DEFAULT_PRUNE_INTERVAL
  end
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.



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

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

#after_fork=(block) ⇒ Object

Register an after_fork proc.



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

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



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

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

#after_pause=(block) ⇒ Object

Register an after_pause proc.



299
300
301
 
# File 'lib/resque.rb', line 299

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.



242
243
244
 
# File 'lib/resque.rb', line 242

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.



247
248
249
 
# File 'lib/resque.rb', line 247

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.



257
258
259
 
# File 'lib/resque.rb', line 257

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

#before_fork=(block) ⇒ Object

Register a before_fork proc.



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

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



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

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

#before_pause=(block) ⇒ Object

Register a before_pause proc.



288
289
290
 
# File 'lib/resque.rb', line 288

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'



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

def classify(dashed_word)
  dashed_word.split('-').map(&:capitalize).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.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/resque.rb', line 93

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.

See Resque.encode, above, for why generate/parse are checked before dump/load.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/resque.rb', line 53

def decode(object)
  return unless object

  begin
    if MultiJson.respond_to?(:generate) && MultiJson.respond_to?(:parse)
      MultiJson.parse object
    elsif 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.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/resque.rb', line 513

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.

multi_json has renamed its core methods twice: first encode/decode became dump/load, then multi_json 1.21 renamed dump/load to generate/parse. Old names keep working as deprecated aliases. Check the newest name first so we prefer it while staying compatible with older installed versions.



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

def encode(object)
  if MultiJson.respond_to?(:generate) && MultiJson.respond_to?(:parse)
    MultiJson.generate object
  elsif 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.



457
458
459
 
# File 'lib/resque.rb', line 457

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.



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/resque.rb', line 470

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.



589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/resque.rb', line 589

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    => data_store.num_failed,
    :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.



604
605
606
 
# File 'lib/resque.rb', line 604

def keys
  data_store.all_resque_keys
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.



411
412
413
414
415
416
417
418
 
# File 'lib/resque.rb', line 411

def list_range(key, start = 0, count = 1)
  results = data_store.list_range(key, start, count)
  if count == 1
    decode(results)
  else
    results.map { |result| decode(result) }
  end
end

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

Returns an array of items currently queued, or the item itself if count = 1. 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)


400
401
402
403
404
405
406
407
 
# File 'lib/resque.rb', line 400

def peek(queue, start = 0, count = 1)
  results = data_store.peek_in_queue(queue,start,count)
  if count == 1
    decode(results)
  else
    results.map { |result| decode(result) }
  end
end

#pop(queue) ⇒ Object

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

Returns a Ruby object.



382
383
384
 
# File 'lib/resque.rb', line 382

def pop(queue)
  decode(data_store.pop_from_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



375
376
377
 
# File 'lib/resque.rb', line 375

def push(queue, item)
  data_store.push_to_queue(queue,encode(item))
end

#queue_empty(&block) ⇒ Object

The queue_empty hook will be run in the parent process when the worker finds no more jobs in the queue and becomes idle.

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



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

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

#queue_empty=(block) ⇒ Object

Register a queue_empty proc.



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

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

#queue_from_class(klass) ⇒ Object

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



531
532
533
534
 
# File 'lib/resque.rb', line 531

def queue_from_class(klass)
  (klass.instance_variable_defined?(:@queue) && 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



609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/resque.rb', line 609

def queue_sizes
  queue_names = queues

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

  Hash[queue_names.zip(sizes)]
end

#queues ⇒ Object

Returns an array of all known Resque queues as strings.



421
422
423
 
# File 'lib/resque.rb', line 421

def queues
  data_store.queue_names
end

#redis ⇒ Object Also known as: data_store

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



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

def redis
  return @data_store if @data_store
  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}


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/resque.rb', line 126

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

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

#redis_id ⇒ Object 



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

def redis_id
  data_store.identifier
end

#remove_queue(queue) ⇒ Object

Given a queue name, completely deletes the queue.



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

def remove_queue(queue)
  data_store.remove_queue(queue)
end

#remove_worker(worker_id) ⇒ Object

A shortcut to unregister_worker useful for command line tool



579
580
581
582
 
# File 'lib/resque.rb', line 579

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.



541
542
543
 
# File 'lib/resque.rb', line 541

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



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/resque.rb', line 622

def sample_queues(sample_size = 1000)
  queue_names = queues

  samples = redis.pipelined do |piped|
    queue_names.each do |name|
      key = "queue:#{name}"
      piped.llen(key)
      piped.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

#shutdown(&block) ⇒ Object

The shutdown hook will be run in the parent process when the worker has received a signal to stop processing

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



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

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

#shutdown=(block) ⇒ Object

Register a shutdown proc.



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

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

#size(queue) ⇒ Object

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



388
389
390
 
# File 'lib/resque.rb', line 388

def size(queue)
  data_store.queue_size(queue)
end

#stat_data_store ⇒ Object

Returns the data store for the statistics module.



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

def stat_data_store
  Resque::Stat.data_store
end

#stat_data_store=(stat_data_store) ⇒ Object

Set the data store for the processed and failed statistics.

By default it uses the same as Resque.redis, but different stores can be used.

A custom store needs to obey the following API to work correctly

class NullDataStore

Returns the current value for the given stat.

def stat(stat) end

# Increments the stat by the given value.
def increment_stat(stat, by)
end

# Decrements the stat by the given value.
def decrement_stat(stat, by)
end

# Clear the values for the given stat.
def clear_stat(stat)
end

end



186
187
188
 
# File 'lib/resque.rb', line 186

def stat_data_store=(stat_data_store)
  Resque::Stat.data_store = stat_data_store
end

#to_s ⇒ Object 



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

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



550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/resque.rb', line 550

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.



432
433
434
 
# File 'lib/resque.rb', line 432

def watch_queue(queue)
  data_store.watch_queue(queue)
end

#worker_exit(&block) ⇒ Object

The worker_exit hook will be run in the parent process after the worker has existed (via SIGQUIT, SIGTERM, SIGINT, etc.).

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



322
323
324
 
# File 'lib/resque.rb', line 322

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

#worker_exit=(block) ⇒ Object

Register a worker_exit proc.



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

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

#workers ⇒ Object

A shortcut to Worker.all



568
569
570
 
# File 'lib/resque.rb', line 568

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



573
574
575
 
# File 'lib/resque.rb', line 573

def working
  Worker.working
end