sidekiq 2.6.0 → 2.6.1

data/Changes.md

@@ -1,3 +1,10 @@
+2.6.1
+-----------
+
+- Dashboard now live updates summary stats also. [brandonhilkert, #605]
+- Add middleware chain APIs `insert_before` and `insert_after` for fine
+  tuning the order of middleware. [jackrg, #595]
+
 2.6.0
 -----------
 

data/README.md

@@ -54,7 +54,7 @@ Please see the [sidekiq wiki](https://github.com/mperham/sidekiq/wiki) for more
 but bug reports or feature requests suggestions should still go through [issues on Github](https://github.com/mperham/sidekiq/issues).
 
 There's also a mailing list via [Librelist](http://librelist.org) that you can subscribe to by sending
-and email to <sidekiq@librelist.org> with a greeting in the body. To unsubscribe, send an email to <sidekiq-unsubscribe@librelist.org> and that's it!
+an email to <sidekiq@librelist.org> with a greeting in the body. To unsubscribe, send an email to <sidekiq-unsubscribe@librelist.org> and that's it!
 Once archiving begins, you'll be able to visit [the archives](http://librelist.com/browser/sidekiq/) to see past threads.
 
 

data/lib/sidekiq.rb

@@ -4,7 +4,6 @@ require 'sidekiq/client'
 require 'sidekiq/worker'
 require 'sidekiq/redis_connection'
 require 'sidekiq/util'
-require 'sidekiq/stats'
 require 'sidekiq/api'
 
 require 'sidekiq/extensions/class_methods'
@@ -109,4 +108,16 @@ module Sidekiq
     self.options[:poll_interval] = interval
   end
 
+  ##
+  # deprecated
+  def self.size(*queues)
+    return Sidekiq::Stats.new.enqueued if queues.empty?
+
+    Sidekiq.redis { |conn|
+      conn.multi {
+        queues.map { |q| conn.llen("queue:#{q}") }
+      }
+    }.inject(0) { |memo, count| memo += count }
+  end
+
 end

data/lib/sidekiq/api.rb

@@ -33,6 +33,14 @@ module Sidekiq
       queues.values.inject(&:+) || 0
     end
 
+    def scheduled_size
+      Sidekiq.redis {|c| c.zcard('schedule') }
+    end
+
+    def retry_size
+      Sidekiq.redis {|c| c.zcard('retry') }
+    end
+
     class History
       def initialize(days_previous, start_date = nil)
         @days_previous = days_previous

data/lib/sidekiq/capistrano.rb

@@ -2,7 +2,6 @@ Capistrano::Configuration.instance.load do
   before "deploy:update_code", "sidekiq:quiet"
   after "deploy:stop",    "sidekiq:stop"
   after "deploy:start",   "sidekiq:start"
-  after "deploy:restart", "sidekiq:restart"
 
   _cset(:sidekiq_cmd) { "#{fetch(:bundle_cmd, "bundle")} exec sidekiq" }
   _cset(:sidekiqctl_cmd) { "#{fetch(:bundle_cmd, "bundle")} exec sidekiqctl" }

data/lib/sidekiq/core_ext.rb

@@ -60,8 +60,15 @@ rescue LoadError
         self[key.to_s] = delete(key)
       end
       self
-    end
-  end if !{}.respond_to?(:stringify_keys)
+    end if !{}.respond_to?(:stringify_keys)
+
+    def symbolize_keys
+      keys.each do |key|
+        self[(key.to_sym rescue key) || key] = delete(key)
+      end
+      self
+    end if !{}.respond_to?(:symbolize_keys)
+  end
 end
 
 begin

data/lib/sidekiq/middleware/chain.rb

@@ -23,6 +23,22 @@ module Sidekiq
   #   end
   # end
   #
+  # To insert immediately preceding another entry:
+  #
+  # Sidekiq.configure_client do |config|
+  #   config.client_middleware do |chain|
+  #     chain.insert_before ActiveRecord, MyClientHook
+  #   end
+  # end
+  #
+  # To insert immediately after another entry:
+  #
+  # Sidekiq.configure_client do |config|
+  #   config.client_middleware do |chain|
+  #     chain.insert_after ActiveRecord, MyClientHook
+  #   end
+  # end
+  #
   # This is an example of a minimal server middleware:
   #
   # class MyServerHook
@@ -60,6 +76,20 @@ module Sidekiq
         entries << Entry.new(klass, *args) unless exists?(klass)
       end
 
+      def insert_before(oldklass, newklass, *args)
+        i = entries.index { |entry| entry.klass == newklass }
+        new_entry = i.nil? ? Entry.new(newklass, *args) : entries.delete_at(i)
+        i = entries.find_index { |entry| entry.klass == oldklass } || 0
+        entries.insert(i, new_entry)
+      end
+
+      def insert_after(oldklass, newklass, *args)
+        i = entries.index { |entry| entry.klass == newklass }
+        new_entry = i.nil? ? Entry.new(newklass, *args) : entries.delete_at(i)
+        i = entries.find_index { |entry| entry.klass == oldklass } || entries.count - 1
+        entries.insert(i+1, new_entry)
+      end
+
       def exists?(klass)
         entries.any? { |entry| entry.klass == klass }
       end

data/lib/sidekiq/processor.rb

@@ -43,8 +43,8 @@ module Sidekiq
               worker.perform(*cloned(msg['args']))
             end
           end
-          rescue Exception => ex
-            handle_exception(ex, msg || { :message => msgstr })
+        rescue Exception => ex
+          handle_exception(ex, msg || { :message => msgstr })
           raise
         end
       end
@@ -72,11 +72,9 @@ module Sidekiq
         end
       end
 
-      dying = false
       begin
         yield
       rescue Exception
-        dying = true
         redis do |conn|
           conn.multi do
             conn.incrby("stat:failed", 1)

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "2.6.0"
+  VERSION = "2.6.1"
 end

data/lib/sidekiq/web.rb

@@ -38,14 +38,6 @@ module Sidekiq
         @stats ||= Sidekiq::Stats.new
       end
 
-      def scheduled_job_count
-        Sidekiq::ScheduledSet.new.size
-      end
-
-      def retry_job_count
-        Sidekiq::RetrySet.new.size
-      end
-
       def retries_with_score(score)
         Sidekiq.redis do |conn|
           results = conn.zrangebyscore('retry', score, score)
@@ -204,7 +196,7 @@ module Sidekiq
     end
 
     get '/dashboard' do
-      @redis_info = Sidekiq.redis{ |conn| conn.info }
+      @redis_info = Sidekiq.redis { |conn| conn.info }
       stats_history = Sidekiq::Stats::History.new((params[:days] || 30).to_i)
       @processed_history = stats_history.processed
       @failed_history = stats_history.failed
@@ -214,7 +206,13 @@ module Sidekiq
     get '/dashboard/stats' do
       stats = Sidekiq::Stats.new
       content_type :json
-      Sidekiq.dump_json({ processed: stats.processed, failed: stats.failed })
+      Sidekiq.dump_json({
+        processed: stats.processed,
+        failed: stats.failed,
+        enqueued: stats.enqueued,
+        scheduled: stats.scheduled_size,
+        retries: stats.retry_size,
+      })
     end
 
     def self.tabs

data/sidekiq.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Sidekiq::VERSION
   gem.add_dependency                  'redis', '~> 3'
   gem.add_dependency                  'redis-namespace'
-  gem.add_dependency                  'connection_pool', '~> 0.9.2'
+  gem.add_dependency                  'connection_pool', '~> 1.0'
   gem.add_dependency                  'celluloid', '~> 0.12.0'
   gem.add_dependency                  'multi_json', '~> 1'
   gem.add_development_dependency      'minitest', '~> 4'

data/test/test_middleware.rb

@@ -41,6 +41,32 @@ class TestMiddleware < MiniTest::Unit::TestCase
       def call(*args)
       end
     end
+    
+    class AnotherCustomMiddleware
+      def initialize(name, recorder)
+        @name = name
+        @recorder = recorder
+      end
+
+      def call(*args)
+        @recorder << [@name, 'before']
+        yield
+        @recorder << [@name, 'after']
+      end
+    end
+
+    class YetAnotherCustomMiddleware
+      def initialize(name, recorder)
+        @name = name
+        @recorder = recorder
+      end
+
+      def call(*args)
+        @recorder << [@name, 'before']
+        yield
+        @recorder << [@name, 'after']
+      end
+    end
 
     it 'executes middleware in the proper order' do
       msg = Sidekiq.dump_json({ 'class' => CustomWorker.to_s, 'args' => [$recorder] })
@@ -48,6 +74,8 @@ class TestMiddleware < MiniTest::Unit::TestCase
       Sidekiq.server_middleware do |chain|
         # should only add once, second should be ignored
         2.times { |i| chain.add CustomMiddleware, i.to_s, $recorder }
+        chain.insert_before CustomMiddleware, AnotherCustomMiddleware, '2', $recorder
+        chain.insert_after AnotherCustomMiddleware, YetAnotherCustomMiddleware, '3', $recorder
       end
 
       boss = MiniTest::Mock.new
@@ -56,7 +84,7 @@ class TestMiddleware < MiniTest::Unit::TestCase
       actor.expect(:processor_done, nil, [processor])
       boss.expect(:async, actor, [])
       processor.process(msg, 'default')
-      assert_equal %w(0 before work_performed 0 after), $recorder.flatten
+      assert_equal %w(2 before 3 before 0 before work_performed 0 after 3 after 2 after), $recorder.flatten
     end
 
     it 'allows middleware to abruptly stop processing rest of chain' do

data/test/test_web.rb

@@ -205,9 +205,12 @@ class TestWeb < MiniTest::Unit::TestCase
         conn.set("stat:processed", 5)
         conn.set("stat:failed", 2)
       end
+      2.times { add_retry }
+      3.times { add_scheduled }
+
       get '/dashboard/stats'
       assert_equal 200, last_response.status
-      assert_equal "{\"processed\":5,\"failed\":2}", last_response.body
+      assert_equal "{\"processed\":5,\"failed\":2,\"enqueued\":0,\"scheduled\":3,\"retries\":2}", last_response.body
     end
 
     def add_scheduled

data/web/assets/javascripts/dashboard.js

@@ -52,6 +52,8 @@ var realtimeGraph = function(updatePath) {
 
       Sidekiq.processed = data.processed;
       Sidekiq.failed = data.failed;
+
+      updateStatsSummary(data);
     });
     i++;
   }, timeInterval);
@@ -104,6 +106,24 @@ var createSeries = function(obj) {
   return series;
 };
 
+var updateStatsSummary = function(data) {
+  $('ul.summary li.processed span.count').html(data.processed.numberWithDelimiter())
+  $('ul.summary li.failed span.count').html(data.failed.numberWithDelimiter())
+  $('ul.summary li.scheduled span.count').html(data.scheduled.numberWithDelimiter())
+  $('ul.summary li.retries span.count').html(data.retries.numberWithDelimiter())
+  $('ul.summary li.enqueued span.count').html(data.enqueued.numberWithDelimiter())
+}
+
+Number.prototype.numberWithDelimiter = function(delimiter) {
+  var number = this + '', delimiter = delimiter || ',';
+  var split = number.split('.');
+  split[0] = split[0].replace(
+      /(\d)(?=(\d\d\d)+(?!\d))/g,
+      '$1' + delimiter
+  );
+  return split.join('.');
+};
+
 $(function(){
   realtimeGraph();
   historyGraph();

data/web/views/_summary.slim

@@ -1,19 +1,19 @@
 ul.unstyled.summary
-  li
+  li.processed
     span.count #{number_with_delimiter(stats.processed)}
     span.desc  Processed
-  li
+  li.failed
     span.count #{number_with_delimiter(stats.failed)}
     span.desc  Failed
   li
     span.count #{number_with_delimiter(workers.size)}
     span.desc  Busy
-  li
-    span.count #{number_with_delimiter(scheduled_job_count)}
+  li.scheduled
+    span.count #{number_with_delimiter(stats.scheduled_size)}
     span.desc  Scheduled
-  li
-    span.count #{number_with_delimiter(retry_job_count)}
+  li.retries
+    span.count #{number_with_delimiter(stats.retry_size)}
     span.desc  Retries
-  li
+  li.enqueued
     span.count #{number_with_delimiter(stats.enqueued)}
     span.desc  Enqueued

data/web/views/dashboard.slim

@@ -15,22 +15,27 @@ h5
 br
 h5 Redis
 
-.stat
-  h3= @redis_info.fetch("redis_version")
-  p Version
-
-.stat
-  h3= @redis_info.fetch("uptime_in_days")
-  p Uptime (days)
-
-.stat
-  h3= @redis_info.fetch("connected_clients")
-  p Connections
-
-.stat
-  h3= @redis_info.fetch("used_memory_human")
-  p Memory Usage
-
-.stat
-  h3= @redis_info.fetch("used_memory_peak_human")
-  p Peak Memory Usage
+- if @redis_info.fetch("redis_version", nil)
+  .stat
+    h3= @redis_info.fetch("redis_version")
+    p Version
+
+- if @redis_info.fetch("uptime_in_days", nil)
+  .stat
+    h3= @redis_info.fetch("uptime_in_days")
+    p Uptime (days)
+
+- if @redis_info.fetch("connected_clients", nil)
+  .stat
+    h3= @redis_info.fetch("connected_clients")
+    p Connections
+
+- if @redis_info.fetch("used_memory_human", nil)
+  .stat
+    h3= @redis_info.fetch("used_memory_human")
+    p Memory Usage
+
+- if @redis_info.fetch("used_memory_peak_human", nil)
+  .stat
+    h3= @redis_info.fetch("used_memory_peak_human")
+    p Peak Memory Usage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-16 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: celluloid
   requirement: !ruby/object:Gem::Requirement
@@ -245,7 +245,6 @@ files:
 - lib/sidekiq/rails.rb
 - lib/sidekiq/redis_connection.rb
 - lib/sidekiq/scheduled.rb
-- lib/sidekiq/stats.rb
 - lib/sidekiq/testing.rb
 - lib/sidekiq/testing/inline.rb
 - lib/sidekiq/util.rb

data/lib/sidekiq/stats.rb

@@ -1,13 +0,0 @@
-module Sidekiq
-  module_function
-
-  def size(*queues)
-    return Sidekiq::Stats.new.enqueued if queues.empty?
-
-    Sidekiq.redis { |conn|
-      conn.multi {
-        queues.map { |q| conn.llen("queue:#{q}") }
-      }
-    }.inject(0) { |memo, count| memo += count }
-  end
-end