sidekiq-configure_notifications 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e509db53279de6d0008868bb571073722284cd10
+  data.tar.gz: bed4f1f553730e5d8c0c70c651794d1650275960
+SHA512:
+  metadata.gz: 8b7360f2bfab033ff53142985489aa58975abf19435fe7ce35efd37f54d1177a140c1e8d69fde724eed6f75d59dfb0a8cd87067fb08f9a1f6cfdd79a0ff1c887
+  data.tar.gz: 5659cef2f9833e741f5e164a0681bb42c5f0139a97f33ce794378d8b89cca04d7bab77860a196ab792e2a5ee7bfc080b481eea05433975abd0361053380e2f10

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-configure_notifications.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Caue Guerra
+
+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,25 @@
+This plugin allows you to define after how many retries an exception should be nofitied to Honeybadger, Newrelic, etc
+
+To use it, just install this gem:
+
+```ruby
+gem 'sidekiq'
+gem 'sidekiq-configure_notifications'
+```
+
+Now, on your worker you can just add :log_exceptions_after => x and :skip_log_exceptions => [Exception, MyCustomError]
+
+as in:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  sidekiq_options :log_exceptions_after => 8, :skip_log_exceptions => [Exception, MyCustomError]
+
+  def perform(user_id)
+    raise Exception.new
+  end
+end
+```
+
+This code will keep retrying, but will only notify external services after 8 retries. Also, all the exceptions that are not "Exception" or "MyCustomError" will be notified as usual. If you don't use the skip_log_exceptions option, all exceptions will be only logged after 8 retries

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  #SO MUCH NOISE
+  #test.warning = true
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/lib/sidekiq/configure_notifications/exception_handler.rb

@@ -0,0 +1,14 @@
+require 'sidekiq'
+
+module Sidekiq
+  module ExceptionHandler
+    alias_method :handle_exception_original, :handle_exception
+
+    def handle_exception(ex, msg)
+      if msg['retry_count'].to_i >= msg['log_exceptions_after'].to_i &&
+          (msg['skip_log_exceptions'].nil? || msg['skip_log_exceptions'].size == 0 || msg['skip_log_exceptions'].include?(ex.class))
+        handle_exception_original(ex, msg)
+      end
+    end
+  end
+end

data/lib/sidekiq/configure_notifications/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module ConfigureNotifications
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq/configure_notifications.rb

@@ -0,0 +1,2 @@
+require "sidekiq/configure_notifications/version"
+require "sidekiq/configure_notifications/exception_handler"

data/sidekiq-configure_notifications.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/configure_notifications'
+require 'sidekiq/configure_notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-configure_notifications"
+  spec.version       = Sidekiq::ConfigureNotifications::VERSION
+  spec.authors       = ["Caue Guerra"]
+  spec.email         = ["caueguerra@gmail.com"]
+  spec.description   = %q{This plugin allows you to define after how many retries an exception should be nofitied to Honeybadger, Newrelic, etc}
+  spec.summary       = %q{This plugin allows you to define after how many retries an exception should be nofitied to Honeybadger, Newrelic, etc}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sidekiq', '~> 2.13.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'minitest', '~> 5'
+end

data/test/helper.rb

@@ -0,0 +1,20 @@
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'celluloid/autostart'
+require 'sidekiq'
+require 'sidekiq/util'
+Sidekiq.logger.level = Logger::ERROR
+
+require 'sidekiq/redis_connection'
+redis_url = ENV['REDIS_URL'] || 'redis://localhost/15'
+REDIS = Sidekiq::RedisConnection.create(:url => redis_url, :namespace => 'testy')
+
+Sidekiq.configure_client do |config|
+  config.redis = { :url => redis_url, :namespace => 'testy' }
+end

data/test/test_exception_handler.rb

@@ -0,0 +1,75 @@
+require 'helper'
+require 'sidekiq'
+require 'sidekiq/exception_handler'
+require 'sidekiq/configure_notifications/exception_handler'
+require 'stringio'
+require 'logger'
+
+ExceptionHandlerTestException = Class.new(StandardError)
+TEST_EXCEPTION = ExceptionHandlerTestException.new("Something didn't work!")
+
+class Component
+  include Sidekiq::ExceptionHandler
+
+  def invoke_exception(args)
+    raise TEST_EXCEPTION
+  rescue ExceptionHandlerTestException => e
+    handle_exception(e,args)
+  end
+end
+
+class TestExceptionHandler < Minitest::Test
+  describe "with log_exceptions_after and skip_log_exceptions options" do
+    after do
+      Object.send(:remove_const, "Airbrake") # HACK should probably inject Airbrake etc into this class in the future
+    end
+
+    describe "does not log" do
+      before do
+        class ::Airbrake
+          def self.notify_or_ignore(*args)
+            raise "it should not be called"
+          end
+        end
+      end
+
+      it "does not log when number of retries is less than log_exceptions_after" do
+        Component.new.invoke_exception('log_exceptions_after' => 4, 'retry_count' => 3)
+      end
+
+      it "does not log when number of retries is bigger than log_exceptions_after and exception is not in skip_log_exceptions" do
+        Component.new.invoke_exception('log_exceptions_after' => 2, 'retry_count' => 3, 'skip_log_exceptions' => [::Exception])
+      end
+    end
+
+    describe "logs" do
+      before do
+        ::Airbrake = Minitest::Mock.new
+      end
+
+      it "logs when number of retries is less than log_exceptions_after and exception is not in skip_log_exceptions 3" do
+        ::Airbrake.expect(:notify_or_ignore,nil,[TEST_EXCEPTION,:parameters => { 'log_exceptions_after' => 2, 'retry_count' => 3, 'skip_log_exceptions' => [ExceptionHandlerTestException] }])
+        Component.new.invoke_exception('log_exceptions_after' => 2, 'retry_count' => 3, 'skip_log_exceptions' => [ExceptionHandlerTestException])
+        ::Airbrake.verify
+      end
+
+      it "logs when number of retries is less than log_exceptions_after and skip_log_exceptions is empty" do
+        ::Airbrake.expect(:notify_or_ignore,nil,[TEST_EXCEPTION,:parameters => { 'log_exceptions_after' => 2, 'retry_count' => 3, 'skip_log_exceptions' => [] }])
+        Component.new.invoke_exception('log_exceptions_after' => 2, 'retry_count' => 3, 'skip_log_exceptions' => [])
+        ::Airbrake.verify
+      end
+
+      it "logs when number of retries is less than log_exceptions_after and skip_log_exceptions is not given" do
+        ::Airbrake.expect(:notify_or_ignore,nil,[TEST_EXCEPTION,:parameters => { 'log_exceptions_after' => 2, 'retry_count' => 3 }])
+        Component.new.invoke_exception('log_exceptions_after' => 2, 'retry_count' => 3)
+        ::Airbrake.verify
+      end
+
+      it "logs when log_exceptions_after is not given" do
+        ::Airbrake.expect(:notify_or_ignore,nil,[TEST_EXCEPTION,:parameters => {}])
+        Component.new.invoke_exception({})
+        ::Airbrake.verify
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-configure_notifications
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caue Guerra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+description: This plugin allows you to define after how many retries an exception
+  should be nofitied to Honeybadger, Newrelic, etc
+email:
+- caueguerra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/configure_notifications.rb
+- lib/sidekiq/configure_notifications/exception_handler.rb
+- lib/sidekiq/configure_notifications/version.rb
+- sidekiq-configure_notifications.gemspec
+- test/helper.rb
+- test/test_exception_handler.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: This plugin allows you to define after how many retries an exception should
+  be nofitied to Honeybadger, Newrelic, etc
+test_files:
+- test/helper.rb
+- test/test_exception_handler.rb