sidekiq-failures 0.0.1.pre

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-failures.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marcelo Silveira
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Sidekiq::Failures
+
+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.
+
+It mimics the way Resque keeps track of failures.
+
+Note that each failed retry will create a new failed job. This might result in a
+pretty big failures list. Think twice before using this project. In most cases
+automatic retries allied to exception notifications will be enough.
+
+## Important Note!
+
+This is an ongoing, alpha level project. Be prepared that the API might change and bugs might occur.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-failures'
+```
+
+## Dependencies
+
+Depends on Sidekiq >= 2.2.1
+
+## Usage
+
+Simply having the gem in your Gemfile should be enough.
+
+Your failed jobs will be visible via a Failures tab in the Web UI.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT License. See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/mhfs/sidekiq-failures/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/sidekiq-failures.rb

@@ -0,0 +1 @@
+require "sidekiq/failures"

data/lib/sidekiq/failures.rb

@@ -0,0 +1,17 @@
+require "sidekiq/web"
+require "sidekiq/processor"
+require "sidekiq/failures/version"
+require "sidekiq/failures/middleware"
+require "sidekiq/failures/web_extension"
+
+module Sidekiq
+  module Failures
+  end
+end
+
+Sidekiq::Web.register Sidekiq::Failures::WebExtension
+Sidekiq::Web.tabs << "Failures"
+
+Sidekiq.server_middleware do |chain|
+  chain.add Sidekiq::Failures::Middleware
+end

data/lib/sidekiq/failures/middleware.rb

@@ -0,0 +1,23 @@
+module Sidekiq
+  module Failures
+    class Middleware
+      def call(worker, msg, queue)
+        yield
+      rescue => e
+        data = {
+          :failed_at => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
+          :payload => msg,
+          :exception => e.class.to_s,
+          :error => e.to_s,
+          :backtrace => e.backtrace,
+          :worker => msg['class'],
+          :queue => queue
+        }
+
+        Sidekiq.redis { |conn| conn.rpush(:failed, Sidekiq.dump_json(data)) }
+
+        raise
+      end
+    end
+  end
+end

data/lib/sidekiq/failures/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Failures
+    VERSION = "0.0.1.pre"
+  end
+end

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

@@ -0,0 +1,26 @@
+h1 Failed Jobs
+
+- if @messages.size > 0
+  == slim :_paging, :locals => { :url => "#{root_path}queues/#{@name}" }
+
+  table class="table table-striped table-bordered"
+    tr
+      th Worker
+      th Args
+      th Queue
+      th Exception
+      th Error
+      th Failed At
+    - @messages.each do |msg|
+      tr
+        td= msg['worker']
+        td= msg['payload']['args'].inspect[0..100]
+        td= msg['queue']
+        td= msg['exception']
+        td= msg['error']
+        td= msg['failed_at']
+
+  == slim :_paging, :locals => { :url => "#{root_path}queues/#{@name}" }
+- else
+  p No failed jobs found.
+  a href="#{root_path}" Back

data/lib/sidekiq/failures/web_extension.rb

@@ -0,0 +1,24 @@
+module Sidekiq
+  module Failures
+    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
+          @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
+        end
+      end
+    end
+  end
+end

data/sidekiq-failures.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sidekiq/failures/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marcelo Silveira"]
+  gem.email         = ["marcelo@mhfs.com.br"]
+  gem.description   = %q{Keep track of Sidekiq failed jobs}
+  gem.summary       = %q{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.}
+  gem.homepage      = "https://github.com/mhfs/sidekiq-failures/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sidekiq-failures"
+  gem.require_paths = ["lib"]
+  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"
+end

data/test/middleware_test.rb

@@ -0,0 +1,41 @@
+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.redis = REDIS
+        Sidekiq.redis { |c| c.flushdb }
+      end
+
+      class MockWorker
+        include Sidekiq::Worker
+        sidekiq_options :retry => false
+
+        def perform(args)
+          $invokes += 1
+          raise TestException.new("failed!")
+        end
+      end
+
+      it 'record failures' do
+        msg = Sidekiq.dump_json({ 'class' => MockWorker.to_s, 'args' => ['myarg'] })
+
+        Sidekiq.redis { |conn| assert_equal 0, conn.llen('failed') || 0 }
+
+        assert_raises TestException do
+          @processor.process(msg, 'default')
+        end
+
+        Sidekiq.redis { |conn| assert_equal 1, conn.llen('failed') || 0 }
+
+        assert_equal 1, $invokes
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/mock"
+
+require "rack/test"
+
+require "sidekiq"
+require "sidekiq-failures"
+
+Celluloid.logger = nil
+Sidekiq.logger.level = Logger::ERROR
+
+REDIS = Sidekiq::RedisConnection.create(:url => "redis://localhost/15", :namespace => 'sidekiq_failures_test')

data/test/web_extension_test.rb

@@ -0,0 +1,54 @@
+require "test_helper"
+
+module Sidekiq
+  describe "WebExtension" do
+    include Rack::Test::Methods
+
+    def app
+      Sidekiq::Web
+    end
+
+    before do
+      Sidekiq.redis = REDIS
+      Sidekiq.redis {|c| c.flushdb }
+    end
+
+    it 'can display home with failures tab' do
+      get '/'
+
+      last_response.status.must_equal 200
+      last_response.body.must_match /Sidekiq is idle/
+      last_response.body.must_match /Failures/
+    end
+
+    it 'can display failures page without any failures' do
+      get '/failures'
+      last_response.status.must_equal 200
+      last_response.body.must_match /Failed Jobs/
+      last_response.body.must_match /No failed jobs found/
+    end
+
+    it 'can display failures page with failures listed' do
+      create_sample_failure
+      get '/failures'
+      last_response.status.must_equal 200
+      last_response.body.must_match /HardWorker/
+      last_response.body.must_match /ArgumentError/
+      last_response.body.wont_match /No failed jobs found/
+    end
+
+    def create_sample_failure
+      data = {
+        :failed_at => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
+        :payload => { :args => ["bob", 5] },
+        :exception => "ArgumentError",
+        :error => "Some new message",
+        :backtrace => ["path/file1.rb", "path/file2.rb"],
+        :worker => 'HardWorker',
+        :queue => 'default'
+      }
+
+      Sidekiq.redis { |conn| conn.rpush(:failed, Sidekiq.dump_json(data)) }
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-failures
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Marcelo Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 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.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: :runtime
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Keep track of Sidekiq failed jobs
+email:
+- marcelo@mhfs.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-failures.rb
+- lib/sidekiq/failures.rb
+- lib/sidekiq/failures/middleware.rb
+- lib/sidekiq/failures/version.rb
+- lib/sidekiq/failures/views/failures.slim
+- lib/sidekiq/failures/web_extension.rb
+- sidekiq-failures.gemspec
+- test/middleware_test.rb
+- test/test_helper.rb
+- test/web_extension_test.rb
+homepage: https://github.com/mhfs/sidekiq-failures/
+licenses: []
+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: -3924324367283502437
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+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:
+- test/middleware_test.rb
+- test/test_helper.rb
+- test/web_extension_test.rb