sidekiq 3.2.5 → 3.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e23b8c86c8a85feffbcd31949baf897e08b8db
-  data.tar.gz: 08fdfb51c221a0f441a84ecc1dfc8a926a9cb93e
+  metadata.gz: b589aea06c5a40ae600d780a9ae6eb89766d8195
+  data.tar.gz: 0648e289e18aa26e8887bb5041a40fb2886080f5
 SHA512:
-  metadata.gz: cda9f58863db3b718f0688c8cc3de8add91b25b6d75e2c7e4f4fba529a082dd69a7a5ab7ae28573aba6e27c5377883c22098c238d73fec98da86bb3c705a317b
-  data.tar.gz: b06be66eccdca4b5b3db27a35b570279a511e9640f19ab2cb023cc8c224ce95cd29408d99947e0c8dbb0f6bc1665cd464355132de746d57c7b1877a02a8dfcaa
+  metadata.gz: 8f02a8ad25930c5123c8a6c52a0d173bd452e8442b6642fe02743ed7b5f1f29f791208dde1e4de257fe126e2909d072f934d28f5517334c350f87bcfab29eee9
+  data.tar.gz: c28264360d2ddd2d0e868d17d8e3b0b8327f8cf6b84a3a845199be63bfb7d57ce2e85596d981da7e7abb8f71d6290b9ade4364ef8157ad99663edbfa1cdb24df

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - rbx-2
   - 2.0.0
   - 2.1
+  - 2.2
 matrix:
   allow_failures:
     - rvm: rbx-2

data/Changes.md

@@ -1,7 +1,15 @@
+HEAD
+-----------
+
+- Deprecate delay extension for ActionMailer 4.2+ . [#1933]
+- Poll interval tuning now accounts for dead processes [epchris, #1984]
+- Add non-production environment to Web UI page titles [JacobEvelyn, #2004]
+
 3.2.5
 -----------
 
-- Lock Celluloid to 0.15.2 due to bugs in 0.16.0.
+- Lock Celluloid to 0.15.2 due to bugs in 0.16.0.  This prevents the
+  "hang on shutdown" problem with Celluloid 0.16.0.
 
 3.2.4
 -----------

data/Pro-Changes.md

@@ -3,6 +3,20 @@ Sidekiq Pro Changelog
 
 Please see [http://sidekiq.org/pro](http://sidekiq.org/pro) for more details and how to buy.
 
+1.9.1
+-----------
+
+- **SECURITY** Fix XSS in batch description, thanks to intercom.io for reporting the
+  issue.  If you don't use batch descriptions, you don't need the fix.
+
+1.9.0
+-----------
+
+- Add new expiring jobs feature [#1982]
+- Show batch expiration on Batch details page [#1981]
+- Add '$' batch success token to the pubsub support. [#1953]
+
+
 1.8.0
 -----------
 

data/README.md

@@ -27,8 +27,7 @@ Requirements
 I test with the latest MRI (2.1, 2.0) and JRuby versions (1.7).  Other versions/VMs
 are untested but might work fine.  MRI 1.9 is no longer supported.
 
-The last two major Rails releases (3.2 and 4.0) are officially supported, other
-versions might work fine.
+All Rails releases starting from 3.2 are officially supported.
 
 Redis 2.4 or greater is required.
 

data/lib/sidekiq/api.rb

@@ -545,32 +545,53 @@ module Sidekiq
   class ProcessSet
     include Enumerable
 
+    def initialize(clean_plz=true)
+      self.class.cleanup if clean_plz
+    end
+
+    # Cleans up dead processes recorded in Redis.
+    # Returns the number of processes cleaned.
+    def self.cleanup
+      count = 0
+      Sidekiq.redis do |conn|
+        procs = conn.smembers('processes').sort
+        heartbeats = conn.pipelined do
+          procs.each do |key|
+            conn.hget(key, 'info')
+          end
+        end
+
+        # the hash named key has an expiry of 60 seconds.
+        # if it's not found, that means the process has not reported
+        # in to Redis and probably died.
+        to_prune = []
+        heartbeats.each_with_index do |beat, i|
+          to_prune << procs[i] if beat.nil?
+        end
+        count = conn.srem('processes', to_prune) unless to_prune.empty?
+      end
+      count
+    end
+
     def each(&block)
-      procs = Sidekiq.redis { |conn| conn.smembers('processes') }
+      procs = Sidekiq.redis { |conn| conn.smembers('processes') }.sort
 
-      to_prune = []
-      sorted = procs.sort
       Sidekiq.redis do |conn|
         # We're making a tradeoff here between consuming more memory instead of
         # making more roundtrips to Redis, but if you have hundreds or thousands of workers,
         # you'll be happier this way
         result = conn.pipelined do
-          sorted.each do |key|
+          procs.each do |key|
             conn.hmget(key, 'info', 'busy', 'beat')
           end
         end
 
         result.each_with_index do |(info, busy, at_s), i|
-          # the hash named key has an expiry of 60 seconds.
-          # if it's not found, that means the process has not reported
-          # in to Redis and probably died.
-          (to_prune << sorted[i]; next) if info.nil?
           hash = Sidekiq.load_json(info)
           yield Process.new(hash.merge('busy' => busy.to_i, 'beat' => at_s.to_f))
         end
       end
 
-      Sidekiq.redis {|conn| conn.srem('processes', to_prune) } unless to_prune.empty?
       nil
     end
 

data/lib/sidekiq/cli.rb

@@ -138,11 +138,11 @@ module Sidekiq
         end
       when 'TTIN'
         Thread.list.each do |thread|
-          Sidekiq.logger.info "Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}"
+          Sidekiq.logger.warn "Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}"
           if thread.backtrace
-            Sidekiq.logger.info thread.backtrace.join("\n")
+            Sidekiq.logger.warn thread.backtrace.join("\n")
           else
-            Sidekiq.logger.info "<no backtrace available>"
+            Sidekiq.logger.warn "<no backtrace available>"
           end
         end
       end

data/lib/sidekiq/extensions/action_mailer.rb

@@ -17,7 +17,20 @@ module Sidekiq
         msg = target.public_send(method_name, *args)
         # The email method can return nil, which causes ActionMailer to return
         # an undeliverable empty message.
-        msg.deliver if msg && (msg.to || msg.cc || msg.bcc) && msg.from
+        deliver(msg) if msg && (msg.to || msg.cc || msg.bcc) && msg.from
+      end
+
+      private
+
+      def deliver(msg)
+        if msg.respond_to?(:deliver_now)
+          ActiveSupport::Deprecation.warn('`ActionMailer.delay.method` is deprecated. Use `ActionMailer.method.deliver_later` instead and configure ActiveJob to use Sidekiq.')
+          # Rails 4.2/5.0
+          msg.deliver_now
+        else
+          # Rails 3.2/4.0/4.1
+          msg.deliver
+        end
       end
     end
 

data/lib/sidekiq/launcher.rb

@@ -52,6 +52,7 @@ module Sidekiq
         manager.wait(:shutdown) if manager.alive?
 
         # Requeue everything in case there was a worker who grabbed work while stopped
+        # This call is a no-op in Sidekiq but necessary for Sidekiq Pro.
         Sidekiq::Fetcher.strategy.bulk_requeue([], @options)
 
         stop_heartbeat

data/lib/sidekiq/processor.rb

@@ -49,7 +49,7 @@ module Sidekiq
 
         stats(worker, msg, queue) do
           Sidekiq.server_middleware.invoke(worker, msg, queue) do
-            worker.perform(*cloned(msg['args']))
+            execute_job(worker, cloned(msg['args']))
           end
         end
       rescue Sidekiq::Shutdown
@@ -71,6 +71,10 @@ module Sidekiq
       "<Processor##{object_id.to_s(16)}>"
     end
 
+    def execute_job(worker, cloned_args)
+      worker.perform(*cloned_args)
+    end
+
     private
 
     def thread_identity

data/lib/sidekiq/scheduled.rb

@@ -1,6 +1,7 @@
 require 'sidekiq'
 require 'sidekiq/util'
 require 'sidekiq/actor'
+require 'sidekiq/api'
 
 module Sidekiq
   module Scheduled
@@ -8,10 +9,10 @@ module Sidekiq
     INITIAL_WAIT = 10
 
     ##
-    # The Poller checks Redis every N seconds for messages in the retry or scheduled
+    # The Poller checks Redis every N seconds for jobs in the retry or scheduled
     # set have passed their timestamp and should be enqueued.  If so, it
-    # just pops the message back onto its original queue so the
-    # workers can pick it up like any other message.
+    # just pops the job back onto its original queue so the
+    # workers can pick it up like any other job.
     class Poller
       include Util
       include Actor
@@ -23,8 +24,8 @@ module Sidekiq
           initial_wait if first_time
 
           begin
-            # A message's "score" in Redis is the time at which it should be processed.
-            # Just check Redis for the set of messages with a timestamp before now.
+            # A job's "score" in Redis is the time at which it should be processed.
+            # Just check Redis for the set of jobs with a timestamp before now.
             now = Time.now.to_f.to_s
             Sidekiq.redis do |conn|
               SETS.each do |sorted_set|
@@ -32,14 +33,14 @@ module Sidekiq
                 # We need to go through the list one at a time to reduce the risk of something
                 # going wrong between the time jobs are popped from the scheduled queue and when
                 # they are pushed onto a work queue and losing the jobs.
-                while message = conn.zrangebyscore(sorted_set, '-inf', now, :limit => [0, 1]).first do
+                while job = conn.zrangebyscore(sorted_set, '-inf', now, :limit => [0, 1]).first do
 
                   # Pop item off the queue and add it to the work queue. If the job can't be popped from
                   # the queue, it's because another process already popped it so we can move on to the
                   # next one.
-                  if conn.zrem(sorted_set, message)
-                    Sidekiq::Client.push(Sidekiq.load_json(message))
-                    logger.debug { "enqueued #{sorted_set}: #{message}" }
+                  if conn.zrem(sorted_set, job)
+                    Sidekiq::Client.push(Sidekiq.load_json(job))
+                    logger.debug { "enqueued #{sorted_set}: #{job}" }
                   end
                 end
               end
@@ -75,7 +76,9 @@ module Sidekiq
       # We only do this if poll_interval is unset (the default).
       def poll_interval
         Sidekiq.options[:poll_interval] ||= begin
-          pcount = Sidekiq.redis {|c| c.scard('processes') } || 1
+          ps = Sidekiq::ProcessSet.new
+          pcount = ps.size
+          pcount = 1 if pcount == 0
           pcount * 15
         end
       end

data/lib/sidekiq/testing.rb

@@ -153,7 +153,7 @@ module Sidekiq
         while job = jobs.shift do
           worker = new
           worker.jid = job['jid']
-          worker.perform(*job['args'])
+          execute_job(worker, job['args'])
         end
       end
 
@@ -163,7 +163,11 @@ module Sidekiq
         job = jobs.shift
         worker = new
         worker.jid = job['jid']
-        worker.perform(*job['args'])
+        execute_job(worker, job['args'])
+      end
+
+      def execute_job(worker, args)
+        worker.perform(*args)
       end
     end
 

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "3.2.5"
+  VERSION = "3.2.6"
 end

data/lib/sidekiq/web.rb

@@ -133,14 +133,13 @@ module Sidekiq
     end
 
     get "/retries/:key" do
-      halt 404 unless params['key']
       @retry = Sidekiq::RetrySet.new.fetch(*parse_params(params['key'])).first
       redirect "#{root_path}retries" if @retry.nil?
       erb :retry
     end
 
     post '/retries' do
-      halt 404 unless params['key']
+      redirect request.path unless params['key']
 
       params['key'].each do |key|
         job = Sidekiq::RetrySet.new.fetch(*parse_params(key)).first
@@ -160,7 +159,6 @@ module Sidekiq
     end
 
     post "/retries/:key" do
-      halt 404 unless params['key']
       job = Sidekiq::RetrySet.new.fetch(*parse_params(params['key'])).first
       retry_or_delete_or_kill job, params if job
       redirect_with_query("#{root_path}retries")
@@ -174,14 +172,13 @@ module Sidekiq
     end
 
     get "/scheduled/:key" do
-      halt 404 unless params['key']
       @job = Sidekiq::ScheduledSet.new.fetch(*parse_params(params['key'])).first
       redirect "#{root_path}scheduled" if @job.nil?
       erb :scheduled_job_info
     end
 
     post '/scheduled' do
-      halt 404 unless params['key']
+      redirect request.path unless params['key']
 
       params['key'].each do |key|
         job = Sidekiq::ScheduledSet.new.fetch(*parse_params(key)).first

data/lib/sidekiq/web_helpers.rb

@@ -21,7 +21,7 @@ module Sidekiq
     end
 
     def locale
-      lang = (request.env["HTTP_ACCEPT_LANGUAGE"] || 'en')[0,2]
+      lang = (request.env["HTTP_ACCEPT_LANGUAGE"] || 'en').split(',')[0].downcase
       strings[lang] ? lang : 'en'
     end
 
@@ -172,5 +172,11 @@ module Sidekiq
         redirect url
       end
     end
+
+    def environment_title_prefix
+      environment = Sidekiq.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+
+      "[#{environment.upcase}] " unless environment == "production"
+    end
   end
 end

data/test/test_api.rb

@@ -469,7 +469,7 @@ class TestApi < Sidekiq::Test
       end
 
       ps = Sidekiq::ProcessSet.new
-      assert_equal 3, ps.size
+      assert_equal 1, ps.size
       assert_equal 1, ps.to_a.size
     end
 

data/test/test_processor.rb

@@ -39,6 +39,12 @@ class TestProcessor < Sidekiq::Test
       assert_equal 1, $invokes
     end
 
+    it 'executes a worker as expected' do
+      worker = Minitest::Mock.new
+      worker.expect(:perform, nil, [1, 2, 3])
+      @processor.execute_job(worker, [1, 2, 3])
+    end
+
     it 'passes exceptions to ExceptionHandler' do
       actor = Minitest::Mock.new
       actor.expect(:real_thread, nil, [nil, Thread])

data/test/test_testing_fake.rb

@@ -261,5 +261,11 @@ class TestTesting < Sidekiq::Test
       assert_equal 1, FirstWorker.count
       assert_equal 1, SecondWorker.count
     end
+
+    it 'can execute a job' do
+      worker = Minitest::Mock.new
+      worker.expect(:perform, nil, [1, 2, 3])
+      DirectWorker.execute_job(worker, [1, 2, 3])
+    end
   end
 end

data/web/views/layout.erb

@@ -1,7 +1,7 @@
 <!doctype html>
 <html>
   <head>
-    <title><%= Sidekiq::NAME %></title>
+    <title><%= environment_title_prefix %><%= Sidekiq::NAME %></title>
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />
     <link href="<%= root_path %>stylesheets/bootstrap.css" media="screen" rel="stylesheet" type="text/css" />
     <link href="<%= root_path %>stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.6
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -245,8 +245,8 @@ files:
 - web/assets/javascripts/locales/jquery.timeago.bg.js
 - web/assets/javascripts/locales/jquery.timeago.bs.js
 - web/assets/javascripts/locales/jquery.timeago.ca.js
+- web/assets/javascripts/locales/jquery.timeago.cs.js
 - web/assets/javascripts/locales/jquery.timeago.cy.js
-- web/assets/javascripts/locales/jquery.timeago.cz.js
 - web/assets/javascripts/locales/jquery.timeago.da.js
 - web/assets/javascripts/locales/jquery.timeago.de.js
 - web/assets/javascripts/locales/jquery.timeago.el.js