sidekiq-status 0.7.0 → 0.8.0

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

@@ -21,7 +21,7 @@ describe 'sidekiq status web' do
 
   it 'shows the list of jobs in progress' do
     capture_status_updates(2) do
-      expect(LongJob.perform_async(1)).to eq(job_id)
+      expect(LongJob.perform_async(0.5)).to eq(job_id)
     end
 
     get '/statuses'

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

@@ -13,7 +13,7 @@ describe Sidekiq::Status::Worker do
 
   describe ".expiration" do
     subject { StubJob.new }
-    
+
     it "allows to set/get expiration" do
       expect(subject.expiration).to be_nil
       subject.expiration = :val

data/spec/lib/sidekiq-status_spec.rb

@@ -15,11 +15,12 @@ describe Sidekiq::Status do
 
       start_server do
         expect(capture_status_updates(2) {
-          expect(LongJob.perform_async(1)).to eq(job_id)
+          expect(LongJob.perform_async(0.5)).to eq(job_id)
         }).to eq([job_id]*2)
         expect(Sidekiq::Status.status(job_id)).to eq(:working)
         expect(Sidekiq::Status.working?(job_id)).to be_truthy
         expect(Sidekiq::Status::queued?(job_id)).to be_falsey
+        expect(Sidekiq::Status::retrying?(job_id)).to be_falsey
         expect(Sidekiq::Status::failed?(job_id)).to be_falsey
         expect(Sidekiq::Status::complete?(job_id)).to be_falsey
         expect(Sidekiq::Status::stopped?(job_id)).to be_falsey
@@ -49,9 +50,9 @@ describe Sidekiq::Status do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
 
       start_server do
-        expect(capture_status_updates(3) {
+        expect(capture_status_updates(4) {
           expect(ProgressJob.perform_async).to eq(job_id)
-        }).to eq([job_id]*3)
+        }).to eq([job_id]*4)
       end
       expect(Sidekiq::Status.at(job_id)).to be(100)
       expect(Sidekiq::Status.total(job_id)).to be(500)
@@ -67,7 +68,7 @@ describe Sidekiq::Status do
 
       start_server do
         expect(capture_status_updates(2) {
-          expect(LongJob.perform_async(1)).to eq(job_id)
+          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'
@@ -82,7 +83,7 @@ describe Sidekiq::Status do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
       start_server do
         expect(capture_status_updates(2) {
-          expect(LongJob.perform_async(1)).to eq(job_id)
+          expect(LongJob.perform_async(0.5)).to eq(job_id)
         }).to eq([job_id]*2)
       end
       expect(Sidekiq::Status.delete(job_id)).to eq(1)
@@ -147,13 +148,30 @@ describe Sidekiq::Status do
     end
 
     it "retries failed jobs" do
-      allow(SecureRandom).to receive(:hex).once.and_return(retried_job_id)
+      allow(SecureRandom).to receive(:hex).and_return(retried_job_id)
       start_server do
-        expect(capture_status_updates(5) {
+        expect(capture_status_updates(3) {
           expect(RetriedJob.perform_async()).to eq(retried_job_id)
-        }).to eq([retried_job_id] * 5)
+        }).to eq([retried_job_id] * 3)
+        expect(Sidekiq::Status.status(retried_job_id)).to eq(:retrying)
+        expect(Sidekiq::Status.working?(retried_job_id)).to be_falsey
+        expect(Sidekiq::Status::queued?(retried_job_id)).to be_falsey
+        expect(Sidekiq::Status::retrying?(retried_job_id)).to be_truthy
+        expect(Sidekiq::Status::failed?(retried_job_id)).to be_falsey
+        expect(Sidekiq::Status::complete?(retried_job_id)).to be_falsey
+        expect(Sidekiq::Status::stopped?(retried_job_id)).to be_falsey
+        expect(Sidekiq::Status::interrupted?(retried_job_id)).to be_falsey
+      end
+      expect(Sidekiq::Status.status(retried_job_id)).to eq(:retrying)
+      expect(Sidekiq::Status::retrying?(retried_job_id)).to be_truthy
+
+      # restarting and waiting for the job to complete
+      start_server do
+        expect(capture_status_updates(3) {}).to eq([retried_job_id] * 3)
+        expect(Sidekiq::Status.status(retried_job_id)).to eq(:complete)
+        expect(Sidekiq::Status.complete?(retried_job_id)).to be_truthy
+        expect(Sidekiq::Status::retrying?(retried_job_id)).to be_falsey
       end
-      expect(Sidekiq::Status.status(retried_job_id)).to eq(:complete)
     end
 
     context ":expiration param" do
@@ -166,7 +184,7 @@ describe Sidekiq::Status do
         expect_2_jobs_ttl_covers (Sidekiq::Status::DEFAULT_EXPIRY+1)..expiration_param
       end
 
-      it "allow to overwrite :expiration parameter by .expiration method from worker" do
+      it "allow to overwrite :expiration parameter by #expiration method from worker" do
         overwritten_expiration = expiration_param * 100
         allow_any_instance_of(NoStatusConfirmationJob).to receive(:expiration).
           and_return(overwritten_expiration)
@@ -176,6 +194,16 @@ describe Sidekiq::Status do
         expect_2_jobs_are_done_and_status_eq :complete
         expect_2_jobs_ttl_covers (expiration_param+1)..overwritten_expiration
       end
+
+      it "reads #expiration from a method when defined" do
+        allow(SecureRandom).to receive(:hex).once.and_return(job_id, job_id_1)
+        start_server do
+          expect(StubJob.perform_async).to eq(job_id)
+          expect(ExpiryJob.perform_async).to eq(job_id_1)
+          expect(redis.ttl("sidekiq:status:#{job_id}")).to eq(30 * 60)
+          expect(redis.ttl("sidekiq:status:#{job_id_1}")).to eq(15)
+        end
+      end
     end
 
     def seed_secure_random_with_job_ids
@@ -185,12 +213,12 @@ describe Sidekiq::Status do
 
     def run_2_jobs!
       start_server(:expiration => expiration_param) do
-        expect(capture_status_updates(12) {
+        expect(capture_status_updates(6) {
           expect(StubJob.perform_async).to eq(plain_sidekiq_job_id)
           NoStatusConfirmationJob.perform_async(1)
           expect(StubJob.perform_async).to eq(job_id_1)
           NoStatusConfirmationJob.perform_async(2)
-        }).to match_array([plain_sidekiq_job_id, job_id_1] * 6)
+        }).to match_array([plain_sidekiq_job_id, job_id_1] * 3)
       end
     end
 

data/spec/spec_helper.rb

@@ -1,6 +1,11 @@
 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'
@@ -9,71 +14,98 @@ require 'sidekiq-status'
 RSpec.configure do |config|
   config.before(:each) do
     Sidekiq.redis { |conn| conn.flushall }
+    client_middleware
     sleep 0.05
   end
 end
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
-def client_middleware(client_middleware_options={})
+# Configures client middleware
+def client_middleware client_middleware_options = {}
   Sidekiq.configure_client do |config|
-    config.client_middleware do |chain|
-      chain.add Sidekiq::Status::ClientMiddleware, client_middleware_options
-    end
+    Sidekiq::Status.configure_client_middleware config, client_middleware_options
   end
 end
 
-def confirmations_thread(messages_limit, *channels)
+def redis_thread messages_limit, *channels
+
   parent = Thread.current
   thread = Thread.new {
-    confirmations = []
+    messages = []
     Sidekiq.redis do |conn|
-      conn.subscribe *channels do |on|
+      puts "Subscribing to #{channels} for #{messages_limit.to_s.bold} messages".cyan if ENV['DEBUG']
+      conn.subscribe_with_timeout 30, *channels do |on|
         on.subscribe do |ch, subscriptions|
+          puts "Subscribed to #{ch}".cyan if ENV['DEBUG']
           if subscriptions == channels.size
             sleep 0.1 while parent.status != "sleep"
             parent.run
           end
         end
         on.message do |ch, msg|
-          confirmations << msg
-          conn.unsubscribe if confirmations.length >= messages_limit
+          puts "Message received: #{ch} -> #{msg}".white if ENV['DEBUG']
+          messages << msg
+          conn.unsubscribe if messages.length >= messages_limit
         end
       end
     end
-    confirmations
+    puts "Returing from thread".cyan if ENV['DEBUG']
+    messages
   }
+
   Thread.stop
   yield if block_given?
   thread
+
 end
 
-def capture_status_updates(n, &block)
-  confirmations_thread(n, "status_updates", &block).value
+def capture_status_updates n, &block
+  redis_thread(n, "status_updates", &block).value
 end
 
-def start_server(server_middleware_options={})
+# Configures server middleware and launches a sidekiq server
+def start_server server_middleware_options = {}
+
+  # Creates a process for the Sidekiq server
   pid = Process.fork do
-    $stdout.reopen File::NULL, 'w'
-    $stderr.reopen File::NULL, 'w'
+
+    # Redirect the server's outputs
+    $stdout.reopen File::NULL, 'w' unless ENV['DEBUG']
+    $stderr.reopen File::NULL, 'w' unless ENV['DEBUG']
+
+    # Load and configure server options
     require 'sidekiq/cli'
     Sidekiq.options[:queues] << 'default'
-    Sidekiq.options[:require] = File.expand_path('environment.rb', File.dirname(__FILE__))
+    Sidekiq.options[:require] = File.expand_path 'environment.rb', File.dirname(__FILE__)
     Sidekiq.options[:timeout] = 1
     Sidekiq.options[:concurrency] = 5
+
+    # Add the server middleware
     Sidekiq.configure_server do |config|
       config.redis = Sidekiq::RedisConnection.create
-      config.server_middleware do |chain|
-        chain.add Sidekiq::Status::ServerMiddleware, server_middleware_options
-      end
+      Sidekiq::Status.configure_server_middleware config, server_middleware_options
     end
+
+    # Launch
+    puts "Server starting".yellow if ENV['DEBUG']
     Sidekiq::CLI.instance.run
+
   end
 
+  # Run the client-side code
   yield
-  sleep 0.1
+
+  # Pause to ensure all jobs are picked up & started before TERM is sent
+  sleep 0.2
+
+  # Attempt to shut down the server normally
   Process.kill 'TERM', pid
-  Timeout::timeout(5) { Process.wait pid } rescue Timeout::Error
+  Process.wait pid
+
 ensure
+
+  # Ensure the server is actually dead
   Process.kill 'KILL', pid rescue "OK" # it's OK if the process is gone already
+
 end

data/spec/support/test_jobs.rb

@@ -4,12 +4,18 @@ class StubJob
   include Sidekiq::Worker
   include Sidekiq::Status::Worker
 
-  sidekiq_options 'retry' => 'false'
+  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] || 0.25
@@ -56,6 +62,12 @@ class FailingJob < StubJob
   end
 end
 
+class FailingHardJob < StubJob
+  def perform
+    raise Exception
+  end
+end
+
 class ExitedJob < StubJob
   def perform
     raise SystemExit
@@ -69,11 +81,13 @@ class InterruptedJob < StubJob
 end
 
 class RetriedJob < StubJob
-  sidekiq_options 'retry' => 'true'
+
+  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
         conn.set key, 'tried'
         raise StandardError

data/web/views/status.erb

@@ -14,30 +14,30 @@
 </style>
 
 <h3>
-  Job Status: <%= @status.jid %>
-  <span class='label label-<%= @status.label %>'>
-    <%= @status.status %>
+  Job Status: <%= @status["jid"] %>
+  <span class='label label-<%= @status["label"] %>'>
+    <%= @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-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 %>%
+      <%= @status["pct_complete"].to_i %>%
     </div>
   </div>
 </div>
 
 <div class="panel panel-default">
   <div class="panel-body">
-    <h4><%= @status.worker %></h4>
+    <h4><%= @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>" : @status.args %></p>
+        <p><%= @status["args"].empty? ? "<i>none</i>" : @status["args"] %></p>
       </div>
     </div>
 
@@ -46,7 +46,7 @@
         <strong>Message</strong>
       </div>
       <div class="col-sm-10">
-        <p><%= @status.message || "<i>none</i>" %></p>
+        <p><%= @status["message"] || "<i>none</i>" %></p>
       </div>
     </div>
 
@@ -56,9 +56,9 @@
       </div>
       <div class="col-sm-10">
         <p>
-          <% secs = Time.now.to_i - @status.update_time.to_i %>
+          <% secs = Time.now.to_i - @status["update_time"].to_i %>
           <% if secs > 0 %>
-            <%= secs %> sec<%= secs == 1 ? '' : 's' %> ago
+            <%= ChronicDuration.output(secs, :weeks => true, :units => 2) %> ago
           <% else %>
             Now
           <% end %>

data/web/views/statuses.erb

@@ -1,4 +1,3 @@
-
 <style>
 .progress {
   background-color: #C8E1ED;
@@ -13,19 +12,61 @@
   font-weight: bold; padding-left: 4px;
   color: #333;
 }
-.header{
+.actions {
   text-align: center;
 }
-.header_update_time{
+.header {
+  text-align: center;
+}
+.header_update_time {
   width: 10%;
 }
-.header_pct_complete{
+.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 {
+  display: flex;
+  align-items: center;
+  margin: 20px 0 20px 10px;
+  white-space: nowrap;
+}
+.nav-container .per-page SELECT {
+  margin: 0 0 0 5px;
+}
 </style>
-
-<h3 class="wi">Recent job statuses</h3>
+<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="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 table-white">
   <tr>
     <% @headers.each do |h| %>
@@ -33,20 +74,23 @@
         <a href="<%= h[:url] %>"><%= h[:name] %></a>
       </th>
     <% end %>
+    <th class="header">
+      Actions
+    </th>
   </tr>
   <% @statuses.each do |container| %>
     <tr>
       <td>
-        <div title='<%= container.jid %>'><a href="<%= root_path %>statuses/<%= container.jid %>"><%= container.worker %></a></div>
+        <div title='<%= container["jid"] %>'><a href="<%= root_path %>statuses/<%= container["jid"] %>"><%= container["worker"] %></a></div>
       </td>
       <td>
-        <div class='args' title='<%= container.jid %>'><%= container.args %></div>
+        <div class='args' title='<%= container["jid"] %>'><%= container["args"] %></div>
       </td>
       <td style='text-align: center;'>
-        <div class='label label-<%= container.label %>'><%= container.status %></div>
+        <div class='label label-<%= container["label"] %>'><%= container["status"] %></div>
       </td>
-      <% 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) %>">
+      <% 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 %>
           <%= ChronicDuration.output(secs, :weeks => true, :units => 2) %> ago
         <% else %>
@@ -56,15 +100,30 @@
       <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 %>
+            <%= 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: <%= container["pct_complete"] %>%;">
+              <%= container["pct_complete"] %>%
             </div>
           <% end %>
         </div>
       </td>
+      <td>
+        <div class="actions">
+          <form action="statuses" method="post">
+            <input type="hidden" name="jid" value="<%= 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? %>