resque 1.11.0 → 1.12.0

data/HISTORY.md

@@ -1,3 +1,12 @@
+## 1.12.0 (2011-02-03)
+
+* Added pidfile writing from `rake resque:work`
+* Added Worker#pid method
+* Added configurable location for `rake install`
+* Bugfix: Errors in failure backend are rescue'd
+* Bugfix: Non-working workers no longer counted in "working" count
+* Bugfix: Don't think resque-web is a worker
+
 ## 1.11.0 (2010-08-23)
 
 * Web UI: Group /workers page by hostnames

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Chris Wanstrath
+Copyright (c) 2009, 2010 Chris Wanstrath
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,8 +1,9 @@
 Resque
 ======
 
-Resque is a Redis-backed library for creating background jobs, placing
-those jobs on multiple queues, and processing them later.
+Resque (pronounced like "rescue") is a Redis-backed library for creating
+background jobs, placing those jobs on multiple queues, and processing
+them later.
 
 Background jobs can be any Ruby class or module that responds to
 `perform`. Your existing classes can easily be converted to background
@@ -234,6 +235,13 @@ variable.
 
     $ VVERBOSE=1 QUEUE=file_serve rake environment resque:work
 
+### Process IDs (PIDs)
+
+There are scenarios where it's helpful to record the PID of a resque
+worker process.  Use the PIDFILE option for easy access to the PID:
+
+    $ PIDFILE=./resque.pid QUEUE=file_serve rake environment resque:work
+
 
 ### Priorities and Queue Lists
 
@@ -419,7 +427,8 @@ You can also set the namespace directly using `resque-web`:
 Using Passenger? Resque ships with a `config.ru` you can use. See
 Phusion's guide:
 
-<http://www.modrails.com/documentation/Users%20guide.html#_deploying_a_rack_based_ruby_application>
+Apache: <http://www.modrails.com/documentation/Users%20guide%20Apache.html#_deploying_a_rack_based_ruby_application>
+Nginx: <http://www.modrails.com/documentation/Users%20guide%20Nginx.html#deploying_a_rack_app>
 
 ### Rack::URLMap
 
@@ -764,7 +773,7 @@ To join the list simply send an email to <resque@librelist.com>. This
 will subscribe you and send you information about your subscription,
 including unsubscribe information.
 
-The archive can be found at <http://librelist.com/browser/>.
+The archive can be found at <http://librelist.com/browser/resque/>.
 
 
 Meta

data/lib/resque/failure/hoptoad.rb

@@ -26,8 +26,11 @@ module Resque
       INPUT_FORMAT = /^([^:]+):(\d+)(?::in `([^']+)')?$/
 
       class << self
-        attr_accessor :secure, :api_key, :proxy_host, :proxy_port
+        attr_accessor :secure, :api_key
+        attr_accessor :proxy_host, :proxy_port, :proxy_user, :proxy_pass
         attr_accessor :server_environment
+        attr_accessor :host, :port
+        attr_accessor :http_read_timeout, :http_open_timeout
       end
 
       def self.count
@@ -43,17 +46,20 @@ module Resque
 
       def save
         http = use_ssl? ? :https : :http
-        url = URI.parse("#{http}://hoptoadapp.com/notifier_api/v2/notices")
+        host = self.class.host || 'hoptoadapp.com'
+        port = self.class.port
+        url = URI.parse("#{http}://#{host}:#{port}/notifier_api/v2/notices/")
 
-        request = Net::HTTP::Proxy(self.class.proxy_host, self.class.proxy_port)
+        request = Net::HTTP::Proxy self.class.proxy_host, self.class.proxy_port,
+                                   self.class.proxy_user, self.class.proxy_pass
         http = request.new(url.host, url.port)
         headers = {
           'Content-type' => 'text/xml',
           'Accept' => 'text/xml, application/xml'
         }
 
-        http.read_timeout = 5 # seconds
-        http.open_timeout = 2 # seconds
+        http.read_timeout = self.class.http_read_timeout || 5 # seconds
+        http.open_timeout = self.class.http_open_timeout || 2 # seconds
 
         http.use_ssl = use_ssl?
 

data/lib/resque/server.rb

@@ -147,7 +147,7 @@ module Resque
 
     %w( overview workers ).each do |page|
       get "/#{page}.poll" do
-        content_type "text/plain"
+        content_type "text/html"
         @polling = true
         show(page.to_sym, false).gsub(/\s{1,}/, ' ')
       end
@@ -201,7 +201,7 @@ module Resque
         stats << "queues.#{queue}=#{Resque.size(queue)}"
       end
 
-      content_type 'text/plain'
+      content_type 'text/html'
       stats.join "\n"
     end
 

data/lib/resque/server/views/queues.erb

@@ -1,4 +1,4 @@
-<% @subtabs = resque.queues unless partial? %>
+<% @subtabs = resque.queues unless partial? || params[:id].nil? %>
 
 <% if queue = params[:id] %>
 

data/lib/resque/server/views/workers.erb

@@ -85,7 +85,7 @@
   <%=poll%>
 
 <% else %>
-
+  <% @subtabs = [] %>
   <h1 class='wi'>Workers</h1>
   <p class='intro'>The hostnames below all have registered workers. Select a hostname to view its workers, or "all" to see all workers.</p>
   <table class='queues'>
@@ -93,7 +93,7 @@
       <th>Hostname</th>
       <th>Workers</th>
     </tr>
-    <% for hostname, workers in worker_hosts %>
+    <% for hostname, workers in worker_hosts.sort_by { |h,w| h } %>
     <tr>
       <td class='queue'><a class="queue" href="<%= url "workers/#{hostname}" %>"><%= hostname %></a></td>
       <td class='size'><%= workers.size %></td>

data/lib/resque/tasks.rb

@@ -8,7 +8,6 @@ namespace :resque do
   task :work => :setup do
     require 'resque'
 
-    worker = nil
     queues = (ENV['QUEUES'] || ENV['QUEUE']).to_s.split(',')
 
     begin
@@ -19,6 +18,10 @@ namespace :resque do
       abort "set QUEUE env var, e.g. $ QUEUE=critical,high rake resque:work"
     end
 
+    if ENV['PIDFILE']
+      File.open(ENV['PIDFILE'], 'w') { |f| f << Process.pid.to_s }
+    end
+
     worker.log "Starting worker #{worker}"
 
     worker.work(ENV['INTERVAL'] || 5) # interval, will block

data/lib/resque/version.rb

@@ -1,3 +1,3 @@
 module Resque
-  Version = VERSION = '1.11.0'
+  Version = VERSION = '1.12.0'
 end

data/lib/resque/worker.rb

@@ -32,8 +32,13 @@ module Resque
     def self.working
       names = all
       return [] unless names.any?
+
       names.map! { |name| "worker:#{name}" }
-      redis.mapped_mget(*names).keys.map do |key|
+
+      reportedly_working = redis.mapped_mget(*names).reject do |key, value|
+        value.nil?
+      end
+      reportedly_working.keys.map do |key|
         find key.sub("worker:", '')
       end.compact
     end
@@ -73,7 +78,7 @@ module Resque
     # in alphabetical order. Queues can be dynamically added or
     # removed without needing to restart workers using this method.
     def initialize(*queues)
-      @queues = queues
+      @queues = queues.map { |queue| queue.to_s.strip }
       validate_queues
     end
 
@@ -157,7 +162,11 @@ module Resque
         job.perform
       rescue Object => e
         log "#{job.inspect} failed: #{e.inspect}"
-        job.fail(e)
+        begin
+          job.fail(e)
+        rescue Object => e
+          log "Received exception when reporting failure: #{e.inspect}"
+        end
         failed!
       else
         log "done: #{job.inspect}"
@@ -178,6 +187,10 @@ module Resque
       end
 
       nil
+    rescue Exception => e
+      log "Error reserving job: #{e.inspect}"
+      log e.backtrace.join("\n")
+      raise e
     end
 
     # Returns a list of queues to use when searching for a job.
@@ -440,7 +453,7 @@ module Resque
     # The string representation is the same as the id for this worker
     # instance. Can be used with `Worker.find`.
     def to_s
-      @to_s ||= "#{hostname}:#{Process.pid}:#{@queues.join(',')}"
+      @to_s ||= "#{hostname}:#{pid}:#{@queues.join(',')}"
     end
     alias_method :id, :to_s
 
@@ -449,10 +462,15 @@ module Resque
       @hostname ||= `hostname`.chomp
     end
 
+    # Returns PID of running worker
+    def pid
+      @pid ||= Process.pid
+    end
+
     # Returns an array of string pids of all the other workers on this
     # machine. Useful when pruning dead workers on startup.
     def worker_pids
-      `ps -A -o pid,command | grep [r]esque`.split("\n").map do |line|
+      `ps -A -o pid,command | grep [r]esque | grep -i "resque-web"`.split("\n").map do |line|
         line.split(' ')[0]
       end
     end

data/tasks/redis.rake

@@ -4,7 +4,6 @@ require 'open-uri'
 require 'pathname'
 
 class RedisRunner
-
   def self.redis_dir
     @redis_dir ||= if ENV['PREFIX']
                      Pathname.new(ENV['PREFIX'])
@@ -48,11 +47,11 @@ class RedisRunner
   def self.stop
     sh 'echo "SHUTDOWN" | nc localhost 6379'
   end
-
 end
 
-namespace :redis do
+INSTALL_DIR = ENV['INSTALL_DIR'] || '/tmp/redis'
 
+namespace :redis do
   desc 'About redis'
   task :about do
     puts "\nSee http://code.google.com/p/redis/ for information about redis.\n\n"
@@ -79,7 +78,12 @@ namespace :redis do
     RedisRunner.attach
   end
 
-  desc 'Install the latest verison of Redis from Github (requires git, duh)'
+  desc <<-DOC
+  Install the latest verison of Redis from Github (requires git, duh).
+    Use INSTALL_DIR env var like "rake redis:install INSTALL_DIR=~/tmp"
+    in order to get an alternate location for your install files.
+  DOC
+
   task :install => [:about, :download, :make] do
     bin_dir = '/usr/bin'
     conf_dir = '/etc'
@@ -93,33 +97,31 @@ namespace :redis do
     end
 
     %w(redis-benchmark redis-cli redis-server).each do |bin|
-      sh "cp /tmp/redis/src/#{bin} #{bin_dir}"
+      sh "cp #{INSTALL_DIR}/src/#{bin} #{bin_dir}"
     end
 
     puts "Installed redis-benchmark, redis-cli and redis-server to #{bin_dir}"
 
     unless File.exists?("#{conf_dir}/redis.conf")
-      sh "cp /tmp/redis/redis.conf #{conf_dir}/redis.conf"
+      sh "cp #{INSTALL_DIR}/redis.conf #{conf_dir}/redis.conf"
       puts "Installed redis.conf to #{conf_dir} \n You should look at this file!"
     end
   end
 
   task :make do
-    sh "cd /tmp/redis/src && make clean"
-    sh "cd /tmp/redis/src && make"
+    sh "cd #{INSTALL_DIR}/src && make clean"
+    sh "cd #{INSTALL_DIR}/src && make"
   end
 
   desc "Download package"
   task :download do
-    sh 'rm -rf /tmp/redis/' if File.exists?("/tmp/redis/.svn")
-    sh 'git clone git://github.com/antirez/redis.git /tmp/redis' unless File.exists?('/tmp/redis')
-    sh "cd /tmp/redis && git pull" if File.exists?("/tmp/redis/.git")
+    sh "rm -rf #{INSTALL_DIR}/" if File.exists?("#{INSTALL_DIR}/.svn")
+    sh "git clone git://github.com/antirez/redis.git #{INSTALL_DIR}" unless File.exists?(INSTALL_DIR)
+    sh "cd #{INSTALL_DIR} && git pull" if File.exists?("#{INSTALL_DIR}/.git")
   end
-
 end
 
 namespace :dtach do
-
   desc 'About dtach'
   task :about do
     puts "\nSee http://dtach.sourceforge.net/ for information about dtach.\n\n"
@@ -130,30 +132,30 @@ namespace :dtach do
 
     bin_dir = "/usr/bin"
 
+
     if ENV['PREFIX']
       bin_dir = "#{ENV['PREFIX']}/bin"
       sh "mkdir -p #{bin_dir}" unless File.exists?("#{bin_dir}")
     end
 
-    sh "cp /tmp/dtach-0.8/dtach #{bin_dir}"
+    sh "cp #{INSTALL_DIR}/dtach-0.8/dtach #{bin_dir}"
   end
 
   task :make do
-    sh 'cd /tmp/dtach-0.8/ && ./configure && make'
+    sh "cd #{INSTALL_DIR}/dtach-0.8/ && ./configure && make"
   end
 
   desc "Download package"
   task :download do
-    unless File.exists?('/tmp/dtach-0.8.tar.gz')
+    unless File.exists?("#{INSTALL_DIR}/dtach-0.8.tar.gz")
       require 'net/http'
 
       url = 'http://downloads.sourceforge.net/project/dtach/dtach/0.8/dtach-0.8.tar.gz'
-      open('/tmp/dtach-0.8.tar.gz', 'wb') do |file| file.write(open(url).read) end
+      open("#{INSTALL_DIR}/dtach-0.8.tar.gz", 'wb') do |file| file.write(open(url).read) end
     end
 
-    unless File.directory?('/tmp/dtach-0.8')
-      sh 'cd /tmp && tar xzf dtach-0.8.tar.gz'
+    unless File.directory?("#{INSTALL_DIR}/dtach-0.8")
+      sh "cd #{INSTALL_DIR} && tar xzf dtach-0.8.tar.gz"
     end
   end
 end
-

data/test/test_helper.rb

@@ -114,3 +114,17 @@ class BadJobWithSyntaxError
     raise SyntaxError, "Extra Bad job!"
   end
 end
+
+class BadFailureBackend < Resque::Failure::Base
+  def save
+    raise Exception.new("Failure backend error")
+  end
+end
+
+def with_failure_backend(failure_backend, &block)
+  previous_backend = Resque::Failure.backend
+  Resque::Failure.backend = failure_backend
+  yield block
+ensure
+  Resque::Failure.backend = previous_backend
+end

data/test/worker_test.rb

@@ -25,6 +25,13 @@ context "Resque::Worker" do
     assert_equal('Extra Bad job!', Resque::Failure.all['error'])
   end
 
+  test "does not allow exceptions from failure backend to escape" do
+    job = Resque::Job.new(:jobs, {})
+    with_failure_backend BadFailureBackend do
+      @worker.perform job
+    end
+  end
+
   test "fails uncompleted jobs on exit" do
     job = Resque::Job.new(:jobs, [GoodJob, "blah"])
     @worker.working_on(job)
@@ -57,6 +64,12 @@ context "Resque::Worker" do
     assert_equal 2, Resque::Failure.count
   end
 
+  test "strips whitespace from queue names" do
+    queues = "critical, high, low".split(',')
+    worker = Resque::Worker.new(*queues)
+    assert_equal %w( critical high low ), worker.queues
+  end
+
   test "can work on multiple queues" do
     Resque::Job.create(:high, GoodJob)
     Resque::Job.create(:critical, GoodJob)
@@ -299,4 +312,8 @@ context "Resque::Worker" do
     workerA.work(0)
     assert $AFTER_FORK_CALLED
   end
+
+  test "returns PID of running process" do
+    assert_equal Process.pid, @worker.pid
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 39
   prerelease: false
   segments: 
   - 1
-  - 11
+  - 12
   - 0
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors: 
 - Chris Wanstrath