sidekiq-status 0.5.0 → 3.0.3

data/spec/spec_helper.rb

@@ -1,69 +1,149 @@
 require "rspec"
-
-require 'celluloid'
+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'
 
+# Clears jobs before every test
+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 }
 
-Sidekiq.configure_client do |config|
-  config.client_middleware do |chain|
-    chain.add Sidekiq::Status::ClientMiddleware
+# Configures client middleware
+def client_middleware client_middleware_options = {}
+  Sidekiq.configure_client do |config|
+    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 60, *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 redis_client_thread message_limit, *channels
+  thread = Thread.new {
+    messages = []
+    Sidekiq.redis do |conn|
+      puts "Subscribing to #{channels} for #{message_limit.to_s.bold} messages".cyan if ENV['DEBUG']
+      pubsub = conn.pubsub
+      pubsub.call("SUBSCRIBE", *channels)
+
+      timeouts = 0
+      loop do
+        type, ch, msg = pubsub.next_event(2)
+        next if type == "subscribe"
+        if msg
+          puts "Message received: #{ch} -> #{msg}".white if ENV['DEBUG']
+          messages << msg
+          break if messages.length >= message_limit
+        else
+          # no new message was received in the allocated timeout
+          timeouts += 1
+          break if timeouts >= 30
+        end
+      end
+    end
+    puts "Returing from thread".cyan if ENV['DEBUG']
+    messages
+  }
+  sleep 0.1
+  yield if block_given?
+  thread.join
+end
+
+def branched_redis_thread n, *channels, &block
+  if Sidekiq.major_version < 7
+    redis_thread(n, *channels, &block)
+  else
+    redis_client_thread(n, *channels, &block)
+  end
 end
 
-def capture_status_updates(n, &block)
-  confirmations_thread(n, "status_updates", &block).value
+def capture_status_updates n, &block
+  branched_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'
+
+    # 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
+      config.concurrency = 5
+      config.redis = Sidekiq::RedisConnection.create if Sidekiq.major_version < 7
+      Sidekiq::Status.configure_server_middleware config, server_middleware_options
     end
-    Sidekiq::CLI.instance.run
+
+    # Launch
+    puts "Server starting".yellow if ENV['DEBUG']
+    instance = Sidekiq::CLI.instance
+    instance.parse(['-r', File.expand_path('environment.rb', File.dirname(__FILE__))])
+    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(10) { 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

@@ -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
@@ -34,7 +59,7 @@ end
 class ConfirmationJob < StubJob
   def perform(*args)
     Sidekiq.redis do |conn|
-      conn.publish "job_messages_#{jid}", "while in #perform, status = #{conn.hget jid, :status}"
+      conn.publish "job_messages_#{jid}", "while in #perform, status = #{conn.hget "sidekiq:status:#{jid}", :status}"
     end
   end
 end
@@ -54,13 +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,31 +1,149 @@
-<h3 class="wi">Recent job statuses</h3>
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
+<style>
+.progress {
+  background-color: #C8E1ED;
+}
+.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;
+}
+.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>
 
-
-<table class="table table-striped table-bordered">
+    <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>Worker/jid</th>
-    <th>Status</th>
-    <th>Last Updated ↆ</th>
-    <th>Progress</th>
-    <th>Message</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>
-          <%= container.worker %>
-          <br />
-          <%= container.jid %>
+        <div title='<%= h container["jid"] %>'><a href="<%= root_path %>statuses/<%= h container["jid"] %>"><%= h container["worker"] %></a></div>
+      </td>
+      <td>
+        <div class='args' title='<%= h container["jid"] %>'><%= h container["args"] %></div>
+      </td>
+      <td style='text-align: center;'>
+        <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; white-space: nowrap;' title="<%= Time.at(container["update_time"].to_i) %>">
+        <% if secs > 0 %>
+          <%= ChronicDuration.output(secs, :weeks => true, :units => 2) %> ago
+        <% else %>
+          Now
+        <% end %>
       </td>
-      <td><%= container.status %></td>
-      <td><%= Time.at(container.update_time.to_i) %></td>
       <td>
         <div class="progress progress-striped" style="margin-bottom: 0">
-          <div class="bar" style="width: <%= container.pct_complete %>%; text-shadow: 1px 1px 1px black; background-color: #AD003D;
-color: white;">
-            <%= container.pct_complete %>%
+          <div class='message' style='text-align:right; padding-right:0.5em; background-color: transparent; float:right;'>
+            <%= h container["message"] %>
           </div>
+          <% 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><%= container.message %></td>
+      </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? %>