sidekiq_hero 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f22a1885f5b4c34c76d75b59e111570f69fe3ab59da2baa1609025bd1b91c3
-  data.tar.gz: 6fd444444c2a4b5d17d5cf5df2aedbe8f83402a3da8881f5ed761224050eb1a8
+  metadata.gz: ebe90bc9afd52c4c1166c895d91fa4cb87830657357322f20566350ecc09f8ba
+  data.tar.gz: f8d9eb82693baafc34b58e25d56af15275c5bb6132d2bb569496d68179a696bd
 SHA512:
-  metadata.gz: 30d4e80644ccc5e1cdbff03eecee63c8f8114b918b4bef0cc8b039bb1e859d7868986551772dec345ab0697c5938a5ac3c84b34612de0217810fea2b6706d76e
-  data.tar.gz: 47a6cc6564643e10b494480ab693503fe945c6d06b665c5205da0167d42a961c7752bc1966f43e7fdec105c0ec0ebfc136d3b7dae49c774938a2ce77e2df5868
+  metadata.gz: ad991fa93628226ab8885f751de5f382f9bf9c5144be776ef7838fa42026afddf2ac8b356afab795fbb31b7a275e72e937ad8bec2cf757a0cfaa7ee51371d2d0
+  data.tar.gz: 470714da5afe71faaa99111c253bc8016a2710e66e850e60ea5e922b9a91191cdc931b873cfd1db78f9256ac2c641527ddc5e6287881776b4d9331dd6ff66980

data/Gemfile.lock

@@ -40,7 +40,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   rake (~> 10.0)
-  rspec (~> 3.0)
+  rspec (~> 3.8)
   sidekiq_hero!
   timecop
 

data/README.md

@@ -1,8 +1,9 @@
 # SidekiqHero
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq_hero`. To experiment with that code, run `bin/console` for an interactive prompt.
+Sidekiq middleware that fire a notification when a flagged worker has ended its job, successful or not.
+A worker can be flagged to always fire a notification or to fire it only when the process exceed a configured time.
 
-TODO: Delete this and the text above, and describe your gem
+The default notifier just log on sidekiq server. You can configure your notification class which will receive all the metadata the job has recorder i.e. exceeded_max_time, failed.
 
 ## Installation
 
@@ -14,25 +15,68 @@ gem 'sidekiq_hero'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
-
-    $ gem install sidekiq_hero
 
 ## Usage
 
-TODO: Write usage instructions here
+In your rails application include the middleware. [What is a middleware?](https://github.com/mperham/sidekiq/wiki/Middleware)
 
-## Development
+```ruby
+# config/initializers/sidekiq.rb
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add SidekiqHero::ServerMiddleware
+  end
+end
+
+SidekiqHero.configure do |config|
+  config.notifier_class = YourNotifier
+  config.queues = ['queue1', 'queue2']
+end
+```
+You can pass your sidekiq_hero configuration via `sidekiq_options`. SidekiqHero will look for `sidekiq_hero_monitor_time` and `sidekiq_hero_monitor`.
+
+`@sidekiq_hero_monitor` boolean value to flag a single worker to be monitored. This worker will always trigger a notification when the job is done, successful or not.
+
+`@sidekiq_hero_monitor_time` is the time in seconds within the job is considered ok. If the job takes more than this time the notifier is triggered. The meta_data will contains `total_time` and `worker_time_out` which can be true or false.
+
+In SidekiqHero.configure:
+`@notifier_class` is where you can add your custom class responsible to notify the job message.
+The default class of sidekiq_hero just log to STDOUT so you need to implement a class that respond to `.notify`
+and takes two arguments: job, meta_data
+
+`@queues` you can flag a whole queue to be monitored.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+`sidekiq_hero_monitor` always takes precendece over other configuration.
+
+Sidekiq will look first to `sidekiq_hero_monitor`, then to the `queues` and finally `sidekiq_hero_monitor_time`. Note that the execution time is always recorded and passed via meta_data to the configured notifier.
+
+```ruby
+class DummyNotifier
+  def self.notify(job, meta_data)
+    new.notify(job, meta_data)
+  end
+
+  # job { 'class': 'SomeWorker', 'jid': 'b4a577edbccf1d805744efa9', 'args': [1, 'arg', true], 'created_at': 123_456_789_0, 'enqueued_at': 123_456_789_0 }
+  # meta_data { status: 'success', total_time: 1, worker_time_out: false}
+  def notify(job, meta_data)
+    send_email if meta_data[:status] == 'success'
+    request_help if meta_data[:status] == 'failed'
+    notify_slack(total_time) if meta_data[:worker_time_out]
+  end
+end
+```
+
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo run `rake spec` to run the tests.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sidekiq_hero.
+Bug reports and pull requests are welcome on GitHub at https://github.com/SamuelMartini/sidekiq_hero
 
 ## License
 

data/lib/sidekiq_hero/configuration.rb

@@ -2,12 +2,11 @@
 
 module SidekiqHero
   class Configuration
-    attr_accessor :notifier_server_message_class, :exceed_maximum_time
+    attr_accessor :notifier_class, :exceed_max_time, :queues
 
     def initialize
-      @notifier_server_message_class = SidekiqHero::Notifier.new
-      @exceed_maximum_time = 0
+      @notifier_class = SidekiqHero::Notifier
+      @queues = []
     end
   end
 end
-

data/lib/sidekiq_hero/notifier.rb

@@ -3,10 +3,6 @@
 module SidekiqHero
   class Notifier
 
-    def self.notify(job, meta_data)
-      new.notify(job, meta_data)
-    end
-
     def notify(job, meta_data)
       Sidekiq.logger.info "#{job} -- #{meta_data}"
     end

data/lib/sidekiq_hero/notifier_wrapper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SidekiqHero
+  class NotifierWrapper
+    attr_reader :job, :meta_data, :notifier, :queues
+
+    def initialize(job: nil, meta_data: nil)
+      @job = job
+      @meta_data = meta_data
+      @notifier = SidekiqHero.configuration.notifier_class.new
+      @queues = SidekiqHero.configuration.queues
+    end
+
+    def call
+      return unless monitor_this_worker?
+
+      meta_data[:worker_time_out] = exceeded_max_time?
+
+      notifier.notify(job, meta_data)
+    end
+
+    private
+
+    def monitor_this_worker?
+      sidekiq_hero_monitor || monitor_queue? || exceeded_max_time?
+    end
+
+    def exceeded_max_time?
+      return false if sidekiq_hero_monitor_time.nil?
+
+      meta_data[:total_time] > sidekiq_hero_monitor_time
+    end
+
+    def sidekiq_hero_monitor_time
+      job['sidekiq_hero_monitor_time']
+    end
+
+    def sidekiq_hero_monitor
+      job['sidekiq_hero_monitor']
+    end
+
+    def monitor_queue?
+      queues.include?(job['queue'])
+    end
+  end
+end

data/lib/sidekiq_hero/recorder.rb

@@ -8,14 +8,32 @@ module SidekiqHero
       @meta_data = {}
     end
 
-    def record(hash)
-      meta_data.merge!(hash)
-    end
-
-    def record_elapsed_time
+    def elapsed_time
       total = meta_data.fetch(:ended_at, 0) - meta_data.fetch(:started_at, 0)
       record(total_time: total)
     end
+
+    def worker_passed
+      record(status: 'passed', started_at: Time.now.utc.round)
+    end
+
+    def worker_succeeded
+      record(status: 'success')
+    end
+
+    def worker_failed(error)
+      record(status: 'failed', error: error.to_s)
+    end
+
+    def worker_ended
+      record(ended_at: Time.now.utc.round)
+    end
+
+    private
+
+    def record(hash)
+      meta_data.merge!(hash)
+    end
   end
 end
 

data/lib/sidekiq_hero/server_middleware.rb

@@ -2,47 +2,24 @@
 
 module SidekiqHero
   class ServerMiddleware
+    attr_reader :recorder
+
+    def initialize
+      @recorder = SidekiqHero::Recorder.new
+    end
+
     def call(_worker, job, _queue)
-      recorder.record(status: 'passed', started_at: Time.now.utc.round)
+      recorder.worker_passed
       yield
-      recorder.record(status: 'success')
+      recorder.worker_succeeded
     rescue => e
-      recorder.record(status: 'failed', error: e.to_s)
+      recorder.worker_failed(e)
+
       raise e
     ensure
-      recorder.record(ended_at: Time.now.utc.round)
-      recorder.record_elapsed_time
-      notifier.notify(job, recorder.meta_data) if exceeded_maximum_time? || job_failed?
-    end
-
-    private
-
-    def recorder
-      @recorder ||= SidekiqHero::Recorder.new
-    end
-
-    def server_message_class
-      @server_message_class ||= SidekiqHero.configuration.server_message_class
-    end
-
-    def meta_data
-      @meta_data ||= {}
-    end
-
-    def notifier
-      SidekiqHero.configuration.notifier_server_message_class
-    end
-
-    def exceed_maximum_time
-      @exceed_maximum_time ||= SidekiqHero.configuration.exceed_maximum_time
-    end
-
-    def exceeded_maximum_time?
-      recorder.meta_data[:total_time] > exceed_maximum_time
-    end
-
-    def job_failed?
-      recorder.meta_data[:status] == 'failed'
+      recorder.worker_ended
+      recorder.elapsed_time
+      NotifierWrapper.new(job: job, meta_data: recorder.meta_data).call
     end
   end
 end

data/lib/sidekiq_hero/version.rb

@@ -1,3 +1,3 @@
 module SidekiqHero
-  VERSION = "0.1.0"
+  VERSION = '0.9.0'
 end

data/lib/sidekiq_hero.rb

@@ -3,6 +3,7 @@
 require 'sidekiq_hero/version'
 require 'sidekiq/api'
 require 'sidekiq_hero/configuration'
+require 'sidekiq_hero/notifier_wrapper'
 require 'sidekiq_hero/notifier'
 require 'sidekiq_hero/recorder'
 require 'sidekiq_hero/server_middleware'

data/sidekiq_hero.gemspec

@@ -1,27 +1,28 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "sidekiq_hero/version"
+require 'sidekiq_hero/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sidekiq_hero"
+  spec.name          = 'sidekiq_hero'
   spec.version       = SidekiqHero::VERSION
-  spec.authors       = ["Samuel"]
-  spec.email         = ["samueljmartini@gmail.com"]
+  spec.authors       = ['Samuel Martini']
+  spec.email         = ['samuelmartini@nebulab.it']
 
-  spec.summary       = ''
-  spec.description   = ''
-  spec.homepage      = ''
-  spec.license       = "MIT"
+  spec.summary       = %q{Sidekiq Middleware for job notification}
+  spec.description   = <<-TEXT
+    Sidekiq middleware that fire a notification when a flagged worker has ended its job, successful or not.
+  TEXT
+  spec.homepage      = 'https://github.com/SamuelMartini/sidekiq_hero'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features|dummy_app)/})
   end
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency             'sidekiq', '>= 3.0'
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "timecop"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_hero
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.9.0
 platform: ruby
 authors:
-- Samuel
+- Samuel Martini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -80,9 +80,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: "    Sidekiq middleware that fire a notification when a flagged worker
+  has ended its job, successful or not.\n"
 email:
-- samueljmartini@gmail.com
+- samuelmartini@nebulab.it
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -98,11 +99,12 @@ files:
 - lib/sidekiq_hero.rb
 - lib/sidekiq_hero/configuration.rb
 - lib/sidekiq_hero/notifier.rb
+- lib/sidekiq_hero/notifier_wrapper.rb
 - lib/sidekiq_hero/recorder.rb
 - lib/sidekiq_hero/server_middleware.rb
 - lib/sidekiq_hero/version.rb
 - sidekiq_hero.gemspec
-homepage: ''
+homepage: https://github.com/SamuelMartini/sidekiq_hero
 licenses:
 - MIT
 metadata: {}
@@ -125,5 +127,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Sidekiq Middleware for job notification
 test_files: []