que-scheduler 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b426bc239a8d5810c33e8df0d62350ec1556c2a
-  data.tar.gz: 15dedc3ff27d43206d7fb9e7c97f592d3cb4847e
+  metadata.gz: 3ac42dcccc27269cd2422b34c0289a65465e1525
+  data.tar.gz: b85f258df6a12f9b21eae3da99c899c7cc1d0003
 SHA512:
-  metadata.gz: b87c40dd29f3aad6e85fa170bf0c855809cabbfa0a7f3793c2d19497b11def0f357135b3e13bf5a3eb5f865677314fbb8fd2b62a56450fe209f60a042fc1ab38
-  data.tar.gz: d7b98ae64b2c6b5400ba1e2e40b0dd7003f5545075926b16537c4ed70d4107ad633043fdcf7c5856ff18821544cdcac1cc59e72accf00fb5d5874420bfd23cc2
+  metadata.gz: 05a947e009768f38ff16b41ed9fa4b1a3c30255cdba0532a6b4e614ce1fca56f642b0dc4cdfb74ee3a3b504382b3d2486e244f9fc41c444cd2ce8b4899c01813
+  data.tar.gz: 69d0447fac46a6e625d357c018874e1d0eedf61d221b12d5ec3299e3ff4ffd476a14f96212fc451b885f784b5d66cc20fb481fcc666879e7ce67906c4f4cddc7

data/README.md

@@ -35,8 +35,8 @@ The schedule file is a list of que job classes with arguments and a schedule fre
 syntax). The format is a superset of the resque-scheduler config format, so it they can be used
 as-is with no modification, assuming the job classes are migrated from Resque to Que.
 
-It has one additional feature, `unmissable: true`. This is set on a job that must be run for every 
-single matching cron time that goes by, even if the system is offline over more than one match. To better process these unmissable jobs, they are always enqueued with the first 
+It has one additional feature, `schedule_type: every_event`. This is set on a job that must be run for every 
+single matching cron time that goes by, even if the system is offline over more than one match. To better process these `every_event` jobs, they are always enqueued with the first 
 argument being the time that they were supposed to be processed.  
  
 For example:
@@ -78,22 +78,36 @@ DailyBatchReport:
   cron: "0 3 * * *"
   # This job will be run every day, and if workers are offline for several days, then the backlog
   # will all be scheduled when they are restored, each with that events timestamp as the first arg.
-  unmissable: true
+  schedule_type: every_event
 ```
 
+## Schedule types
+
+A job can have a `schedule_type` assigned to it. Valid values are:
+
+1. `default` - This job will be scheduled when a worker becomes available. If multiple cron times 
+  go by during an extended period of downtime then only one job will be enqueued. This is closer to 
+  how ordinary cron works.
+1. `every_event` - This job will always be scheduled with an ISO8601 time as the first argument. 
+  If multiple cron times go by during an extended period of downtime, then a job will be scheduled 
+  for every one missed. This schedule_type should be used for daily batch jobs that need to know 
+  which day they are running a batch for.
+
 ## Environment Variables
 
 You can configure some aspects of the gem with environment variables.
 
 * `QUE_SCHEDULER_CONFIG_LOCATION` - The location of the schedule configuration (default `config/que_schedule.yml`)
 
-## Redundancy and Fail-Over
+## HA Redundancy and DB restores
 
 Because of the way que-scheduler works, it requires no additional processes. It is, itself, a Que job.
 As long as there are Que workers functioning, then jobs will continue to be scheduled correctly. There
 are no HA concerns to worry about and no namespace collisions between different databases. 
 
-Additionally, like Que, when your database is backed up, your scheduling state is stored too.
+Additionally, like Que, when your database is backed up, your scheduling state is stored too. If your 
+workers are down for an extended period, or a DB restore is performed, the scheduler will always be 
+in a coherent state with the rest of your database.
 
 ## Multiple scheduler detection
 

data/lib/que/scheduler/defined_job.rb

@@ -7,6 +7,11 @@ module Que
     class DefinedJob < Hashie::Dash
       include Hashie::Extensions::Dash::PropertyTranslation
 
+      SCHEDULE_TYPES = [
+        SCHEDULE_TYPE_DEFAULT = :default,
+        SCHEDULE_TYPE_EVERY_EVENT = :every_event
+      ].freeze
+
       def self.err_field(f, v)
         suffix = 'in que-scheduler config ' \
                  "#{Que::Scheduler::ScheduleParser::QUE_SCHEDULER_CONFIG_LOCATION}"
@@ -22,7 +27,9 @@ module Que
       property :queue, transform_with: ->(v) { v.is_a?(String) ? v : err_field(:queue, v) }
       property :priority, transform_with: ->(v) { v.is_a?(Integer) ? v : err_field(:priority, v) }
       property :args
-      property :unmissable, default: false
+      property :schedule_type, default: SCHEDULE_TYPE_DEFAULT, transform_with: lambda { |v|
+        v.to_sym.tap { |vs| SCHEDULE_TYPES.include?(vs) || err_field(:schedule_type, v) }
+      }
 
       # Given a "last time", return the next Time the event will occur, or nil if it
       # is after "to".

data/lib/que/scheduler/enqueueing_calculator.rb

@@ -13,7 +13,7 @@ module Que
 
           # For each scheduled item, we need not schedule a job it if it has no history, as it is
           # new. Otherwise, check how many times we have missed the job since the last run time.
-          # If it is "unmissable" then we schedule all of them, with the missed time as an arg,
+          # If it is "every_event" then we schedule all of them, with the missed time as an arg,
           # otherwise just schedule it once.
           scheduler_config.each do |desc|
             job_name = desc.name
@@ -60,7 +60,7 @@ module Que
               priority: desc.priority
             }.compact
 
-            if desc.unmissable
+            if desc.schedule_type == DefinedJob::SCHEDULE_TYPE_EVERY_EVENT
               missed_times.each do |time_missed|
                 jobs_for_class << options.merge(args: [time_missed] + (desc.args || []))
               end

data/lib/que/scheduler/schedule_parser.rb

@@ -9,19 +9,32 @@ module Que
       QUE_SCHEDULER_CONFIG_LOCATION =
         ENV.fetch('QUE_SCHEDULER_CONFIG_LOCATION', 'config/que_schedule.yml')
 
-      def self.defined_jobs
-        @defined_jobs ||= YAML.load_file(QUE_SCHEDULER_CONFIG_LOCATION).map do |k, v|
-          Que::Scheduler::DefinedJob.new(
-            {
-              name: k,
-              job_class: v['class'] || k,
-              queue: v['queue'],
-              args: v['args'],
-              priority: v['priority'],
-              cron: v['cron'],
-              unmissable: v['unmissable']
-            }.compact
-          )
+      class << self
+        def defined_jobs
+          @defined_jobs ||= YAML.load_file(QUE_SCHEDULER_CONFIG_LOCATION).map do |k, v|
+            Que::Scheduler::DefinedJob.new(
+              {
+                name: k,
+                job_class: v['class'] || k,
+                queue: v['queue'],
+                args: v['args'],
+                priority: v['priority'],
+                cron: v['cron'],
+                schedule_type: schedule_type(v)
+              }.compact
+            )
+          end
+        end
+
+        private
+
+        # Migrate legacy config that used the `unmissable` config key.
+        def schedule_type(v)
+          if v['unmissable']
+            DefinedJob::SCHEDULE_TYPE_EVERY_EVENT
+          else
+            v['schedule_type'] || DefinedJob::SCHEDULE_TYPE_DEFAULT
+          end
         end
       end
     end

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '0.9.1'.freeze
+    VERSION = '0.10.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Harry Lascelles