sidekiq-status 0.5.0 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c4b871d99e1ab00e5786f91d61a3f0fc4c17087e
-  data.tar.gz: 6909a5063a68811982f9e38580b1aeb146f5313f
+SHA256:
+  metadata.gz: 7c4653623b20223d993b2c5f2ce82a1ee214083c1adb51530a76d82e4d2b3977
+  data.tar.gz: 6cee1ff677b1b964465e79facf5dd1e747c6747f9e99c7fd54e0330082a4b201
 SHA512:
-  metadata.gz: 952fb2284e645179db9b5242bf4a9adcc6f8512b02335b60056b964711498c2c87d633e6f1b95116d576524ca4e3931db25fa51a22eab4d67cc41ac86e84099f
-  data.tar.gz: 249eba2c142648813996c685d6bb5e03b08765580bd36139ce24f348ddc3a1cd19ec0569a9c398d9c08a2d948a2f64d7e537695df6d93b45869416a1546a16ef
+  metadata.gz: 99971994088169aa3ba0c21417557ce9d9fc072917b06c05a9cb7815f0405e331882f057d56079b41256f028c8248a780d9f74592a660a850959109a579519cc
+  data.tar.gz: aa7030ebbbb8161f5e9e81c3fac25357cac7bff62d810a3f785e9343c12c3a5839f94060d993aafc5381700b7803ca5e1de17dcb00762525eda6fa9a6bdb4725

data/.github/workflows/ci.yaml

@@ -0,0 +1,53 @@
+name: Ruby CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+        gemfile:
+          - 'gemfiles/sidekiq_6.1.gemfile'
+          - 'gemfiles/sidekiq_6.x.gemfile'
+          - 'gemfiles/sidekiq_7.x.gemfile'
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+          rubygems: latest
+      - name: Run tests
+        run: |
+          bundle exec rake test

data/.gitignore

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

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

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

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+**Version 3.0.3**
+ - Fixes a Sidekiq warning about the deprecated `hmset` redis command (https://github.com/kenaniah/sidekiq-status/pull/37)
+
+**Version 3.0.2**
+ - Avoids setting statuses for non-status jobs when an exception is thrown (https://github.com/kenaniah/sidekiq-status/pull/32)
+
+**Version 3.0.1**
+ - Adds elapsed time and ETA to the job status page (https://github.com/kenaniah/sidekiq-status/pull/13)
+
+**Version 3.0.0**
+ - Drops support for Sidekiq 5.x
+ - Adds support for Sidekiq 7.x
+ - Migrates from Travis CI to GitHub Actions
+
+**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,47 +1,72 @@
 # 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)](https://badge.fury.io/rb/sidekiq-status)
+[![Build Status](https://github.com/kenaniah/sidekiq-status/actions/workflows/ci.yaml/badge.svg)](https://github.com/kenaniah/sidekiq-status/actions/)
 
-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).
+
+Requires Ruby 2.6+ and Sidekiq 6.0+ or newer.
 
 ## Installation
 
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-status'
+```
+
+Or install it yourself as:
+
+```bash
 gem install sidekiq-status
+```
+
+### Migrating to Version 3.x from 2.x
+
+Version 3.0.0 adds support for Sidekiq 7.x, but drops support for Sidekiq 5.x. **You should be able to upgrade cleanly from version 2.x to 3.x provided you are running Sidekiq 6.x or newer.**
+
+#### 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:
 
-## 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|
-    chain.add Sidekiq::Status::ClientMiddleware
-  end
+  # accepts :expiration (optional)
+  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes.to_i
 end
 
 Sidekiq.configure_server do |config|
-  config.server_middleware do |chain|
-    chain.add Sidekiq::Status::ServerMiddleware, expiration: 30.minutes # default
-  end
-  config.client_middleware do |chain|
-    chain.add Sidekiq::Status::ClientMiddleware
-  end
+  # accepts :expiration (optional)
+  Sidekiq::Status.configure_server_middleware config, expiration: 30.minutes.to_i
+
+  # accepts :expiration (optional)
+  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes.to_i
 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.
+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
@@ -49,14 +74,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:
+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:
 
 ``` 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)
@@ -65,23 +93,61 @@ 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.
 
-### Retrieving status
+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`.
 
-Query for job status any time later:
+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.
+
+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)
-# :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::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, the result will be `nil` or `false`.
+
+### ActiveJob Support
 
-### Tracking progress, saving and retrieveing data associated with job
+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:
+
+```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
@@ -93,13 +159,13 @@ 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
-    # remember that retrieved data is always is String|nil
+    # a way of retrieving stored data
+    # remember that retrieved data is always String|nil
     vino = retrieve :vino
   end
 end
@@ -112,28 +178,57 @@ Sidekiq::Status::at      job_id #=> 5
 Sidekiq::Status::total   job_id #=> 100
 Sidekiq::Status::message job_id #=> "Almost done"
 Sidekiq::Status::pct_complete job_id #=> 5
+Sidekiq::Status::working_at job_id #=> 2718
+Sidekiq::Status::update_time job_id #=> 2819
 ```
+
 ### Unscheduling
 
 ```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 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.
+
+```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 a `/statuses` page.
+![Sidekiq Status Web](web/sidekiq-status-web.png)
 
-Setup Sidekiq web interface according to Sidekiq documentation and add the Sidekiq::Status::Web require:
+Information for an individual job may be found at `/statuses/:job_id`.
+
+![Sidekiq Status Web](web/sidekiq-status-single-web.png)
+
+Note: _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),
@@ -153,17 +248,29 @@ To use `sidekiq-status` inlining, require it too in your `{test,spec}_helper.rb`
 
 `require 'sidekiq-status/testing/inline'`
 
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
-### Features coming
-* Stopping jobs by id
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes along with test cases (`git commit -am 'Add some feature'`)
+4. If possible squash your commits to one commit if they all belong to same feature.
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request.
 
 ## Thanks
+* Pramod Shinde
+* Kenaniah Cerny
 * Clay Allsopp
 * Andrew Korzhuev
 * Jon Moses
 * Wayne Hoover
 * Dylan Robinson
+* Dmitry Novotochinov
+* Mohammed Elalj
+* Ben Sharpe
 
 ## License
-MIT License , see LICENSE for more details.
-© 2012 - 2014 Evgeniy Tsvigun
+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_6.1.gemfile

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

data/gemfiles/sidekiq_6.x.gemfile

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

data/gemfiles/sidekiq_7.x.gemfile

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

data/lib/sidekiq-status/client_middleware.rb

@@ -1,15 +1,68 @@
+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
     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
+
+      # Determine the actual job class
+      klass = msg["args"][0]["job_class"] || worker_class rescue worker_class
+      job_class = if klass.is_a?(Class)
+                    klass
+                  elsif Module.const_defined?(klass)
+                    Module.const_get(klass)
+                  else
+                    nil
+                  end
+
+      # Store data if the job is a Sidekiq::Status::Worker
+      if job_class && job_class.ancestors.include?(Sidekiq::Status::Worker)
+        initial_metadata = {
+          jid: msg['jid'],
+          status: :queued,
+          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
+      end
+
       yield
+
+    end
+
+    def display_args(msg, queue)
+      job = JOB_CLASS.new(msg, queue)
+      return job.display_args.to_a.empty? ? "{}" : job.display_args.to_json
+    rescue Exception => e
+      # For Sidekiq ~> 2.7
+      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

data/lib/sidekiq-status/redis_adapter.rb

@@ -0,0 +1,18 @@
+# adapter for redis-rb client
+class Sidekiq::Status::RedisAdapter
+  def initialize(client)
+    @client = client
+  end
+
+  def scan(**options, &block)
+    @client.scan_each(**options, &block)
+  end
+
+  def schedule_batch(key, options)
+    @client.zrangebyscore key, options[:start], options[:end], limit: [options[:offset], options[:limit]]
+  end
+
+  def method_missing(method, *args)
+    @client.send(method, *args)
+  end
+end

data/lib/sidekiq-status/redis_client_adapter.rb

@@ -0,0 +1,14 @@
+# adapter for redis-client client
+class Sidekiq::Status::RedisClientAdapter
+  def initialize(client)
+    @client = client
+  end
+
+  def schedule_batch(key, options)
+    @client.zrange(key, options[:start], options[:end], :byscore, :limit, options[:offset], options[:limit])
+  end
+
+  def method_missing(method, *args)
+    @client.send(method, *args)
+  end
+end