sidekiq-status 1.1.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 852f99075106d76a18f3a0f21a3e49785069af7e8ee479c08959edeeef655439
-  data.tar.gz: 02fb95b39d1e37a081e64b2442a4c9a19b708d44bb52af24c1ccdff4d3a884c7
+  metadata.gz: fc3436d5bc785da39c9f4f9d56d8179d75acc534935b9cab980ef7266bcdbe94
+  data.tar.gz: 373f55bc1dc6cb235fe1f858ceb6ccb49fbe4e8864e9dd1951c83cd1ae053e69
 SHA512:
-  metadata.gz: 7091b83f0ae9277478d75e6d5aab3a29936e76d0cb7c9f671031aa357e8fe2b4f1cacb92716fa3b5b2e474bbde3c5c26f8298195154d798f82d0f52a4e0661e7
-  data.tar.gz: 58c13e7c9fa8c1712bfbd47fbcb47a5cd69e0804093def9745de5d591d8dc1959e6701c6baff6efb808d305e7fe4f750859d5575f62b2d28f29484b6e2029f02
+  metadata.gz: 30ac2390e17ceb73ace6481921e28ad42ab2111012007ff2577a997ca7f34a6e8da59f06fa856f7abcbb07086c1863110417a6c2063399af672ee3e17fc227ad
+  data.tar.gz: b0084cbfdd76b4215d6787b5d910d84722bc538de84ef0f0663990a2dd0ec2ed3bc3e8aee9b71b50336517c11c86843c5abd190964c6321e5a0c27f8353f3fb3

data/.gitignore

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

data/.travis.yml

@@ -1,14 +1,13 @@
 language: ruby
 rvm:
-  - 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

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,71 +1,15 @@
-**Version 1.1.4**
-* Ensures jobs without sidekiq-status do not record status exceptions (#150)
+**Version 2.0.2**
+ * Fixes for dark mode theme
 
-**Version 1.1.3**
-* Adds a job status filter to the UI (#149)
+**Version 2.0.1**
+ * Adds support for dark mode to the job status page
 
-**Version 1.1.2**
-* Job detail pages now show custom data keys (#146)
+**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
 
-**Version 1.1.1**
-* Uses SCAN rather than KEYS when retrieving job ids from Redis (#139)
+**Versions 1.1.4 and prior**
 
-**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 labels 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 cleanup
-
-**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
+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/storage.rb

@@ -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.4'
+    VERSION = '2.1.0'
   end
 end

data/lib/sidekiq-status/web.rb

@@ -136,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))
@@ -148,19 +148,23 @@ 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", "status"].each do |key|
   Sidekiq::WebHelpers::SAFE_QPARAMS.push(key)

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/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

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/web/views/status.erb

@@ -28,7 +28,7 @@
   </div>
 </div>
 
-<div class="panel panel-default">
+<div class="panel panel-default" style="background-color: inherit">
   <div class="panel-body">
     <h4><%= @status["worker"] %></h4>
 

data/web/views/status_not_found.erb

@@ -1,5 +1,5 @@
 <h3>Job Status: <%= 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

@@ -76,7 +76,7 @@ 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] %>">

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Evgeniy Tsvigun
 - Kenaniah Cerny
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-08 00:00:00.000000000 Z
+date: 2021-09-23 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
@@ -141,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
@@ -168,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
@@ -187,8 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs
 test_files: