sidekiq_error_label 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e139082e8a73bfdabb2ca42dfee491388accd04
+  data.tar.gz: 26e5b03da02e6ddc74e2aa8f6ba52f9326c0ccda
+SHA512:
+  metadata.gz: 7a7d2b01572ea0803d6ce6f2977907084e9943a07e6c38641766d6f2ab481fde92e22bd88acaccc411bfd283f0baf7e5c3704d08fbfd06c8395ac92a6bda01c6
+  data.tar.gz: e6c32776b81e353f3a8c269fd730d4ce0255bca4fafc0c0bcc97af3ecd97f404ff2d8960fecb03f14928725a6a53f8c4ab6bf715b9032d3e52feae23f8068fe4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tema Bolshakov
+
+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,69 @@
+# SidekiqErrorLabel
+
+Label sidekiq exception.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq_error_label'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_error_label
+
+## Usage
+
+Include middleware to server chain and configure list of errors which should be marked as `SilentException`. 
+
+```ruby
+module SilentException
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add SidekiqErrorLabel::Middleware, 
+        exceptions: [
+          Errno::ECONNRESET,
+          Net::OpenTimeout,
+          Errno::EHOSTUNREACH,
+          Net::ReadTimeout
+        ], 
+        retries_threshold: 3,
+        as: SilentException
+  end
+end
+```
+
+
+Middleware extands listed exceptions with `SilentException` module if same job
+have been failing with one of this errors for `retries_threshold` times. So you may catch them by the module name.
+
+If no `:as` option given exceptions would be labeled with `SidekiqErrorLabel::Middleware::Labels::Default`
+
+E.g. you may configure Airbrake to log those types of errors only if job have failed `retries_threshold` times in a row:
+
+```ruby
+Airbrake.configure do |config|
+  config.ignore << SilentException 
+end
+```
+
+You may create labels on the fly:
+
+```ruby
+SidekiqErrorLabel::Middleware.label(:default) #=> SidekiqErrorLabel::Middleware::Labels::Default
+SidekiqErrorLabel::Middleware.label(:Silent) #=> SidekiqErrorLabel::Middleware::Labels::Silent
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/SPBTV/sidekiq_error_label/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sidekiq_error_label/labels.rb

@@ -0,0 +1,4 @@
+module SidekiqErrorLabel::Middleware::Labels
+  module Default
+  end
+end

data/lib/sidekiq_error_label/middleware.rb

@@ -0,0 +1,37 @@
+require 'active_support/inflections'
+
+class SidekiqErrorLabel::Middleware
+  require_relative 'labels'
+
+  RETRIES_THRESHOLD = 5
+
+  def initialize(options = {})
+    @exceptions = options.fetch(:exceptions, [])
+    @retries_threshold = options.fetch(:retries_threshold, RETRIES_THRESHOLD)
+    @label = options.fetch(:as, self.class.label)
+  end
+
+  def call(worker, job, queue)
+    yield
+  rescue *@exceptions => error
+    if label_exception?(job)
+      error.extend @label
+      raise error
+    else
+      raise
+    end
+  end
+
+  def label_exception?(job)
+    job['retry_count'] && job['retry_count'] < @retries_threshold
+  end
+
+  def self.label(name = :default)
+    label_name = name.to_s.classify.to_sym
+    if Labels.constants.include?(label_name)
+      Labels.const_get(label_name)
+    else
+      Labels.const_set(label_name, Module.new)
+    end
+  end
+end

data/lib/sidekiq_error_label/version.rb

@@ -0,0 +1,3 @@
+module SidekiqErrorLabel
+  VERSION = "1.0.0"
+end

data/lib/sidekiq_error_label.rb

@@ -0,0 +1,6 @@
+require "sidekiq_error_label/version"
+require 'sidekiq_error_label/middleware'
+
+module SidekiqErrorLabel
+  # Your code goes here...
+end

data/sidekiq_error_label.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq_error_label/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_error_label"
+  spec.version       = SidekiqErrorLabel::VERSION
+  spec.authors       = ["Tema Bolshakov"]
+  spec.email         = ["abolshakov@spbtv.com"]
+  spec.summary       = %q{Label sidekiq exception.}
+  spec.description   = %q{Label sidekiq exception.}
+  spec.homepage      = "https://github.com/SPBTV/sidekiq_error_label"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sidekiq"
+  spec.add_runtime_dependency 'activesupport'
+end

data/spec/sidekiq_error_label/middleware_spec.rb

@@ -0,0 +1,104 @@
+require 'sidekiq/worker'
+
+RSpec.describe SidekiqErrorLabel::Middleware do
+  let(:worker) do
+    Class.new  do
+      include ::Sidekiq::Worker
+    end
+  end
+  let(:my_label) { Module.new }
+  let(:exception) { Class.new(StandardError) }
+
+  let(:job) do
+    { 'class' => 'Bob', 'args' => [1,2,'foo'], 'retry' => 2, 'jid' => 'jid-string' }
+  end
+
+  context '#label?' do
+    let(:retries_threshold) { SidekiqErrorLabel::Middleware::RETRIES_THRESHOLD }
+    subject do
+      SidekiqErrorLabel::Middleware.new exceptions: [exception]
+    end
+
+    it 'should not #label_exception? if retry_count is not set' do
+      expect(subject.label_exception?(job.dup)).to be_falsey
+    end
+
+    it '#label_exception? if retry_count is less then retries_threshold' do
+      the_job = job.dup.merge('retry_count' => retries_threshold - 1)
+      expect(subject.label_exception?(the_job)).to be_truthy
+    end
+
+    it 'should not #label_exception? if retry_count is equals to retries_threshold' do
+      the_job = job.dup.merge('retry_count' => retries_threshold)
+      expect(subject.label_exception?(the_job)).to be_falsey
+    end
+
+    it 'should not #label_exception? if retry_count is greater then retries_threshold' do
+      the_job = job.dup.merge('retry_count' => retries_threshold + 1)
+      expect(subject.label_exception?(the_job)).to be_falsey
+    end
+
+    it 'should count :retries_threshold options' do
+      separator = SidekiqErrorLabel::Middleware.new exceptions: [exception], retries_threshold: 1
+      the_job = job.dup.merge('retry_count' => 1)
+      expect(separator.label_exception?(the_job)).to be_falsey
+    end
+  end
+
+  context '#call' do
+    subject do
+      SidekiqErrorLabel::Middleware.new exceptions: [exception]
+    end
+
+    it 'raise not labeled exception' do
+      expect(subject).to receive(:label_exception?).with(job).and_return(false)
+      begin
+        subject.call(worker, job, 'default') do
+          raise exception
+        end
+      rescue => error
+        expect(error).not_to be_kind_of SidekiqErrorLabel::Middleware.label
+        expect(error).to be_kind_of exception
+      end
+    end
+
+    it 'raise labeled exception' do
+      expect(subject).to receive(:label_exception?).with(job).and_return(true)
+      begin
+        subject.call(worker, job, 'default') do
+          raise exception
+        end
+      rescue => error
+        expect(error).to be_kind_of SidekiqErrorLabel::Middleware.label
+        expect(error).to be_kind_of exception
+      end
+    end
+
+    it 'count :as option' do
+      separator = SidekiqErrorLabel::Middleware.new exceptions: [exception], as: my_label
+      expect(separator).to receive(:label_exception?).with(job).and_return(true)
+      begin
+        separator.call(worker, job, 'default') do
+          raise exception
+        end
+      rescue => error
+        expect(error).not_to be_kind_of SidekiqErrorLabel::Middleware.label
+        expect(error).to be_kind_of my_label
+        expect(error).to be_kind_of exception
+      end
+    end
+  end
+
+  context '.label' do
+    it 'create new label' do
+      label = SidekiqErrorLabel::Middleware.label(:default)
+      expect(label).to eq SidekiqErrorLabel::Middleware::Labels::Default
+    end
+
+    it 'return same label if called twice' do
+      label = SidekiqErrorLabel::Middleware.label(:default)
+
+      expect(SidekiqErrorLabel::Middleware.label(:default)).to eq label
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require 'sidekiq_error_label'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_error_label
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tema Bolshakov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Label sidekiq exception.
+email:
+- abolshakov@spbtv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq_error_label.rb
+- lib/sidekiq_error_label/labels.rb
+- lib/sidekiq_error_label/middleware.rb
+- lib/sidekiq_error_label/version.rb
+- sidekiq_error_label.gemspec
+- spec/sidekiq_error_label/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SPBTV/sidekiq_error_label
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Label sidekiq exception.
+test_files:
+- spec/sidekiq_error_label/middleware_spec.rb
+- spec/spec_helper.rb