sidekiq-status 1.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b21776f1059a82b3a04c1e81639bcfba2c9184a00906688639333b2ee0df42
-  data.tar.gz: 06ffc2506014272d4a40272cc3204696efed21fee426000da8b6c3a6c5e183d9
+  metadata.gz: 73189e5075131660e13e76ce8e8eeedd84953c90998941dd73a16825dc96d951
+  data.tar.gz: 5923bc75138cee22d8b5edcc5fbb9ad42dad4e0d89f29df74df68656a73adadc
 SHA512:
-  metadata.gz: a0f173c573f137b0626b9a76d8977e4d536083e685d376f8ea6201a9d9ed8f48b793f3e59b5f06e57c0c518210ffe7c1fefebbfce9ea4033e77a270eab73d9f1
-  data.tar.gz: 4f963ddaaa7f5a205fc9b6927ed994734f177a6438dd893ba2df435aa626c15614c3676b33d1feaaea03c341cfedb7e344e1a862e004acbd457ae7f9347cabd9
+  metadata.gz: '09e500e508e3a0d309e5d817a0fb7e1f58b9013f32284608ae5e2512bd556d07e7846c240789a2df4d5790f0aa183b3623181fd14acb12fd14a863ae354f627e'
+  data.tar.gz: 37b1eb9dec966fc8d8645c0ea4139d9a4cee715aca5c5b988881d63599d77e4d7cc564472a3f72e58923b8fb903ed0254c123821dafa2122c622e0dfc5b1e3ca

data/.gitignore

@@ -4,6 +4,7 @@ gemfiles/*.lock
 .bundle
 .config
 .rvmrc
+.ruby-version
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.gitlab-ci.yml

@@ -0,0 +1,17 @@
+dependency_scanning:
+  image: docker:stable
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env DEP_SCAN_DISABLE_REMOTE_CHECKS="${DEP_SCAN_DISABLE_REMOTE_CHECKS:-false}"
+        --volume "$PWD:/code"
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/dependency-scanning:$SP_VERSION" /code
+  artifacts:
+    reports:
+      dependency_scanning: gl-dependency-scanning-report.json

data/.travis.yml

@@ -1,16 +1,20 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+  - ruby-head
 gemfile:
-  - gemfiles/sidekiq_3.x.gemfile
-  - gemfiles/sidekiq_4.x.gemfile
   - gemfiles/sidekiq_5.x.gemfile
+  - gemfiles/sidekiq_6.1.gemfile
+  - gemfiles/sidekiq_6.x.gemfile
 before_install:
   - gem update --system
   - gem update bundler
 services: redis
 notifications:
   email: false
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

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

data/CHANGELOG.md

@@ -1,59 +1,27 @@
-**Version 1.1.0**
-+ Fixes the use case of multiple services sharing the same redis instance (#135)
-
-**Version 1.0.2**
-+ Fixes status not being set to `:failed` after retries
-
-**Version 1.0.1**
-+ Fixes namespacing in `sidekiq-status/testing/inline`
-
-**Version 1.0.0**
-+ Version number bumped to indicate stable release
-
-**Version 0.8.1**
-+ Avoids transient celluloid dependency in Sidekiq < 5.x
-
-**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
-  + Styling updated to stay consistent with Sidekiq UI
-  + Added header sorting
-  + Fixed argument formatting
-  + Times now display using natural language via ChronicDuration
-+ Test suite fixed
-
-**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
+**Version 2.1.3**
+* Fixes redis deprecation warnings (https://github.com/kenaniah/sidekiq-status/issues/11)
+
+**Version 2.1.2**
+ * Casts values to strings when HTML-encoding
+
+**Version 2.1.1**
+ * Ensures parameter outputs are properly HTML-encoded
+
+**Version 2.1.0**
+ * Adds support for Sidekiq 6.2.2+ (https://github.com/mperham/sidekiq/issues/4955)
+
+**Version 2.0.2**
+ * Fixes for dark mode theme
+
+**Version 2.0.1**
+ * Adds support for dark mode to the job status page
+
+**Version 2.0.0**
+ * Adds support for Ruby 2.7, 3.0
+ * Adds support for Sidekiq 6.x
+ * Removes support for Ruby 2.3, 2.4, 2.5
+ * Removes support for Sidekiq 3.x, 4.x
+
+**Versions 1.1.4 and prior**
+
+See https://github.com/utgarda/sidekiq-status/blob/master/CHANGELOG.md.

data/README.md

@@ -1,16 +1,11 @@
 # 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)
+[![Gem Version](https://badge.fury.io/rb/sidekiq-status.svg)](https://badge.fury.io/rb/sidekiq-status)
+[![Build Status](https://www.travis-ci.com/kenaniah/sidekiq-status.svg?branch=main)](https://www.travis-ci.com/github/kenaniah/sidekiq-status)
+[![Inline docs](https://inch-ci.org/github/kenaniah/sidekiq-status.svg?branch=main)](https://inch-ci.org/github/kenaniah/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.
+Sidekiq-status is an extension to [Sidekiq](https://github.com/mperham/sidekiq) that tracks information about your Sidekiq and provides a UI to that purpose. It was inspired by [resque-status](https://github.com/quirkey/resque-status).
 
-Fully compatible with ActiveJob.
-
-Supports the latest versions of Sidekiq and all the way back to 3.x.
+Requires Ruby 2.6+ and Sidekiq 5.0+ or newer.
 
 ## Installation
 
@@ -20,18 +15,18 @@ Add this line to your application's Gemfile:
 gem 'sidekiq-status'
 ```
 
-And then execute:
-
-```bash
-$ bundle
-```
-
 Or install it yourself as:
 
 ```bash
 gem install sidekiq-status
 ```
 
+#### Migrating to Version 2.x from 1.x
+
+Version 2.0.0 was published in order to add support for Ruby 3.0 and Sidekiq 6.x and to remove support for versions of both that are now end-of-life. **You should be able to upgrade cleanly from version 1.x to 2.x provided you are running Sidekiq 5.x or newer.**
+
+Sidekiq-status version 1.1.4 provides support all the way back to Sidekiq 3.x and was maintained at https://github.com/utgarda/sidekiq-status/.
+
 ## Setup Checklist
 
 To get started:
@@ -63,9 +58,7 @@ Sidekiq.configure_server do |config|
 end
 ```
 
-**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.
+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
@@ -78,7 +71,7 @@ class MyJob
 end
 ```
 
-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.
+Note: _only jobs that include `Sidekiq::Status::Worker`_ will have their statuses tracked.
 
 To overwrite expiration on a per-worker basis, write an expiration method like the one below:
 
@@ -105,7 +98,7 @@ As sidekiq-status stores information about jobs in Redis, it is necessary to set
 
 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`.
 
-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.
+The expiration time set will be used as the [Redis expire time](https://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.
 
 It is advised that you set the expiration time greater than the amount of time required to complete the job.
 
@@ -131,7 +124,7 @@ Important: If you try any of the above status method after the expiration time,
 
 ### ActiveJob Support
 
-Version 0.7.0 has added full support for ActiveJob. The status of ActiveJob jobs will be tracked automatically.
+This gem also supports ActiveJob jobs. Their status 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:
 
@@ -216,11 +209,11 @@ This gem provides an extension to Sidekiq's web interface with an index at `/sta
 
 ![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`.
+Information for an individual job may be found at `/statuses/:job_id`.
 
 ![Sidekiq Status Web](web/sidekiq-status-single-web.png)
 
-As of 0.8.0, only jobs that include `Sidekiq::Status::Worker` will be reported in the web interface.
+Note: _only jobs that include `Sidekiq::Status::Worker`_ will be reported in the web interface.
 
 #### Adding the Web Interface
 

data/gemfiles/{sidekiq_4.x.gemfile → sidekiq_6.1.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "sidekiq", "~> 4"
+gem "sidekiq", "~> 6.1"
 
 gemspec path: "../"

data/gemfiles/{sidekiq_3.x.gemfile → sidekiq_6.x.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "sidekiq", "~> 3"
+gem "sidekiq", "~> 6"
 
 gemspec path: "../"

data/lib/sidekiq-status/client_middleware.rb

@@ -1,4 +1,6 @@
 require 'sidekiq/api'
+JOB_CLASS = Sidekiq.constants.include?(:JobRecord) ? Sidekiq::JobRecord : Sidekiq::Job
+
 module Sidekiq::Status
 # Should be in the client middleware chain
   class ClientMiddleware
@@ -34,7 +36,7 @@ module Sidekiq::Status
         initial_metadata = {
           jid: msg['jid'],
           status: :queued,
-          worker: Sidekiq::Job.new(msg, queue).display_class,
+          worker: JOB_CLASS.new(msg, queue).display_class,
           args: display_args(msg, queue)
         }
         store_for_id msg['jid'], initial_metadata, job_class.new.expiration || @expiration, redis_pool
@@ -45,7 +47,7 @@ module Sidekiq::Status
     end
 
     def display_args(msg, queue)
-      job = Sidekiq::Job.new(msg, queue)
+      job = JOB_CLASS.new(msg, queue)
       return job.display_args.to_a.empty? ? nil : job.display_args.to_json
     rescue Exception => e
       # For Sidekiq ~> 2.7

data/lib/sidekiq-status/server_middleware.rb

@@ -61,7 +61,7 @@ module Sidekiq::Status
           status = :retrying
         end
       end
-      store_status worker.jid, status, expiry
+      store_status(worker.jid, status, expiry) if job_class && job_class.ancestors.include?(Sidekiq::Status::Worker)
       raise
     end
 

data/lib/sidekiq-status/storage.rb

@@ -13,10 +13,10 @@ module Sidekiq::Status::Storage
   # @return [String] Redis operation status code
   def store_for_id(id, status_updates, expiration = nil, redis_pool=nil)
     redis_connection(redis_pool) do |conn|
-      conn.multi do
-        conn.hmset  key(id), 'update_time', Time.now.to_i, *(status_updates.to_a.flatten(1))
-        conn.expire key(id), (expiration || Sidekiq::Status::DEFAULT_EXPIRY)
-        conn.publish "status_updates", id
+      conn.multi do |pipeline|
+        pipeline.hmset  key(id), 'update_time', Time.now.to_i, *(status_updates.to_a.flatten(1))
+        pipeline.expire key(id), (expiration || Sidekiq::Status::DEFAULT_EXPIRY)
+        pipeline.publish "status_updates", id
       end[0]
     end
   end
@@ -90,7 +90,7 @@ module Sidekiq::Status::Storage
   #  -  end: end score (i.e. +inf or a unix timestamp)
   #  -  offset: current progress through (all) jobs (e.g.: 100 if you want jobs from 100 to BATCH_LIMIT)
   def schedule_batch(options)
-    options[:conn].zrangebyscore "schedule", options[:start], options[:end], {limit: [options[:offset], BATCH_LIMIT]}
+    options[:conn].zrangebyscore "schedule", options[:start], options[:end], limit: [options[:offset], BATCH_LIMIT]
   end
 
   # Searches the jobs Array for the job_id

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = '1.1.0'
+    VERSION = '2.1.3'
   end
 end

data/lib/sidekiq-status/web.rb

@@ -8,6 +8,7 @@ module Sidekiq::Status
 
     DEFAULT_PER_PAGE_OPTS = [25, 50, 100].freeze
     DEFAULT_PER_PAGE = 25
+    COMMON_STATUS_HASH_KEYS = %w(update_time jid status worker args label pct_complete total at message)
 
     class << self
       def per_page_opts= arr
@@ -47,9 +48,14 @@ module Sidekiq::Status
         def add_details_to_status(status)
           status['label'] = status_label(status['status'])
           status["pct_complete"] ||= pct_complete(status)
+          status["custom"] = process_custom_data(status)
           return status
         end
 
+        def process_custom_data(hash)
+          hash.reject { |key, _| COMMON_STATUS_HASH_KEYS.include?(key) }
+        end
+
         def pct_complete(status)
           return 100 if status['status'] == 'complete'
           Sidekiq::Status::pct_complete(status['jid']) || 0
@@ -75,8 +81,11 @@ module Sidekiq::Status
 
       app.get '/statuses' do
 
-        namespace_jids = Sidekiq.redis{ |conn| conn.keys('sidekiq:status:*') }
-        jids = namespace_jids.map{ |id_namespace| id_namespace.split(':').last }
+        jids = Sidekiq.redis do |conn|
+          conn.scan_each(match: 'sidekiq:status:*', count: 100).map do |key|
+            key.split(':').last
+          end.uniq
+        end
         @statuses = []
 
         jids.each do |jid|
@@ -96,6 +105,10 @@ module Sidekiq::Status
           @statuses = @statuses.sort { |y,x| (x[sort_by] <=> y[sort_by]) || 1 }
         end
 
+        if params[:status] && params[:status] != "all"
+          @statuses = @statuses.select {|job_status| job_status["status"] == params[:status] }
+        end
+
         # Sidekiq pagination
         @total_size = @statuses.count
         @count = params[:per_page] ? params[:per_page].to_i : Sidekiq::Status::Web.default_per_page
@@ -123,7 +136,7 @@ module Sidekiq::Status
         job = Sidekiq::Status::get_all params['jid']
 
         if job.empty?
-          halt [404, {"Content-Type" => "text/html"}, [erb(sidekiq_status_template(:status_not_found))]]
+          throw :halt, [404, {"Content-Type" => "text/html"}, [erb(sidekiq_status_template(:status_not_found))]]
         else
           @status = add_details_to_status(job)
           erb(sidekiq_status_template(:status))
@@ -135,21 +148,25 @@ module Sidekiq::Status
         job = Sidekiq::RetrySet.new.find_job(params[:jid])
         job ||= Sidekiq::DeadSet.new.find_job(params[:jid])
         job.retry if job
-        halt [302, { "Location" => request.referer }, []]
+        throw :halt, [302, { "Location" => request.referer }, []]
       end
 
       # Removes a completed job from the status list
       app.delete '/statuses' do
         Sidekiq::Status.delete(params[:jid])
-        halt [302, { "Location" => request.referer }, []]
+        throw :halt, [302, { "Location" => request.referer }, []]
       end
     end
   end
 end
 
-require 'sidekiq/web' unless defined?(Sidekiq::Web)
+unless defined?(Sidekiq::Web)
+  require 'delegate' # Needed for sidekiq 5.x
+  require 'sidekiq/web'
+end
+
 Sidekiq::Web.register(Sidekiq::Status::Web)
-["per_page", "sort_by", "sort_dir"].each do |key|
+["per_page", "sort_by", "sort_dir", "status"].each do |key|
   Sidekiq::WebHelpers::SAFE_QPARAMS.push(key)
 end
 if Sidekiq::Web.tabs.is_a?(Array)

data/sidekiq-status.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ['Evgeniy Tsvigun', 'Kenaniah Cerny']
   gem.email         = ['utgarda@gmail.com', 'kenaniah@gmail.com']
   gem.summary       = 'An extension to the sidekiq message processing to track your jobs'
-  gem.homepage      = 'http://github.com/utgarda/sidekiq-status'
+  gem.homepage      = 'https://github.com/kenaniah/sidekiq-status'
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)
@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Sidekiq::Status::VERSION
 
-  gem.add_dependency                  'sidekiq', '>= 3.0'
+  gem.add_dependency                  'sidekiq', '>= 5.0'
   gem.add_dependency                  'chronic_duration'
   gem.add_development_dependency      'appraisal'
   gem.add_development_dependency      'colorize'

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

@@ -12,13 +12,13 @@ describe Sidekiq::Status::ClientMiddleware do
   describe "without :expiration parameter" do
 
     it "sets queued status" do
-      expect(StubJob.perform_async arg1: 'val1').to eq(job_id)
+      expect(StubJob.perform_async 'arg1' => 'val1').to eq(job_id)
       expect(redis.hget("sidekiq:status:#{job_id}", :status)).to eq('queued')
       expect(Sidekiq::Status::queued?(job_id)).to be_truthy
     end
 
     it "sets status hash ttl" do
-      expect(StubJob.perform_async arg1: 'val1').to eq(job_id)
+      expect(StubJob.perform_async 'arg1' => 'val1').to eq(job_id)
       expect(1..Sidekiq::Status::DEFAULT_EXPIRY).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
 
@@ -50,7 +50,7 @@ describe Sidekiq::Status::ClientMiddleware do
     end
 
     it "overwrites default expiry value" do
-      StubJob.perform_async arg1: 'val1'
+      StubJob.perform_async 'arg1' => 'val1'
       expect((Sidekiq::Status::DEFAULT_EXPIRY+1)..huge_expiration).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
 

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

@@ -10,7 +10,7 @@ describe Sidekiq::Status::ServerMiddleware do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
       start_server do
         thread = redis_thread 4, "status_updates", "job_messages_#{job_id}"
-        expect(ConfirmationJob.perform_async arg1: 'val1').to eq(job_id)
+        expect(ConfirmationJob.perform_async 'arg1' => 'val1').to eq(job_id)
         expect(thread.value).to eq([
           job_id,
           job_id,
@@ -36,21 +36,39 @@ describe Sidekiq::Status::ServerMiddleware do
     it "sets failed status when Exception raised" do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
       start_server do
-        expect(capture_status_updates(3) {
-          expect(FailingHardJob.perform_async).to eq(job_id)
-        }).to eq([job_id]*3)
+      expect(capture_status_updates(3) {
+        expect(FailingHardJob.perform_async).to eq(job_id)
+      }).to eq([job_id]*3)
       end
       expect(redis.hget("sidekiq:status:#{job_id}", :status)).to eq('failed')
       expect(Sidekiq::Status::failed?(job_id)).to be_truthy
     end
 
+    context "when Sidekiq::Status::Worker is not included in the job" do
+      it "should not set a failed status" do
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+        start_server do
+          expect(FailingNoStatusJob.perform_async).to eq(job_id)
+        end
+        expect(redis.hget("sidekiq:status:#{job_id}", :status)).to be_nil
+      end
+
+      it "should not set any status when Exception raised" do
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+        start_server do
+          expect(FailingHardNoStatusJob.perform_async).to eq(job_id)
+        end
+        expect(redis.hget("sidekiq:status:#{job_id}", :status)).to be_nil
+      end
+    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)
+        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
@@ -72,7 +90,7 @@ describe Sidekiq::Status::ServerMiddleware do
     it "sets status hash ttl" do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
       start_server do
-        expect(StubJob.perform_async arg1: 'val1').to eq(job_id)
+        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
@@ -86,7 +104,7 @@ describe Sidekiq::Status::ServerMiddleware do
 
     it "overwrites default expiry value" do
       start_server(:expiration => huge_expiration) do
-        StubJob.perform_async arg1: 'val1'
+        StubJob.perform_async 'arg1' => 'val1'
       end
       expect((Sidekiq::Status::DEFAULT_EXPIRY-1)..huge_expiration).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
@@ -95,7 +113,7 @@ describe Sidekiq::Status::ServerMiddleware do
       overwritten_expiration = huge_expiration * 100
       allow_any_instance_of(StubJob).to receive(:expiration).and_return(overwritten_expiration)
       start_server(:expiration => huge_expiration) do
-        StubJob.perform_async arg1: 'val1'
+        StubJob.perform_async 'arg1' => 'val1'
       end
       expect((huge_expiration+1)..overwritten_expiration).to cover redis.ttl("sidekiq:status:#{job_id}")
     end

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

@@ -13,6 +13,7 @@ describe 'sidekiq status web' do
   end
 
   before do
+    env 'rack.session', csrf: Base64.urlsafe_encode64('token')
     client_middleware
     allow(SecureRandom).to receive(:hex).and_return(job_id)
   end
@@ -31,6 +32,27 @@ describe 'sidekiq status web' do
     expect(last_response.body).to match(/working/)
   end
 
+  it 'allows filtering the list of jobs by status' do
+    capture_status_updates(2) do
+      LongJob.perform_async(0.5)
+    end
+
+    get '/statuses?status=working'
+    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
+
+  it 'allows filtering the list of jobs by completed status' do
+    capture_status_updates(2) do
+      LongJob.perform_async(0.5)
+    end
+    get '/statuses?status=completed'
+    expect(last_response).to be_ok
+    expect(last_response.body).to_not match(/LongJob/)
+  end
+
   it 'shows a single job in progress' do
     capture_status_updates(2) do
       LongJob.perform_async(1, 'another argument')
@@ -39,10 +61,21 @@ describe 'sidekiq status web' do
     get "/statuses/#{job_id}"
     expect(last_response).to be_ok
     expect(last_response.body).to match(/#{job_id}/)
-    expect(last_response.body).to match(/1,"another argument"/)
+    expect(last_response.body).to match(/1,"another argument"/)
     expect(last_response.body).to match(/working/)
   end
 
+  it 'shows custom data for a single job' do
+    capture_status_updates(3) do
+      CustomDataJob.perform_async
+    end
+
+    get "/statuses/#{job_id}"
+    expect(last_response).to be_ok
+    expect(last_response.body).to match(/mister_cat/)
+    expect(last_response.body).to match(/meow/)
+  end
+
   it 'show an error when the requested job ID is not found' do
     get '/statuses/12345'
     expect(last_response).to be_not_found

data/spec/lib/sidekiq-status_spec.rb

@@ -105,7 +105,7 @@ describe Sidekiq::Status do
         second_job = LongJob.perform_in(3600)
         expect(second_job).to eq(job_id_1)
 
-        initial_schedule = redis.zrange "schedule", 0, -1, {withscores: true}
+        initial_schedule = redis.zrange "schedule", 0, -1, withscores: true
         expect(initial_schedule.size).to  be(2)
         expect(initial_schedule.select {|scheduled_job| JSON.parse(scheduled_job[0])["jid"] == job_id }.size).to be(1)
 
@@ -113,7 +113,7 @@ describe Sidekiq::Status do
         # Unused, therefore unfound => false
         expect(Sidekiq::Status.cancel(unused_id)).to be_falsey
 
-        remaining_schedule = redis.zrange "schedule", 0, -1, {withscores: true}
+        remaining_schedule = redis.zrange "schedule", 0, -1, withscores: true
         expect(remaining_schedule.size).to be(initial_schedule.size - 1)
         expect(remaining_schedule.select {|scheduled_job| JSON.parse(scheduled_job[0])["jid"] == job_id }.size).to be(0)
       end
@@ -126,14 +126,14 @@ describe Sidekiq::Status do
         returned_job_id = LongJob.perform_at(scheduled_time)
         expect(returned_job_id).to eq(job_id)
 
-        initial_schedule = redis.zrange "schedule", 0, -1, {withscores: true}
+        initial_schedule = redis.zrange "schedule", 0, -1, withscores: true
         expect(initial_schedule.size).to be(1)
         # wrong time, therefore unfound => false
         expect(Sidekiq::Status.cancel(returned_job_id, (scheduled_time + 1))).to be_falsey
-        expect((redis.zrange "schedule", 0, -1, {withscores: true}).size).to be(1)
+        expect((redis.zrange "schedule", 0, -1, withscores: true).size).to be(1)
         # same id, same time, deletes
         expect(Sidekiq::Status.cancel(returned_job_id, (scheduled_time))).to be_truthy
-        expect(redis.zrange "schedule", 0, -1, {withscores: true}).to be_empty
+        expect(redis.zrange "schedule", 0, -1, withscores: true).to be_empty
       end
     end
   end
@@ -159,7 +159,7 @@ describe Sidekiq::Status do
     end
 
     it "retries failed jobs" do
-      allow(SecureRandom).to receive(:hex).and_return(retried_job_id)
+      allow(SecureRandom).to receive(:hex).exactly(3).times.and_return(retried_job_id)
       start_server do
         expect(capture_status_updates(3) {
           expect(RetriedJob.perform_async()).to eq(retried_job_id)

data/spec/support/test_jobs.rb

@@ -10,6 +10,16 @@ class StubJob
   end
 end
 
+class StubNoStatusJob
+  include Sidekiq::Worker
+
+  sidekiq_options 'retry' => false
+
+  def perform(*args)
+  end
+end
+
+
 class ExpiryJob < StubJob
   def expiration
     15
@@ -31,6 +41,13 @@ class DataJob < StubJob
   end
 end
 
+class CustomDataJob < StubJob
+  def perform
+    store({mister_cat: 'meow'})
+    sleep 0.5
+  end
+end
+
 class ProgressJob < StubJob
   def perform
     total 500
@@ -62,6 +79,12 @@ class FailingJob < StubJob
   end
 end
 
+class FailingNoStatusJob < StubNoStatusJob
+  def perform
+    raise StandardError
+  end
+end
+
 class RetryAndFailJob < StubJob
   sidekiq_options retry: 1
 
@@ -76,6 +99,12 @@ class FailingHardJob < StubJob
   end
 end
 
+class FailingHardNoStatusJob < StubNoStatusJob
+  def perform
+    raise Exception
+  end
+end
+
 class ExitedJob < StubJob
   def perform
     raise SystemExit
@@ -90,13 +119,13 @@ end
 
 class RetriedJob < StubJob
 
-  sidekiq_options 'retry' => true
+  sidekiq_options retry: true
   sidekiq_retry_in do |count| 3 end # 3 second delay > job timeout in test suite
 
-  def perform()
+  def perform
     Sidekiq.redis do |conn|
       key = "RetriedJob_#{jid}"
-      unless conn.exists key
+      if [0, false].include? conn.exists(key)
         conn.set key, 'tried'
         raise StandardError
       end

data/web/views/status.erb

@@ -1,3 +1,4 @@
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
 <style>
   .progress {
     background-color: #C8E1ED;
@@ -14,9 +15,9 @@
 </style>
 
 <h3>
-  Job Status: <%= @status["jid"] %>
-  <span class='label label-<%= @status["label"] %>'>
-    <%= @status["status"] %>
+  Job Status: <%= h @status["jid"] %>
+  <span class='label label-<%= h @status["label"] %>'>
+    <%= h @status["status"] %>
   </span>
 </h3>
 
@@ -28,16 +29,16 @@
   </div>
 </div>
 
-<div class="panel panel-default">
+<div class="panel panel-default" style="background-color: inherit">
   <div class="panel-body">
-    <h4><%= @status["worker"] %></h4>
+    <h4><%= h @status["worker"] %></h4>
 
     <div class="row">
       <div class="col-sm-2">
         <strong>Arguments</strong>
       </div>
       <div class="col-sm-10">
-        <p><%= @status["args"].empty? ? "<i>none</i>" : @status["args"] %></p>
+        <p><%= @status["args"].empty? ? "<i>none</i>" : h(@status["args"]) %></p>
       </div>
     </div>
 
@@ -46,7 +47,7 @@
         <strong>Message</strong>
       </div>
       <div class="col-sm-10">
-        <p><%= @status["message"] || "<i>none</i>" %></p>
+        <p><%= h(@status["message"]) || "<i>none</i>" %></p>
       </div>
     </div>
 
@@ -65,6 +66,24 @@
         </p>
       </div>
     </div>
+
+    <% if @status["custom"].any? %>
+      <hr>
+      <% @status["custom"].each do |key, val| %>
+        <div class="row">
+          <div class="col-sm-2">
+            <strong><%= key %></strong>
+          </div>
+          <div class="col-sm-10">
+            <% if val && val.include?("\n") %>
+              <pre><%= h val %></pre>
+            <% else  %>
+              <p><%= h(val) || "<i>none</i>" %></p>
+            <% end %>
+          </div>
+        </div>
+      <% end %>
+    <% end %>
   </div>
 </div>
 

data/web/views/status_not_found.erb

@@ -1,5 +1,6 @@
-<h3>Job Status: <%= params[:jid] %></h3>
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
+<h3>Job Status: <%= h params[:jid] %></h3>
 
-<div class="alert alert-danger" role="alert">
+<div role="alert">
   <strong>Uh oh!</strong> That job can't be found. It may have expired already.
 </div>

data/web/views/statuses.erb

@@ -1,3 +1,4 @@
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
 <style>
 .progress {
   background-color: #C8E1ED;
@@ -38,7 +39,7 @@
   display: flex;
   align-items: center;
 }
-.nav-container .per-page {
+.nav-container .per-page, .filter-status {
   display: flex;
   align-items: center;
   margin: 20px 0 20px 10px;
@@ -57,6 +58,15 @@ function setPerPage(select){
   <h3 class="wi">Recent job statuses</h3>
   <div class="nav-container">
     <%= erb :_paging, locals: { url: "#{root_path}statuses" } %>
+    <div class="filter-status">
+      Filter Status:
+      <select class="form-control" onchange="setPerPage(this)">
+        <% (['all', 'complete', 'failed', 'interrupted', 'queued', 'retrying', 'stopped', 'working']).each do |status| %>
+          <option data-url="?<%= qparams(status: status)%>" value="<%= status %>" <%= 'selected="selected"' if status == (params[:status]) %>><%= status %></option>
+        <% end %>
+      </select>
+    </div>
+
     <div class="per-page">
       Per page:
       <select class="form-control" onchange="setPerPage(this)">
@@ -67,11 +77,11 @@ function setPerPage(select){
     </div>
   </div>
 </div>
-<table class="table table-hover table-bordered table-striped table-white">
+<table class="table table-hover table-bordered table-striped">
   <tr>
-    <% @headers.each do |h| %>
-      <th class="header <%= h[:class] %> header_<%= h[:id] %>">
-        <a href="<%= h[:url] %>"><%= h[:name] %></a>
+    <% @headers.each do |hdr| %>
+      <th class="header <%= h hdr[:class] %> header_<%= h hdr[:id] %>">
+        <a href="<%= h hdr[:url] %>"><%= h hdr[:name] %></a>
       </th>
     <% end %>
     <th class="header">
@@ -81,13 +91,13 @@ function setPerPage(select){
   <% @statuses.each do |container| %>
     <tr>
       <td>
-        <div title='<%= container["jid"] %>'><a href="<%= root_path %>statuses/<%= container["jid"] %>"><%= container["worker"] %></a></div>
+        <div title='<%= h container["jid"] %>'><a href="<%= root_path %>statuses/<%= h container["jid"] %>"><%= h container["worker"] %></a></div>
       </td>
       <td>
-        <div class='args' title='<%= container["jid"] %>'><%= container["args"] %></div>
+        <div class='args' title='<%= h container["jid"] %>'><%= h container["args"] %></div>
       </td>
       <td style='text-align: center;'>
-        <div class='label label-<%= container["label"] %>'><%= container["status"] %></div>
+        <div class='label label-<%= h container["label"] %>'><%= h container["status"] %></div>
       </td>
       <% secs = Time.now.to_i - container["update_time"].to_i %>
       <td style='text-align: center; white-space: nowrap;' title="<%= Time.at(container["update_time"].to_i) %>">
@@ -100,11 +110,11 @@ function setPerPage(select){
       <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"] %>
+            <%= h container["message"] %>
           </div>
           <% if container["pct_complete"].to_i > 0 %>
-            <div class="bar message" style="width: <%= container["pct_complete"] %>%;">
-              <%= container["pct_complete"] %>%
+            <div class="bar message" style="width: <%= h container["pct_complete"] %>%;">
+              <%= h container["pct_complete"] %>%
             </div>
           <% end %>
         </div>
@@ -112,7 +122,7 @@ function setPerPage(select){
       <td>
         <div class="actions">
           <form action="statuses" method="post">
-            <input type="hidden" name="jid" value="<%= container["jid"] %>" />
+            <input type="hidden" name="jid" value="<%= h container["jid"] %>" />
             <%= csrf_tag %>
             <% if container["status"] == "complete" %>
               <input type="hidden" name="_method" value="delete" />

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Evgeniy Tsvigun
 - Kenaniah Cerny
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: chronic_duration
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - utgarda@gmail.com
 - kenaniah@gmail.com
@@ -132,6 +132,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".travis.yml"
 - Appraisals
@@ -140,9 +141,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/sidekiq_3.x.gemfile
-- gemfiles/sidekiq_4.x.gemfile
 - gemfiles/sidekiq_5.x.gemfile
+- gemfiles/sidekiq_6.1.gemfile
+- gemfiles/sidekiq_6.x.gemfile
 - lib/sidekiq-status.rb
 - lib/sidekiq-status/client_middleware.rb
 - lib/sidekiq-status/server_middleware.rb
@@ -167,11 +168,11 @@ files:
 - web/views/status.erb
 - web/views/status_not_found.erb
 - web/views/statuses.erb
-homepage: http://github.com/utgarda/sidekiq-status
+homepage: https://github.com/kenaniah/sidekiq-status
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,9 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs
 test_files: