sidekiq-failures 0.1.0 → 0.2.0

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 ## Unreleased
+
+## 0.2.0
+  * Added processor identity to failure data (@krasnoukhov)
+  * Handle Sidekiq::Shutdown exceptions (@krasnoukhov)
+  * Add failures maximum count option (@mathieulaporte)
+  * User Expception#message instead of Exception#to_s (@supaspoida)
+  * Removed web depencies (@LongMan)
+  * Stop overloading find_template (@zquestz)
+
+## 0.1.0
   * Allow per worker configuration of failure tracking mode. Thanks to
     @kbaum for most of the work.
   * Prevent sidekiq-failures from loading up sidekiq/processor (and thus

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-failures (0.2.0)
+      sidekiq (>= 2.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.14.0)
+      timers (>= 1.0.0)
+    connection_pool (1.0.0)
+    hike (1.2.1)
+    json (1.8.0)
+    multi_json (1.7.3)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    redis (3.0.4)
+    redis-namespace (1.3.0)
+      redis (~> 3.0.0)
+    sidekiq (2.12.0)
+      celluloid (>= 0.14.0)
+      connection_pool (>= 1.0.0)
+      json
+      redis (>= 3.0)
+      redis-namespace
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    slim (1.3.4)
+      temple (~> 0.5.5)
+      tilt (~> 1.3.3)
+    sprockets (2.8.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    temple (0.5.5)
+    tilt (1.3.3)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test
+  rake
+  sidekiq-failures!
+  sinatra
+  slim
+  sprockets

data/README.md

@@ -5,9 +5,7 @@ them. Makes use of Sidekiq's custom tabs and middleware chain.
 
 It mimics the way Resque keeps track of failures.
 
-TIP: Note that each failed job/retry might create a new failed job that will
-only be removed by you manually. This might result in a pretty big failures list
-depending on how you configure failures tracking in your workers.
+WARNING: by default sidekiq-failures will keep up to 1000 failures. See [Maximum Tracked Failures](https://github.com/mhfs/sidekiq-failures#maximum-tracked-failures) below.
 
 ## Installation
 
@@ -17,19 +15,47 @@ Add this line to your application's Gemfile:
 gem 'sidekiq-failures'
 ```
 
-## Dependencies
+## Usage
 
-Depends on Sidekiq >= 2.2.1
+Simply having the gem in your Gemfile is enough to get you started. Your failed
+jobs will be visible via a Failures tab in the Web UI.
+
+## Configuring
+
+### Maximum Tracked Failures
+
+Since each failed job/retry creates a new failure entry that will only be removed 
+by you manually, your failures list might consume more resources than you have 
+available.
+
+To avoid this sidekiq-failures adopts a default of 1000 maximum tracked failures.
+
+To change the maximum amount:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.failures_max_count = 5000
+end
+```
+
+To disable the limit entirely:
 
-## Usage and Modes
+```ruby
+Sidekiq.configure_server do |config|
+  config.failures_max_count = false
+end
+```
 
-Simply having the gem in your Gemfile is enough to get you started. Your failed jobs will be visible via a Failures tab in the Web UI.
+### Failures Tracking Mode
 
 Sidekiq-failures offers three failures tracking options (per worker):
 
-### all (default)
 
-Tracks failures everytime a background job fails. This mean a job with 25 retries enabled might generate up to 25 failure entries. If the worker has retry disabled only one failure will be tracked.
+#### :all (default)
+
+Tracks failures every time a background job fails. This mean a job with 25 retries
+enabled might generate up to 25 failure entries. If the worker has retry disabled
+only one failure will be tracked.
 
 This is the default behavior but can be made explicit with:
 
@@ -43,9 +69,10 @@ class MyWorker
 end
 ```
 
-### exhausted
+#### :exhausted
 
-Only track failures if the job exhausts all its retries (or doesn't have retries enabled).
+Only track failures if the job exhausts all its retries (or doesn't have retries
+enabled).
 
 You can set this mode as follows:
 
@@ -59,7 +86,7 @@ class MyWorker
 end
 ```
 
-### off
+#### :off
 
 You can also completely turn off failures tracking for a given worker as follows:
 
@@ -73,9 +100,10 @@ class MyWorker
 end
 ```
 
-### Change the default mode
+#### Change the default mode
 
-You can also change the default of all your workers at once by setting the following server config:
+You can also change the default of all your workers at once by setting the following
+server config:
 
 ```ruby
 Sidekiq.configure_server do |config|
@@ -85,6 +113,10 @@ end
 
 The valid modes are `:all`, `:exhausted` or `:off`.
 
+## Dependencies
+
+Depends on Sidekiq >= 2.2.1
+
 ## TODO
 
 * Allow triggering retry of specific failed jobs via Web UI.

data/lib/sidekiq/failures/middleware.rb

@@ -1,11 +1,15 @@
 module Sidekiq
   module Failures
+
     class Middleware
+      include Sidekiq::Util
       attr_accessor :msg
 
       def call(worker, msg, queue)
         self.msg = msg
         yield
+      rescue Sidekiq::Shutdown
+        raise
       rescue => e
         raise e if skip_failure?
 
@@ -13,13 +17,19 @@ module Sidekiq
           :failed_at => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
           :payload => msg,
           :exception => e.class.to_s,
-          :error => e.to_s,
+          :error => e.message,
           :backtrace => e.backtrace,
           :worker => msg['class'],
+          :processor => "#{hostname}:#{process_id}-#{Thread.current.object_id}",
           :queue => queue
         }
 
-        Sidekiq.redis { |conn| conn.lpush(:failed, Sidekiq.dump_json(data)) }
+        Sidekiq.redis do |conn|
+          conn.rpush(:failed, Sidekiq.dump_json(data))
+          unless Sidekiq.failures_max_count == false
+            conn.ltrim(:failed, (-Sidekiq.failures_max_count), -1)
+          end
+        end
 
         raise e
       end

data/lib/sidekiq/failures/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Failures
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/sidekiq/failures/views/failures.slim

@@ -25,6 +25,8 @@ header.row
         td style="overflow: auto; padding: 10px;"
           a.backtrace href="#" onclick="$(this).next().toggle(); return false"  = "#{msg['exception']}: #{msg['error']}"
           pre style="display: none; background: none; border: 0; width: 100%; max-height: 30em; font-size: 0.8em; white-space: nowrap;" == msg['backtrace'].join("<br />")
+          p
+            span Processor: #{msg['processor']}
 
   div.row
     .span5

data/lib/sidekiq/failures/web_extension.rb

@@ -3,20 +3,14 @@ module Sidekiq
     module WebExtension
 
       def self.registered(app)
-        app.helpers do
-          def find_template(view, *a, &b)
-            dir = File.expand_path("../views/", __FILE__)
-            super(dir, *a, &b)
-            super
-          end
-        end
-
         app.get "/failures" do
+          view_path = File.join(File.expand_path("..", __FILE__), "views")
+
           @count = (params[:count] || 25).to_i
           (@current_page, @total_size, @messages) = page("failed", params[:page], @count)
           @messages = @messages.map { |msg| Sidekiq.load_json(msg) }
 
-          slim :failures
+          render(:slim, File.read(File.join(view_path, "failures.slim")))
         end
 
         app.post "/failures/remove" do

data/lib/sidekiq/failures.rb

@@ -1,4 +1,9 @@
-require "sidekiq/web"
+begin
+  require "sidekiq/web"
+rescue LoadError
+  # client-only usage
+end
+
 require "sidekiq/failures/version"
 require "sidekiq/failures/middleware"
 require "sidekiq/failures/web_extension"
@@ -26,17 +31,26 @@ module Sidekiq
     @failures_default_mode || :all
   end
 
-  module Failures
+  # Sets the maximum number of failures to track
+  #
+  # If the number of failures exceeds this number the list will be trimmed (oldest
+  # failures will be purged).
+  #
+  # Defaults to 1000
+  # Set to false to disable rotation
+  def self.failures_max_count=(value)
+    @failures_max_count = value
   end
-end
 
-Sidekiq::Web.register Sidekiq::Failures::WebExtension
+  # Fetches the failures max count value
+  def self.failures_max_count
+    return 1000 if @failures_max_count.nil?
+
+    @failures_max_count
+  end
 
-if Sidekiq::Web.tabs.is_a?(Array)
-  # For sidekiq < 2.5
-  Sidekiq::Web.tabs << "failures"
-else
-  Sidekiq::Web.tabs["Failures"] = "failures"
+  module Failures
+  end
 end
 
 Sidekiq.configure_server do |config|
@@ -44,3 +58,14 @@ Sidekiq.configure_server do |config|
     chain.add Sidekiq::Failures::Middleware
   end
 end
+
+if defined?(Sidekiq::Web)
+  Sidekiq::Web.register Sidekiq::Failures::WebExtension
+
+  if Sidekiq::Web.tabs.is_a?(Array)
+    # For sidekiq < 2.5
+    Sidekiq::Web.tabs << "failures"
+  else
+    Sidekiq::Web.tabs["Failures"] = "failures"
+  end
+end

data/sidekiq-failures.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
   gem.version       = Sidekiq::Failures::VERSION
 
   gem.add_dependency "sidekiq", ">= 2.2.1"
-  gem.add_dependency "slim"
-  gem.add_dependency "sinatra"
-  gem.add_dependency "sprockets"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "sprockets"
+  gem.add_development_dependency "sinatra"
+  gem.add_development_dependency "slim"
 end

data/test/middleware_test.rb

@@ -5,8 +5,8 @@ module Sidekiq
     describe "Middleware" do
       before do
         $invokes = 0
-        boss = MiniTest::Mock.new
-        @processor = ::Sidekiq::Processor.new(boss)
+        @boss = MiniTest::Mock.new
+        @processor = ::Sidekiq::Processor.new(@boss)
         Sidekiq.server_middleware {|chain| chain.add Sidekiq::Failures::Middleware }
         Sidekiq.redis = REDIS
         Sidekiq.redis { |c| c.flushdb }
@@ -14,12 +14,14 @@ module Sidekiq
       end
 
       TestException = Class.new(StandardError)
+      ShutdownException = Class.new(Sidekiq::Shutdown)
 
       class MockWorker
         include Sidekiq::Worker
 
         def perform(args)
           $invokes += 1
+          raise ShutdownException.new if args == "shutdown"
           raise TestException.new("failed!")
         end
       end
@@ -35,12 +37,12 @@ module Sidekiq
       end
 
       it 'records all failures by default' do
-        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'])
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'])
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg, 'default')
+          @processor.process(msg)
         end
 
         assert_equal 1, failures_count
@@ -48,25 +50,40 @@ module Sidekiq
       end
 
       it 'records all failures if explicitly told to' do
-        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => true)
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => true)
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg, 'default')
+          @processor.process(msg)
         end
 
         assert_equal 1, failures_count
         assert_equal 1, $invokes
       end
 
+      it "doesn't record internal shutdown failure" do
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['shutdown'], 'failures' => true)
+
+        assert_equal 0, failures_count
+
+        actor = MiniTest::Mock.new
+        actor.expect(:processor_done, nil, [@processor])
+        @boss.expect(:async, actor, [])
+        @processor.process(msg)
+        @boss.verify
+
+        assert_equal 0, failures_count
+        assert_equal 1, $invokes
+      end
+
       it "doesn't record failure if failures disabled" do
-        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => false)
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => false)
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg, 'default')
+          @processor.process(msg)
         end
 
         assert_equal 0, failures_count
@@ -76,12 +93,12 @@ module Sidekiq
       it "doesn't record failure if going to be retired again and configured to track exhaustion by default" do
         Sidekiq.failures_default_mode = :exhausted
 
-        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'] )
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'] )
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg, 'default')
+          @processor.process(msg)
         end
 
         assert_equal 0, failures_count
@@ -90,12 +107,12 @@ module Sidekiq
 
 
       it "doesn't record failure if going to be retired again and configured to track exhaustion" do
-        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => 'exhausted')
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => 'exhausted')
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg, 'default')
+          @processor.process(msg)
         end
 
         assert_equal 0, failures_count
@@ -103,12 +120,12 @@ module Sidekiq
       end
 
       it "records failure if failing last retry and configured to track exhaustion" do
-        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'], 'retry_count' => 24, 'failures' => 'exhausted')
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'], 'retry_count' => 24, 'failures' => 'exhausted')
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg, 'default')
+          @processor.process(msg)
         end
 
         assert_equal 1, failures_count
@@ -118,26 +135,47 @@ module Sidekiq
       it "records failure if failing last retry and configured to track exhaustion by default" do
         Sidekiq.failures_default_mode = 'exhausted'
 
-        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'], 'retry_count' => 24)
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'], 'retry_count' => 24)
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg, 'default')
+          @processor.process(msg)
         end
 
         assert_equal 1, failures_count
         assert_equal 1, $invokes
       end
 
+      it "removes old failures when failures_max_count has been reached" do
+        assert_equal 1000, Sidekiq.failures_max_count
+        Sidekiq.failures_max_count = 2
 
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'])
+
+        assert_equal 0, failures_count
+
+        3.times do
+          assert_raises TestException do
+            ::Sidekiq::Processor.new(MiniTest::Mock.new).process(msg)
+          end
+        end
+
+        assert_equal 2, failures_count
+
+        Sidekiq.failures_max_count = false
+        assert Sidekiq.failures_max_count == false
+
+        Sidekiq.failures_max_count = nil
+        assert_equal 1000, Sidekiq.failures_max_count
+      end
 
       def failures_count
         Sidekiq.redis { |conn|conn.llen('failed') } || 0
       end
 
-      def create_message(params)
-        Sidekiq.dump_json(params)
+      def create_work(msg)
+        Sidekiq::BasicFetch::UnitOfWork.new('default', Sidekiq.dump_json(msg))
       end
     end
   end

data/test/test_helper.rb

@@ -14,9 +14,12 @@ end
 
 require "rack/test"
 
+require "celluloid"
 require "sidekiq"
 require "sidekiq-failures"
 require "sidekiq/processor"
+require "sidekiq/fetch"
+require "sidekiq/cli"
 
 Celluloid.logger = nil
 Sidekiq.logger.level = Logger::ERROR

data/test/web_extension_test.rb

@@ -1,4 +1,5 @@
 require "test_helper"
+require "sidekiq/web"
 
 module Sidekiq
   describe "WebExtension" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-failures
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-30 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -28,14 +28,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.1
 - !ruby/object:Gem::Dependency
-  name: slim
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -44,14 +44,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -67,7 +67,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: slim
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -117,6 +117,7 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -144,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4591242293469057094
+      hash: -4370758603814256180
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4591242293469057094
+      hash: -4370758603814256180
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23