sidekiq-failures 0.2.2 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 708163dea57e9c34fbaf279980cd23c56420415f
+  data.tar.gz: 1a8967ec4c7efc057fa48e2481601fc42980edf0
+SHA512:
+  metadata.gz: d8bca52118ae7b792ac8387c25aad0662680b2797ab8fe0bd0b668986fe4643f26ddefc2200d33cbf4c662a85d16d1279f2ff33097ebaa502eddbd1da5413beb
+  data.tar.gz: 5ac567f23aa5f0e9f27769ca5223da6c4d08f4e6de981c398c87e6a3978706d543302370539d413f9023a7c504e0015b200f641a76f433fbc1ca7c058242c2d8

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+services:
+  - redis-server
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Unreleased
 
+## 0.3.0
+  * Bump sidekiq dependency to sidekiq >= 2.14.0
+  * Remove slim templates and dependecy
+  * Escape exception info when outputing to html
+  * Add `Sidekiq::Failures.reset_failures` helper method
+  * Add `Sidekiq::Failures.count` helper method (@zanker)
+  * Adhere to sidekiq approach of showing UTC times
+  * Catch all exceptions, not just those that inherit from StandardError (@tylerkovacs)
+  * Fix pricate method call (@bwthomas)
+
 ## 0.2.2
   * Support ERB for sidekiq >= 2.14.0 (@tobiassvn)
   * Bump sidekiq dep to >= 2.9.0

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    sidekiq-failures (0.2.2)
-      sidekiq (>= 2.9.0)
+    sidekiq-failures (0.3.0)
+      sidekiq (>= 2.14.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    celluloid (0.14.1)
-      timers (>= 1.0.0)
-    connection_pool (1.1.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    connection_pool (1.2.0)
     hike (1.2.1)
-    json (1.8.0)
+    json (1.8.1)
     multi_json (1.7.3)
     rack (1.4.1)
     rack-protection (1.2.0)
@@ -19,28 +19,24 @@ GEM
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (0.9.2.2)
-    redis (3.0.4)
-    redis-namespace (1.3.1)
-      redis (~> 3.0.0)
-    sidekiq (2.13.0)
-      celluloid (>= 0.14.1)
+    redis (3.0.6)
+    redis-namespace (1.3.2)
+      redis (~> 3.0.4)
+    sidekiq (2.17.0)
+      celluloid (>= 0.15.2)
       connection_pool (>= 1.0.0)
       json
-      redis (>= 3.0)
-      redis-namespace
+      redis (>= 3.0.4)
+      redis-namespace (>= 1.3.1)
     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)
 
@@ -52,5 +48,4 @@ DEPENDENCIES
   rake
   sidekiq-failures!
   sinatra
-  slim
   sprockets

data/README.md

@@ -113,9 +113,30 @@ end
 
 The valid modes are `:all`, `:exhausted` or `:off`.
 
+## Helper Methods
+
+### Failures Count
+
+Gives back the number of failed jobs currently stored in Sidekiq Failures. Notice that it's
+different from `Sidekiq` built in failed stat. Also, notice that this might be
+influenced by `failures_max_count`.
+
+```ruby
+Sidekiq::Failures.count
+```
+
+### Reset Failures
+
+Gives a convenient way of reseting Sidekiq Failure stored failed jobs programmatically.
+Takes an options hash and if the `counter` key is present also resets Sidekiq own failed stats.
+
+```ruby
+Sidekiq::Failures.reset_failures
+```
+
 ## Dependencies
 
-Depends on Sidekiq >= 2.9.0
+Depends on Sidekiq >= 2.14.0
 
 ## Contributing
 

data/lib/sidekiq/failures.rb

@@ -50,6 +50,21 @@ module Sidekiq
   end
 
   module Failures
+
+    LIST_KEY = :failed
+
+    def self.reset_failures(options = {})
+      Sidekiq.redis { |c|
+        c.multi do
+          c.del(LIST_KEY)
+          c.set("stat:failed", 0) if options[:counter] || options["counter"]
+        end
+      }
+    end
+
+    def self.count
+      Sidekiq.redis {|r| r.llen(LIST_KEY) }
+    end
   end
 end
 

data/lib/sidekiq/failures/middleware.rb

@@ -10,11 +10,11 @@ module Sidekiq
         yield
       rescue Sidekiq::Shutdown
         raise
-      rescue => e
+      rescue Exception => e
         raise e if skip_failure?
 
         data = {
-          :failed_at => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
+          :failed_at => Time.now.utc,
           :payload => msg,
           :exception => e.class.to_s,
           :error => e.message,
@@ -25,9 +25,9 @@ module Sidekiq
         }
 
         Sidekiq.redis do |conn|
-          conn.lpush(:failed, Sidekiq.dump_json(data))
+          conn.lpush(LIST_KEY, Sidekiq.dump_json(data))
           unless Sidekiq.failures_max_count == false
-            conn.ltrim(:failed, 0, Sidekiq.failures_max_count - 1)
+            conn.ltrim(LIST_KEY, 0, Sidekiq.failures_max_count - 1)
           end
         end
 
@@ -66,7 +66,7 @@ module Sidekiq
       end
 
       def max_retries
-        retry_middleware.retry_attempts_from(msg['retry'], default_max_retries)
+        retry_middleware.send(:retry_attempts_from, msg['retry'], default_max_retries)
       end
 
       def retry_middleware

data/lib/sidekiq/failures/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Failures
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/lib/sidekiq/failures/views/failures.erb

@@ -26,13 +26,11 @@
         </td>
         <td><%= msg['queue'] %></td>
         <td>
-          <time datetime="<%= "#{Time.parse(msg['failed_at']).getutc.iso8601}" %>">
-            <%= msg['failed_at'] %>
-          </time>
+          <%= relative_time(Time.parse(msg['failed_at'])) %>
         </td>
         <td style="overflow: auto; padding: 10px;">
           <a class="backtrace" href="#" onclick="$(this).next().toggle(); return false">
-            <%= msg['exception'] %>: <%= msg['error'] %>
+            <%= h msg['exception'] %>: <%= h msg['error'] %>
           </a>
           <pre style="display: none; background: none; border: 0; width: 100%; max-height: 30em; font-size: 0.8em; white-space: nowrap;">
             <%= msg['backtrace'].join("<br />") %>

data/lib/sidekiq/failures/web_extension.rb

@@ -10,20 +10,11 @@ module Sidekiq
           (@current_page, @total_size, @messages) = page("failed", params[:page], @count)
           @messages = @messages.map { |msg| Sidekiq.load_json(msg) }
 
-          if Sidekiq::VERSION < "2.14.0"
-            render(:slim, File.read(File.join(view_path, "failures.slim")))
-          else
-            render(:erb, File.read(File.join(view_path, "failures.erb")))
-          end
+          render(:erb, File.read(File.join(view_path, "failures.erb")))
         end
 
         app.post "/failures/remove" do
-          Sidekiq.redis {|c|
-            c.multi do
-              c.del("failed")
-              c.set("stat:failed", 0) if params["counter"]
-            end
-          }
+          Sidekiq::Failures.reset_failures(counter: params["counter"])
 
           redirect "#{root_path}failures"
         end

data/sidekiq-failures.gemspec

@@ -15,11 +15,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Sidekiq::Failures::VERSION
 
-  gem.add_dependency "sidekiq", ">= 2.9.0"
+  gem.add_dependency "sidekiq", ">= 2.14.0"
 
   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

@@ -4,6 +4,7 @@ module Sidekiq
   module Failures
     describe "Middleware" do
       before do
+        Celluloid.boot
         $invokes = 0
         @boss = MiniTest::Mock.new
         @processor = ::Sidekiq::Processor.new(@boss)
@@ -13,7 +14,7 @@ module Sidekiq
         Sidekiq.instance_eval { @failures_default_mode = nil }
       end
 
-      TestException = Class.new(StandardError)
+      TestException = Class.new(Exception)
       ShutdownException = Class.new(Sidekiq::Shutdown)
 
       class MockWorker
@@ -177,11 +178,11 @@ module Sidekiq
         assert_raises TestException do
           @processor.process(msg)
         end
- 
+
         assert_equal 1, failures_count
         assert_equal 1, $invokes
        end
- 
+
       it "records failure if retry disabled and configured to track exhaustion by default" do
         Sidekiq.failures_default_mode = 'exhausted'
 
@@ -233,7 +234,7 @@ module Sidekiq
         3.times do
           boss = MiniTest::Mock.new
           processor = ::Sidekiq::Processor.new(boss)
-          
+
           actor = MiniTest::Mock.new
           actor.expect(:processor_done, nil, [processor])
           actor.expect(:real_thread, nil, [nil, Celluloid::Thread])
@@ -253,6 +254,23 @@ module Sidekiq
         assert_equal 1000, Sidekiq.failures_max_count
       end
 
+      it 'returns the total number of failed jobs in the queue' do
+        msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'], 'failures' => true)
+
+        assert_equal 0, Sidekiq::Failures.count
+
+        actor = MiniTest::Mock.new
+        actor.expect(:processor_done, nil, [@processor])
+        actor.expect(:real_thread, nil, [nil, Celluloid::Thread])
+        @boss.expect(:async, actor, [])
+
+        assert_raises TestException do
+          @processor.process(msg)
+        end
+
+        assert_equal 1, Sidekiq::Failures.count
+      end
+
       def failures_count
         Sidekiq.redis { |conn|conn.llen('failed') } || 0
       end

data/test/test_helper.rb

@@ -5,13 +5,6 @@ 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 "celluloid"

metadata

@@ -1,110 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-failures
 version: !ruby/object:Gem::Version
-  version: 0.2.2
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Marcelo Silveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: slim
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Keep track of Sidekiq failed jobs
@@ -115,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -126,7 +100,6 @@ files:
 - lib/sidekiq/failures/middleware.rb
 - lib/sidekiq/failures/version.rb
 - lib/sidekiq/failures/views/failures.erb
-- lib/sidekiq/failures/views/failures.slim
 - lib/sidekiq/failures/web_extension.rb
 - sidekiq-failures.gemspec
 - test/middleware_test.rb
@@ -134,33 +107,26 @@ files:
 - test/web_extension_test.rb
 homepage: https://github.com/mhfs/sidekiq-failures/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -612683227478286431
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -612683227478286431
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you
   browse them. Makes use of Sidekiq's custom tabs and middleware chain.
 test_files:

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

@@ -1,41 +0,0 @@
-header.row
-  .span5
-    h3 Failed Jobs
-  .span4
-    - if @messages.size > 0
-      == 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;"
-    thead
-      th style="width: 25%" Worker, Args
-      th style="width: 10%" Queue
-      th style="width: 15%" Failed At
-      th style="width: 50%" Exception
-    - @messages.each do |msg|
-      tr
-        td style="overflow: hidden; text-overflow: ellipsis;"
-          = msg['worker']
-          br
-          = msg['payload']['args'].inspect[0..100]
-        td= msg['queue']
-        td
-          time datetime="#{Time.parse(msg['failed_at']).getutc.iso8601}"
-            = msg['failed_at']
-        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
-      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" }
-- else
-  .alert.alert-success  No failed jobs found.