sidekiq-status 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1750cf2e429082ad9d404598e45fe7bf15bb31cc
-  data.tar.gz: 708de7f5f0a83d59fec644600f2a4e70e99c89d5
+  metadata.gz: 5c97c75d07e08298c13cd5b502d3d75f812f1de2
+  data.tar.gz: ed623bce78155a817cc1b29479ae4d11ca0cbaba
 SHA512:
-  metadata.gz: 7228891c5252a1df3da9ad85942552f5426a466d18ddc6b9e963ad3ec6f91512ecaadeb8e0ff00c09f36d2c9a044cfb44619271b772637b88c044868d15fdc4c
-  data.tar.gz: 56a416d652d875528fd64cebaa490fc3ae173ba96d8ea080c7d2d202a67ecdc11d365c66d3d4cac4691977a5d8d2b006addc0f84cbb2a7fca52ad3fa5cb07530
+  metadata.gz: f46cff2d00bc9d824888a1b06a5586418f8072a93b7161fba30896ea4b34ef4fc4145516549fbc556f2fbe40ea0180c4dc906942b9599fcba3227018d0ec43ce
+  data.tar.gz: 017db214e0b033de8f93cb6116e4759c67e04d8f95f500f1bd61d62fdd99aeaf2f3250b199caebe05a17de07f667502a4b5259ba499c65d7bababbacae4f20f8

data/.gitignore

@@ -1,7 +1,9 @@
+gemfiles/*.lock
 *.gem
 *.rbc
 .bundle
 .config
+.rvmrc
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -16,4 +18,4 @@ test/tmp
 test/version_tmp
 tmp
 
-.idea/
+.idea/

data/.travis.yml

@@ -3,8 +3,11 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
 gemfile:
-  - Gemfile
+  - gemfiles/sidekiq_3.x.gemfile
+  - gemfiles/sidekiq_4.x.gemfile
+  - gemfiles/sidekiq_5.x.gemfile
 before_install:
   - gem update --system
   - gem update bundler

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "sidekiq-3.x" do
+  gem "sidekiq", "~> 3"
+end
+
+appraise "sidekiq-4.x" do
+  gem "sidekiq", "~> 4"
+end
+
+appraise "sidekiq-5.x" do
+  gem "sidekiq", "~> 5"
+end

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-Version 0.7.0
+**Version 0.8.0**
++ Properly ignores jobs that do not have `Sidekiq::Status::Worker` included
++ Honors custom job expirations for ActiveJob jobs
++ Adds a `:retrying` status
++ Adds remove / retry buttons to the index page
++ Server middleware will now catches all exception types
++ Changes where server middleware is inserted in the chain
++ Reduces the amount of Redis calls made
++ Adds pagination / per page setting
++ Restores column sorting functionality
+
+**Version 0.7.0**
 + Sidekiq 4.2 and 5 now supported
 + Added full support for ActiveJob
 + Updated Web UI
@@ -8,7 +19,7 @@ Version 0.7.0
   + Times now display using natural language via ChronicDuration
 + Test suite fixed
 
-Version 0.6.0
+**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
@@ -17,17 +28,17 @@ Version 0.6.0
 + Added way to specify :expiration for Sidekiq::Status::ClientMiddleware
 + Bug fixes & Code cleaup
 
-Version 0.5.3
+**Version 0.5.3**
 + some tweaks in web UI, separate redis namespace
 
-Version 0.5.2
+**Version 0.5.2**
 + Sidekiq versions up to 3.3.* supported, jobs sorting options in web UI, more ruby versions
 
-Version 0.5.1
+**Version 0.5.1**
 + dependencies versions requirements relaxed
 
-Version 0.5.0
+**Version 0.5.0**
 + Sidekiq v3 support, redis pools support
 
-Version 0.4.0
+**Version 0.4.0**
 + WebUI added, per-worker expiration setting enabled

data/README.md

@@ -1,13 +1,17 @@
 # Sidekiq::Status
-[![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)
+[![Gem Version](https://badge.fury.io/rb/sidekiq-status.svg)](http://badge.fury.io/rb/sidekiq-status)
+[![Code Climate](https://codeclimate.com/github/utgarda/sidekiq-status.svg)](https://codeclimate.com/github/utgarda/sidekiq-status)
+[![Build Status](https://secure.travis-ci.org/utgarda/sidekiq-status.svg)](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.
 
+Fully compatible with ActiveJob.
+
+Supports the latest versions of Sidekiq and all the way back to 3.x.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,49 +19,58 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'sidekiq-status'
 ```
+
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    gem install sidekiq-status
+```bash
+gem install sidekiq-status
+```
+
+## Setup Checklist
+
+To get started:
 
-## Usage
+ * [Configure](#configuration) the middleware
+ * (Optionally) add the [web interface](#adding-the-web-interface)
+ * (Optionally) enable support for [ActiveJob](#activejob-support)
 
 ### Configuration
 
-Configure your middleware chains, lookup [Middleware usage](https://github.com/mperham/sidekiq/wiki/Middleware)
-on Sidekiq wiki for more info.
+To use, add sidekiq-status to the middleware chains. See [Middleware usage](https://github.com/mperham/sidekiq/wiki/Middleware)
+on the Sidekiq wiki for more info.
 
 ``` ruby
 require 'sidekiq'
 require 'sidekiq-status'
 
 Sidekiq.configure_client do |config|
-  config.client_middleware do |chain|
-    # accepts :expiration (optional)
-    chain.add Sidekiq::Status::ClientMiddleware, expiration: 30.minutes # default
-  end
+  # accepts :expiration (optional)
+  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes
 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|
-    # accepts :expiration (optional)
-    chain.add Sidekiq::Status::ClientMiddleware, expiration: 30.minutes # default
-  end
+  # accepts :expiration (optional)
+  Sidekiq::Status.configure_server_middleware config, expiration: 30.minutes
+
+  # accepts :expiration (optional)
+  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes
 end
 ```
 
-After that you can use your jobs as usual and only include `Sidekiq::Status::Worker` module if you want additional functionality of tracking progress and passing any data from job to client.
+**Note:** This method of configuration is new as of version 0.8.0.
+
+After that you can use your jobs as usual. You need to also include the `Sidekiq::Status::Worker` module in your jobs if you want the additional functionality of tracking progress and storing / retrieving job data.
 
 ``` ruby
 class MyJob
   include Sidekiq::Worker
+  include Sidekiq::Status::Worker # enables job status tracking
 
   def perform(*args)
   # your code goes here
@@ -65,14 +78,17 @@ class MyJob
 end
 ```
 
-To overwrite expiration on worker basis and don't use global expiration for all workers write a expiration method like this below:
+As of version 0.8.0, _only jobs that include `Sidekiq::Status::Worker`_ will have their statuses tracked. Previous versions of this gem used to track statuses for all jobs, even when `Sidekiq::Status::Worker` was not included.
+
+To overwrite expiration on a per-worker basis, write an expiration method like the one below:
 
 ``` ruby
 class MyJob
   include Sidekiq::Worker
+  include Sidekiq::Status::Worker # enables job status tracking
 
   def expiration
-    @expiration ||= 60*60*24*30 # 30 days
+    @expiration ||= 60 * 60 * 24 * 30 # 30 days
   end
 
   def perform(*args)
@@ -81,19 +97,23 @@ class MyJob
 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.
+The job status and any additional stored details will remain in Redis until the expiration time is reached. It is recommended that you find an expiration time that works best for your workload.
+
+### Expiration Times
+
+As sidekiq-status stores information about jobs in Redis, it is necessary to set an expiration time for the data that gets stored. A default expiration time may be configured at the time the middleware is loaded via the `:expiration` parameter.
 
-### 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 
+As explained above, the default expiration may also be overridden on a per-job basis by defining it within the job itself via a method called `#expiration`.
 
-+ [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.
+The expiration time set will be used as the [Redis expire time](http://redis.io/commands/expire), which is also known as the TTL (time to live). Once the expiration time has passed, all information about the job's status and any custom data stored via sidekiq-status will disappear.
 
-### Retrieving status
+It is advised that you set the expiration time greater than the amount of time required to complete the job.
 
-Query for job status any time later:
+The default expiration time is 30 minutes.
+
+### Retrieving Status
+
+You may query for job status any time up to expiration:
 
 ``` ruby
 job_id = MyJob.perform_async(*args)
@@ -101,14 +121,37 @@ job_id = MyJob.perform_async(*args)
 status = Sidekiq::Status::status(job_id)
 Sidekiq::Status::queued?      job_id
 Sidekiq::Status::working?     job_id
+Sidekiq::Status::retrying?    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` 
+Important: If you try any of the above status method after the expiration time, the result will be `nil` or `false`.
+
+### ActiveJob Support
 
-### Tracking progress, saving, and retrieving data associated with job
+Version 0.7.0 has added full support for ActiveJob. The status of ActiveJob jobs will be tracked automatically.
+
+To also enable job progress tracking and data storage features, simply add the  `Sidekiq::Status::Worker` module to your base class, like below:
+
+```ruby
+# app/jobs/application_job.rb
+class ApplicationJob < ActiveJob::Base
+  include Sidekiq::Status::Worker
+end
+
+# app/jobs/my_job.rb
+class MyJob < ApplicationJob
+  def perform(*args)
+    # your code goes here
+  end
+end
+```
+
+### Tracking Progress and Storing Data
+
+sidekiq-status comes with a feature that allows you to track the progress of a job, as well as store and retrieve any custom data related to a job.
 
 ``` ruby
 class MyJob
@@ -120,12 +163,12 @@ class MyJob
 
     # the common idiom to track progress of your task
     total 100 # by default
-    at 5, "Almost done"
+    at 5, "Almost done" # 5/100 = 5 % completion
 
     # a way to associate data with your job
     store vino: 'veritas'
 
-    # a way of retrieving said data
+    # a way of retrieving stored data
     # remember that retrieved data is always String|nil
     vino = retrieve :vino
   end
@@ -140,6 +183,7 @@ Sidekiq::Status::total   job_id #=> 100
 Sidekiq::Status::message job_id #=> "Almost done"
 Sidekiq::Status::pct_complete job_id #=> 5
 ```
+
 ### Unscheduling
 
 ```ruby
@@ -148,35 +192,45 @@ Sidekiq::Status.cancel scheduled_job_id #=> true
 # 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 
+# 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`.
+Important: If you schedule a job and then try any of the status methods after the expiration time, the result will be either `nil` or `false`. The job itself will still be in Sidekiq's scheduled queue and will execute normally. Once the job is started at its scheduled time, sidekiq-status' job metadata will once again be added back to Redis and you will be able to get status info for the job until the expiration time.
+
+### Deleting Job Status by Job ID
+
+Job status and metadata will automatically be removed from Redis once the expiration time is reached. But if you would like to remove job information from Redis prior to the TTL expiration, `Sidekiq::Status#delete` will do just that. Note that this will also remove any metadata that was stored with the job.
 
-### Deleting Status by Job ID
 ```ruby
 # returns number of keys/jobs that were removed
 Sidekiq::Status.delete(job_id) #=> 1
 Sidekiq::Status.delete(bad_job_id) #=> 0
 ```
 
-### Sidekiq web integration
+### Sidekiq Web Integration
+
+This gem provides an extension to Sidekiq's web interface with an index at `/statuses`.
 
-Sidekiq::Status also provides an extension to Sidekiq web interface with an index at `/statuses` and a single job at `/statuses/123`.
 ![Sidekiq Status Web](web/sidekiq-status-web.png)
+
+As of 0.7.0, status information for an individual job may be found at `/statuses/:job_id`.
+
 ![Sidekiq Status Web](web/sidekiq-status-single-web.png)
 
-Setup Sidekiq web interface according to Sidekiq documentation and add the Sidekiq::Status::Web require:
+As of 0.8.0, only jobs that include `Sidekiq::Status::Worker` will be reported in the web interface.
+
+#### Adding the Web Interface
+
+To use, setup the Sidekiq Web interface according to Sidekiq documentation and add the `Sidekiq::Status::Web` require:
 
 ``` ruby
 require 'sidekiq/web'
 require 'sidekiq-status/web'
 ```
 
-
 ### Testing
 
 Drawing analogy from [sidekiq testing by inlining](https://github.com/mperham/sidekiq/wiki/Testing#testing-workers-inline),
@@ -209,6 +263,7 @@ Bug reports and pull requests are welcome. This project is intended to be a safe
 
 ## Thanks
 * Pramod Shinde
+* Kenaniah Cerny
 * Clay Allsopp
 * Andrew Korzhuev
 * Jon Moses
@@ -219,5 +274,5 @@ Bug reports and pull requests are welcome. This project is intended to be a safe
 * Ben Sharpe
 
 ## License
-MIT License , see LICENSE for more details.
+MIT License, see LICENSE for more details.
 © 2012 - 2016 Evgeniy Tsvigun

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+
+require "bundler/setup"
 require "bundler/gem_tasks"
 
 require 'rspec/core/rake_task'

data/gemfiles/sidekiq_3.x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3"
+
+gemspec path: "../"

data/gemfiles/sidekiq_4.x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 4"
+
+gemspec path: "../"

data/gemfiles/sidekiq_5.x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 5"
+
+gemspec path: "../"

data/lib/sidekiq-status.rb

@@ -1,4 +1,5 @@
-require "sidekiq-status/version"
+require 'sidekiq-status/version'
+require 'sidekiq-status/sidekiq_extensions'
 require 'sidekiq-status/storage'
 require 'sidekiq-status/worker'
 require 'sidekiq-status/client_middleware'
@@ -9,7 +10,7 @@ require 'chronic_duration'
 module Sidekiq::Status
   extend Storage
   DEFAULT_EXPIRY = 60 * 30
-  STATUS = [ :queued, :working, :complete, :stopped, :failed, :interrupted ].freeze
+  STATUS = [ :queued, :working, :retrying, :complete, :stopped, :failed, :interrupted ].freeze
 
   class << self
     # Job status by id
@@ -57,7 +58,7 @@ module Sidekiq::Status
     end
 
     def pct_complete(job_id)
-      ((at(job_id) / total(job_id).to_f) * 100 ).to_i if total(job_id).to_f > 0
+      get(job_id, :pct_complete).to_i
     end
 
     def message(job_id)

data/lib/sidekiq-status/client_middleware.rb

@@ -18,14 +18,24 @@ module Sidekiq::Status
     # @param [String] queue the queue's name
     # @param [ConnectionPool] redis_pool optional redis connection pool
     def call(worker_class, msg, queue, redis_pool=nil)
-      initial_metadata = {
-        jid: msg['jid'],
-        status: :queued,
-        worker: Sidekiq::Job.new(msg, queue).display_class,
-        args: display_args(msg, queue)
-      }
-      store_for_id msg['jid'], initial_metadata, @expiration, redis_pool
+
+      # Determine the actual job class
+      klass = msg["args"][0]["job_class"] || worker_class rescue worker_class
+      job_class = klass.is_a?(Class) ? klass : Module.const_get(klass)
+
+      # Store data if the job is a Sidekiq::Status::Worker
+      if job_class.ancestors.include?(Sidekiq::Status::Worker)
+        initial_metadata = {
+          jid: msg['jid'],
+          status: :queued,
+          worker: Sidekiq::Job.new(msg, queue).display_class,
+          args: display_args(msg, queue)
+        }
+        store_for_id msg['jid'], initial_metadata, job_class.new.expiration || @expiration, redis_pool
+      end
+
       yield
+
     end
 
     def display_args(msg, queue)
@@ -36,4 +46,15 @@ module Sidekiq::Status
       return msg['args'].to_a.empty? ? nil : msg['args'].to_json
     end
   end
+
+  # Helper method to easily configure sidekiq-status client middleware
+  # whatever the Sidekiq version is.
+  # @param [Sidekiq] sidekiq_config the Sidekiq config
+  # @param [Hash] client_middleware_options client middleware initialization options
+  # @option client_middleware_options [Fixnum] :expiration ttl for complete jobs
+  def self.configure_client_middleware(sidekiq_config, client_middleware_options = {})
+    sidekiq_config.client_middleware do |chain|
+      chain.add Sidekiq::Status::ClientMiddleware, client_middleware_options
+    end
+  end
 end