sidekiq_metered_exceptions 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ae923f55f11631fda824789433b8bb7fc6b2f60
-  data.tar.gz: 3406ec90499d78ae923ae9632d67efe3f495cbd9
+SHA256:
+  metadata.gz: 56422876f36311742587f82a042322fa3a0d3dad131b97e88fc4b2c07333b4ca
+  data.tar.gz: c790384cdc16e828fe6a246a3aea55dad3cd2b95b875993775b6ce96f1b56636
 SHA512:
-  metadata.gz: b564599aa0dcc387e7b5ad30e8d877a6be1502946360f2dfacc7ab83f4a4b442ae1e15311a07af6dc7f200201c0dbebd5a712df630d4c336d4d5496e93d1aedf
-  data.tar.gz: a9544e6ce6eb4afbd50ec0acc84818ed30e9e2bce941e6cd4b57432f26473fddef981f6cdb1c5c917ee499d717b5fe151f41a421785f4994b6fc6d49e0bd5da9
+  metadata.gz: 4c7a7331f793110bcd5c3b5cd9b37125ec0f6cde1b33b1203695c6011238d3b104c6d1a3bd30b44c4dd8c44d1902cd519f63f0064987eee40391d899f66543c1
+  data.tar.gz: 9f4a7c2732f6b136e8e2d54b0e96cba380418a07613b9140064fea09defbddee4c8bf49f136f23c21f79194303c109a0f7189bcf47a96ee2b8ac359f57c4704b

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.5.3

data/Gemfile

@@ -2,10 +2,11 @@ source "http://rubygems.org"
 
 gem 'sidekiq', '>= 2.12.4', '< 6.0'
 gem 'sentry-raven', '~> 2.3'
+gem 'activesupport'
 
 group :development do
-  gem 'minitest', '>= 0'
+  gem 'rspec'
   gem 'rdoc', '~> 6.0'
   gem 'bundler'
-  gem 'jeweler', '~> 2.3'
+  gem 'juwelier'
 end

data/Rakefile

@@ -11,9 +11,8 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
   gem.name = "sidekiq_metered_exceptions"
   gem.homepage = "http://github.com/woodhull/sidekiq_metered_exceptions"
   gem.license = "MIT"
@@ -21,18 +20,23 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Some exceptions are transient, so notifying an admin is not useful.}
   gem.email = "woodhull@gmail.com"
   gem.authors = ["Nathan Woodhull"]
+
   # dependencies defined in Gemfile
 end
-Jeweler::RubygemsDotOrgTasks.new
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :default => :test
+task :default => :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/lib/metered_raven_error_handler.rb

@@ -1,8 +1,15 @@
 require 'sidekiq'
+require 'active_support/core_ext/hash'  # for deep_symbolize_keys
 require 'raven/integrations/sidekiq'
 
 module SidekiqMeteredExceptions
   class MeteredRavenErrorHandler < ::Raven::SidekiqErrorHandler
+    attr_reader :errors_to_ignore_on_first_occurrence
+
+    def initialize(errors_to_ignore_on_first_occurrence: [])
+      @errors_to_ignore_on_first_occurrence = errors_to_ignore_on_first_occurrence
+    end
+
     def call(ex, original_context)
       ::Rails.logger.debug("MeteredRavenErrorHandler -- Error on Sidekiq job. Exception: #{ex.inspect} - Context: #{original_context.inspect}")
 
@@ -16,10 +23,14 @@ module SidekiqMeteredExceptions
       # Is this a retryable job?
       is_retryable = context[:retry] || (context[:job] && context[:job][:retry])
 
-      # We notify if this job has been retried at least once.
-      # Someday we plan to make this number configurable.
-      # If this isn't a retryable job, we notify even if this is the first attempt, because there will not be more attempts.
-      if retry_count > 0 || !is_retryable
+      # We notify to Sentry unless:
+      # Is not one of the errors that should be ignored on first occurrence
+      #             AND
+      # This job has not been retried at least once
+      #             AND
+      # Sidekiq is automatically retrying the job
+      #
+      unless errors_to_ignore_on_first_occurrence.include?(ex.class) && retry_count < 1 && is_retryable
         ::Rails.logger.debug("MeteredRavenErrorHandler -- Current retry count: #{retry_count}. Notifying upstream...")
 
         super(ex, original_context)

data/sidekiq_metered_exceptions.gemspec

@@ -1,17 +1,17 @@
-# Generated by jeweler
+# Generated by juwelier
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: sidekiq_metered_exceptions 0.3.4 ruby lib
+# stub: sidekiq_metered_exceptions 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "sidekiq_metered_exceptions".freeze
-  s.version = "0.3.4"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Nathan Woodhull".freeze]
-  s.date = "2018-12-04"
+  s.date = "2019-11-06"
   s.description = "Some exceptions are transient, so notifying an admin is not useful.".freeze
   s.email = "woodhull@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -30,39 +30,42 @@ Gem::Specification.new do |s|
     "lib/metered_raven_error_handler.rb",
     "lib/sidekiq_metered_exceptions.rb",
     "sidekiq_metered_exceptions.gemspec",
-    "test/helper.rb",
-    "test/test_sidekiq_metered_exceptions.rb"
+    "spec/sidekiq_metered_exceptions_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/woodhull/sidekiq_metered_exceptions".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.12".freeze
+  s.rubygems_version = "3.0.3".freeze
   s.summary = "Only propagate sidekiq exceptions that have already been retried once.".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<sidekiq>.freeze, ["< 6.0", ">= 2.12.4"])
+      s.add_runtime_dependency(%q<sidekiq>.freeze, [">= 2.12.4", "< 6.0"])
       s.add_runtime_dependency(%q<sentry-raven>.freeze, ["~> 2.3"])
-      s.add_development_dependency(%q<minitest>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0"])
       s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
-      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3"])
+      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<sidekiq>.freeze, ["< 6.0", ">= 2.12.4"])
+      s.add_dependency(%q<sidekiq>.freeze, [">= 2.12.4", "< 6.0"])
       s.add_dependency(%q<sentry-raven>.freeze, ["~> 2.3"])
-      s.add_dependency(%q<minitest>.freeze, [">= 0"])
+      s.add_dependency(%q<activesupport>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
       s.add_dependency(%q<bundler>.freeze, [">= 0"])
-      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3"])
+      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<sidekiq>.freeze, ["< 6.0", ">= 2.12.4"])
+    s.add_dependency(%q<sidekiq>.freeze, [">= 2.12.4", "< 6.0"])
     s.add_dependency(%q<sentry-raven>.freeze, ["~> 2.3"])
-    s.add_dependency(%q<minitest>.freeze, [">= 0"])
+    s.add_dependency(%q<activesupport>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
     s.add_dependency(%q<bundler>.freeze, [">= 0"])
-    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3"])
+    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
   end
 end
 

data/spec/sidekiq_metered_exceptions_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+class Rails
+end
+
+describe SidekiqMeteredExceptions::MeteredRavenErrorHandler do
+  describe '#initialize' do
+    it 'should not raise if errors_to_ignore_on_first_occurrence argument not provided' do
+      expect { SidekiqMeteredExceptions::MeteredRavenErrorHandler.new }.not_to raise_error ArgumentError
+    end
+
+    it 'should set errors_to_ignore_on_first_occurrence if provided' do
+      subject = SidekiqMeteredExceptions::MeteredRavenErrorHandler.new(errors_to_ignore_on_first_occurrence: [StandardError, RuntimeError])
+      expect(subject.errors_to_ignore_on_first_occurrence).to eq([StandardError, RuntimeError])
+    end
+  end
+
+  describe '#call' do
+    before :each do
+      allow(::Rails).to receive(:logger).and_return(double(debug: true))
+    end
+
+    context 'without any exceptions being reported on first occurrence' do
+      let(:exception) { Exception.new }
+
+      subject { SidekiqMeteredExceptions::MeteredRavenErrorHandler.new }
+
+      it 'should capture exception if it is first occurrence' do
+        expect(Raven).to receive(:capture_exception).with(exception, anything)
+
+        subject.call(exception, { 'retry_count' => 0, 'retry' => true })
+      end
+
+      it 'should capture exception if has been retried at least once' do
+        expect(Raven).to receive(:capture_exception).with(exception, anything)
+
+        subject.call(exception, { 'retry_count' => 1, 'retry' => true })
+      end
+    end
+
+    context 'with collection of exceptions being reported on first occurrence' do
+      let(:exceptions_reported_on_first_occurrence) { [ZeroDivisionError, NameError] }
+
+      subject { SidekiqMeteredExceptions::MeteredRavenErrorHandler.new(errors_to_ignore_on_first_occurrence: exceptions_reported_on_first_occurrence) }
+
+      it 'should not capture exception if it is first occurrence and is included in errors_to_ignore_on_first_occurrence' do
+        expect(Raven).not_to receive(:capture_exception)
+
+        subject.call(ZeroDivisionError.new, { 'retry_count' => 0, 'retry' => true })
+      end
+
+      it 'should capture exception if it is first occurrence and is not included in errors_to_ignore_on_first_occurrence' do
+        exception = StandardError.new
+        expect(Raven).to receive(:capture_exception).with(exception, anything)
+
+        subject.call(exception, { 'retry_count' => 0, 'retry' => true })
+      end
+
+      it 'should capture exception if it is first occurrence, it is not retryable and is included in errors_to_ignore_on_first_occurrence' do
+        exception = ZeroDivisionError.new
+        expect(Raven).to receive(:capture_exception).with(exception, anything)
+
+        subject.call(exception, { 'retry_count' => 0, 'retry' => false })
+      end
+
+      it 'should capture exception if it has been retried at least once and is included in errors_to_ignore_on_first_occurrence' do
+        exception = ZeroDivisionError.new
+        expect(Raven).to receive(:capture_exception).with(exception, anything)
+
+        subject.call(exception, { 'retry_count' => 1, 'retry' => true })
+      end
+    end
+  end
+end

data/{test/helper.rb → spec/spec_helper.rb}

@@ -7,10 +7,12 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'minitest/autorun'
-require 'minitest/pride'
+
+require 'rspec'
+require 'sentry-raven'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'sidekiq_metered_exceptions'
 
+

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_metered_exceptions
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Nathan Woodhull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +45,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,19 +101,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: juwelier
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 description: Some exceptions are transient, so notifying an admin is not useful.
 email: woodhull@gmail.com
 executables: []
@@ -119,8 +133,8 @@ files:
 - lib/metered_raven_error_handler.rb
 - lib/sidekiq_metered_exceptions.rb
 - sidekiq_metered_exceptions.gemspec
-- test/helper.rb
-- test/test_sidekiq_metered_exceptions.rb
+- spec/sidekiq_metered_exceptions_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/woodhull/sidekiq_metered_exceptions
 licenses:
 - MIT
@@ -140,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Only propagate sidekiq exceptions that have already been retried once.

data/test/test_sidekiq_metered_exceptions.rb

@@ -1,14 +0,0 @@
-require 'helper'
-
-class TestSidekiqMeteredExceptions < Minitest::Test
-  describe 'middleware' do
-    before do
-      @exception = Exception.new
-      @middleware = SidekiqMeteredExceptions::MeteredRavenErrorHandler.new
-    end
-
-    # todo: figure out how to use minitest.
-
-
-  end
-end