resque-scheduler 2.2.0 → 4.10.2

data/lib/{resque_scheduler → resque/scheduler}/server/views/delayed.erb

@@ -1,10 +1,11 @@
 <h1>Delayed Jobs</h1>
-<%- size = resque.delayed_queue_schedule_size %>
-<% if size > 0 %>
-  <form method="POST" action="<%=u 'delayed/clear'%>" class='clear-delayed'>
-    <input type='submit' name='' value='Clear Delayed Jobs' />
-  </form>
-<% end %>
+<% size = resque.delayed_queue_schedule_size %>
+
+<%= scheduler_view :search_form, layout: false %>
+
+<p style="color: red; font-weight: bold;">
+  <%= @error_message %>
+</p>
 
 <p class='intro'>
   This list below contains the timestamps for scheduled delayed jobs.
@@ -15,6 +16,14 @@
   Showing <%= start = params[:start].to_i %> to <%= start + 20 %> of <b><%= size %></b> timestamps
 </p>
 
+<% if size > 0 %>
+  <div style="padding-bottom: 10px">
+    <form method="POST" action="<%= u 'delayed/clear' %>" class='clear-delayed confirmSubmission'>
+      <input type='submit' name='' value='Clear Delayed Jobs' />
+    </form>
+  </div>
+<% end %>
+
 <table>
   <tr>
     <th></th>
@@ -22,10 +31,11 @@
     <th>Job count</th>
     <th>Class</th>
     <th>Args</th>
+    <th>All schedules</th>
   </tr>
   <% resque.delayed_queue_peek(start, 20).each do |timestamp| %>
     <tr>
-      <td>
+      <td style="padding-top: 12px; padding-bottom: 2px; width: 10px">
         <form action="<%= u "/delayed/queue_now" %>" method="post">
           <input type="hidden" name="timestamp" value="<%= timestamp.to_i %>">
           <input type="submit" value="Queue now">
@@ -41,7 +51,12 @@
           <a href="<%= u "delayed/#{timestamp}" %>">see details</a>
         <% end %>
       </td>
-      <td><%= h(job['args'].inspect) if job && delayed_timestamp_size == 1 %></td>
+      <td><%= h(show_job_arguments(job['args'])) if job && delayed_timestamp_size == 1 %></td>
+      <td>
+        <% if job %>
+          <a href="<%= u URI("/delayed/jobs/#{CGI.escape(job['class'])}?args=" + CGI.escape(job['args'].to_json)) %>">All schedules</a>
+        <% end %>
+      </td>
     </tr>
   <% end %>
 </table>

data/lib/resque/scheduler/server/views/delayed_schedules.erb

@@ -0,0 +1,20 @@
+<h1>Delayed jobs scheduled for <%=h params[:klass] %> (<%=h show_job_arguments(@args) %>)</h1>
+
+<table class='jobs'>
+<tr>
+  <th>Timestamp</th>
+</tr>
+
+<% @timestamps.each do |t| %>
+<tr>
+  <td>
+    <%= Time.at(t) %>
+  </td>
+</tr>
+<% end %>
+<% if @timestamps.empty? %>
+  <tr>
+    <td class='no-data'>There are no such jobs scheduled.</td>
+  </tr>
+<% end %>
+</table>

data/lib/{resque_scheduler → resque/scheduler}/server/views/delayed_timestamp.erb

@@ -13,7 +13,7 @@
   <% jobs.each do |job| %>
     <tr>
       <td class='class'><%= job['class'] %></td>
-      <td class='args'><%=h job['args'].inspect %></td>
+      <td class='args'><%= h show_job_arguments(job['args']) %></td>
     </tr>
   <% end %>
   <% if jobs.empty? %>

data/lib/resque/scheduler/server/views/scheduler.erb

@@ -0,0 +1,58 @@
+<h1>Schedule</h1>
+
+<p class='intro'>
+  The list below contains all scheduled jobs.  Click &quot;Queue now&quot; to queue
+  a job immediately.
+  <br/> Server local time: <%= Time.now %>
+  <br/> Server Environment: <%= Resque::Scheduler.env %>
+  <br/> Current master: <%= Resque.redis.get(Resque::Scheduler.master_lock.key) %>
+</p>
+<p class='intro'>
+  The highlighted jobs are skipped for current environment.
+</p>
+<div style="overflow-y: auto; width:100%; padding: 0px 5px;">
+<table>
+  <tr>
+    <th>Index</th>
+    <% if Resque::Scheduler.dynamic %>
+      <th></th>
+  <% end %>
+    <th></th>
+    <th>Name</th>
+    <th>Description</th>
+    <th>Interval</th>
+    <th>Class</th>
+    <th>Queue</th>
+    <th>Arguments</th>
+    <th>Last Enqueued</th>
+  </tr>
+  <% Resque.schedule.keys.sort.each_with_index do |name, index| %>
+    <% config = Resque.schedule[name] %>
+    <tr style="<%= scheduled_in_this_env?(name) ? '' : 'color: #9F6000;background: #FEEFB3;' %>">
+      <td style="padding-left: 15px;"><%= index + 1 %>.</td>
+      <% if Resque::Scheduler.dynamic %>
+        <td style="padding-top: 12px; padding-bottom: 2px; width: 10px">
+          <form action="<%= u "/schedule" %>" method="post" style="margin-left: 0">
+            <input type="hidden" name="job_name" value="<%= h name %>">
+            <input type="hidden" name="_method" value="delete">
+            <input type="submit" value="Delete">
+          </form>
+        </td>
+      <% end %>
+      <td style="padding-top: 12px; padding-bottom: 2px; width: 10px">
+        <form action="<%= u "/schedule/requeue" %>" method="post" style="margin-left: 0">
+          <input type="hidden" name="job_name" value="<%= h name %>">
+          <input type="submit" value="Queue now">
+        </form>
+      </td>
+      <td><%= h name %></td>
+      <td><%= h config['description'] %></td>
+      <td style="white-space:nowrap"><%= h schedule_interval(config) %></td>
+      <td><%= h schedule_class(config) %></td>
+      <td><%= h config['queue'] || queue_from_class_name(config['class']) %></td>
+      <td><%= h show_job_arguments(config['args']) %></td>
+      <td><%= h Resque.get_last_enqueued_at(name) || 'Never' %></td>
+    </tr>
+  <% end %>
+</table>
+</div>

data/lib/resque/scheduler/server/views/search.erb

@@ -0,0 +1,69 @@
+<h1>Search Results</h1>
+<%= scheduler_view :search_form, layout: false %>
+<hr>
+<% delayed = @jobs.select { |j| j['where_at'] == 'delayed' } %>
+<h1>Delayed jobs</h1>
+<table class='jobs'>
+  <tr>
+    <th></th>
+    <th></th>
+    <th>Timestamp</th>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% delayed.each do |job| %>
+      <tr>
+        <td style="padding-top: 12px; padding-bottom: 2px; width: 10px">
+          <form action="<%= u "/delayed/queue_now" %>" method="post">
+            <input type="hidden" name="timestamp" value="<%= job['timestamp'].to_i %>">
+            <input type="submit" value="Queue now">
+          </form>
+        </td>
+        <td style="padding-top: 12px; padding-bottom: 2px; width: 10px">
+          <form action="<%= u "/delayed/cancel_now" %>" method="post">
+            <input type="hidden" name="timestamp" value="<%= job['timestamp'].to_i %>">
+            <input type="hidden" name="klass" value="<%= job['class'] %>">
+            <input type="hidden" name="args" value="<%= h(Resque.encode job['args']) %>">
+            <input type="submit" value="Cancel Job">
+          </form>
+        </td>
+        <td class='args'><%= format_time(Time.at(job['timestamp'])) %></td>
+        <td class='class'><%= job['class'] %></td>
+        <td class='args'><%= h job['args'].inspect %></td>
+      </tr>
+  <% end %>
+</table>
+
+<% queued = @jobs.select { |j| j['where_at'] == 'queued' } %>
+<h1>Queued jobs</h1>
+<table class='jobs'>
+  <tr>
+    <th>Queue</th>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% queued.each do |job| %>
+  <tr>
+    <td class='class'><%= job['queue'] %></td>
+    <td class='class'><%= job['class'] %></td>
+    <td class='args'><%= h job['args'].inspect %></td>
+  </tr>
+  <% end %>
+</table>
+
+<% working = @jobs.select { |j| j['where_at'] == 'working' } %>
+<h1>Working jobs</h1>
+<table class='jobs'>
+  <tr>
+    <th>Queue</th>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% working.each do |job| %>
+  <tr>
+    <td class='class'><%= job['queue'] %></td>
+    <td class='class'><%= job['class'] %></td>
+    <td class='args'><%= h job['args'].inspect %></td>
+  </tr>
+  <% end %>
+</table>

data/lib/resque/scheduler/server/views/search_form.erb

@@ -0,0 +1,4 @@
+<form method="POST" action="<%= u 'delayed/search' %>">
+  <input type='input' name='search' value="<%= h params[:search] %>"/>
+  <input type='submit' value='Search'/>
+</form>

data/lib/resque/scheduler/server.rb

@@ -0,0 +1,268 @@
+# vim:fileencoding=utf-8
+require 'resque-scheduler'
+require 'resque/server'
+require 'tilt/erb'
+require 'json'
+
+# Extend Resque::Server to add tabs
+module Resque
+  module Scheduler
+    module Server
+      TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S %z'.freeze
+
+      unless defined?(::Resque::Scheduler::Server::VIEW_PATH)
+        VIEW_PATH = File.join(File.dirname(__FILE__), 'server', 'views')
+      end
+
+      def self.included(base)
+        base.class_eval do
+          helpers { include HelperMethods }
+          include ServerMethods
+
+          get('/schedule') { schedule }
+          post('/schedule/requeue') { schedule_requeue }
+          post('/schedule/requeue_with_params') do
+            schedule_requeue_with_params
+          end
+          delete('/schedule') { delete_schedule }
+          get('/delayed') { delayed }
+          get('/delayed/jobs/:klass') { delayed_jobs_klass }
+          post('/delayed/search') { delayed_search }
+          get('/delayed/:timestamp') { delayed_timestamp }
+          post('/delayed/queue_now') { delayed_queue_now }
+          post('/delayed/cancel_now') { delayed_cancel_now }
+          post('/delayed/clear') { delayed_clear }
+        end
+      end
+
+      module ServerMethods
+        def schedule
+          Resque.reload_schedule! if Resque::Scheduler.dynamic
+          erb scheduler_template('scheduler')
+        end
+
+        def schedule_requeue
+          @job_name = params['job_name'] || params[:job_name]
+          config = Resque.schedule[@job_name]
+          @parameters = config['parameters'] || config[:parameters]
+          if @parameters
+            erb scheduler_template('requeue-params')
+          else
+            Resque::Scheduler.enqueue_from_config(config)
+            redirect u('/overview')
+          end
+        end
+
+        def schedule_requeue_with_params
+          job_name = params['job_name'] || params[:job_name]
+          config = Resque.schedule[job_name]
+          # Build args hash from post data (removing the job name)
+          submitted_args = params.reject do |key, _value|
+            key == 'job_name' || key == :job_name
+          end
+
+          # Merge constructed args hash with existing args hash for
+          # the job, if it exists
+          config_args = config['args'] || config[:args] || {}
+          config_args = config_args.merge(submitted_args)
+
+          # Insert the args hash into config and queue the resque job
+          config = config.merge('args' => config_args)
+          Resque::Scheduler.enqueue_from_config(config)
+          redirect u('/overview')
+        end
+
+        def delete_schedule
+          if Resque::Scheduler.dynamic
+            job_name = params['job_name'] || params[:job_name]
+            Resque.remove_schedule(job_name)
+          end
+          redirect u('/schedule')
+        end
+
+        def delayed
+          erb scheduler_template('delayed')
+        end
+
+        def delayed_jobs_klass
+          begin
+            klass = Resque::Scheduler::Util.constantize(params[:klass])
+            @args = JSON.load(CGI.unescape(params[:args]))
+            @timestamps = Resque.scheduled_at(klass, *@args)
+          rescue
+            @timestamps = []
+          end
+
+          erb scheduler_template('delayed_schedules')
+        end
+
+        def delayed_search
+          @jobs = find_job(params[:search])
+          erb scheduler_template('search')
+        end
+
+        def delayed_timestamp
+          erb scheduler_template('delayed_timestamp')
+        end
+
+        def delayed_queue_now
+          timestamp = params['timestamp'].to_i
+          formatted_time = Time.at(timestamp).strftime(
+            ::Resque::Scheduler::Server::TIMESTAMP_FORMAT
+          )
+
+          if timestamp > 0
+            unless Resque::Scheduler.enqueue_next_item(timestamp)
+              @error_message = "Unable to remove item at #{formatted_time}"
+            end
+          else
+            @error_message = "Incorrect timestamp #{formatted_time}"
+          end
+
+          erb scheduler_template('delayed')
+        end
+
+        def delayed_cancel_now
+          klass = Resque::Scheduler::Util.constantize(params['klass'])
+          timestamp = params['timestamp']
+          args = Resque.decode params['args']
+          Resque.remove_delayed_job_from_timestamp(timestamp, klass, *args)
+          redirect u('/delayed')
+        end
+
+        def delayed_clear
+          Resque.reset_delayed_queue
+          redirect u('delayed')
+        end
+      end
+
+      module HelperMethods
+        def format_time(t)
+          t.strftime(::Resque::Scheduler::Server::TIMESTAMP_FORMAT)
+        end
+
+        def show_job_arguments(args)
+          Array(args).map(&:inspect).join("\n")
+        end
+
+        def queue_from_class_name(class_name)
+          Resque.queue_from_class(
+            Resque::Scheduler::Util.constantize(class_name)
+          )
+        end
+
+        def find_job(worker)
+          worker = worker.downcase
+          results = working_jobs_for_worker(worker)
+
+          dels = delayed_jobs_for_worker(worker)
+          results += dels.select do |j|
+            j['class'].downcase.include?(worker) &&
+              j.merge!('where_at' => 'delayed')
+          end
+
+          Resque.queues.each do |queue|
+            queued = Resque.peek(queue, 0, Resque.size(queue))
+            queued = [queued] unless queued.is_a?(Array)
+            results += queued.select do |j|
+              j['class'].downcase.include?(worker) &&
+                j.merge!('queue' => queue, 'where_at' => 'queued')
+            end
+          end
+
+          results
+        end
+
+        def schedule_interval(config)
+          if config['every']
+            schedule_interval_every(config['every'])
+          elsif config['cron']
+            'cron: ' + config['cron'].to_s
+          else
+            'Not currently scheduled'
+          end
+        end
+
+        def schedule_interval_every(every)
+          every = [*every]
+          s = 'every: ' << every.first
+
+          return s unless every.length > 1
+
+          s << ' ('
+          meta = every.last.map do |key, value|
+            "#{key.to_s.tr('_', ' ')} #{value}"
+          end
+          s << meta.join(', ') << ')'
+        end
+
+        def schedule_class(config)
+          if config['class'].nil? && !config['custom_job_class'].nil?
+            config['custom_job_class']
+          else
+            config['class']
+          end
+        end
+
+        def scheduler_template(name)
+          File.read(
+            File.expand_path("../server/views/#{name}.erb", __FILE__)
+          )
+        end
+
+        def scheduled_in_this_env?(name)
+          return true if rails_env(name).nil?
+          rails_env(name).split(/[\s,]+/).include?(Resque::Scheduler.env)
+        end
+
+        def rails_env(name)
+          Resque.schedule[name]['rails_env'] || Resque.schedule[name]['env']
+        end
+
+        def scheduler_view(filename, options = {}, locals = {})
+          source = File.read(File.join(VIEW_PATH, "#{filename}.erb"))
+          erb source, options, locals
+        end
+
+        private
+
+        def working_jobs_for_worker(worker)
+          [].tap do |results|
+            working = [*Resque.working]
+            work = working.select do |w|
+              w.job && w.job['payload'] &&
+                w.job['payload']['class'].downcase.include?(worker)
+            end
+            work.each do |w|
+              results += [
+                w.job['payload'].merge(
+                  'queue' => w.job['queue'], 'where_at' => 'working'
+                )
+              ]
+            end
+          end
+        end
+
+        def delayed_jobs_for_worker(_worker)
+          [].tap do |dels|
+            schedule_size = Resque.delayed_queue_schedule_size
+            Resque.delayed_queue_peek(0, schedule_size).each do |d|
+              Resque.delayed_timestamp_peek(
+                d, 0, Resque.delayed_timestamp_size(d)
+              ).each do |j|
+                dels << j.merge!('timestamp' => d)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Resque::Server.tabs << 'Schedule'
+Resque::Server.tabs << 'Delayed'
+
+Resque::Server.class_eval do
+  include Resque::Scheduler::Server
+end

data/lib/resque/scheduler/signal_handling.rb

@@ -0,0 +1,40 @@
+# vim:fileencoding=utf-8
+
+module Resque
+  module Scheduler
+    module SignalHandling
+      attr_writer :signal_queue
+
+      def signal_queue
+        @signal_queue ||= []
+      end
+
+      # For all signals, set the shutdown flag and wait for current
+      # poll/enqueuing to finish (should be almost instant).  In the
+      # case of sleeping, exit immediately.
+      def register_signal_handlers
+        (Signal.list.keys & %w(INT TERM USR1 USR2 QUIT)).each do |sig|
+          trap(sig) do
+            signal_queue << sig
+            # break sleep in the primary scheduler thread, allowing
+            # the signal queue to get processed as soon as possible.
+            @th.wakeup if @th && @th.alive?
+          end
+        end
+      end
+
+      def handle_signals
+        loop do
+          sig = signal_queue.shift
+          break unless sig
+          log! "Got #{sig} signal"
+          case sig
+          when 'INT', 'TERM', 'QUIT' then shutdown
+          when 'USR1' then print_schedule
+          when 'USR2' then reload_schedule!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/resque/scheduler/tasks.rb

@@ -0,0 +1,25 @@
+# vim:fileencoding=utf-8
+
+require 'resque/tasks'
+require 'resque-scheduler'
+
+namespace :resque do
+  task :setup
+
+  def scheduler_cli
+    @scheduler_cli ||= Resque::Scheduler::Cli.new(
+      %W(#{ENV['RESQUE_SCHEDULER_OPTIONS']})
+    )
+  end
+
+  desc 'Start Resque Scheduler'
+  task scheduler: :scheduler_setup do
+    scheduler_cli.setup_env
+    scheduler_cli.run_forever
+  end
+
+  task :scheduler_setup do
+    scheduler_cli.parse_options
+    Rake::Task['resque:setup'].invoke unless scheduler_cli.pre_setup
+  end
+end

data/lib/resque/scheduler/util.rb

@@ -0,0 +1,39 @@
+# vim:fileencoding=utf-8
+
+module Resque
+  module Scheduler
+    class Util
+      # In order to upgrade to resque(1.25) which has deprecated following
+      # methods, we just added these useful helpers back to use in Resque
+      # Scheduler.  refer to:
+      # https://github.com/resque/resque-scheduler/pull/273
+
+      def self.constantize(camel_cased_word)
+        camel_cased_word = camel_cased_word.to_s
+
+        if camel_cased_word.include?('-')
+          camel_cased_word = classify(camel_cased_word)
+        end
+
+        names = camel_cased_word.split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        names.each do |name|
+          args = Module.method(:const_get).arity != 1 ? [false] : []
+
+          constant = if constant.const_defined?(name, *args)
+                       constant.const_get(name)
+                     else
+                       constant.const_missing(name)
+                     end
+        end
+        constant
+      end
+
+      def self.classify(dashed_word)
+        dashed_word.split('-').map(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/resque/scheduler/version.rb

@@ -0,0 +1,7 @@
+# vim:fileencoding=utf-8
+
+module Resque
+  module Scheduler
+    VERSION = '4.10.2'.freeze
+  end
+end