sidekiq-status 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9e28c839b7f13a3090f9c0b79473d53a5aa3cef
-  data.tar.gz: 3bf8d40d93ecac1a37be26b169a487e0a519f062
+  metadata.gz: 8c3bd23f9fe0e80f8354ca3860fbeb5e5f7ca44d
+  data.tar.gz: 1ad626cad36a7f56fab5f4ca89350c55879a2d86
 SHA512:
-  metadata.gz: e1811cf4ce46c6fc18e4f67be00c844a6cc80b6b0aaee122f62758078e3e60b4b355d2cb68da834c0ce7279122363e0244f9711c01ab66c989e6bbc1753214f8
-  data.tar.gz: 072e5deb3d27574a0326fb5cefb5e4ec8efa2d009afded7f652680657fb03d715e3b36643de6b007200b1ea2b524b114019440082ecbac5682d99361d153a001
+  metadata.gz: 46cbab187b63bc2fb458e7530180a7f0b41858067213346297ec45dc62bdd04db997b2e2031205cf426d3e6eafe9921c4d22491cbcb7f86be0dda4875e3ac8d6
+  data.tar.gz: e187d76f19d38d903df4258d8a55627da09e5cf4a9faf20b51ce16f682206cbe526142a4c88b8abb3fa993ab2bca7e21866dcd9e5e4591fe937fb3ce7c1810cb

data/.travis.yml

@@ -3,13 +3,14 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
-  - jruby
   - rbx-2
 gemfile:
   - gemfiles/Gemfile.sidekiq-2
   - Gemfile
+before_install:
+  - gem update --system
+  - gem update bundler
 services: redis
 matrix:
   allow_failures:
-    - rvm: jruby
     - rvm: rbx-2

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+Version 0.6.0
++ Updated Web UI 
+  + Will have all job statuses, previously it was showing only :working status
+  + Bootstrap lables instead of badges for status 
+  + Added Arguments column to statuses page 
++ New :interrupted status added 
++ Added way to specify :expiration for Sidekiq::Status::ClientMiddleware
++ Bug fixes & Code cleaup 
+
+Version 0.5.3 
++ some tweaks in web UI, separate redis namespace
+
+Version 0.5.2 
++ Sidekiq versions up to 3.3.* supported, jobs sorting options in web UI, more ruby versions
+
+Version 0.5.1
++ dependencies versions requirements relaxed
+
+Version 0.5.0
++ Sidekiq v3 support, redis pools support
+
+Version 0.4.0
++ WebUI added, per-worker expiration setting enabled

data/Gemfile

@@ -2,3 +2,7 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :test do 
+  gem 'celluloid'
+end

data/README.md

@@ -2,6 +2,8 @@
 [![Gem Version](https://badge.fury.io/rb/sidekiq-status.png)](http://badge.fury.io/rb/sidekiq-status)
 [![Code Climate](https://codeclimate.com/github/utgarda/sidekiq-status.png)](https://codeclimate.com/github/utgarda/sidekiq-status)
 [![Build Status](https://secure.travis-ci.org/utgarda/sidekiq-status.png)](http://travis-ci.org/utgarda/sidekiq-status)
+[![Dependency Status](https://gemnasium.com/utgarda/sidekiq-status.svg)](https://gemnasium.com/utgarda/sidekiq-status)
+[![Inline docs](http://inch-ci.org/github/utgarda/sidekiq-status.svg?branch=master)](http://inch-ci.org/github/utgarda/sidekiq-status)
 
 An extension to [Sidekiq](http://github.com/mperham/sidekiq) message processing to track your jobs. Inspired
 by [resque-status](http://github.com/quirkey/resque-status) and mostly copying its features, using Sidekiq's middleware.
@@ -23,16 +25,19 @@ require 'sidekiq-status'
 
 Sidekiq.configure_client do |config|
   config.client_middleware do |chain|
-    chain.add Sidekiq::Status::ClientMiddleware
+    # accepts :expiration (optional)
+    chain.add Sidekiq::Status::ClientMiddleware, expiration: 30.minutes # default
   end
 end
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
+    # accepts :expiration (optional)
     chain.add Sidekiq::Status::ServerMiddleware, expiration: 30.minutes # default
   end
   config.client_middleware do |chain|
-    chain.add Sidekiq::Status::ClientMiddleware
+    # accepts :expiration (optional)
+    chain.add Sidekiq::Status::ClientMiddleware, expiration: 30.minutes # default
   end
 end
 ```
@@ -67,21 +72,32 @@ end
 
 But keep in mind that such thing will store details of job as long as expiration is set, so it may charm your Redis storage/memory consumption. Because Redis stores all data in RAM.
 
+### What is expiration time ?
+As you noticed you can set expiration time for jobs globally by expiration option while adding middleware or writing a expiration method on each worker this expiration time is nothing but 
+
++ [Redis expire time](http://redis.io/commands/expire), also know as TTL(time to live) 
++ After expiration time all the info like status, update_time etc. about the worker disappears.
++ It is advised to set this expiration time greater than time required for completion of the job.
++ Default expiration time is 30 minutes.
+
 ### Retrieving status
 
 Query for job status any time later:
 
 ``` ruby
 job_id = MyJob.perform_async(*args)
-# :queued, :working, :complete or :failed , nil after expiry (30 minutes)
+# :queued, :working, :complete, :failed or :interrupted, nil after expiry (30 minutes)
 status = Sidekiq::Status::status(job_id)
-Sidekiq::Status::queued?   job_id
-Sidekiq::Status::working?  job_id
-Sidekiq::Status::complete? job_id
-Sidekiq::Status::failed?   job_id
+Sidekiq::Status::queued?      job_id
+Sidekiq::Status::working?     job_id
+Sidekiq::Status::complete?    job_id
+Sidekiq::Status::failed?      job_id
+Sidekiq::Status::interrupted? job_id
+
 ```
+Important: If you try any of the above status method after the expiration time, will result into `nil` or `false` 
 
-### Tracking progress, saving and retrieveing data associated with job
+### Tracking progress, saving, and retrieving data associated with job
 
 ``` ruby
 class MyJob
@@ -118,13 +134,21 @@ Sidekiq::Status::pct_complete job_id #=> 5
 ```ruby
 scheduled_job_id = MyJob.perform_in 3600
 Sidekiq::Status.cancel scheduled_job_id #=> true
-#doesn't cancel running jobs, this is more like unscheduling, therefore an alias:
+# doesn't cancel running jobs, this is more like unscheduling, therefore an alias:
 Sidekiq::Status.unschedule scheduled_job_id #=> true
+
+# returns false if invalid or wrong scheduled_job_id is provided 
+Sidekiq::Status.unschedule some_other_unschedule_job_id #=> false
+Sidekiq::Status.unschedule nil #=> false
+Sidekiq::Status.unschedule '' #=> false
+# Note: cancel and unschedule are alias methods.
 ```
+Important: If you try any of the status method after the expiration time for scheduled jobs, will result into `nil` or `false`. But job will be in sidekiq's scheduled queue and will execute normally, once job is started on scheduled time you will get status info for job till expiration time defined on `Sidekiq::Status::ServerMiddleware`.
 
 ### Sidekiq web integration
 
-Sidekiq::Status also provides an extension to Sidekiq web interface with a `/statuses` page.
+Sidekiq::Status also provides an extension to Sidekiq web interface with a `/statuses`.
+![Sidekiq Status Web](https://raw.github.com/utgarda/sidekiq-status/master/web/sidekiq-status-web.png)
 
 Setup Sidekiq web interface according to Sidekiq documentation and add the Sidekiq::Status::Web require:
 
@@ -158,6 +182,7 @@ To use `sidekiq-status` inlining, require it too in your `{test,spec}_helper.rb`
 * Stopping jobs by id
 
 ## Thanks
+* Pramod Shinde
 * Clay Allsopp
 * Andrew Korzhuev
 * Jon Moses

data/lib/sidekiq-status.rb

@@ -8,7 +8,7 @@ require 'sidekiq-status/web' if defined?(Sidekiq::Web)
 module Sidekiq::Status
   extend Storage
   DEFAULT_EXPIRY = 60 * 30
-  STATUS = %w(queued working complete stopped failed).map(&:to_sym).freeze
+  STATUS = [ :queued, :working, :complete, :stopped, :failed, :interrupted ].freeze
 
   class << self
     # Job status by id
@@ -52,7 +52,7 @@ module Sidekiq::Status
     end
 
     def pct_complete(job_id)
-      (at(job_id).to_f / total(job_id)) * 100
+      ((at(job_id) / total(job_id).to_f) * 100 ).to_i if total(job_id).to_f > 0
     end
 
     def message(job_id)

data/lib/sidekiq-status/client_middleware.rb

@@ -2,14 +2,29 @@ module Sidekiq::Status
 # Should be in the client middleware chain
   class ClientMiddleware
     include Storage
+
+    # Parameterized initialization, use it when adding middleware to client chain
+    # chain.add Sidekiq::Status::ClientMiddleware, :expiration => 60 * 5
+    # @param [Hash] opts middleware initialization options
+    # @option opts [Fixnum] :expiration ttl for complete jobs
+    def initialize(opts = {})
+      @expiration = opts[:expiration]
+    end
+
     # Uses msg['jid'] id and puts :queued status in the job's Redis hash
     # @param [Class] worker_class if includes Sidekiq::Status::Worker, the job gets processed with the plugin
     # @param [Array] msg job arguments
     # @param [String] queue the queue's name
     # @param [ConnectionPool] redis_pool optional redis connection pool
     def call(worker_class, msg, queue, redis_pool=nil)
-      store_status msg['jid'], :queued, nil, redis_pool
+      initial_metadata = { 
+        jid: msg['jid'],
+        status: :queued,
+        worker: worker_class, 
+        args: msg['args'].to_a.empty? ? nil : msg['args'].to_json
+      }
+      store_for_id msg['jid'], initial_metadata, @expiration, redis_pool
       yield
     end
   end
-end
+end

data/lib/sidekiq-status/server_middleware.rb

@@ -38,6 +38,9 @@ module Sidekiq::Status
       store_status worker.jid, :complete, @expiration
     rescue Worker::Stopped
       store_status worker.jid, :stopped, @expiration
+    rescue SystemExit, Interrupt
+      store_status worker.jid, :interrupted, @expiration
+      raise
     rescue
       store_status worker.jid, :failed,  @expiration
       raise

data/lib/sidekiq-status/storage.rb

@@ -58,7 +58,7 @@ module Sidekiq::Status::Storage
   # @return [String] Redis operation status code
   def read_field_for_id(id, field)
     Sidekiq.redis do |conn|
-      conn.hmget(key(id), field)[0]
+      conn.hget(key(id), field)
     end
   end
 
@@ -91,8 +91,7 @@ module Sidekiq::Status::Storage
     # A Little skecthy, I know, but the structure of these internal JSON
     # is predefined in such a way where this will not catch unintentional elements,
     # and this is notably faster than performing JSON.parse() for every listing:
-    scheduled_jobs.each { |job_listing| (return job_listing) if job_listing.include?("\"jid\":\"#{job_id}") }
-    nil
+    scheduled_jobs.select { |job_listing| job_listing.match(/\"jid\":\"#{job_id}\"/) }[0]
   end
 
   # Yields redis connection. Uses redis pool if available.

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = '0.5.4'
+    VERSION = '0.6.0'
   end
 end

data/lib/sidekiq-status/web.rb

@@ -13,44 +13,65 @@ module Sidekiq::Status
           path = File.join(VIEW_PATH, name.to_s) + ".erb"
           File.open(path).read
         end
+
+        def add_details_to_status(status)
+          status['label'] = status_label(status['status'])
+          status["pct_complete"] = pct_complete(status)
+          return status
+        end
+
+        def pct_complete(status)
+          return 100 if status['status'] == 'complete'
+          Sidekiq::Status::pct_complete(status['jid'])
+        end
+
+        def status_label(status)
+          case status
+          when 'complete'
+            'success'
+          when 'working'
+            'warning'
+          when 'queued'
+            'primary'
+          else
+            'danger'
+          end
+        end
+
+        def has_sort_by?(value)
+          ["worker", "status", "update_time", "pct_complete", "message"].include?(value)
+        end
       end
 
       app.get '/statuses' do
-        queue = Sidekiq::Workers.new
+        namespace_jids = Sidekiq.redis{ |conn| conn.keys('sidekiq:status:*') }
+        jids = namespace_jids.map{|id_namespace| id_namespace.split(':').last }
         @statuses = []
 
-        queue.each do |*args|
-          work = if args[1].is_a?(Hash)
-            # For sidekiq < 3
-            args[1]
-          else
-            args[2]
-          end
-          job = Struct.new(:jid, :klass, :args).new(work["payload"]["jid"], work["payload"]["class"], work["payload"]["args"])
-          status = Sidekiq::Status::get_all job.jid
+        jids.each do |jid|
+          status = Sidekiq::Status::get_all jid
           next if !status || status.count < 2
-          status["worker"] = job.klass
-          status["args"] = job.args
-          status["jid"] = job.jid
-          status["pct_complete"] = ((status["at"].to_f / status["total"].to_f) * 100).to_i if status["total"].to_f > 0
+          status = add_details_to_status(status)
           @statuses << OpenStruct.new(status)
         end
 
-        if ["worker", "status", "update_time", "pct_complete", "message"].include?(params[:sort_by])
-          sort_by = params[:sort_by]
-        else
-          sort_by = "worker"
-        end
-
+        sort_by = has_sort_by?(params[:sort_by]) ? params[:sort_by] : "update_time"
         sort_dir = "asc"
 
         if params[:sort_dir] == "asc"
           @statuses = @statuses.sort { |x,y| x.send(sort_by) <=> y.send(sort_by) }
-        else # DESC
+        else
           sort_dir = "desc"
           @statuses = @statuses.sort { |y,x| x.send(sort_by) <=> y.send(sort_by) }
         end
-
+        
+        working_jobs = @statuses.select{|job| job.status == "working"}
+        if working_jobs.size >= 25
+          @statuses = working_jobs
+        else
+          @statuses = (@statuses.size >= 25) ? @statuses.take(25) : @statuses 
+        end
+        
         @headers = [
           { id: "worker", name: "Worker/jid", class: nil, url: nil},
           { id: "status", name: "Status", class: nil, url: nil},

data/spec/lib/sidekiq-status/client_middleware_spec.rb

@@ -9,6 +9,7 @@ describe Sidekiq::Status::ClientMiddleware do
   before { redis.flushall }
 
   describe "#call" do
+    before { client_middleware }
     it "sets queued status" do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
       expect(StubJob.perform_async(:arg1 => 'val1')).to eq(job_id)
@@ -38,4 +39,17 @@ describe Sidekiq::Status::ClientMiddleware do
       end
     end
   end
+
+  describe ":expiration parameter" do
+    let(:huge_expiration) { Sidekiq::Status::DEFAULT_EXPIRY * 100 }
+    before do
+      allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+    end
+
+    it "overwrites default expiry value" do
+      client_middleware(expiration: huge_expiration)
+      StubJob.perform_async(:arg1 => 'val1')
+      expect((Sidekiq::Status::DEFAULT_EXPIRY+1)..huge_expiration).to cover redis.ttl("sidekiq:status:#{job_id}")
+    end
+  end
 end

data/spec/lib/sidekiq-status/server_middleware_spec.rb

@@ -35,9 +35,36 @@ describe Sidekiq::Status::ServerMiddleware do
       expect(Sidekiq::Status::failed?(job_id)).to be_truthy
     end
 
+    context "sets interrupted status" do 
+      it "on system exit signal" do 
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+        start_server do
+          expect(capture_status_updates(3) {
+            expect(ExitedJob.perform_async).to eq(job_id)
+          }).to eq([job_id]*3)
+        end
+        expect(redis.hget("sidekiq:status:#{job_id}", :status)).to eq('interrupted')
+        expect(Sidekiq::Status::interrupted?(job_id)).to be_truthy
+      end
+
+      it "on interrupt signal" do 
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+        start_server do
+          expect(capture_status_updates(3) {
+            expect(InterruptedJob.perform_async).to eq(job_id)
+          }).to eq([job_id]*3)
+        end
+        expect(redis.hget("sidekiq:status:#{job_id}", :status)).to eq('interrupted')
+        expect(Sidekiq::Status::interrupted?(job_id)).to be_truthy
+      end
+
+    end
+
     it "sets status hash ttl" do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
-      expect(StubJob.perform_async(:arg1 => 'val1')).to eq(job_id)
+      start_server do
+        expect(StubJob.perform_async(:arg1 => 'val1')).to eq(job_id)
+      end
       expect(1..Sidekiq::Status::DEFAULT_EXPIRY).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
   end

data/spec/lib/sidekiq-status/web_spec.rb

@@ -18,7 +18,8 @@ describe 'sidekiq status web' do
   end
 
   it 'shows a job in progress' do
-    allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+    client_middleware
+    allow(SecureRandom).to receive(:hex).and_return(job_id)
 
     start_server do
       capture_status_updates(2) do
@@ -28,6 +29,8 @@ describe 'sidekiq status web' do
       get '/statuses'
       expect(last_response).to be_ok
       expect(last_response.body).to match(/#{job_id}/)
+      expect(last_response.body).to match(/LongJob/)
+      expect(last_response.body).to match(/working/)
     end
   end
 

data/spec/lib/sidekiq-status_spec.rb

@@ -28,6 +28,7 @@ describe Sidekiq::Status do
         expect(Sidekiq::Status::failed?(job_id)).to be_falsey
         expect(Sidekiq::Status::complete?(job_id)).to be_falsey
         expect(Sidekiq::Status::stopped?(job_id)).to be_falsey
+        expect(Sidekiq::Status::interrupted?(job_id)).to be_falsey
       end
       expect(Sidekiq::Status.status(job_id)).to eq(:complete)
       expect(Sidekiq::Status.complete?(job_id)).to be_truthy

data/spec/spec_helper.rb

@@ -9,9 +9,11 @@ require 'sidekiq-status'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
-Sidekiq.configure_client do |config|
-  config.client_middleware do |chain|
-    chain.add Sidekiq::Status::ClientMiddleware
+def client_middleware(client_middleware_options={}) 
+  Sidekiq.configure_client do |config|
+    config.client_middleware do |chain|
+      chain.add Sidekiq::Status::ClientMiddleware, client_middleware_options
+    end
   end
 end
 

data/spec/support/test_jobs.rb

@@ -54,6 +54,18 @@ class FailingJob < StubJob
   end
 end
 
+class ExitedJob < StubJob
+  def perform
+    raise SystemExit
+  end
+end
+
+class InterruptedJob < StubJob
+  def perform
+    raise Interrupt
+  end
+end
+
 class RetriedJob < StubJob
   sidekiq_options 'retry' => 'true'
   def perform()

data/web/views/statuses.erb

@@ -5,28 +5,39 @@
 }
 .bar {
   background-color: #2897cb; 
+  color: white; 
+  text-shadow: 0 0 0;
 }
 .message {
   text-shadow: 0 0 5px white;
   font-weight: bold; padding-left: 4px;
   color: #333;
 }
+.header{
+  text-align: center;
+}
 </style>
 
 <h3 class="wi">Recent job statuses</h3>
-
-
-<table class="table table-striped table-bordered">
+<table class="table table-hover table-bordered table-striped table-white">  
   <tr>
-    <th>Worker/jid</th>
-    <th style='text-align:center;'>Status</th>
-    <th style='width: 10%; text-align:center;'>Last Updated</th>
-    <th style='width: 50%;'>Progress</th>
+    <th class="header">Worker/jid</th>
+    <th class="header">Arguments</th>
+    <th class="header">Status</th>
+    <th class="header" style="width: 10%;">Last Updated</th>
+    <th class="header" style="width: 45%;">Progress</th>
   </tr>
   <% @statuses.each do |container| %>
     <tr>
-      <td><span title='<%= container.jid %>'><%= container.worker %></span></td>
-      <td style='text-align: center;'><span class='badge'><%= container.status %></span></td>
+      <td>
+        <div title='<%= container.jid %>'><%= container.worker %></div>
+      </td>
+      <td>
+        <div class='args' title='<%= container.jid %>'><%= container.args %></div>
+      </td>
+      <td style='text-align: center;'>
+        <div class='label label-<%= container.label %>'><%= container.status %></div>
+      </td>
       <% secs = Time.now.to_i - container.update_time.to_i %>
       <td style='text-align: center;'>
         <% if secs > 0 %>
@@ -37,9 +48,11 @@
       </td>
       <td>
         <div class="progress progress-striped" style="margin-bottom: 0">
-          <div class='message' style='text-align:right; padding-right:0.5em; background-color: transparent; float:right;'><%= container.message %></div>
+          <div class='message' style='text-align:right; padding-right:0.5em; background-color: transparent; float:right;'>
+            <%= container.message %>
+          </div>
           <% if container.pct_complete.to_i > 0 %>
-            <div class="bar message" style="width: <%= container.pct_complete %>%; color: white; text-shadow: 0 0 0;">
+            <div class="bar message" style="width: <%= container.pct_complete %>%;">
               <%= container.pct_complete %>%
             </div>
           <% end %>
@@ -52,4 +65,4 @@
       <td colspan="6"></td>
     </tr>
   <% end %>
-</table>
+</table>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Evgeniy Tsvigun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -90,7 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -113,6 +113,7 @@ files:
 - spec/lib/sidekiq-status_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_jobs.rb
+- web/sidekiq-status-web.png
 - web/views/statuses.erb
 homepage: http://github.com/utgarda/sidekiq-status
 licenses:
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs

data/CHANGELOG

@@ -1,6 +0,0 @@
-Version 0.5.4:Mere removal of sidekiq version upper limitation
-Version 0.5.3:Sidekiq some tweaks in web UI, separate redis namespace
-Version 0.5.2:Sidekiq versions up to 3.3.* supported, jobs sorting options in web UI, more ruby versions
-Version 0.5.1:dependencies versions requirements relaxed
-Version 0.5.0:Sidekiq v3 support, redis pools support
-Version 0.4.0:WebUI added, per-worker expiration setting enabled