resque-admin-scheduler 1.0.2 → 1.3.0

data/lib/resque_admin/scheduler/logger_builder.rb

@@ -0,0 +1,72 @@
+# vim:fileencoding=utf-8
+
+require 'mono_logger'
+
+module ResqueAdmin
+  module Scheduler
+    # Just builds a logger, with specified verbosity and destination.
+    # The simplest example:
+    #
+    #   ResqueAdmin::Scheduler::LoggerBuilder.new.build
+    class LoggerBuilder
+      # Initializes new instance of the builder
+      #
+      # Pass :opts Hash with
+      #   - :quiet if logger needs to be silent for all levels. Default - false
+      #   - :verbose if there is a need in debug messages. Default - false
+      #   - :log_dev to output logs into a desired file. Default - STDOUT
+      #   - :format log format, either 'text' or 'json'. Default - 'text'
+      #
+      # Example:
+      #
+      #   LoggerBuilder.new(
+      #     :quiet => false, :verbose => true, :log_dev => 'log/scheduler.log'
+      #   )
+      def initialize(opts = {})
+        @quiet = !!opts[:quiet]
+        @verbose = !!opts[:verbose]
+        @log_dev = opts[:log_dev] || $stdout
+        @format = opts[:format] || 'text'
+      end
+
+      # Returns an instance of MonoLogger
+      def build
+        logger = MonoLogger.new(@log_dev)
+        logger.level = level
+        logger.formatter = send(:"#{@format}_formatter")
+        logger
+      end
+
+      private
+
+      def level
+        if @verbose && !@quiet
+          MonoLogger::DEBUG
+        elsif !@quiet
+          MonoLogger::INFO
+        else
+          MonoLogger::FATAL
+        end
+      end
+
+      def text_formatter
+        proc do |severity, datetime, _progname, msg|
+          "resque_admin-scheduler: [#{severity}] #{datetime.iso8601}: #{msg}\n"
+        end
+      end
+
+      def json_formatter
+        proc do |severity, datetime, progname, msg|
+          require 'json'
+          JSON.dump(
+            name: 'resque_admin-scheduler',
+            progname: progname,
+            level: severity,
+            timestamp: datetime.iso8601,
+            msg: msg
+          ) + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/{resque → resque_admin}/scheduler/plugin.rb

@@ -1,6 +1,6 @@
 # vim:fileencoding=utf-8
 
-module Resque
+module ResqueAdmin
   module Scheduler
     module Plugin
       def self.hooks(job, pattern)

data/lib/resque_admin/scheduler/scheduling_extensions.rb

@@ -0,0 +1,141 @@
+# vim:fileencoding=utf-8
+
+module ResqueAdmin
+  module Scheduler
+    module SchedulingExtensions
+      # Accepts a new schedule configuration of the form:
+      #
+      #   {
+      #     "MakeTea" => {
+      #       "every" => "1m" },
+      #     "some_name" => {
+      #       "cron"        => "5/* * * *",
+      #       "class"       => "DoSomeWork",
+      #       "args"        => "work on this string",
+      #       "description" => "this thing works it"s butter off" },
+      #     ...
+      #   }
+      #
+      # Hash keys can be anything and are used to describe and reference
+      # the scheduled job. If the "class" argument is missing, the key
+      # is used implicitly as "class" argument - in the "MakeTea" example,
+      # "MakeTea" is used both as job name and resque_admin worker class.
+      #
+      # Any jobs that were in the old schedule, but are not
+      # present in the new schedule, will be removed.
+      #
+      # :cron can be any cron scheduling string
+      #
+      # :every can be used in lieu of :cron. see rufus-scheduler's 'every'
+      # usage for valid syntax. If :cron is present it will take precedence
+      # over :every.
+      #
+      # :class must be a resque_admin worker class. If it is missing, the job name
+      # (hash key) will be used as :class.
+      #
+      # :args can be any yaml which will be converted to a ruby literal and
+      # passed in a params. (optional)
+      #
+      # :rails_envs is the list of envs where the job gets loaded. Envs are
+      # comma separated (optional)
+      #
+      # :description is just that, a description of the job (optional). If
+      # params is an array, each element in the array is passed as a separate
+      # param, otherwise params is passed in as the only parameter to
+      # perform.
+      def schedule=(schedule_hash)
+        @non_persistent_schedules = nil
+        prepared_schedules = prepare_schedules(schedule_hash)
+
+        prepared_schedules.each do |schedule, config|
+          set_schedule(schedule, config, false)
+        end
+
+        # ensure only return the successfully saved data!
+        reload_schedule!
+      end
+
+      # Returns the schedule hash
+      def schedule
+        @schedule ||= all_schedules
+        @schedule || {}
+      end
+
+      # reloads the schedule from redis and memory
+      def reload_schedule!
+        @schedule = all_schedules
+      end
+
+      # gets the schedules as it exists in redis
+      def all_schedules
+        non_persistent_schedules.merge(persistent_schedules)
+      end
+
+      # Create or update a schedule with the provided name and configuration.
+      #
+      # Note: values for class and custom_job_class need to be strings,
+      # not constants.
+      #
+      #    ResqueAdmin.set_schedule('some_job', {:class => 'SomeJob',
+      #                                     :every => '15mins',
+      #                                     :queue => 'high',
+      #                                     :args => '/tmp/poop'})
+      #
+      # Preventing a reload is optional and available to batch operations
+      def set_schedule(name, config, reload = true)
+        persist = config.delete(:persist) || config.delete('persist')
+
+        if persist
+          redis.hset(:persistent_schedules, name, encode(config))
+        else
+          non_persistent_schedules[name] = decode(encode(config))
+        end
+
+        redis.sadd(:schedules_changed, name)
+        reload_schedule! if reload
+      end
+
+      # retrive the schedule configuration for the given name
+      def fetch_schedule(name)
+        schedule[name]
+      end
+
+      # remove a given schedule by name
+      def remove_schedule(name)
+        non_persistent_schedules.delete(name)
+        redis.hdel(:persistent_schedules, name)
+        redis.sadd(:schedules_changed, name)
+
+        reload_schedule!
+      end
+
+      private
+
+      # we store our non-persistent schedules in this hash
+      def non_persistent_schedules
+        @non_persistent_schedules ||= {}
+      end
+
+      # reads the persistent schedules from redis
+      def persistent_schedules
+        redis.hgetall(:persistent_schedules).tap do |h|
+          h.each do |name, config|
+            h[name] = decode(config)
+          end
+        end
+      end
+
+      def prepare_schedules(schedule_hash)
+        prepared_hash = {}
+        schedule_hash.each do |name, job_spec|
+          job_spec = job_spec.dup
+          unless job_spec.key?('class') || job_spec.key?(:class)
+            job_spec['class'] = name
+          end
+          prepared_hash[name] = job_spec
+        end
+        prepared_hash
+      end
+    end
+  end
+end

data/lib/resque_admin/scheduler/server/views/delayed.erb

@@ -0,0 +1,63 @@
+<h1>Delayed Jobs</h1>
+<%- size = resque_admin.delayed_queue_schedule_size %>
+
+<%= scheduler_view :search_form, layout: false %>
+
+<p style="font-color: red; font-weight: bold;">
+  <%= @error_message %>
+</p>
+
+<p class='intro'>
+  This list below contains the timestamps for scheduled delayed jobs.
+  Server local time: <%= Time.now %>
+</p>
+
+<p class='sub'>
+  Showing <%= start = params[:start].to_i %> to <%= start + 20 %> of <b><%= size %></b> timestamps
+</p>
+
+<table>
+  <tr>
+    <th></th>
+    <th>Timestamp</th>
+    <th>Job count</th>
+    <th>Class</th>
+    <th>Args</th>
+    <th>All schedules</th>
+  </tr>
+  <% resque_admin.delayed_queue_peek(start, 20).each do |timestamp| %>
+    <tr>
+      <td>
+        <form action="<%= u "/delayed/queue_now" %>" method="post">
+          <input type="hidden" name="timestamp" value="<%= timestamp.to_i %>">
+          <input type="submit" value="Queue now">
+        </form>
+      </td>
+      <td><a href="<%= u "delayed/#{timestamp}" %>"><%= format_time(Time.at(timestamp)) %></a></td>
+      <td><%= delayed_timestamp_size = resque_admin.delayed_timestamp_size(timestamp) %></td>
+      <% job = resque_admin.delayed_timestamp_peek(timestamp, 0, 1).first %>
+      <td>
+        <% if job && delayed_timestamp_size == 1 %>
+          <%= h(job['class']) %>
+        <% else %>
+          <a href="<%= u "delayed/#{timestamp}" %>">see details</a>
+        <% end %>
+      </td>
+      <td><%= h(show_job_arguments(job['args'])) if job && delayed_timestamp_size == 1 %></td>
+      <td>
+        <% if job %>
+          <a href="<%=u URI("/delayed/jobs/#{job['class']}?args=" + URI.encode(job['args'].to_json)) %>">All schedules</a>
+        <% end %>
+      </td>
+    </tr>
+  <% end %>
+</table>
+
+<% if size > 0 %>
+  <br>
+  <form method="POST" action="<%=u 'delayed/clear'%>" class='clear-delayed'>
+    <input type='submit' name='' value='Clear Delayed Jobs' />
+  </form>
+<% end %>
+
+<%= partial :next_more, :start => start, :size => size %>

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

@@ -2,14 +2,14 @@
 
 <h1>Delayed jobs scheduled for <%= format_time(Time.at(timestamp)) %></h1>
 
-<p class='sub'>Showing <%= start = params[:start].to_i %> to <%= start + 20 %> of <b><%=size = resque.delayed_timestamp_size(timestamp)%></b> jobs</p>
+<p class='sub'>Showing <%= start = params[:start].to_i %> to <%= start + 20 %> of <b><%=size = resque_admin.delayed_timestamp_size(timestamp)%></b> jobs</p>
 
 <table class='jobs'>
   <tr>
     <th>Class</th>
     <th>Args</th>
   </tr>
-  <% jobs = resque.delayed_timestamp_peek(timestamp, start, 20) %>
+  <% jobs = resque_admin.delayed_timestamp_peek(timestamp, start, 20) %>
   <% jobs.each do |job| %>
     <tr>
       <td class='class'><%= job['class'] %></td>

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

@@ -4,8 +4,8 @@
   The list below contains all scheduled jobs.  Click "Queue now" 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) %>
+  <br/> Server Environment: <%= ResqueAdmin::Scheduler.env %>
+  <br/> Current master: <%= ResqueAdmin.redis.get(ResqueAdmin::Scheduler.master_lock.key) %>
 </p>
 <p class='intro'>
 	The highlighted jobs are skipped for current environment.
@@ -14,7 +14,7 @@
 <table>
   <tr>
     <th>Index</th>
-    <% if Resque::Scheduler.dynamic %>
+    <% if ResqueAdmin::Scheduler.dynamic %>
       <th></th>
   <% end %>
     <th></th>
@@ -26,11 +26,11 @@
     <th>Arguments</th>
     <th>Last Enqueued</th>
   </tr>
-  <% Resque.schedule.keys.sort.each_with_index do |name, index| %>
-    <% config = Resque.schedule[name] %>
+  <% ResqueAdmin.schedule.keys.sort.each_with_index do |name, index| %>
+    <% config = ResqueAdmin.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 %>
+      <% if ResqueAdmin::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 %>">
@@ -51,7 +51,7 @@
       <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>
+      <td><%= h ResqueAdmin.get_last_enqueued_at(name) || 'Never' %></td>
     </tr>
   <% end %>
 </table>

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

@@ -0,0 +1,72 @@
+<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>
+          <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>
+          <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(ResqueAdmin.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>
+</h1>
+
+<% 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>
+
+