sidekiq-status 3.0.3 → 4.0.0

data/lib/sidekiq-status/worker.rb

@@ -15,13 +15,14 @@ module Sidekiq::Status::Worker
   end
 
   # Read value from job status hash
-  # @param String|Symbol hask key
+  # @param String|Symbol hash key
   # @return [String]
   def retrieve(name)
     read_field_for_id @provider_job_id || @job_id || @jid || "", name
   end
 
-  # Sets current task progress
+  # Sets current task progress. This will stop the job if `.stop!` has been
+  # called with this job's ID.
   # (inspired by resque-status)
   # @param Fixnum number of tasks done
   # @param String optional message
@@ -29,7 +30,8 @@ module Sidekiq::Status::Worker
   def at(num, message = nil)
     @_status_total = 100 if @_status_total.nil?
     pct_complete = ((num / @_status_total.to_f) * 100).to_i rescue 0
-    store(at: num, total: @_status_total, pct_complete: pct_complete, message: message, working_at: working_at)
+    store(at: num, total: @_status_total, pct_complete: pct_complete, message: message)
+    raise Stopped if retrieve(:stop) == 'true'
   end
 
   # Sets total number of tasks
@@ -37,12 +39,6 @@ module Sidekiq::Status::Worker
   # @return [String]
   def total(num)
     @_status_total = num
-    store(total: num, working_at: working_at)
-  end
-
-  private
-
-  def working_at
-    @working_at ||= Time.now.to_i
+    store(total: num)
   end
 end

data/lib/sidekiq-status.rb

@@ -42,6 +42,10 @@ module Sidekiq::Status
       delete_status(job_id)
     end
 
+    def stop!(job_id)
+      store_for_id(job_id, {stop: 'true'})
+    end
+
     alias_method :unschedule, :cancel
 
     STATUS.each do |name|
@@ -63,19 +67,31 @@ module Sidekiq::Status
       get(job_id, :pct_complete).to_i
     end
 
-    def working_at(job_id)
-      (get(job_id, :working_at) || Time.now).to_i
+    def enqueued_at(job_id)
+      get(job_id, :enqueued_at)&.to_i
+    end
+
+    def started_at(job_id)
+      get(job_id, :started_at)&.to_i
+    end
+
+    def updated_at(job_id)
+      # sidekiq-status v3.x and earlier used :update_time
+      get(job_id, :updated_at)&.to_i || get(job_id, :update_time)&.to_i
     end
 
-    def update_time(job_id)
-      (get(job_id, :update_time) || Time.now).to_i
+    def ended_at(job_id)
+      get(job_id, :ended_at)&.to_i
     end
 
     def eta(job_id)
       at = at(job_id)
       return nil if at.zero?
 
-      (Time.now.to_i - working_at(job_id)).to_f / at * (total(job_id) - at)
+      start_time = started_at(job_id) || enqueued_at(job_id) || updated_at(job_id)
+      elapsed = Time.now.to_i - start_time if start_time
+      return nil unless elapsed
+      elapsed.to_f / at * (total(job_id) - at)
     end
 
     def message(job_id)

data/sidekiq-status.gemspec

@@ -12,14 +12,20 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'sidekiq-status'
   gem.require_paths = ['lib']
+  gem.required_ruby_version = '>= 3.2'
   gem.version       = Sidekiq::Status::VERSION
 
-  gem.add_dependency                  'sidekiq', '>= 6.0', '< 8'
+  gem.add_dependency                  'sidekiq', '>= 7', '< 9'
   gem.add_dependency                  'chronic_duration'
+  gem.add_dependency                  'logger'
+  gem.add_dependency                  'base64'
   gem.add_development_dependency      'appraisal'
   gem.add_development_dependency      'colorize'
+  gem.add_development_dependency      'irb'
   gem.add_development_dependency      'rack-test'
   gem.add_development_dependency      'rake'
   gem.add_development_dependency      'rspec'
   gem.add_development_dependency      'sinatra'
+  gem.add_development_dependency      'webrick'
+  gem.add_development_dependency      'rack-session'
 end

data/spec/environment.rb

@@ -1 +1,12 @@
-# This file has been intentionally left blank
+# This file is used to load the test environment for Sidekiq::Status when launching Sidekiq workers directly
+require "sidekiq-status"
+require_relative "support/test_jobs"
+
+Sidekiq.configure_client do |config|
+  Sidekiq::Status.configure_client_middleware config
+end
+
+Sidekiq.configure_server do |config|
+  Sidekiq::Status.configure_server_middleware config
+  Sidekiq::Status.configure_client_middleware config
+end

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

@@ -38,6 +38,14 @@ describe Sidekiq::Status::ClientMiddleware do
       end
     end
 
+    context "when first argument is a string containing substring 'job_class'" do
+      it "uses the constantized class name" do
+        expect(StubJob.perform_async 'a string with job_class inside').to eq(job_id)
+        expect(redis.hget("sidekiq:status:#{job_id}", :status)).to eq('queued')
+        expect(Sidekiq::Status::queued?(job_id)).to be_truthy
+        expect(Sidekiq::Status::get_all(job_id)).to include('worker' => 'StubJob')
+      end
+    end
   end
 
   describe "with :expiration parameter" do

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

@@ -45,6 +45,19 @@ describe Sidekiq::Status::ServerMiddleware do
       expect(Sidekiq::Status::failed?(job_id)).to be_truthy
     end
 
+    context "when first argument is a string containing substring 'job_class'" do
+      it "uses the default class name" do
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+        start_server do
+          expect(capture_status_updates(3) {
+            expect(ConfirmationJob.perform_async 'a string with job_class inside').to eq(job_id)
+          }).to eq([job_id]*3)
+        end
+        expect(redis.hget("sidekiq:status:#{job_id}", :status)).to eq('complete')
+        expect(Sidekiq::Status::get_all(job_id)).to include('worker' => 'ConfirmationJob')
+      end
+    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)

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

@@ -1,6 +1,7 @@
 require 'spec_helper'
 require 'sidekiq-status/web'
 require 'rack/test'
+require 'base64'
 
 describe 'sidekiq status web' do
   include Rack::Test::Methods
@@ -9,13 +10,14 @@ describe 'sidekiq status web' do
   let!(:job_id) { SecureRandom.hex(12) }
 
   def app
-    Sidekiq::Web
+    @app ||= Sidekiq::Web.new
   end
 
   before do
-    env 'rack.session', csrf: Base64.urlsafe_encode64('token')
-    client_middleware
     allow(SecureRandom).to receive(:hex).and_return(job_id)
+    # Set up a basic session for Sidekiq's CSRF protection
+    env 'rack.session', {}
+    client_middleware
   end
 
   around { |example| start_server(&example) }
@@ -81,4 +83,71 @@ describe 'sidekiq status web' do
     expect(last_response).to be_not_found
     expect(last_response.body).to match(/That job can't be found/)
   end
+
+  it 'handles POST with PUT method override for retrying failed jobs' do
+    # Create a failed job first
+    capture_status_updates(3) do
+      FailingJob.perform_async
+    end
+
+    # First make a GET request to establish the session and get the CSRF token
+    get '/statuses'
+    expect(last_response).to be_ok
+
+    # Extract the CSRF token from the environment
+    csrf_token = last_request.env[:csrf_token]
+
+    # Simulate the retry form submission with a referer header
+    header 'Referer', 'http://example.com/statuses'
+    post '/statuses', {
+      'jid' => job_id,
+      '_method' => 'put',
+      'authenticity_token' => csrf_token
+    }
+
+    expect(last_response.status).to eq(302)
+    expect(last_response.headers['Location']).to eq('http://example.com/statuses')
+  end
+
+  it 'handles POST with DELETE method override for removing completed jobs' do
+    # Create a completed job first
+    capture_status_updates(2) do
+      StubJob.perform_async
+    end
+
+    # First make a GET request to establish the session and get the CSRF token
+    get '/statuses'
+    expect(last_response).to be_ok
+
+    # Extract the CSRF token from the environment
+    csrf_token = last_request.env[:csrf_token]
+
+    # Simulate the remove form submission with a referer header
+    header 'Referer', 'http://example.com/statuses'
+    post '/statuses', {
+      'jid' => job_id,
+      '_method' => 'delete',
+      'authenticity_token' => csrf_token
+    }
+
+    expect(last_response.status).to eq(302)
+    expect(last_response.headers['Location']).to eq('http://example.com/statuses')
+    expect(Sidekiq::Status.status(job_id)).to be_nil
+  end
+
+  it 'returns 405 for POST without valid method override' do
+    # First make a GET request to establish the session and get the CSRF token
+    get '/statuses'
+    expect(last_response).to be_ok
+
+    # Extract the CSRF token from the environment
+    csrf_token = last_request.env[:csrf_token]
+
+    post '/statuses', {
+      'jid' => job_id,
+      'authenticity_token' => csrf_token
+    }
+
+    expect(last_response.status).to eq(405)
+  end
 end

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

@@ -25,17 +25,17 @@ describe Sidekiq::Status::Worker do
     subject { StubJob.new }
 
     it "records when the worker has started" do
-      expect { subject.at(0) }.to(change { subject.retrieve('working_at') })
+      expect { subject.at(0) }.to(change { subject.retrieve('updated_at') })
     end
 
     context "when setting the total for the worker" do
       it "records when the worker has started" do
-        expect { subject.total(100) }.to(change { subject.retrieve('working_at') })
+        expect { subject.total(100) }.to(change { subject.retrieve('updated_at') })
       end
     end
 
     it "records when the worker last worked" do
-      expect { subject.at(0) }.to(change { subject.retrieve('update_time') })
+      expect { subject.at(0) }.to(change { subject.retrieve('updated_at') })
     end
   end
 end

data/spec/lib/sidekiq-status_spec.rb

@@ -72,10 +72,13 @@ describe Sidekiq::Status do
           expect(LongJob.perform_async(0.5)).to eq(job_id)
         }).to eq([job_id]*2)
         expect(hash = Sidekiq::Status.get_all(job_id)).to include 'status' => 'working'
-        expect(hash).to include 'update_time'
+        expect(hash).to include 'started_at'
+        expect(hash).to include 'updated_at'
       end
       expect(hash = Sidekiq::Status.get_all(job_id)).to include 'status' => 'complete'
-      expect(hash).to include 'update_time'
+      expect(hash).to include 'started_at'
+      expect(hash).to include 'updated_at'
+      expect(hash).to include 'ended_at'
     end
   end
 
@@ -138,6 +141,20 @@ describe Sidekiq::Status do
     end
   end
 
+  describe ".stop!" do
+    it "allows a job to be stopped" do
+      allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+      start_server do
+        expect(capture_status_updates(1) {
+          expect(LongProgressJob.perform_async).to eq(job_id)
+          expect(Sidekiq::Status.stop!(job_id)).to be_truthy
+        }).to eq([job_id]*1)
+      end
+      expect(Sidekiq::Status.at(job_id)).to be(0)
+      expect(Sidekiq::Status.stopped?(job_id)).to be_truthy
+    end
+  end
+
   context "keeps normal Sidekiq functionality" do
     let(:expiration_param) { nil }
 
@@ -152,7 +169,7 @@ describe Sidekiq::Status do
       seed_secure_random_with_job_ids
       start_server(:expiration => expiration_param) do
         expect {
-          Sidekiq::Client.new(Sidekiq.redis_pool).
+          Sidekiq::Client.new(pool: Sidekiq.redis_pool).
             push("class" => "NotAKnownClass", "args" => [])
         }.to_not raise_error
       end

data/spec/spec_helper.rb

@@ -1,11 +1,6 @@
 require "rspec"
 require 'colorize'
 require 'sidekiq'
-
-# Celluloid should only be manually required before Sidekiq versions 4.+
-require 'sidekiq/version'
-require 'celluloid' if Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new('4.0')
-
 require 'sidekiq/processor'
 require 'sidekiq/manager'
 require 'sidekiq-status'
@@ -50,7 +45,7 @@ def redis_thread messages_limit, *channels
         end
       end
     end
-    puts "Returing from thread".cyan if ENV['DEBUG']
+    puts "Returning from thread".cyan if ENV['DEBUG']
     messages
   }
 
@@ -83,7 +78,7 @@ def redis_client_thread message_limit, *channels
         end
       end
     end
-    puts "Returing from thread".cyan if ENV['DEBUG']
+    puts "Returning from thread".cyan if ENV['DEBUG']
     messages
   }
   sleep 0.1
@@ -126,7 +121,7 @@ def start_server server_middleware_options = {}
     # Launch
     puts "Server starting".yellow if ENV['DEBUG']
     instance = Sidekiq::CLI.instance
-    instance.parse(['-r', File.expand_path('environment.rb', File.dirname(__FILE__))])
+    instance.parse(['-r', File.expand_path('test_environment.rb', File.dirname(__FILE__))])
     instance.run
 
   end

data/spec/support/test_jobs.rb

@@ -32,6 +32,17 @@ class LongJob < StubJob
   end
 end
 
+class LongProgressJob < StubJob
+  def perform(*args)
+    sleep 0.25
+    10.times do |i|
+      at i * 10
+      sleep (args[0] || 0.25) / 10.0
+    end
+    at 100
+  end
+end
+
 class DataJob < StubJob
   def perform
     sleep 0.1

data/spec/test_environment.rb

@@ -0,0 +1 @@
+# This file has been intentionally left blank

data/web/assets/statuses.css

@@ -0,0 +1,124 @@
+.progress {
+  background-color: #C8E1ED;
+  border-radius: 8px;
+  height: 100%;
+}
+.progress-bar {
+  display: flex;
+  align-items: center;
+}
+.progress-percentage {
+  padding-left: 6px;
+  color: #333;
+  text-align: left;
+  text-shadow: 0 0 5px white;
+  font-weight: bold;
+}
+.bar {
+  background-color: #2897cb;
+  color: white;
+  text-shadow: 0 0 0;
+}
+.message {
+  text-shadow: 0 0 5px white;
+  font-weight: bold; padding-left: 4px;
+  color: #333;
+}
+.actions {
+  text-align: center;
+}
+.btn-warning {
+  background-image: linear-gradient(#f0ad4e, #eea236)
+}
+.index-header {
+  display: flex;
+  justify-content: space-between;
+}
+.nav-container {
+  display: flex;
+  line-height: 45px;
+}
+.nav-container .pull-right {
+  float: none !important;
+}
+.nav-container .pagination {
+  display: flex;
+  align-items: center;
+}
+.nav-container .per-page, .filter-status {
+  display: flex;
+  align-items: center;
+  margin: 20px 0 20px 10px;
+  white-space: nowrap;
+}
+.nav-container .per-page SELECT {
+  margin: 0 0 0 5px;
+}
+.status-header {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+}
+.status-table th {
+  font-weight: bold;
+  width: 25%;
+  padding: 12px;
+}
+.status-table td {
+  padding: 12px;
+  vertical-align: top;
+}
+.status-table .timestamp {
+  font-family: monospace;
+  font-size: 13px;
+}
+.status-table .multiline {
+  white-space: pre-wrap;
+  font-family: monospace;
+  background-color: #f8f8f8;
+  padding: 8px;
+  border-radius: 3px;
+}
+.label {
+  display: inline-block;
+}
+.label-primary {
+  background-color: #337ab7;
+}
+.center {
+  text-align: center;
+}
+.nowrap {
+  white-space: nowrap;
+}
+.h-30px {
+  height: 30px;
+}
+.mb-0 {
+  margin-bottom: 0;
+}
+.fs-lg {
+  font-size: 1.4em;
+}
+
+/* Dark mode support */
+@media screen and (prefers-color-scheme: dark) {
+  .progress {
+    background-color: #233240;
+  }
+
+  .progress-percentage {
+    color: #ecf0f1;
+    text-shadow: none;
+  }
+
+  .bar {
+    background-color: #3498db;
+    color: #ecf0f1;
+  }
+
+  .message {
+    color: #ecf0f1;
+    text-shadow: none;
+  }
+}

data/web/assets/statuses.js

@@ -0,0 +1,24 @@
+// Handles the navigation for the filter and per-page select dropdowns
+document.addEventListener("change", function(event) {
+  if (event.target.matches(".nav-container select.form-control")) {
+    window.location = event.target.options[event.target.selectedIndex].getAttribute('data-url')
+  }
+})
+
+// Set width of progress bars based on their aria-valuenow attribute
+function updateProgressBarWidths() {
+  document.querySelectorAll('.progress-bar').forEach(function(progressBar) {
+    const valueNow = progressBar.getAttribute('aria-valuenow');
+    if (valueNow !== null) {
+      progressBar.style.width = valueNow + '%';
+    }
+  });
+}
+updateProgressBarWidths();
+
+// Update progress bar widths when the page loads
+document.addEventListener("DOMContentLoaded", updateProgressBarWidths);
+
+// Also update when new content is dynamically loaded
+document.addEventListener("DOMContentMounted", updateProgressBarWidths);
+