sidekiq-failures 0.0.3 → 0.1.0

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 ## Unreleased
+  * 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
+    Celluloid actors) except for inside a Sidekiq server context (@cheald)
+  * Fix pagination bug
+  * Add failures default mode option (@kbaum)
+  * Add checkbox option to reset failed counter (@krasnoukhov)
 
 ## 0.0.3
 

data/README.md

@@ -5,8 +5,9 @@ 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 will create a new failed job that will
-only be removed by you manually. This might result in a pretty big failures list.
+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.
 
 ## Installation
 
@@ -20,17 +21,73 @@ gem 'sidekiq-failures'
 
 Depends on Sidekiq >= 2.2.1
 
-## Usage
+## Usage and Modes
 
-Simply having the gem in your Gemfile should be enough.
+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.
 
-Your failed jobs will be visible via a Failures tab in the Web UI.
+Sidekiq-failures offers three failures tracking options (per worker):
 
-## TODO and Limitations
+### all (default)
 
-* Skip failures of specific workers (or the opposite).
-* Trigger retry of specific failed jobs via Web UI.
-* Deal with retries. Maybe just track a failure when there's no attempt left.
+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.
+
+This is the default behavior but can be made explicit with:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+
+  sidekiq_options :failures => true # or :all
+
+  def perform; end
+end
+```
+
+### exhausted
+
+Only track failures if the job exhausts all its retries (or doesn't have retries enabled).
+
+You can set this mode as follows:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+
+  sidekiq_options :failures => :exhausted
+
+  def perform; end
+end
+```
+
+### off
+
+You can also completely turn off failures tracking for a given worker as follows:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+
+  sidekiq_options :failures => false # or :off
+
+  def perform; end
+end
+```
+
+### Change the default mode
+
+You can also change the default of all your workers at once by setting the following server config:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.failures_default_mode = :off
+end
+```
+
+The valid modes are `:all`, `:exhausted` or `:off`.
+
+## TODO
+
+* Allow triggering retry of specific failed jobs via Web UI.
 
 ## Contributing
 

data/lib/sidekiq/failures.rb

@@ -1,10 +1,31 @@
 require "sidekiq/web"
-require "sidekiq/processor"
 require "sidekiq/failures/version"
 require "sidekiq/failures/middleware"
 require "sidekiq/failures/web_extension"
 
 module Sidekiq
+
+  SIDEKIQ_FAILURES_MODES = [:all, :exhausted, :off].freeze
+
+  # Sets the default failure tracking mode.
+  #
+  # The value provided here will be the default behavior but can be overwritten
+  # per worker by using `sidekiq_options :failures => :mode`
+  #
+  # Defaults to :all
+  def self.failures_default_mode=(mode)
+    unless SIDEKIQ_FAILURES_MODES.include?(mode.to_sym)
+      raise ArgumentError, "Sidekiq#failures_default_mode valid options: #{SIDEKIQ_FAILURES_MODES}"
+    end
+
+    @failures_default_mode = mode.to_sym
+  end
+
+  # Fetches the default failure tracking mode.
+  def self.failures_default_mode
+    @failures_default_mode || :all
+  end
+
   module Failures
   end
 end
@@ -18,6 +39,8 @@ else
   Sidekiq::Web.tabs["Failures"] = "failures"
 end
 
-Sidekiq.server_middleware do |chain|
-  chain.add Sidekiq::Failures::Middleware
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Failures::Middleware
+  end
 end

data/lib/sidekiq/failures/middleware.rb

@@ -1,9 +1,14 @@
 module Sidekiq
   module Failures
     class Middleware
+      attr_accessor :msg
+
       def call(worker, msg, queue)
+        self.msg = msg
         yield
       rescue => e
+        raise e if skip_failure?
+
         data = {
           :failed_at => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
           :payload => msg,
@@ -16,7 +21,50 @@ module Sidekiq
 
         Sidekiq.redis { |conn| conn.lpush(:failed, Sidekiq.dump_json(data)) }
 
-        raise
+        raise e
+      end
+
+      private
+
+      def skip_failure?
+        failure_mode == :off || not_exhausted?
+      end
+
+      def not_exhausted?
+        failure_mode == :exhausted && !last_try?
+      end
+
+      def failure_mode
+        case msg['failures'].to_s
+        when 'true', 'all'
+          :all
+        when 'false', 'off'
+          :off
+        when 'exhausted'
+          :exhausted
+        else
+          Sidekiq.failures_default_mode
+        end
+      end
+
+      def last_try?
+        retry_count == max_retries - 1
+      end
+
+      def retry_count
+        msg['retry_count'] || 0
+      end
+
+      def max_retries
+        retry_middleware.retry_attempts_from(msg['retry'], default_max_retries)
+      end
+
+      def retry_middleware
+        @retry_middleware ||= Sidekiq::Middleware::Server::RetryJobs.new
+      end
+
+      def default_max_retries
+        Sidekiq::Middleware::Server::RetryJobs::DEFAULT_MAX_RETRY_ATTEMPTS
       end
     end
   end

data/lib/sidekiq/failures/version.rb

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

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

@@ -3,7 +3,7 @@ header.row
     h3 Failed Jobs
   .span4
     - if @messages.size > 0
-      == slim :_paging, :locals => { :url => "#{root_path}failures/#@name" }
+      == slim :_paging, :locals => { :url => "#{root_path}failures#@name" }
 
 - if @messages.size > 0
   table class="table table-striped table-bordered table-white" style="width: 100%; margin: 0; table-layout:fixed;"
@@ -28,9 +28,12 @@ header.row
 
   div.row
     .span5
-      form.form-horizontal action="#{root_path}failures/remove" method="post" style="margin: 20px 0"
+      form.form-inline action="#{root_path}failures/remove" method="post" style="margin: 20px 0"
         input.btn.btn-danger.btn-small type="submit" name="delete" value="Clear All"
+        label class="checkbox"
+          input type="checkbox" name="counter" value="true"
+          = "reset failed counter"
     .span4
-      == slim :_paging, :locals => { :url => "#{root_path}failures/#@name" }
+      == slim :_paging, :locals => { :url => "#{root_path}failures#@name" }
 - else
   .alert.alert-success  No failed jobs found.

data/lib/sidekiq/failures/web_extension.rb

@@ -20,7 +20,12 @@ module Sidekiq
         end
 
         app.post "/failures/remove" do
-          Sidekiq.redis {|c| c.del(:failed) }
+          Sidekiq.redis {|c|
+            c.multi do
+              c.del("failed")
+              c.set("stat:failed", 0) if params["counter"]
+            end
+          }
 
           redirect "#{root_path}failures"
         end

data/test/middleware_test.rb

@@ -3,19 +3,20 @@ require "test_helper"
 module Sidekiq
   module Failures
     describe "Middleware" do
-      TestException = Class.new(StandardError)
-
       before do
         $invokes = 0
         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 }
+        Sidekiq.instance_eval { @failures_default_mode = nil }
       end
 
+      TestException = Class.new(StandardError)
+
       class MockWorker
         include Sidekiq::Worker
-        sidekiq_options :retry => false
 
         def perform(args)
           $invokes += 1
@@ -23,19 +24,121 @@ module Sidekiq
         end
       end
 
-      it 'record failures' do
-        msg = Sidekiq.dump_json({ 'class' => MockWorker.to_s, 'args' => ['myarg'] })
+      it 'raises an error when failures_default_mode is configured incorrectly' do
+        assert_raises ArgumentError do
+          Sidekiq.failures_default_mode = 'exhaustion'
+        end
+      end
+
+      it 'defaults failures_default_mode to all' do
+        assert_equal :all, Sidekiq.failures_default_mode
+      end
+
+      it 'records all failures by default' do
+        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'])
+
+        assert_equal 0, failures_count
+
+        assert_raises TestException do
+          @processor.process(msg, 'default')
+        end
+
+        assert_equal 1, failures_count
+        assert_equal 1, $invokes
+      end
+
+      it 'records all failures if explicitly told to' do
+        msg = create_message('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => true)
+
+        assert_equal 0, failures_count
+
+        assert_raises TestException do
+          @processor.process(msg, 'default')
+        end
+
+        assert_equal 1, 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)
 
-        Sidekiq.redis { |conn| assert_equal 0, conn.llen('failed') || 0 }
+        assert_equal 0, failures_count
 
         assert_raises TestException do
           @processor.process(msg, 'default')
         end
 
-        Sidekiq.redis { |conn| assert_equal 1, conn.llen('failed') || 0 }
+        assert_equal 0, failures_count
+        assert_equal 1, $invokes
+      end
+
+      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'] )
+
+        assert_equal 0, failures_count
+
+        assert_raises TestException do
+          @processor.process(msg, 'default')
+        end
 
+        assert_equal 0, failures_count
         assert_equal 1, $invokes
       end
+
+
+      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')
+
+        assert_equal 0, failures_count
+
+        assert_raises TestException do
+          @processor.process(msg, 'default')
+        end
+
+        assert_equal 0, failures_count
+        assert_equal 1, $invokes
+      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')
+
+        assert_equal 0, failures_count
+
+        assert_raises TestException do
+          @processor.process(msg, 'default')
+        end
+
+        assert_equal 1, failures_count
+        assert_equal 1, $invokes
+      end
+
+      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)
+
+        assert_equal 0, failures_count
+
+        assert_raises TestException do
+          @processor.process(msg, 'default')
+        end
+
+        assert_equal 1, failures_count
+        assert_equal 1, $invokes
+      end
+
+
+
+      def failures_count
+        Sidekiq.redis { |conn|conn.llen('failed') } || 0
+      end
+
+      def create_message(params)
+        Sidekiq.dump_json(params)
+      end
     end
   end
 end

data/test/test_helper.rb

@@ -5,10 +5,18 @@ require "minitest/autorun"
 require "minitest/spec"
 require "minitest/mock"
 
+# FIXME Remove once https://github.com/mperham/sidekiq/pull/548 is released.
+class String
+  def blank?
+    self !~ /[^[:space:]]/
+  end
+end
+
 require "rack/test"
 
 require "sidekiq"
 require "sidekiq-failures"
+require "sidekiq/processor"
 
 Celluloid.logger = nil
 Sidekiq.logger.level = Logger::ERROR

data/test/web_extension_test.rb

@@ -49,9 +49,12 @@ module Sidekiq
         last_response.body.must_match /failures\/remove/
         last_response.body.must_match /method=\"post/
         last_response.body.must_match /Clear All/
+        last_response.body.must_match /reset failed counter/
       end
 
-      it 'can remove all failures' do
+      it 'can remove all failures without clearing counter' do
+        assert_equal failed_count, "1"
+
         last_response.body.must_match /HardWorker/
 
         post '/failures/remove'
@@ -61,6 +64,24 @@ module Sidekiq
         get '/failures'
         last_response.status.must_equal 200
         last_response.body.must_match /No failed jobs found/
+
+        assert_equal failed_count, "1"
+      end
+
+      it 'can remove all failures and clear counter' do
+        assert_equal failed_count, "1"
+
+        last_response.body.must_match /HardWorker/
+
+        post '/failures/remove', counter: "true"
+        last_response.status.must_equal 302
+        last_response.location.must_match /failures$/
+
+        get '/failures'
+        last_response.status.must_equal 200
+        last_response.body.must_match /No failed jobs found/
+
+        assert_equal failed_count, "0"
       end
     end
 
@@ -75,7 +96,16 @@ module Sidekiq
         :queue => 'default'
       }
 
-      Sidekiq.redis { |conn| conn.rpush(:failed, Sidekiq.dump_json(data)) }
+      Sidekiq.redis do |c|
+        c.multi do
+          c.rpush("failed", Sidekiq.dump_json(data))
+          c.set("stat:failed", 1)
+        end
+      end
+    end
+
+    def failed_count
+      Sidekiq.redis { |c| c.get("stat:failed") }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-failures
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2012-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -144,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2051440200690725249
+      hash: -4591242293469057094
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2051440200690725249
+      hash: -4591242293469057094
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23