qless 0.9.1 → 0.9.2

data/lib/qless/server/views/_job_list.erb

@@ -0,0 +1,8 @@
+<%= erb :_pagination, :layout => false %>
+
+<% jobs.each do |job| %>
+<%= erb :_job, :layout => false, :locals => { :job => job, :queues => queues } %>
+<% end %>
+
+<%= erb :_pagination, :layout => false %>
+

data/lib/qless/server/views/_pagination.erb

@@ -0,0 +1,7 @@
+<div class="pagination">
+  <ul>
+    <li><a href="<%= prev_page_url %>">Prev</a></li>
+    <li><a href="<%= next_page_url %>">Next</a></li>
+  </ul>
+</div>
+

data/lib/qless/server/views/about.erb

@@ -0,0 +1,130 @@
+<div class="subnav subnav-fixed">
+  <ul class="nav nav-pills">
+    <li><a href="#philosophy">Philosophy</a></li>
+    <li><a href="#features">Features</a></li>
+    <li><a href="#benchmarks">Benchmarks</a></li>
+  </ul>
+</div>
+
+<header class="jumbotron subhead" style="margin-top: 40px">
+  <h1>Qless <small>In 50 words or less</small></h1>
+  <p class="lead">Qless is a <a href="http://redis.io/">Redis</a>-backed, robust, language-agnostic job queueing system.
+    It is a collection of <a href="http://github.com/seomoz/qless-core">Lua scripts</a> that run on a Redis server,
+    as well as this web app). <a href="http://github.com/seomoz/qless">Qless</a> is open-sourced under the MIT license
+    and currently has bindings for <a href="http://github.com/seomoz/qless">Ruby</a>, <a href="http://github.com/seomoz/qless-py">Python</a>
+    with C++ and Node.js support coming soon.</p>
+</header>
+
+<section id="philosophy">
+  <div class="page-header">
+    <h1>Philosophy <small>and nomenclature</h1>
+  </div>
+  <div class="row">
+    <div class="span12">
+      <p class="lead">A job is a unit of work. A queue can contain several jobs that are scheduled to be run at a certain time, several jobs that are waiting to run, and jobs that are currently running. A worker is a process on a host, identified uniquely, that asks for jobs from the queue, performs some process associated with that job, and then marks it as complete. When it's completed, it can be put into another queue.</p>
+      <p class="lead">Jobs can only be in one queue at a time. That queue is whatever queue they were last put in. So if a worker is working on a job, and you move it, the worker's request to complete the job will be ignored.</p>
+      <p class="lead">A job can be canceled, which means it disappears into the ether, and we'll never pay it any mind ever again. A job can be dropped, which is when a worker fails to heartbeat or complete the job in a timely fashion, or a job can be failed, which is when a host recognizes some systematically problematic state about the job. A worker should only fail a job if the error is likely not a transient one; otherwise, that worker should just drop it and let the system reclaim it.</p>
+    </div>
+  </div>
+</section>
+
+<section id="features">
+  <div class="page-header">
+    <h1>Features <small>In no particular order</small></h1>
+  </div>
+  <div class="row">
+    <div class="span12">
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Jobs don't get dropped on the floor</h3>
+        </div>
+        <div class="span6">
+          <h3><small>even in the face of the flakiest workers</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Jobs are stored temporarily</h3>
+        </div>
+        <div class="span6">
+          <h3><small>but automatically expire after a configurable amount of time</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Tagging and Tracking</h3>
+        </div>
+        <div class="span6">
+          <h3><small>for keeping tabs on important jobs</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">High Performance</h3>
+        </div>
+        <div class="span6">
+          <h3><small>thanks to Redis and Lua</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Scheduled Work</h3>
+        </div>
+        <div class="span6">
+          <h3><small>for delayed or periodic processing</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Retry Logic</h3>
+        </div>
+        <div class="span6">
+          <h3><small>for jobs that have been dropped on the floor</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Web App</h3>
+        </div>
+        <div class="span6">
+          <h3><small>for checking up on progress and monitoring</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Priority</h3>
+        </div>
+        <div class="span6">
+          <h3><small>for jobs means you can put selected jobs before others</small></h3>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="span6">
+          <h3 style="text-align:right">Stats</h3>
+        </div>
+        <div class="span6">
+          <h3><small>about how long jobs wait, how long they take to process</small></h3>
+        </div>
+      </div>
+    </div>
+  </div>
+</section>
+
+<section id="benchmarks">
+  <div class="page-header">
+    <h1>Benchmarks <small>In Amazon's EC2</small></h1>
+  </div>
+  <div class="row">
+    <div class="span12">
+      <p class="lead">These benchmarks were performed on a <span class="badge badge-info">m1.medium</span>, which has 3.75GB of RAM and 2 ECUs. Actually, I'm going to wait until development's a little more complete before posting these.</p>
+    </div>
+  </div>
+</section>

data/lib/qless/server/views/config.erb

@@ -0,0 +1,14 @@
+<div class="page-header">
+  <h1>Configuration Settings <small>Including defaults</small></h1>
+</div>
+
+<% options.each do |key, value| %>
+<div class="row">
+  <div class="span4">
+    <h2><%= key %></h2>
+  </div>
+  <div class="span8">
+    <h2>=> <%= value %></h2>
+  </div>
+</div>
+<% end %>

data/lib/qless/server/views/failed.erb

@@ -0,0 +1,48 @@
+<div class="subnav subnav-fixed">
+  <ul class="nav nav-pills">
+    <% failed.sort_by { |f| -f['total'] }.each do |f| %>
+    <li><a href="#<%= sanitize_attr(f['type']) %>" data-toggle="tab"><%= f['type'] %> (<%= f['total'] %>)</a></li>
+    <% end %>
+  </ul>
+</div>
+
+<div id="alerts" style="margin-top: 40px"></div>
+
+<% if failed.empty? %>
+  <div class="page-header">
+    <h1>No Failed Jobs <small>You Have Done Well!</small></h1>
+  </div>
+<% else %>
+  <div class="page-header">
+    <h1>Failed Jobs <small>Failure is a Part of Success!</small></h1>
+  </div>
+<% end %>
+
+<div class="tab-content">
+  <% failed.sort_by { |f| -f['total'] }.each do |f| %>
+  <div class="tab-pane active" id="<%= sanitize_attr(f['type']) %>">
+    <div class="page-header">
+      <div class="row">
+        <div class="span8">
+          <h2>
+            <a href="<%= u "/failed/#{f['type']}" %>"><%= f['type'] %></a> | <%= f['total'] %> <small>Jobs</small
+          </h2>
+        </div>
+        <div class="span4">
+          <div class="btn-group" style="float:right; margin-top: 5px">
+            <button class="btn btn-danger" title="cancel" onclick="confirmation(this, 'Cancel?', function() { cancelall('<%= f['type'] %>', fade) })"><i class="icon-remove"></i></button>
+            <button class="btn btn-success" title="retry all" onclick="retryall('<%= f['type'] %>', fade)"><i class="icon-repeat"></i></button>
+          </div>
+        </div>
+      </div>
+    </div>
+    <div class="row">
+      <div class="span12">
+        <% f['jobs'][0..5].each do |job| %>
+        <%= erb :_job, :layout => false, :locals => { :job => job, :queues => queues, :brief => true } %>
+        <% end %>
+      </div>
+    </div>
+  </div>
+  <% end %>
+</div>

data/lib/qless/server/views/failed_type.erb

@@ -0,0 +1,18 @@
+<div id="alerts"></div>
+
+<div class="page-header">
+  <div class="row">
+    <div class="span8">
+      <h2>Type '<%= type %>' Failed Jobs <small>These jobs are all failed :-/</small></h2>
+    </div>
+    <div class="span4">
+      <div class="btn-group" style="float:right; margin-top: 5px">
+        <button class="btn btn-danger" title="cancel" onclick="confirmation(this, 'Cancel?', function() { cancelall('<%= type %>', fade) })"><i class="icon-remove"></i></button>
+        <button class="btn btn-success" title="retry all" onclick="retryall('<%= type %>', fade)"><i class="icon-repeat"></i></button>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%= erb :_job_list, :locals => { :jobs => failed.fetch('jobs'), :queues => queues } %>
+

data/lib/qless/server/views/job.erb

@@ -0,0 +1,17 @@
+<script>
+var fade = function(jid, type) {
+  if (type == 'cancel') {
+    $('#job-' + jid).slideUp();
+  }
+}
+</script>
+
+<% if job.nil? %>
+  <div class="row">
+    <div class="span12">
+      <h2><%= jid %> doesn't exist, was canceled, or expired</h2>
+    </div>
+  </div>
+<% else %>
+  <%= erb :_job, :layout => false, :locals => { :job => job, :queues => queues } %>
+<% end %>

data/lib/qless/server/views/layout.erb

@@ -0,0 +1,341 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title><%= application_name %><%= (title.length == 0) ? '' : (' | ' + title) %></title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="">
+    <meta name="author" content="Dan Lecocq">
+
+    <link href="<%= u '/css/bootstrap.css' %>" rel="stylesheet">
+    <link href="<%= u '/css/bootstrap-responsive.css' %>" rel="stylesheet">
+    <link href="<%= u '/css/docs.css' %>" rel="stylesheet">
+    <link href="<%= u '/css/jquery.noty.css' %>" rel="stylesheet">
+    <link href="<%= u '/css/noty_theme_twitter.css' %>" rel="stylesheet">
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js" type="text/javascript"></script>
+
+    <style type="text/css">
+    body {
+      padding-top: 60px;
+    }
+    
+    .btn-group span {
+      /* This is ugly. Anyone want to change it? */
+      border-color: #e6e6e6 #e6e6e6 #bfbfbf;
+      border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
+      border: 1px solid #cccccc;
+      border-bottom-color: #b3b3b3;
+      background-color: #f5f5f5;
+      font-size: 13px;
+      line-height: 18px;
+      padding: 4px 10px 4px;
+    }
+    
+	 .btn-group input, .btn-group span {
+      position: relative;
+      float: left;
+      margin-left: -1px;
+      -webkit-border-radius: 0;
+      -moz-border-radius: 0;
+      border-radius: 0;
+      margin-bottom: 0px;
+	  }
+    
+    .btn-group input:first-child, .btn-group span:first-child {
+      margin-left: 0;
+      -webkit-border-top-left-radius: 4px;
+      -moz-border-radius-topleft: 4px;
+      border-top-left-radius: 4px;
+      -webkit-border-bottom-left-radius: 4px;
+      -moz-border-radius-bottomleft: 4px;
+      border-bottom-left-radius: 4px;
+    }
+    </style>
+
+    <script type="text/javascript">
+    /* This is a helper method to display an alert at the top of the page,
+     * in a vein similar to that of Ruby's flash */
+    var flash = function(message, t, duration) {
+      var noty_id = noty({
+        text   : '<strong>' + message + '</strong>',
+        layout : 'top',
+        type   : t || 'error',
+        theme  : 'noty_theme_twitter',
+        timeout: duration || 1500});
+    }
+
+    /* This just sets a few options that we use */
+    var _ajax = function(obj) {
+      $.ajax({
+        url: obj.url,
+        type: 'POST',
+        dataType: 'json',
+        data: JSON.stringify(obj.data),
+        processData: false,
+        success: obj.success || function() {},
+        error: obj.error || function() {}
+      });
+    }
+
+    /* This is a helper method to move a job into a queue, and then it will
+     * flash a message to that effect on the page */
+    var move = function(jid, queue, cb) {
+      _ajax({
+        url: '<%= u "/move" %>',
+        data: {id:jid, queue:queue},
+        success: function() { flash('Moved ' + jid + ' to ' + queue, 'success', 1500); cb(jid, queue); },
+        erorr:   function() { flash('Failed to move ' + jid + ' to ' + queue); }
+      });
+    }
+
+    /* Helper function for retrying a job */
+    var retry = function(jid, cb) {
+      _ajax({
+        url: '<%= u "/retry" %>',
+        data: {id:jid},
+        success: function() { flash('Retrying ' + jid, 'success', 1500); if (cb) { cb(jid, 'retry'); } },
+        erorr:   function() { flash('Failed to retry ' + jid); }
+      });
+    }
+
+    /* This is a helper method to cancel a job */
+    var cancel = function(jid, cb) {
+      _ajax({
+        url: '<%= u "/cancel" %>',
+        data: [jid],
+        success: function() { flash('Canceled ' + jid, null, 1500); if (cb) { cb(jid, 'cancel'); } },
+        error:   function() { flash('Failed to cancel ' + jid); }
+      });
+    }
+
+    /* This is a helper method to untrack a job */
+    var untrack = function(jid, cb) {
+      _ajax({
+        url: '<%= u "/untrack" %>',
+        data: [jid],
+        success: function() { flash('Stopped tracking ' + jid, 'success', 1500); if (cb) { cb(jid, 'untrack'); }  },
+        error:   function() { flash('Failed to track ' + jid); }
+      });
+    }
+
+    /* This is a helper to start tracking a job, with tags */
+    var track = function(jid, tags, cb) {
+      _ajax({
+        url: '<%= u "/track" %>',
+        data: {id:jid, tags:(tags || [])},
+        success: function() { flash('Now tracking ' + jid, 'success', 1500); if (cb) { cb(jid, 'track'); }  },
+        error:   function() { flash('Failed to track ' + jid); }
+      });
+    }
+
+    /* This is a helper to retry all jobs of a certain failure type */
+    var retryall = function(type, cb) {
+      _ajax({
+        url: '<%= u "/retryall" %>',
+        data: {type: type},
+        success: function(response) {
+          flash('Retrying failures of type ' + type, 'success', 1500);
+          if (cb) {
+            for (var i in response) {
+              cb(response[i].id);
+            }
+          }
+        },
+        error:   function() { flash('Failed to retry failures of type ' + type); }
+      });
+    }
+
+    /* This is a helper to cancel all jobs of a certain failure type */
+    var cancelall = function(type, cb) {
+      _ajax({
+        url: '<%= u "/cancelall" %>',
+        data: {type: type},
+        success: function(response) {
+          flash('Canceling failures of type ' + type, 'success', 1500);
+          if (cb) {
+            for (var i in response) {
+              cb(response[i].id);
+            }
+          }
+        },
+        error:   function() { flash('Failed to cancel failures of type ' + type); }
+      });
+    }
+
+    /* This is a helper to remove job dependencies */
+    var undepend = function(jid, dependency, cb) {
+      _ajax({
+        url: '<%= u "/undepend" %>',
+        data: {id:jid, dependency:dependency},
+        success: function() { flash(jid + ' no longer depends on ' + dependency, 'success', 1500); if (cb) { cb(jid, 'undepend'); }  },
+        error:   function() { flash('Failed to remove ' + jid + '\'s dependency on ' + dependency); }
+      });
+    }
+
+    /* Helper function to fade out a particular element id */
+    var fade = function(jid, type) {
+      if (type != 'untrack' && type != 'track') {
+        $('#job-' + jid).slideUp();
+      }
+    }
+
+    /* Helper function to make a button ask for confirmation
+     * after being pressed once. Accepts the confirmation text,
+     * and the function to execute after it has been run */
+    var confirmation = function(button, html, action, delay) {
+      var obj      = $(button);
+      var original = obj.html();
+      var timeout  = setTimeout(function() {
+        obj.html(original).unbind('click').click(function() {
+          confirmation(button, html, action, delay);
+        });
+      }, delay || 3000);
+      obj.removeAttr('onclick').html(html).unbind('click').click(function() {
+        clearTimeout(timeout);
+        obj.html(original).unbind('click').click(function() {
+          confirmation(button, html, action, delay);
+        });
+        action();
+      });
+    }
+    
+    /* Helper function for adding a tag to a job */
+    var tag = function(jid, tag) {
+      var data  = {};
+      data[jid] = [tag];
+      // The button group of the 'add tag' bit
+      var group = 
+      _ajax({
+        url: '<%= u "/tag" %>',
+        data: data,
+        success : function() {
+          var div  = $('<div>').attr('class', 'btn-group').attr('style', 'float:left');
+          var span = $('<span>').attr('class', 'tag').text(tag);
+          var btn  = $('<button>').attr('class', 'btn').click(function() {
+            untag(jid, tag);
+          });
+          btn.append($('<i>').attr('class', 'icon-remove'));
+          div.append(span).append(btn);
+          $('#job-' + jid).find('.add-tag').val(null).parent().before(div);
+        }, error: function() {
+          flash('Failed to tag ' + jid + ' with ' + tag);
+        }
+      });
+    }
+    
+    /* Helper function for untagging a job */
+    var untag = function(jid, tag) {
+      var data  = {};
+      data[jid] = [tag];
+      // The button group of the 'add tag' bit
+      var group = 
+      _ajax({
+        url: '<%= u "/untag" %>',
+        data: data,
+        success : function() {
+          $("#job-" + jid).find('.tag').filter(function() {
+            return $(this).text() === tag;
+          }).parent().remove();
+        }, error: function() {
+          flash('Failed to untag ' + jid + ' with ' + tag);
+        }
+      });
+    }
+    
+    /* Helper function for changing a job's priority */
+    var priority = function(jid, priority) {
+      var p     = parseInt(priority);
+      var input = $('#job-' + jid).find('.priority');
+      if (p != null) {
+        input.attr('disabled', true);
+        var data = {};
+        data[jid] = priority;
+        _ajax({
+          url: '<%= u "/priority" %>',
+          data: data,
+          success : function(data) {
+            if (data[jid] != 'failed' && data[jid] != null) {
+              input.attr('disabled', false).attr('placeholder', 'Pri ' + priority).val(null).blur();
+            } else {
+              flash('Couldn\'t reprioritize ' + jid);
+              input.val(null).blur();
+            }
+          }, error: function() {
+            flash('Couldn\'t reprioritize ' + jid);
+            input.val(null).blur();
+          }
+        });
+      } else {
+        // Reset it to its original value, and print an error
+        flash('Cannot derive integer from "' + priority + '"');
+        input.val(null).blur();
+      }
+    }
+
+    $(document).ready(function() {
+      $('button').tooltip({delay:200});
+    });
+    </script>
+    <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+    <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+
+  <body>
+    <div class="navbar navbar-fixed-top">
+      <div class="navbar-inner">
+        <div class="container">
+          <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+          </a>
+          <a class="brand" href="<%= u '/' %>"><%= application_name %></a>
+          <div class="nav-collapse">
+            <ul class="nav nav-bar">
+            <% tabs.each do |tab| %>
+              <li><a href='<%= u tab[:path] %>'><%= tab[:name] %></a></li>
+            <% end %>
+            </ul>
+            <ul class="nav nav-bar pull-right">
+              <li>
+                <form class="navbar-search" action="<%= u '/tag' %>">
+                  <input id="tag-search" type="text" class="search-query" placeholder="Search by Tag" data-provide="typeahead" name="tag"/>
+                </form>
+              </li>
+            </ul>
+          </div>
+        </div>
+      </div>
+    </div>
+
+      <div class="container">
+      <%= yield %>
+      <!-- <footer class="footer">
+        <p>Powered by <a href="http://github.com/seomoz/qless">qless</a> v<%=Qless::VERSION%></p>
+      </footer> -->
+      </div> <!-- /container -->
+
+    <!-- Le javascript
+    ================================================== -->
+    <script src="<%= u '/js/bootstrap.min.js' %>"></script>
+    <script src="<%= u '/js/bootstrap-tab.js' %>"></script>
+    <script src="<%= u '/js/bootstrap-alert.js' %>"></script>
+    <script src="<%= u '/js/bootstrap-tooltip.js' %>"></script>
+    <script src="<%= u '/js/bootstrap-scrollspy.js' %>"></script>
+    <script src="<%= u '/js/bootstrap-typeahead.js' %>"></script>
+
+    <!-- Noty! This is such a wonderful-looking library, and /exactly/ what I wanted. Thank you so much! -->
+    <script src="<%= u '/js/jquery.noty.js' %>"></script>
+    <!--
+    <script src="../assets/js/bootstrap-transition.js"></script>
+    <script src="../assets/js/bootstrap-modal.js"></script>
+    <script src="../assets/js/bootstrap-dropdown.js"></script>
+    <script src="../assets/js/bootstrap-popover.js"></script>
+    <script src="../assets/js/bootstrap-button.js"></script>
+    <script src="../assets/js/bootstrap-collapse.js"></script>
+    <script src="../assets/js/bootstrap-carousel.js"></script>
+    -->
+  </body>
+</html>