sidekiq-hierarchy 0.1.1

data/sidekiq-hierarchy.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/hierarchy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-hierarchy"
+  spec.version       = Sidekiq::Hierarchy::VERSION
+  spec.authors       = ["Anuj Das"]
+  spec.email         = ["anujdas@gmail.com"]
+
+  spec.summary       = %q{A set of sidekiq middlewares to track workflows consisting of multiple levels of sidekiq jobs}
+  spec.description   = %q{A set of sidekiq middlewares to track workflows consisting of multiple levels of sidekiq jobs}
+  spec.homepage      = 'https://www.github.com/anujdas/sidekiq-hierarchy'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sidekiq', '~> 3.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'fakeredis'
+  spec.add_development_dependency 'rspec-sidekiq'
+
+  spec.add_development_dependency 'faraday'
+  spec.add_development_dependency 'rack'
+end

data/web/views/_job_progress_bar.erb

@@ -0,0 +1,28 @@
+<% status = job.status %>
+<% enqueued_at = job.enqueued_at %>
+<% run_at = job.run_at %>
+
+<% if status == :enqueued %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, 1.0]]} %>
+
+<% elsif status == :requeued %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:requeued, 1.0]]} %>
+
+<% elsif status == :running %>
+  <% runtime = Time.now - enqueued_at %>
+  <% enqueued_pct = (run_at - enqueued_at) / runtime %>
+  <% run_pct = 1.0 - enqueued_pct %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, enqueued_pct], [:running, run_pct]], active: true} %>
+
+<% elsif status == :complete %>
+  <% runtime = job.complete_at - enqueued_at %>
+  <% enqueued_pct = (run_at - enqueued_at) / runtime %>
+  <% run_pct = 1.0 - enqueued_pct %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, enqueued_pct], [:complete, run_pct]]} %>
+
+<% elsif status == :failed %>
+  <% runtime = job.failed_at - enqueued_at %>
+  <% enqueued_pct = (run_at - enqueued_at) / runtime %>
+  <% failed_pct = 1.0 - enqueued_pct %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, enqueued_pct], [:failed, failed_pct]]} %>
+<% end %>

data/web/views/_job_table.erb

@@ -0,0 +1,37 @@
+<table class="table table-hover table-bordered table-striped table-white">
+  <thead>
+    <tr>
+      <th>JID</th>
+      <th>Class</th>
+      <th>Queue</th>
+      <th>Status</th>
+      <th>Enqueued at</th>
+      <th>Run at</th>
+      <th>Completed at</th>
+      <th>Failed at</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% jobs.each do |job| %>
+      <tr>
+        <td>
+          <a href="<%= job_url(job) %>">
+            <%= job.jid %>
+          </a>
+        </td>
+        <td><%= job.info['class'] %></td>
+        <td><%= job.info['queue'] %></td>
+        <td>
+          <span class="label label-<%= bootstrap_status(job.status) %>">
+            <%= job.status %>
+          </span>
+        </td>
+        <td><%= job.enqueued_at %></td>
+        <td><%= job.run_at %></td>
+        <td><%= job.complete_at %></td>
+        <td><%= job.failed_at %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/web/views/_job_timings.erb

@@ -0,0 +1,10 @@
+<% if run_at = job.run_at %>
+  <dl class="dl-horizontal">
+      <dt>Enqueued for</dt>
+      <dd><%= run_at - job.enqueued_at %> seconds</dd>
+      <% if run_at && finished_at = (job.complete_at || job.failed_at) %>
+        <dt>Ran for</dt>
+        <dd><%= finished_at - run_at %> seconds</dd>
+      <% end %>
+  </dl>
+<% end %>

data/web/views/_progress_bar.erb

@@ -0,0 +1,8 @@
+<%# input: local var 'bars', in the format [[status, width], ...]; local var 'active', true == moving bar %>
+<div class="progress<%= ' progress-striped active' if !!locals[:active] %>">
+  <% bars.each do |status, width| %>
+    <div class="progress-bar progress-bar-<%= bootstrap_status(status) %>" style="width: <%= width * 100 %>%">
+      <%= status.to_s.capitalize %>
+    </div>
+  <% end %>
+</div>

data/web/views/_search_bar.erb

@@ -0,0 +1,17 @@
+<div class="row col-sm-12" style="margin: 20px 0">
+  <form class="form-inline col-sm-6" action="<%= workflow_url %>" method="get">
+    <div class="form-group">
+      <label for="workflow_jid" class="sr-only">Workflow ID</label>
+      <input type="search" class="form-control" name="workflow_jid" placeholder="Enter Workflow ID" size="24">
+    </div>
+    <button type="submit" class="btn btn-default">Search workflows</button>
+  </form>
+
+  <form class="form-inline col-sm-6" action="<%= job_url %>" method="get">
+    <div class="form-group">
+      <label for="jid" class="sr-only">Job ID</label>
+      <input type="search" class="form-control" name="jid" placeholder="Enter Job ID" size="24">
+    </div>
+    <button type="submit" class="btn btn-default">Search jobs</button>
+  </form>
+</div>

data/web/views/_summary_bar.erb

@@ -0,0 +1,30 @@
+<div class="col-sm-12 summary_bar">
+  <ul class="list-unstyled summary row">
+    <li class="busy col-sm-4" style="width: 33%">
+      <a href="<%= workflow_set_url(:running) %>">
+        <span class="count">
+          <%= Sidekiq::Hierarchy::RunningSet.new.size %>
+        </span>
+        <span class="desc">Running</span>
+      </a>
+    </li>
+
+    <li class="processed col-sm-4" style="width: 33%">
+      <a href="<%= workflow_set_url(:complete) %>">
+        <span class="count">
+          <%= Sidekiq::Hierarchy::CompleteSet.new.size %>
+        </span>
+        <span class="desc">Complete</span>
+      </a>
+    </li>
+
+    <li class="dead col-sm-4" style="width: 33%">
+      <a href="<%= workflow_set_url(:failed) %>">
+        <span class="count">
+          <%= Sidekiq::Hierarchy::FailedSet.new.size %>
+        </span>
+        <span class="desc">Failed</span>
+      </a>
+    </li>
+  </ul>
+</div>

data/web/views/_workflow_progress_bar.erb

@@ -0,0 +1,24 @@
+<% enqueued_at = workflow.enqueued_at %>
+<% run_at = workflow.run_at %>
+
+<% if workflow.root.enqueued? %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, 1.0]]} %>
+
+<% elsif workflow.running? %>
+  <% runtime = Time.now - enqueued_at %>
+  <% enqueued_pct = (run_at - enqueued_at) / runtime %>
+  <% run_pct = 1.0 - enqueued_pct %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, enqueued_pct], [:running, run_pct]], active: true} %>
+
+<% elsif complete_at = workflow.complete_at %>
+  <% runtime = complete_at - enqueued_at %>
+  <% enqueued_pct = (run_at - enqueued_at) / runtime %>
+  <% run_pct = 1.0 - enqueued_pct %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, enqueued_pct], [:complete, run_pct]]} %>
+
+<% elsif failed_at = workflow.failed_at %>
+  <% runtime = failed_at - enqueued_at %>
+  <% enqueued_pct = (run_at - enqueued_at) / runtime %>
+  <% failed_pct = 1.0 - enqueued_pct %>
+  <%= erb sidekiq_hierarchy_template(:_progress_bar), locals: {bars: [[:enqueued, enqueued_pct], [:failed, failed_pct]]} %>
+<% end %>

data/web/views/_workflow_set_clear.erb

@@ -0,0 +1,7 @@
+<form action="<%= workflow_set_url(status) %>" method="post">
+  <div style="margin:0;padding:0">
+    <input name="_method" type="hidden" value="delete" />
+    <input name="authenticity_token" type="hidden" value="<%= session[:csrf] %>">
+  </div>
+  <button type="submit" class="btn btn-sm btn-danger" onclick="return confirm('Are you sure? This is irreversible and potentially very expensive')">Clear Set</button>
+</form>

data/web/views/_workflow_table.erb

@@ -0,0 +1,33 @@
+<div class="table_container">
+  <table class="table table-hover table-bordered table-striped table-white">
+    <thead>
+      <tr>
+        <th>Workflow ID</th>
+        <th>Status</th>
+        <th>Enqueued at</th>
+        <th>Run at</th>
+        <th>Completed at</th>
+        <th>Failed at</th>
+        <th>Jobs</th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% workflows.each do |workflow| %>
+        <tr>
+          <td>
+            <a href="<%= workflow_url(workflow) %>">
+              <%= workflow.jid %>
+            </a>
+          </td>
+          <td><%= workflow.status %></td>
+          <td><%= workflow.enqueued_at %></td>
+          <td><%= workflow.run_at %></td>
+          <td><%= workflow.complete_at %></td>
+          <td><%= workflow.failed_at %></td>
+          <td><%= workflow.jobs.count %></td>
+        </tr>
+      <% end%>
+    </tbody>
+  </table>
+</div>

data/web/views/_workflow_timings.erb

@@ -0,0 +1,14 @@
+<% if run_at = workflow.run_at %>
+  <dl class="dl-horizontal">
+    <% if workflow.complete? %>
+      <dt>Ran for</dt>
+      <dd><%= workflow.complete_at - run_at %> seconds</dd>
+    <% elsif workflow.failed? %>
+      <dt>Failed in</dt>
+      <dd><%= workflow.failed_at - run_at %> seconds</dd>
+    <% else %>
+      <dt>Running for</dt>
+      <dd><%= Time.now - run_at %> seconds</dd>
+    <% end %>
+  </dl>
+<% end %>

data/web/views/_workflow_tree.erb

@@ -0,0 +1,82 @@
+<style>
+  /* Lifted from http://www.cssscript.com/demo/minimalist-tree-view-in-pure-css */
+  /* Alternative styling: http://www.goocode.net/css/153-pure-css-to-create-family-tree.html */
+
+  ul.workflow_tree  {
+    padding-left: 0px;
+  }
+
+  .workflow_tree li {
+    list-style-type: none;
+    margin: 10px;
+    position: relative;
+  }
+
+  .workflow_tree li::before {
+    content: "";
+    position: absolute;
+    top: -7px;
+    left: -20px;
+    border-left: 1px solid #ccc;
+    border-bottom: 1px solid #ccc;
+    border-radius: 0 0 0 0px;
+    width: 20px;
+    height: 15px;
+  }
+
+  .workflow_tree li::after {
+    position: absolute;
+    content: "";
+    top: 8px;
+    left: -20px;
+    border-left: 1px solid #ccc;
+    border-top: 1px solid #ccc;
+    border-radius: 0px 0 0 0;
+    width: 20px;
+    height: 100%;
+  }
+
+  .workflow_tree li:last-child::after  {
+    display: none;
+  }
+
+  .workflow_tree li:last-child:before{
+    border-radius: 0 0 0 5px;
+  }
+
+  ul.workflow_tree > li:first-child::before {
+    display: none;
+  }
+
+  ul.workflow_tree > li:first-child::after {
+    border-radius: 5px 0 0 0;
+  }
+
+  .workflow_tree li a {
+    border-radius: 5px;
+    padding: 2px 5px;
+  }
+
+  .workflow_tree li a:hover, .workflow_tree li a:focus {
+    background: #ccc;
+    color: #000;
+    text-decoration: none;
+  }
+
+  .workflow_tree li a:hover+ul li a, .workflow_tree li a:focus+ul li a {
+    color: #000;
+  }
+
+  .workflow_tree li a:hover+ul li::after, .workflow_tree li a:focus+ul li::after,
+  .workflow_tree li a:hover+ul li::before, .workflow_tree li a:focus+ul li::before 
+  .workflow_tree li a:hover+ul::before, .workflow_tree li a:focus+ul::before 
+  .workflow_tree li a:hover+ul ul::before, .workflow_tree li a:focus+ul ul::before{
+    border-color: #000;
+  }
+</style>
+
+<ul class="workflow_tree">
+  <% unless root.root? %><ul><% end %>
+    <%= erb sidekiq_hierarchy_template(:_workflow_tree_node), locals: {job: root} %>
+  <% unless root.root? %></ul><% end %>
+</ul>

data/web/views/_workflow_tree_node.erb

@@ -0,0 +1,18 @@
+<li>
+  <a href="<%= root_path %>hierarchy/jobs/<%= job.jid %>">
+    <span title="<%= job.jid %>">
+      <%= job.info['class'] %>
+    </span>
+    (<%= job.info['queue'] %>)
+    <span class="label label-<%= bootstrap_status(job.status) %>">
+      <%= job.status %> <%= relative_time(status_updated_at(job)) %>
+    </span>
+  </a>
+  <% unless job.leaf? %>
+    <ul>
+      <% job.children.each do |child| %>
+        <%= erb sidekiq_hierarchy_template(:_workflow_tree_node), locals: {job: child} %>
+      <% end %>
+    </ul>
+  <% end %>
+</li>

data/web/views/job.erb

@@ -0,0 +1,12 @@
+<a href="<%= workflow_url(@workflow) %>">
+  <h3>Workflow <%= @workflow.jid %></h3>
+</a>
+<h4>Job <%= @job.jid %></h4>
+
+<%= erb sidekiq_hierarchy_template(:_job_progress_bar), locals: {job: @job} %>
+
+<%= erb sidekiq_hierarchy_template(:_job_table), locals: {jobs: [@job]} %>
+<%= erb sidekiq_hierarchy_template(:_job_timings), locals: {job: @job} %>
+
+<h4>Job Tree</h4>
+<%= erb sidekiq_hierarchy_template(:_workflow_tree), locals: {root: @job} %>

data/web/views/not_found.erb

@@ -0,0 +1 @@
+<h2>404 NOT FOUND</h2>

data/web/views/status.erb

@@ -0,0 +1,120 @@
+<h3>Sidekiq Hierarchy</h3>
+
+<%= erb sidekiq_hierarchy_template(:_summary_bar) %>
+<%= erb sidekiq_hierarchy_template(:_search_bar) %>
+
+<div class="panel panel-info">
+  <div class="panel-heading">
+    <a href="<%= workflow_set_url(:running) %>">
+      <h4>Running Workflows</h4>
+    </a>
+  </div>
+
+  <div class="panel-body">
+    <div class="table_container">
+      <table class="table table-hover table-bordered table-striped table-white">
+        <thead>
+          <tr>
+            <th>Workflow ID</th>
+            <th>Enqueued at</th>
+            <th>Run at</th>
+          </tr>
+        </thead>
+
+        <tbody>
+          <% @running.each do |workflow| %>
+            <tr>
+              <td>
+                <a href="<%= workflow_url(workflow) %>">
+                  <%= workflow.jid %>
+                </a>
+              </td>
+              <td><%= relative_time(workflow.enqueued_at) %></td>
+              <td><%= relative_time(workflow.run_at) if workflow.run_at %></td>
+            </tr>
+          <% end%>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>
+
+<div class="panel panel-success">
+  <div class="panel-heading">
+    <a href="<%= workflow_set_url(:complete) %>">
+      <h4>Complete Workflows</h4>
+    </a>
+  </div>
+
+  <div class="panel-body">
+    <div class="table_container">
+      <table class="table table-hover table-bordered table-striped table-white">
+        <thead>
+          <tr>
+            <th>Workflow ID</th>
+            <th>Enqueued at</th>
+            <th>Run at</th>
+            <th>Completed at</th>
+          </tr>
+        </thead>
+
+        <tbody>
+          <% @complete.each do |workflow| %>
+            <tr>
+              <td>
+                <a href="<%= workflow_url(workflow) %>">
+                  <%= workflow.jid %>
+                </a>
+              </td>
+              <td><%= relative_time(workflow.enqueued_at) %></td>
+              <td><%= relative_time(workflow.run_at) %></td>
+              <td><%= relative_time(workflow.complete_at) %></td>
+            </tr>
+          <% end%>
+        </tbody>
+      </table>
+    </div>
+
+    <%= erb sidekiq_hierarchy_template(:_workflow_set_clear), locals: {status: :complete} %>
+  </div>
+</div>
+
+<div class="panel panel-danger">
+  <div class="panel-heading">
+    <a href="<%= workflow_set_url(:failed) %>">
+      <h4>Failed Workflows</h4>
+    </a>
+  </div>
+
+  <div class="panel-body">
+    <div class="table_container">
+      <table class="table table-hover table-bordered table-striped table-white">
+        <thead>
+          <tr>
+            <th>Workflow ID</th>
+            <th>Enqueued at</th>
+            <th>Run at</th>
+            <th>Failed at</th>
+          </tr>
+        </thead>
+
+        <tbody>
+          <% @failed.each do |workflow| %>
+            <tr>
+              <td>
+                <a href="<%= workflow_url(workflow) %>">
+                  <%= workflow.jid %>
+                </a>
+              </td>
+              <td><%= relative_time(workflow.enqueued_at) %></td>
+              <td><%= relative_time(workflow.run_at) %></td>
+              <td><%= relative_time(workflow.failed_at) %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+
+    <%= erb sidekiq_hierarchy_template(:_workflow_set_clear), locals: {status: :failed} %>
+  </div>
+</div>