sidekiq-status 0.6.0 → 3.0.3

data/spec/support/test_jobs.rb

@@ -1,16 +1,34 @@
+require 'sidekiq-status'
+
 class StubJob
   include Sidekiq::Worker
   include Sidekiq::Status::Worker
 
-  sidekiq_options 'retry' => 'false'
+  sidekiq_options 'retry' => false
+
+  def perform(*args)
+  end
+end
+
+class StubNoStatusJob
+  include Sidekiq::Worker
+
+  sidekiq_options 'retry' => false
 
   def perform(*args)
   end
 end
 
+
+class ExpiryJob < StubJob
+  def expiration
+    15
+  end
+end
+
 class LongJob < StubJob
   def perform(*args)
-    sleep args[0] || 1
+    sleep args[0] || 0.25
   end
 end
 
@@ -23,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
@@ -54,25 +79,65 @@ class FailingJob < StubJob
   end
 end
 
+class FailingNoStatusJob < StubNoStatusJob
+  def perform
+    raise StandardError
+  end
+end
+
+class RetryAndFailJob < StubJob
+  sidekiq_options retry: 1
+
+  def perform
+    raise StandardError
+  end
+end
+
+class FailingHardJob < StubJob
+  def perform
+    raise Exception
+  end
+end
+
+class FailingHardNoStatusJob < StubNoStatusJob
+  def perform
+    raise Exception
+  end
+end
+
 class ExitedJob < StubJob
   def perform
     raise SystemExit
   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'
-  def perform()
+
+  sidekiq_options retry: true
+  sidekiq_retry_in do |count| 3 end # 3 second delay > job timeout in test suite
+
+  def perform
     Sidekiq.redis do |conn|
       key = "RetriedJob_#{jid}"
-      sleep 1
-      unless conn.exists key
+      if [0, false].include? conn.exists(key)
         conn.set key, 'tried'
         raise StandardError
       end

data/web/views/status.erb

@@ -0,0 +1,118 @@
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
+<style>
+  .progress {
+    background-color: #C8E1ED;
+  }
+  .progress-percentage {
+    margin: 5px;
+    padding-left: 4px;
+    color: #333;
+    text-align: left;
+    text-shadow: 0 0 5px white;
+    font-weight: bold;
+    font-size: 14px;
+  }
+</style>
+
+<h3>
+  Job Status: <%= h @status["jid"] %>
+  <span class='label label-<%= h @status["label"] %>'>
+    <%= h @status["status"] %>
+  </span>
+</h3>
+
+<div class="progress" style="height: 30px;">
+  <div class="progress-bar" role="progressbar" aria-valuenow="<%= @status["pct_complete"].to_i %>" aria-valuemin="0" aria-valuemax="100" style="width: <%= @status["pct_complete"].to_i %>%">
+    <div class="progress-percentage">
+      <%= @status["pct_complete"].to_i %>%
+    </div>
+  </div>
+</div>
+
+<div class="panel panel-default" style="background-color: inherit">
+  <div class="panel-body">
+    <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>" : h(@status["args"]) %></p>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="col-sm-2">
+        <strong>Message</strong>
+      </div>
+      <div class="col-sm-10">
+        <p><%= h(@status["message"]) || "<i>none</i>" %></p>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="col-sm-2">
+        <strong>Last Updated</strong>
+      </div>
+      <div class="col-sm-10">
+        <p>
+          <% secs = Time.now.to_i - @status["update_time"].to_i %>
+          <% if secs > 0 %>
+            <%= ChronicDuration.output(secs, :weeks => true, :units => 2) %> ago
+          <% else %>
+            Now
+          <% end %>
+        </p>
+      </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| %>
+        <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>
+
+<a href="<%= root_path %>statuses">
+  <small>&larr; back to all statuses</small>
+</a>

data/web/views/status_not_found.erb

@@ -0,0 +1,6 @@
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
+<h3>Job Status: <%= h params[:jid] %></h3>
+
+<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,11 +1,11 @@
-
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
 <style>
 .progress {
   background-color: #C8E1ED;
 }
 .bar {
-  background-color: #2897cb; 
-  color: white; 
+  background-color: #2897cb;
+  color: white;
   text-shadow: 0 0 0;
 }
 .message {
@@ -13,35 +13,96 @@
   font-weight: bold; padding-left: 4px;
   color: #333;
 }
-.header{
+.actions {
+  text-align: center;
+}
+.header {
   text-align: center;
 }
+.header_update_time {
+  width: 10%;
+}
+.header_pct_complete {
+  width: 45%;
+}
+.btn-warning {
+  background-image: linear-gradient(#f0ad4e, #eea236)
+}
+.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;
+}
 </style>
+<script>
+function setPerPage(select){
+  window.location = select.options[select.selectedIndex].getAttribute('data-url')
+}
+</script>
+<div style="display: flex; justify-content: space-between;">
+  <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>
 
-<h3 class="wi">Recent job statuses</h3>
-<table class="table table-hover table-bordered table-striped table-white">  
+    <div class="per-page">
+      Per page:
+      <select class="form-control" onchange="setPerPage(this)">
+        <% (Sidekiq::Status::Web.per_page_opts + ['all']).each do |num| %>
+        <option data-url="?<%= qparams(page: 1, per_page: num)%>" value="<%= num %>" <%= 'selected="selected"' if num.to_s == (params[:per_page] || @count) %>><%= num %></option>
+        <% end %>
+      </select>
+    </div>
+  </div>
+</div>
+<table class="table table-hover table-bordered table-striped">
   <tr>
-    <th class="header">Worker/jid</th>
-    <th class="header">Arguments</th>
-    <th class="header">Status</th>
-    <th class="header" style="width: 10%;">Last Updated</th>
-    <th class="header" style="width: 45%;">Progress</th>
+    <% @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">
+      Actions
+    </th>
   </tr>
   <% @statuses.each do |container| %>
     <tr>
       <td>
-        <div title='<%= container.jid %>'><%= container.worker %></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;'>
+      <% 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) %>">
         <% if secs > 0 %>
-          <%= secs %> sec<%= secs == 1 ? '' : 's' %> ago
+          <%= ChronicDuration.output(secs, :weeks => true, :units => 2) %> ago
         <% else %>
           Now
         <% end %>
@@ -49,15 +110,40 @@
       <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 %>%
+          <% if container["pct_complete"].to_i > 0 %>
+            <div class="bar message" style="width: <%= h container["pct_complete"] %>%;">
+              <%= h container["pct_complete"] %>%
             </div>
           <% 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">
+            <input type="hidden" name="jid" value="<%= h container["jid"] %>" />
+            <%= csrf_tag %>
+            <% if container["status"] == "complete" %>
+              <input type="hidden" name="_method" value="delete" />
+              <input type="submit" class="btn btn-danger btn-xs" value="Remove" />
+            <% elsif container["status"] == "failed" %>
+              <input type="hidden" name="_method" value="put" />
+              <input type="submit" class="btn btn-warning btn-xs" value="Retry Now" />
+            <% end %>
+          </form>
+        </div>
+      </td>
     </tr>
   <% end %>
   <% if @statuses.empty? %>
@@ -65,4 +151,4 @@
       <td colspan="6"></td>
     </tr>
   <% end %>
-</table>
+</table>

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 3.0.3
 platform: ruby
 authors:
 - Evgeniy Tsvigun
-autorequire: 
+- Kenaniah Cerny
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -16,14 +17,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -80,31 +129,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - utgarda@gmail.com
+- kenaniah@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
-- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/Gemfile.sidekiq-2
+- gemfiles/sidekiq_6.1.gemfile
+- gemfiles/sidekiq_6.x.gemfile
+- gemfiles/sidekiq_7.x.gemfile
 - lib/sidekiq-status.rb
 - lib/sidekiq-status/client_middleware.rb
+- lib/sidekiq-status/redis_adapter.rb
+- lib/sidekiq-status/redis_client_adapter.rb
 - lib/sidekiq-status/server_middleware.rb
+- lib/sidekiq-status/sidekiq_extensions.rb
 - lib/sidekiq-status/storage.rb
 - lib/sidekiq-status/testing/inline.rb
 - lib/sidekiq-status/version.rb
 - lib/sidekiq-status/web.rb
 - lib/sidekiq-status/worker.rb
 - sidekiq-status.gemspec
+- spec/environment.rb
 - spec/lib/sidekiq-status/client_middleware_spec.rb
 - spec/lib/sidekiq-status/server_middleware_spec.rb
 - spec/lib/sidekiq-status/testing_spec.rb
@@ -113,13 +171,16 @@ files:
 - spec/lib/sidekiq-status_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_jobs.rb
+- web/sidekiq-status-single-web.png
 - web/sidekiq-status-web.png
+- 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
@@ -134,12 +195,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs
 test_files:
+- spec/environment.rb
 - spec/lib/sidekiq-status/client_middleware_spec.rb
 - spec/lib/sidekiq-status/server_middleware_spec.rb
 - spec/lib/sidekiq-status/testing_spec.rb

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - rbx-2
-gemfile:
-  - gemfiles/Gemfile.sidekiq-2
-  - Gemfile
-before_install:
-  - gem update --system
-  - gem update bundler
-services: redis
-matrix:
-  allow_failures:
-    - rvm: rbx-2

data/gemfiles/Gemfile.sidekiq-2

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: '..'
-
-gem 'sidekiq', '~> 2.17'