canvas-jobs 0.9.13 → 0.9.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 145b66e2c267b807d327df23ac5c0511a2ddd173
-  data.tar.gz: 25187fc7c1e9c13e7a50e676c2162e7cd594bfe5
+  metadata.gz: cd2ac418daa325d715cb4388d48f7f08c44fdea2
+  data.tar.gz: 4cc439b8bea527dd524c45e5e82186af2d5352c0
 SHA512:
-  metadata.gz: 9bd66fddb3dd3d6baebc607aa6822bfb139ace0300734855d34ee742c52e283ff937aed054e1125361afdedc202f66022be0e7092b30014ccdc34c48d8bc9729
-  data.tar.gz: 2759d931447d3254756e033c94d524230b3af4c231386c028dbdb93a96a0adc251986d61211e3cc790357828b84b94ddb1b40a1331332a084ff1da10d445a5c1
+  metadata.gz: 6daa755b75bbc555e0d87e6e7a6905462e3bf71ed64a238e99cec05cf583febd53f3d85429afafb2d9247f817302806179ab5444da2f0529571ff9991b2c64fa
+  data.tar.gz: 55148fbafe336859c77fce7df57da578653acd15b18f0141c8a8f13817ca23ff9685221b0d0cff758469bc62ff055aef010e298504321153c62830aa84e752eb

data/lib/delayed/backend/base.rb

@@ -105,7 +105,7 @@ module Delayed
         # Note: This does not ping the DB to get the time, so all your clients
         # must have syncronized clocks.
         def db_time_now
-          Time.zone.now
+          Time.now.utc
         end
 
         def unlock_orphaned_jobs(pid = nil, name = nil)

data/lib/delayed/pool.rb

@@ -22,25 +22,7 @@ class Pool
   end
 
   def run
-    op = OptionParser.new do |opts|
-      opts.banner = "Usage #{$0} <command> <options>"
-      opts.separator %{\nWhere <command> is one of:
-  start      start the jobs daemon
-  stop       stop the jobs daemon
-  run        start and run in the foreground
-  restart    stop and then start the jobs daemon
-  status     show daemon status
-}
-
-      opts.separator "\n<options>"
-      opts.on("-c", "--config", "Use alternate config file (default #{options[:config_file]})") { |c| options[:config_file] = c }
-      opts.on("-p", "--pid", "Use alternate folder for PID files (default #{options[:pid_folder]})") { |p| options[:pid_folder] = p }
-      opts.on("--no-tail", "Don't tail the logs (only affects non-daemon mode)") { options[:tail_logs] = false }
-      opts.on("--with-prejudice", "When stopping, interrupt jobs in progress, instead of letting them drain") { options[:kill] ||= true }
-      opts.on("--with-extreme-prejudice", "When stopping, immediately kill jobs in progress, instead of letting them drain") { options[:kill] = 9 }
-      opts.on_tail("-h", "--help", "Show this message") { puts opts; exit }
-    end
-    op.parse!(@args)
+    parse_cli_options!
 
     read_config(options[:config_file])
 
@@ -80,6 +62,28 @@ class Pool
     end
   end
 
+  def parse_cli_options!
+    op = OptionParser.new do |opts|
+      opts.banner = "Usage #{$0} <command> <options>"
+      opts.separator %{\nWhere <command> is one of:
+  start      start the jobs daemon
+  stop       stop the jobs daemon
+  run        start and run in the foreground
+  restart    stop and then start the jobs daemon
+  status     show daemon status
+}
+
+      opts.separator "\n<options>"
+      opts.on("-c", "--config [CONFIG_PATH]", "Use alternate config file (default #{options[:config_file]})") { |c| options[:config_file] = c }
+      opts.on("-p", "--pid", "Use alternate folder for PID files (default #{options[:pid_folder]})") { |p| options[:pid_folder] = p }
+      opts.on("--no-tail", "Don't tail the logs (only affects non-daemon mode)") { options[:tail_logs] = false }
+      opts.on("--with-prejudice", "When stopping, interrupt jobs in progress, instead of letting them drain") { options[:kill] ||= true }
+      opts.on("--with-extreme-prejudice", "When stopping, immediately kill jobs in progress, instead of letting them drain") { options[:kill] = 9 }
+      opts.on_tail("-h", "--help", "Show this message") { puts opts; exit }
+    end
+    op.parse!(@args)
+  end
+
   protected
 
   def procname

data/lib/delayed/server.rb

@@ -0,0 +1,120 @@
+require 'sinatra/base'
+require 'sinatra/json'
+require 'json'
+require 'delayed_job'
+
+module Delayed
+  class Server < Sinatra::Base
+    APP_DIR = File.dirname(File.expand_path(__FILE__))
+    set :views,         File.join(APP_DIR, 'server', 'views')
+    set :public_folder, File.join(APP_DIR, 'server', 'public')
+
+    def initialize(*args, &block)
+      super()
+      # Rails will take care of establishing the DB connection for us if there is
+      # an application present
+      if using_active_record? && !ActiveRecord::Base.connected?
+        ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+      end
+    end
+
+    def using_active_record?
+      Delayed::Job == Delayed::Backend::ActiveRecord::Job
+    end
+
+    # Ensure we're connected to the DB before processing the request
+    before do
+      if ActiveRecord::Base.respond_to?(:verify_active_connections!) && using_active_record?
+        ActiveRecord::Base.verify_active_connections!
+      end
+    end
+
+    # Release any used connections back to the pool
+    after do
+      ActiveRecord::Base.clear_active_connections! if using_active_record?
+    end
+
+    configure :development do
+      require 'sinatra/reloader'
+      register Sinatra::Reloader
+    end
+
+    helpers do
+      # this can't get required until the class has been opened for the first time
+      require 'delayed/server/helpers'
+      include Delayed::Server::Helpers
+    end
+
+    get '/' do
+      erb :index
+    end
+
+    get '/running' do
+      content_type :json
+      json({
+        draw: params['draw'].to_i,
+        recordsTotal: Delayed::Job.running.count,
+        recordsFiltered: Delayed::Job.running.count,
+        data: Delayed::Job.running_jobs.map{ |j|
+          j.as_json(include_root: false, except: [:handler, :last_error])
+        },
+      })
+    end
+
+    get '/tags' do
+      content_type :json
+      json({
+        draw: params['draw'].to_i,
+        data: Delayed::Job.tag_counts('current', 10)
+      })
+    end
+
+    DEFAULT_PAGE_SIZE = 10
+    MAX_PAGE_SIZE = 100
+    get '/jobs' do
+      content_type :json
+      flavor = params['flavor'] || 'current'
+      page_size = extract_page_size
+      offset = Integer(params['start'] || 0)
+      case flavor
+      when 'id'
+        jobs = Delayed::Job.where(id: params['search_term'])
+        total_records = 1
+      when 'future', 'current', 'failed'
+        jobs = Delayed::Job.list_jobs(flavor, page_size, offset)
+        total_records =  Delayed::Job.jobs_count(flavor)
+      else
+        query = params['search_term']
+        if query.present?
+          jobs = Delayed::Job.list_jobs(flavor, page_size, offset, query)
+        else
+          jobs = []
+        end
+        total_records =  Delayed::Job.jobs_count(flavor, query)
+      end
+      json({
+        draw: params['draw'].to_i,
+        recordsTotal: total_records,
+        recordsFiltered: jobs.size,
+        data: build_jobs_json(jobs),
+      })
+    end
+
+    private
+
+    def extract_page_size
+      page_size = Integer(params['length'] || DEFAULT_PAGE_SIZE)
+      # if dataTables wants all of the records it will send us -1 but we don't
+      # want the potential to kill our servers with this request so we'll limit it
+      page_size = DEFAULT_PAGE_SIZE if page_size == -1
+      [page_size, MAX_PAGE_SIZE].min
+    end
+
+
+    def build_jobs_json(jobs)
+      json = jobs.map{ |j|
+        j.as_json(root: false, except: [:handler, :last_error])
+      }
+    end
+  end
+end

data/lib/delayed/server/helpers.rb

@@ -0,0 +1,28 @@
+module Delayed
+  class Server
+    module Helpers
+      def h(text)
+        Rack::Utils.escape_html(text)
+      end
+
+      def url_path(*path_parts)
+        [path_prefix, path_parts].join('/').squeeze('/')
+      end
+
+      def path_prefix
+        request.env['SCRIPT_NAME']
+      end
+
+      def render_javascript_env
+        {
+          Routes: {
+            root: path_prefix,
+            running: url_path('running'),
+            tags: url_path('tags'),
+            jobs: url_path('jobs'),
+          }
+        }.to_json
+      end
+    end
+  end
+end

data/lib/delayed/server/public/css/app.css

@@ -0,0 +1,12 @@
+table.dataTable td {
+    word-wrap: break-word;
+}
+table.dataTable td.strand {
+    max-width: 100px;
+}
+table.dataTable td.tag {
+    max-width: 100px;
+}
+div.job-list-row {
+    padding-top: 10px;
+}

data/lib/delayed/server/public/js/app.js

@@ -0,0 +1,132 @@
+(function () {
+    var Delayed = {};
+
+    Delayed.Render = {};
+    Delayed.Render.attempts = function (previousAttempts, callType, jobData) {
+        var thisAttempt = parseInt(previousAttempts, 10) + 1;
+        switch(callType) {
+            case "display":
+                return thisAttempt + "/" + jobData.max_attempts;
+            default:
+                return thisAttempt;
+        }
+    };
+
+    Delayed.Render.runTime = function (lockedAt, callType) {
+        var elapsed, days, hours, minutes, seconds, remaining, formattedTime;
+        elapsed = Math.round((new Date().getTime() - Date.parse(lockedAt)) / 1000);
+        switch(callType) {
+            case "display": {
+                days = Math.floor(elapsed / 86400);
+                remaining = elapsed - (days * 86400);
+                hours = Math.floor(remaining / 3600);
+                remaining = remaining - (hours * 3600);
+                minutes = Math.floor(remaining / 60);
+                seconds = remaining - (minutes * 60);
+                formattedTime = ""
+                if(days > 0) {
+                    formattedTime = days + "d "
+                }
+                formattedTime = formattedTime + ("0" + hours).slice(-2) + ":" + ("0" + minutes).slice(-2) + ":" + ("0" + seconds).slice(-2);
+                return formattedTime;
+            }
+            default:
+                return elapsed;
+        }
+    };
+
+    $(document).ready(function () {
+        var runningTable, runningInterval, tagsTable, tagsInterval, jobsTable, jobsInterval
+        runningTable = $('#running').DataTable({
+            "autoWidth": false,
+            "bSort": false,
+            "paging": false,
+            "processing": true,
+            "searching": false,
+            "scrollY": "200px",
+            "serverSide": true,
+            "order": [[5, "desc"]],
+            "ajax": ENV.Routes.running,
+            "columns": [
+                {"data": "id"},
+                {"data": "locked_by", "className": "worker"},
+                {"data": "tag", "className": "tag"},
+                {"data": "attempts", "render": Delayed.Render.attempts, "className": "attempts"},
+                {"data": "strand", "className": "strand"},
+                {"data": "locked_at", "render": Delayed.Render.runTime}
+            ]
+        });
+        runningInterval = setInterval(function () { runningTable.ajax.reload(); }, 2000);
+
+        tagsTable = $("#tags").DataTable({
+            "autoWidth": false,
+            "bSort": false,
+            "paging": false,
+            "processing": true,
+            "searching": false,
+            "scrollY": "200px",
+            "order": [[1, "desc"]],
+            "ajax": ENV.Routes.tags,
+            "columns": [
+                {"data": "tag", "className": "tag"},
+                {"data": "count"}
+            ]
+        });
+        tagsInterval = setInterval(function () { tagsTable.ajax.reload(); }, 10000);
+
+        jobsTable = $("#jobs").DataTable({
+            "autoWidth": false,
+            "bSort": false,
+            "paging": true,
+            "processing": true,
+            "searching": false,
+            "scrollY": "200px",
+            "serverSide": true,
+            "order": [[1, "desc"]],
+            "ajax": {
+                "url": ENV.Routes.jobs,
+                "data": function (data) {
+                    data.flavor      = $("select#current_jobs_flavor").val();
+                    data.search_term = $("input#jobs_search_term").val();
+                }
+            },
+            "columns": [
+                {"data": "id"},
+                {"data": "tag", "className": "tag"},
+                {"data": "attempts", "render": Delayed.Render.attempts},
+                {"data": "priority"},
+                {"data": "strand"},
+                {"data": "run_at"}
+            ]
+        });
+
+        $('body').on('click', '.refresh_jobs_link', function(event) {
+            event.preventDefault();
+            jobsTable.ajax.reload();
+            return true
+        });
+
+        $('body').on('change', 'select#current_jobs_flavor', function (event) {
+            event.preventDefault();
+            $selectBox = $(this);
+            $selectedOption = $($selectBox.children(':selected'));
+            $searchDiv = $('div#job_search');
+
+            if ($selectedOption.data('requires-search')) {
+                $searchDiv.show();
+            } else {
+                $searchDiv.hide();
+            }
+
+            jobsTable.ajax.reload();
+            return true
+        });
+
+        $('body').on('keyup', '#jobs_search_term', function (event) {
+            if (event.keyCode == 13) {
+                jobsTable.ajax.reload();
+            }
+            return true
+        });
+    });
+})();

data/lib/delayed/server/views/index.erb

@@ -0,0 +1,90 @@
+<div class="row">
+  <div class="col-md-8">
+    <h2>Running</h2>
+    <table id="running" class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <th>Worker</th>
+          <th>Tag</th>
+          <th>Attempt</th>
+          <th>Strand</th>
+          <th>Runtime</th>
+        </tr>
+      </thead>
+      <tbody>
+      </tbody>
+    </table>
+  </div>
+  <div class="col-md-4">
+    <h2>Tags</h2>
+    <table id="tags" class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>Tag</th>
+          <th>Count</th>
+        </tr>
+      </thead>
+      <tbody>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-md-12">
+    <h2>Jobs List</h2>
+  </div>
+</div>
+
+<div class="row">
+  <div class="form-group">
+    <div class="col-md-2">
+      <select id="current_jobs_flavor" class="form-control">
+        <option value="current">Current</option>
+        <option value="future">Future</option>
+        <option value="failed">Failed</option>
+        <option value="id" data-requires-search="true">ID</option>
+        <option value="strand" data-requires-search="true">Strand</option>
+        <option value="tag" data-requires-search="true">Tag</option>
+      </select>
+    </div>
+    <div class="col-md-3">
+      <!-- this inline style makes me sad but doing it in the stylesheet seems to break bootstrap -->
+      <div class="input-group" id="job_search" style="display: none;">
+        <input type="text" class="form-control" id="jobs_search_term" placeholder="">
+        <span class="input-group-btn">
+          <a href="" class="btn btn-default refresh_jobs_link" aria-label="Run Search">
+            Filter <span class="glyphicon glyphicon-filter"></span>
+          </a>
+        </span>
+      </div>
+    </div>
+    <div class="col-md-6">
+    </div>
+    <div class="col-md-1">
+      <a href="" class="btn btn-default pull-right refresh_jobs_link" aria-label="Refresh Jobs Table">
+        <span class="glyphicon glyphicon-refresh"></span> Refresh
+      </a>
+    </div>
+  </div>
+</div>
+
+<div class="row job-list-row">
+  <div class="col-md-12">
+    <table id="jobs" class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <th>Tag</th>
+          <th>Attempt</th>
+          <th>Priority</th>
+          <th>Strand</th>
+          <th>Run At</th>
+        </tr>
+      </thead>
+      <tbody>
+      </tbody>
+    </table>
+  </div>
+</div>