sidekiq-status 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5188215b7cc5735ac70ba8ea4fa9d62df0a2b8d317b901540bf9665bbf5b0e9a
-  data.tar.gz: 4db9d510d4a0908c6a6763f1b89075fa7e031779387c8c05d7940719a3da404f
+  metadata.gz: 7c2c40656501ca39c5bc87ec1b1a81acc8f8f24fcde74dfe13b60a3659ae67fb
+  data.tar.gz: 1647fe3d39f47444615bf83e6ba31d69ad750fdab07c23a7cafeb85f15991b93
 SHA512:
-  metadata.gz: de2e9e08e65532dce024e2250e641b6a25833fdf5e977c86860018225c7769538d16076c627eb2f90af1ac4b9b0e035fc347c3651bcae06af43a4e622eef147b
-  data.tar.gz: 3b1508b26d23b45b48692e033d78341dd65ca81f9382bd2498cee07f236b781a176c52dbb079a37409242ffd61632266d00e5c99e60d37eba434e495245117bd
+  metadata.gz: 29f7ba740739147cf2a3f3050d89ed89403d83c39e1c23d31246e4c5a0f73883a1cf7146c5b11d378673a057ab6629c76fd666c9436c5f14b4ef292e0765a0ff
+  data.tar.gz: c71ff262e667f0c1f330dbcf0ab51783cef4d7a5fe37a7406465d3f6a8df51b1989040b817fd2c3f671c63cb0ea670eeb46240e9c4b6b0ab332544b779e75060

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+**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

data/README.md

@@ -1,7 +1,6 @@
 # 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/)
-[![Inline docs](https://inch-ci.org/github/kenaniah/sidekiq-status.svg?branch=main)](https://inch-ci.org/github/kenaniah/sidekiq-status)
 
 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).
 
@@ -21,6 +20,10 @@ Or install it yourself as:
 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.**
@@ -46,15 +49,15 @@ require 'sidekiq-status'
 
 Sidekiq.configure_client do |config|
   # accepts :expiration (optional)
-  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes
+  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes.to_i
 end
 
 Sidekiq.configure_server do |config|
   # accepts :expiration (optional)
-  Sidekiq::Status.configure_server_middleware config, expiration: 30.minutes
+  Sidekiq::Status.configure_server_middleware config, expiration: 30.minutes.to_i
 
   # accepts :expiration (optional)
-  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes
+  Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes.to_i
 end
 ```
 
@@ -175,6 +178,8 @@ 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

data/lib/sidekiq-status/server_middleware.rb

@@ -43,26 +43,28 @@ module Sidekiq::Status
         return
       end
 
-      # Determine job expiration
-      expiry = job_class.new.expiration || @expiration rescue @expiration
-
-      store_status worker.jid, :working,  expiry
-      yield
-      store_status worker.jid, :complete, expiry
-    rescue Worker::Stopped
-      store_status worker.jid, :stopped, expiry
-    rescue SystemExit, Interrupt
-      store_status worker.jid, :interrupted, expiry
-      raise
-    rescue Exception
-      status = :failed
-      if msg['retry']
-        if retry_attempt_number(msg) < retry_attempts_from(msg['retry'], DEFAULT_MAX_RETRY_ATTEMPTS)
-          status = :retrying
+      begin
+        # Determine job expiration
+        expiry = job_class.new.expiration || @expiration rescue @expiration
+
+        store_status worker.jid, :working,  expiry
+        yield
+        store_status worker.jid, :complete, expiry
+      rescue Worker::Stopped
+        store_status worker.jid, :stopped, expiry
+      rescue SystemExit, Interrupt
+        store_status worker.jid, :interrupted, expiry
+        raise
+      rescue Exception
+        status = :failed
+        if msg['retry']
+          if retry_attempt_number(msg) < retry_attempts_from(msg['retry'], DEFAULT_MAX_RETRY_ATTEMPTS)
+            status = :retrying
+          end
         end
+        store_status(worker.jid, status, expiry) if job_class && job_class.ancestors.include?(Sidekiq::Status::Worker)
+        raise
       end
-      store_status(worker.jid, status, expiry) if job_class && job_class.ancestors.include?(Sidekiq::Status::Worker)
-      raise
     end
 
     private

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = '3.0.0'
+    VERSION = '3.0.2'
   end
 end

data/lib/sidekiq-status/web.rb

@@ -8,7 +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)
+    COMMON_STATUS_HASH_KEYS = %w(update_time jid status worker args label pct_complete total at message working_at elapsed eta)
 
     class << self
       def per_page_opts= arr
@@ -48,6 +48,8 @@ module Sidekiq::Status
         def add_details_to_status(status)
           status['label'] = status_label(status['status'])
           status["pct_complete"] ||= pct_complete(status)
+          status["elapsed"] ||= elapsed(status).to_s
+          status["eta"] ||= eta(status).to_s
           status["custom"] = process_custom_data(status)
           return status
         end
@@ -61,6 +63,19 @@ module Sidekiq::Status
           Sidekiq::Status::pct_complete(status['jid']) || 0
         end
 
+        def elapsed(status)
+          case status['status']
+          when 'complete'
+            Sidekiq::Status.update_time(status['jid']) - Sidekiq::Status.working_at(status['jid'])
+          when 'working', 'retrying'
+            Time.now.to_i - Sidekiq::Status.working_at(status['jid'])
+          end
+        end
+
+        def eta(status)
+          Sidekiq::Status.eta(status['jid']) if status['status'] == 'working'
+        end
+
         def status_label(status)
           case status
           when 'complete'
@@ -122,6 +137,8 @@ module Sidekiq::Status
           {id: "status", name: "Status", class: nil, url: nil},
           {id: "update_time", name: "Last Updated", class: nil, url: nil},
           {id: "pct_complete", name: "Progress", class: nil, url: nil},
+          {id: "elapsed", name: "Time Elapsed", class: nil, url: nil},
+          {id: "eta", name: "ETA", class: nil, url: nil},
         ]
 
         @headers.each do |h|

data/lib/sidekiq-status/worker.rb

@@ -29,7 +29,7 @@ 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)
+    store(at: num, total: @_status_total, pct_complete: pct_complete, message: message, working_at: working_at)
   end
 
   # Sets total number of tasks
@@ -37,7 +37,12 @@ module Sidekiq::Status::Worker
   # @return [String]
   def total(num)
     @_status_total = num
-    store(total: num)
+    store(total: num, working_at: working_at)
   end
 
+  private
+
+  def working_at
+    @working_at ||= Time.now.to_i
+  end
 end

data/lib/sidekiq-status.rb

@@ -63,6 +63,21 @@ 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
+    end
+
+    def update_time(job_id)
+      (get(job_id, :update_time) || Time.now).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)
+    end
+
     def message(job_id)
       get(job_id, :message)
     end

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

@@ -61,6 +61,22 @@ describe Sidekiq::Status::ServerMiddleware do
         end
         expect(redis.hget("sidekiq:status:#{job_id}", :status)).to be_nil
       end
+
+      it "should not set any status on system exit signal" do
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+        start_server do
+          expect(ExitedNoStatusJob.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 on interrupt signal" do
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id)
+        start_server do
+          expect(InterruptedNoStatusJob.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

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

@@ -20,4 +20,22 @@ describe Sidekiq::Status::Worker do
       expect(subject.expiration).to eq(:val)
     end
   end
+
+  describe ".at" do
+    subject { StubJob.new }
+
+    it "records when the worker has started" do
+      expect { subject.at(0) }.to(change { subject.retrieve('working_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') })
+      end
+    end
+
+    it "records when the worker last worked" do
+      expect { subject.at(0) }.to(change { subject.retrieve('update_time') })
+    end
+  end
 end

data/spec/support/test_jobs.rb

@@ -111,12 +111,24 @@ class ExitedJob < StubJob
   end
 end
 
+class ExitedNoStatusJob < StubNoStatusJob
+  def perform
+    raise SystemExit
+  end
+end
+
 class InterruptedJob < StubJob
   def perform
     raise Interrupt
   end
 end
 
+class InterruptedNoStatusJob < StubNoStatusJob
+  def perform
+    raise Interrupt
+  end
+end
+
 class RetriedJob < StubJob
 
   sidekiq_options retry: true

data/web/views/status.erb

@@ -67,6 +67,32 @@
       </div>
     </div>
 
+    <div class="row">
+      <div class="col-sm-2">
+        <strong>Elapsed Time</strong>
+      </div>
+      <div class="col-sm-10">
+        <p>
+          <% if @status["elapsed"] %>
+            <%= ChronicDuration.output(@status["elapsed"].to_i, :weeks => true, :units => 2) %>
+          <% end %>
+        </p>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="col-sm-2">
+        <strong>ETA</strong>
+      </div>
+      <div class="col-sm-10">
+        <p>
+          <% if @status["eta"] %>
+            <%= ChronicDuration.output(@status["eta"].to_i, :weeks => true, :units => 2) %>
+          <% end %>
+        </p>
+      </div>
+    </div>
+
     <% if @status["custom"].any? %>
       <hr>
       <% @status["custom"].each do |key, val| %>

data/web/views/statuses.erb

@@ -119,6 +119,16 @@ function setPerPage(select){
           <% end %>
         </div>
       </td>
+      <td style='text-align: center; white-space: nowrap;'>
+        <% if container["elapsed"] %>
+          <%= ChronicDuration.output(container["elapsed"].to_i, :weeks => true, :units => 2) %>
+        <% end %>
+      </td>
+      <td style='text-align: center; white-space: nowrap;'>
+        <% if container["eta"] %>
+          <%= ChronicDuration.output(container["eta"].to_i, :weeks => true, :units => 2) %>
+        <% end %>
+      </td>
       <td>
         <div class="actions">
           <form action="statuses" method="post">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Evgeniy Tsvigun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq