sidekiq 2.5.3 → 2.5.4

data/Changes.md

@@ -1,4 +1,14 @@
-HEAD
+2.5.4
+-----------
+
+- `Sidekiq::Client.push` now accepts the worker class as a string so the
+  Sidekiq client does not have to load your worker classes at all.  [#524]
+- `Sidekiq::Client.push_bulk` now works with inline testing.
+- **Really** fix status icon in Web UI this time.
+- Add "Delete All" and "Retry All" buttons to Retries in Web UI
+
+
+2.5.3
 -----------
 
 - Small Web UI fixes

data/lib/sidekiq/api.rb

@@ -43,6 +43,15 @@ module Sidekiq
         end
       end
     end
+
+    def clear
+      Sidekiq.redis do |conn|
+        conn.multi do
+          conn.del("queue:#{name}")
+          conn.srem("queues", name)
+        end
+      end
+    end
   end
 
   ##
@@ -143,6 +152,12 @@ module Sidekiq
       end
       count != 0
     end
+
+    def clear
+      Sidekiq.redis do |conn|
+        conn.del(@zset)
+      end
+    end
   end
 
   ##

data/lib/sidekiq/cli.rb

@@ -126,12 +126,23 @@ module Sidekiq
         require 'sidekiq/rails'
         require File.expand_path("#{options[:require]}/config/environment.rb")
         ::Rails.application.eager_load!
-        options[:tag] ||= File.basename(::Rails.root)
+        options[:tag] ||= default_tag
       else
         require options[:require]
       end
     end
 
+    def default_tag
+      dir = ::Rails.root
+      name = File.basename(dir)
+      if name.to_i != 0 && prevdir = File.dirname(dir) # Capistrano release directory?
+        if File.basename(prevdir) == 'releases'
+          return File.basename(File.dirname(prevdir))
+        end
+      end
+      name
+    end
+
     def validate!
       options[:queues] << 'default' if options[:queues].empty?
 

data/lib/sidekiq/client.rb

@@ -65,13 +65,7 @@ module Sidekiq
       end.compact
 
       pushed = false
-      Sidekiq.redis do |conn|
-        _, pushed = conn.multi do
-          conn.sadd('queues', normed['queue'])
-          conn.rpush("queue:#{normed['queue']}", payloads)
-        end
-      end
-
+      pushed = raw_push(normed, payloads)
       pushed ? payloads.size : nil
     end
 
@@ -98,7 +92,9 @@ module Sidekiq
     def self.raw_push(normed, payload) # :nodoc:
       pushed = false
       Sidekiq.redis do |conn|
-        if normed['at']
+        if normed['at'] && payload.is_a?(Array)
+          pushed = conn.zadd('schedule', payload.map {|hash| [normed['at'].to_s, hash]})
+        elsif normed['at']
           pushed = conn.zadd('schedule', normed['at'].to_s, payload)
         else
           _, pushed = conn.multi do
@@ -122,13 +118,17 @@ module Sidekiq
     def self.normalize_item(item)
       raise(ArgumentError, "Message must be a Hash of the form: { 'class' => SomeWorker, 'args' => ['bob', 1, :foo => 'bar'] }") unless item.is_a?(Hash)
       raise(ArgumentError, "Message must include a class and set of arguments: #{item.inspect}") if !item['class'] || !item['args']
-      raise(ArgumentError, "Message must include a Sidekiq::Worker class, not class name: #{item['class'].ancestors.inspect}") if !item['class'].is_a?(Class) || !item['class'].respond_to?('get_sidekiq_options')
+      raise(ArgumentError, "Message class must be either a Class or String representation of the class name") unless item['class'].is_a?(Class) || item['class'].is_a?(String)
+
+      if item['class'].is_a?(Class)
+        raise(ArgumentError, "Message must include a Sidekiq::Worker class, not class name: #{item['class'].ancestors.inspect}") if !item['class'].respond_to?('get_sidekiq_options')
+        normalized_item = item['class'].get_sidekiq_options.merge(item)
+        normalized_item['class'] = normalized_item['class'].to_s
+      else
+        normalized_item = Sidekiq::Worker::ClassMethods::DEFAULT_OPTIONS.merge(item)
+      end
 
-      normalized_item = item['class'].get_sidekiq_options.merge(item.dup)
-      normalized_item['class'] = normalized_item['class'].to_s
-      normalized_item['retry'] = !!normalized_item['retry'] unless normalized_item['retry'].is_a?(Fixnum)
       normalized_item['jid'] = SecureRandom.hex(12)
-
       normalized_item
     end
 

data/lib/sidekiq/testing/inline.rb

@@ -28,8 +28,11 @@ module Sidekiq
     #
     singleton_class.class_eval do
       alias_method :raw_push_old, :raw_push
-      def raw_push(hash, _)
-        hash['class'].constantize.new.perform(*Sidekiq.load_json(Sidekiq.dump_json(hash['args'])))
+      def raw_push(normed, payload)
+        Array.wrap(payload).each do |hash|
+          normed['class'].constantize.new.perform(*Sidekiq.load_json(hash)['args'])
+        end
+
         true
       end
     end

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "2.5.3"
+  VERSION = "2.5.4"
 end

data/lib/sidekiq/web.rb

@@ -136,10 +136,7 @@ module Sidekiq
     end
 
     post "/queues/:name" do
-      Sidekiq.redis do |conn|
-        conn.del("queue:#{params[:name]}")
-        conn.srem("queues", params[:name])
-      end
+      Sidekiq::Queue.new(params[:name]).clear
       redirect "#{root_path}queues"
     end
 
@@ -195,6 +192,18 @@ module Sidekiq
       redirect "#{root_path}retries"
     end
 
+    post "/retries/all/delete" do
+      Sidekiq::RetrySet.new.clear
+      redirect "#{root_path}retries"
+    end
+
+    post "/retries/all/retry" do
+      Sidekiq::RetrySet.new.each do |job|
+        process_score('retry', job.score, :retry)
+      end
+      redirect "#{root_path}retries"
+    end
+
     post "/retries/:score" do
       halt 404 unless params[:score]
       score = params[:score].to_f

data/test/test_api.rb

@@ -36,6 +36,17 @@ class TestApi < MiniTest::Unit::TestCase
       assert_equal 0, q.size
     end
 
+    it 'can clear a queue' do
+      q = Sidekiq::Queue.new
+      2.times { ApiWorker.perform_async(1, 'mike') }
+      q.clear
+
+      Sidekiq.redis do |conn|
+        refute conn.smembers('queues').include?('foo')
+        refute conn.exists('queues:foo')
+      end
+    end
+
     it 'shows empty retries' do
       r = Sidekiq::RetrySet.new
       assert_equal 0, r.size
@@ -64,9 +75,18 @@ class TestApi < MiniTest::Unit::TestCase
       assert_equal 0, r.size
     end
 
-    def add_retry
+    it 'can clear retries' do
+      add_retry
+      add_retry('test')
+      r = Sidekiq::RetrySet.new
+      assert_equal 2, r.size
+      r.clear
+      assert_equal 0, r.size
+    end
+
+    def add_retry(jid = 'bob')
       at = Time.now.to_f
-      payload = Sidekiq.dump_json('class' => 'ApiWorker', 'args' => [1, 'mike'], 'queue' => 'default', 'jid' => 'bob')
+      payload = Sidekiq.dump_json('class' => 'ApiWorker', 'args' => [1, 'mike'], 'queue' => 'default', 'jid' => jid)
       Sidekiq.redis do |conn|
         conn.zadd('retry', at.to_s, payload)
       end

data/test/test_client.rb

@@ -30,6 +30,15 @@ class TestClient < MiniTest::Unit::TestCase
       assert_raises ArgumentError do
         Sidekiq::Client.push('foo', :class => 'Foo', :noargs => [1, 2])
       end
+
+      assert_raises ArgumentError do
+        Sidekiq::Client.push('queue' => 'foo', 'class' => MyWorker, 'noargs' => [1, 2])
+      end
+
+      assert_raises ArgumentError do
+        Sidekiq::Client.push('queue' => 'foo', 'class' => 42, 'args' => [1, 2])
+      end
+
     end
 
     it 'pushes messages to redis' do
@@ -40,6 +49,14 @@ class TestClient < MiniTest::Unit::TestCase
       @redis.verify
     end
 
+    it 'pushes messages to redis using a String class' do
+      @redis.expect :rpush, 1, ['queue:foo', String]
+      pushed = Sidekiq::Client.push('queue' => 'foo', 'class' => 'MyWorker', 'args' => [1, 2])
+      assert pushed
+      assert_equal 24, pushed.size
+      @redis.verify
+    end
+
     class MyWorker
       include Sidekiq::Worker
     end
@@ -105,6 +122,11 @@ class TestClient < MiniTest::Unit::TestCase
       count = Sidekiq::Client.push_bulk('class' => QueuedWorker, 'args' => (1..1_000).to_a.map { |x| Array(x) })
       assert_equal 1_000, count
     end
+    it 'can push a large set of jobs at once using a String class' do
+      a = Time.now
+      count = Sidekiq::Client.push_bulk('class' => 'QueuedWorker', 'args' => (1..1_000).to_a.map { |x| Array(x) })
+      assert_equal 1_000, count
+    end
   end
 
   class BaseWorker

data/test/test_scheduling.rb

@@ -28,6 +28,12 @@ class TestScheduling < MiniTest::Unit::TestCase
       assert ScheduledWorker.perform_in(5.days.from_now, 'mike')
       @redis.verify
     end
+
+    it 'schedules multiple jobs at once' do
+      @redis.expect :zadd, true, ['schedule', Array]
+      assert Sidekiq::Client.push_bulk('class' => ScheduledWorker, 'args' => ['mike', 'mike'], 'at' => 600)
+      @redis.verify
+    end
   end
 
 end

data/test/test_testing_inline.rb

@@ -80,6 +80,14 @@ class TestInline < MiniTest::Unit::TestCase
       end
     end
 
+    it 'stubs the push_bulk call when in testing mode' do
+      assert Sidekiq::Client.push_bulk({'class' => InlineWorker, 'args' => [true, true]})
+
+      assert_raises InlineError do
+        Sidekiq::Client.push_bulk({'class' => InlineWorker, 'args' => [true, false]})
+      end
+    end
+
     it 'should relay parameters through json' do
       assert Sidekiq::Client.enqueue(InlineWorkerWithTimeParam, Time.now)
     end

data/test/test_web.rb

@@ -72,9 +72,10 @@ class TestWeb < MiniTest::Unit::TestCase
 
       Sidekiq.redis do |conn|
         refute conn.smembers('queues').include?('foo')
+        refute conn.exists('queues:foo')
       end
     end
-    
+
     it 'can delete a job' do
       Sidekiq.redis do |conn|
         conn.rpush('queue:foo', "{}")
@@ -154,6 +155,15 @@ class TestWeb < MiniTest::Unit::TestCase
       refute_match /#{score}/, last_response.body
     end
 
+    it 'can delete all retries' do
+      3.times { add_retry }
+
+      post "/retries/all/delete", 'delete' => 'Delete'
+      assert_equal 0, Sidekiq::RetrySet.new.size
+      assert_equal 302, last_response.status
+      assert_equal 'http://example.org/retries', last_response.header['Location']
+    end
+
     it 'can retry a single retry now' do
       msg, score = add_retry
 
@@ -166,6 +176,20 @@ class TestWeb < MiniTest::Unit::TestCase
       assert_match /#{msg['args'][2]}/, last_response.body
     end
 
+    it 'can retry all retries' do
+      msg, score = add_retry
+      add_retry
+
+      post "/retries/all/retry", 'retry' => 'Retry'
+      assert_equal 302, last_response.status
+      assert_equal 'http://example.org/retries', last_response.header['Location']
+      assert_equal 2, Sidekiq::Queue.new("default").size
+
+      get '/queues/default'
+      assert_equal 200, last_response.status
+      assert_match /#{msg['args'][2]}/, last_response.body
+    end
+
     it 'can show user defined tab' do
       begin
         Sidekiq::Web.tabs['Custom Tab'] = '/custom'

data/web/assets/stylesheets/application.css

@@ -216,12 +216,12 @@ header.row .pagination {
   padding: 4px 0 2px 0;
 }
 .summary_bar ul .desc {
-  font-size: 1.1em;
+  font-size: 1em;
   font-weight: normal;
 }
 .summary_bar ul .count {
   color: #b1003e;
-  font-size: 1.1em;
+  font-size: 1em;
   font-weight: bold;
   float: right;
 }
@@ -447,7 +447,7 @@ img.smallogo {
 }
 
 .status-sprite {
-  background-image: url(/images/status-sd8051fd480.png);
+  background-image: url(../images/status-sd8051fd480.png);
   height: 30px;
   width: 30px;
   display: inline-block;

data/web/views/_nav.slim

@@ -9,5 +9,9 @@
     div.nav-collapse
       ul.nav
         - tabs.each do |title, url|
-          li class="#{(current_path==url) ? 'active':''}"
-            a href='#{{root_path}}#{{url}}' #{title}
+          - if url.blank?
+            li class="#{(current_path == url) ? 'active':''}"
+              a href='#{{root_path}}#{{url}}' #{title}
+          - else
+            li class="#{(current_path =~ Regexp.new(url)) ? 'active':''}"
+              a href='#{{root_path}}#{{url}}' #{title}

data/web/views/retries.slim

@@ -28,7 +28,13 @@ header.row
             a href="#{root_path}queues/#{msg['queue']}" #{msg['queue']}
           td= msg['class']
           td= display_args(msg['args'])
-    input.btn.btn-danger.btn-small.pull-right type="submit" name="delete" value="Delete"
-    input.btn.btn-primary.btn-small.pull-right type="submit" name="retry" value="Retry Now" 
+    input.btn.btn-primary.btn-small.pull-left type="submit" name="retry" value="Retry Now"
+    input.btn.btn-danger.btn-small.pull-left type="submit" name="delete" value="Delete"
+
+  form action="#{root_path}retries/all/delete" method="post"
+    input.btn.btn-danger.btn-small.pull-right type="submit" name="delete" value="Delete All" data-confirm="Are you sure?"
+  form action="#{root_path}retries/all/retry" method="post"
+    input.btn.btn-danger.btn-small.pull-right type="submit" name="retry" value="Retry All" data-confirm="Are you sure?"
+
 - else
   .alert.alert-success No retries were found

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis