freekiqs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 638d7e5e400a98fe5dbde8e7c145c8caf279a145
-  data.tar.gz: 967ad2c2b650ed7a27f4573dfdaaf3ac61070e0c
+  metadata.gz: 0c3fd9d32956c0caab13e95a0a6738d7ce66eb33
+  data.tar.gz: 8c42f1a66be5cb37ac7bcd83c7a9653625010a6c
 SHA512:
-  metadata.gz: 01e4a44ec9eebe9e8328f258c69c18ff42ce1e7c8cc50d0166b958dab857a95e5cf30e5c2bac0fcb1af5bcdd0a37817b14bf9d5df5437927a37446760bdf523e
-  data.tar.gz: 65a722fce7bd7eaf1dc575dcf227a3d33efaaf9fa81f05989b70e4349ac5d92eff246d672bf0897fd6c25955bbdc5bc808e368437bbbd2a1fd83bf4adb25ca73
+  metadata.gz: 7b7084b08cc39dc0ab99e67fe0313ae36dc9abe960b133ce1ed0214b18746d2f0e09a18d9270fec00d19a173ecf5621a6ef2a37a946f9312128850d8030bab1b
+  data.tar.gz: 1cf24ca22cab4863beb6874be99a021e4b60030de4e743e5bb91c8998375958224c698d15405d79d5641efd313d0c81d40121a639f15d0ad1ad3ed302cab284f

data/README.md

@@ -40,6 +40,16 @@ Example:
   end
 ```
 
+A callback can be fired when a freekiq happens.
+This can be useful for tracking or logging freekiqs separately from the sidekiq logs.
+
+Example:
+``` ruby
+  Sidekiq::Middleware::Server::Freekiqs::callback = ->(worker, msg, queue) do
+    Librato::Metrics.submit freekiqs: { value: 1, source: worker.class.name }
+  end
+```
+
 ## Overview
 
 Up to the configured number of "freekiqs", catch exceptions thrown

data/Rakefile

@@ -1,7 +1,6 @@
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/freekiqs.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name                  = 'freekiqs'
-  gem.version               = '0.1.0'
+  gem.version               = '0.2.0'
   gem.authors               = ['Rob Lewis']
   gem.email                 = ['rob@bookbub.com']
   gem.summary               = 'Sidekiq middleware extending RetryJobs to allow silient errors.'
@@ -17,5 +17,5 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_dependency             'sidekiq', '>= 1.0.0', '< 4.0.0'
-  gem.add_development_dependency 'rspec', '~> 2.14.1'
+  gem.add_development_dependency 'rspec', '>= 2.14.1'
 end

data/lib/sidekiq/middleware/server/freekiqs.rb

@@ -8,6 +8,7 @@ module Sidekiq
     module Server
       class Freekiqs
         include Sidekiq::Util
+        @@callback = nil
 
         def initialize(opts={})
           @default_freekiqs = opts[:freekiqs]
@@ -19,7 +20,13 @@ module Sidekiq
           freekiqs = get_freekiqs_if_enabled(worker, msg)
           if freekiqs
             if msg['retry_count'].nil? || msg['retry_count'] < freekiqs-1
-              raise FreekiqException, ex.message
+              begin
+                @@callback.call(worker, msg, queue) if @@callback
+              rescue => callback_exception
+                Sidekiq.logger.info { "Freekiq callback failed for #{msg['class']} job #{msg['jid']}" }
+              ensure
+                raise FreekiqException, ex.message
+              end
             else
               Sidekiq.logger.info { "Out of free kiqs for #{msg['class']} job #{msg['jid']}" }
             end
@@ -40,6 +47,14 @@ module Sidekiq
           end
           freekiqs
         end
+
+        def self.callback
+          @@callback
+        end
+
+        def self.callback=(callback_lambda)
+          @@callback = callback_lambda
+        end
       end
     end
   end

data/spec/freekiqs_spec.rb

@@ -165,4 +165,37 @@ describe Sidekiq::Middleware::Server::Freekiqs do
     expect(Sidekiq::RetrySet.new.size).to eq(0)
     expect(Sidekiq::DeadSet.new.size).to eq(0)
   end
+
+  it 'should execute a defined callback' do
+    Sidekiq::Middleware::Server::Freekiqs::callback = ->(worker, msg, queue) do
+      return true
+    end
+
+    handler = build_handler_chain
+    worker = worker_with_freekiqs_enabled
+    job = build_job
+
+    expect(Sidekiq::Middleware::Server::Freekiqs::callback).to receive(:call)
+    expect {
+      handler.invoke(worker, job, 'default') do
+        raise ArgumentError, 'overlooked'
+      end
+    }.to raise_error(Sidekiq::FreekiqException, 'overlooked')
+  end
+
+  it 'should still raise FreekiqException if the callback fails' do
+    Sidekiq::Middleware::Server::Freekiqs::callback = ->(worker, msg, queue) do
+      raise 'callback error'
+    end
+
+    handler = build_handler_chain
+    worker = worker_with_freekiqs_enabled
+    job = build_job
+
+    expect {
+      handler.invoke(worker, job, 'default') do
+        raise ArgumentError, 'overlooked'
+      end
+    }.to raise_error(Sidekiq::FreekiqException, 'overlooked')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freekiqs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -34,14 +34,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.1
 description: Sidekiq middleware extending RetryJobs to allow configuring how many