que-scheduler 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b868cd1f3196296444a8927ad9c12f9e006b6c643033f96b93b61bf62ae871c3
-  data.tar.gz: 7367e82954c938a1ff1408dc65b8fd23042a88f0adbd9716e4763d43b6322bd4
+  metadata.gz: aa36f08ca0ae716d68fe7e97532c232a4e7740a625869962f433591ea034a987
+  data.tar.gz: c36e219b43f7b8a84fce908f21c32f5289512b2f9cf681fbb063046773165d72
 SHA512:
-  metadata.gz: aaf6d2512f701f1eb526eb7a89b60108b80b355581a37d3b4b5bae1cbccd6829006cadd9dff45a692d51aba79530fd0d13af05f67c4afd46b35411f7ebce552d
-  data.tar.gz: 75901d2616803d878c81317b7d6b70919fef77303264d80ad264d7f362e0664df9772607c563c922380cd27792e7e38493d3b586e6479dac25e7f7aea00ed8ca
+  metadata.gz: 767db06347c8be4daa350a1b38df514ac7ae58c124a5c022cf284b6bb32ba2794cf58df053ecce4ecd00c2e8532bd6de3f432fa4a5f6bbc05890aea818fc4138
+  data.tar.gz: 340c0d10f00ccfdeae9791d48e0112b227c92a1c9e00774a9b8d7bdb632a96587fac1be6fef59e597569491c5da6b39f21cfc89ce26fc8ad9c40104c2a668ae8

data/README.md

@@ -37,7 +37,8 @@ integers, and job classes must be migrated from Resque to Que. Cron syntax can b
 understood by [fugit](https://github.com/floraison/fugit#fugitcron).
 
 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 
+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:
@@ -137,3 +138,4 @@ This gem was inspired by the makers of the excellent [Que](https://github.com/ch
 ## Contributors
 
 * @jish
+* @joehorsnell

data/lib/que/scheduler/adapters/orm.rb

@@ -6,6 +6,7 @@ module Que
           SCHEDULER_COUNT_SQL =
             'SELECT COUNT(*) FROM que_jobs WHERE job_class = ' \
             "'#{Que::Scheduler::SchedulerJob.name}'".freeze
+          NOW_SQL = 'SELECT now()'.freeze
 
           def transaction
             transaction_base.transaction do
@@ -16,6 +17,10 @@ module Que
           def count_schedulers
             dml(SCHEDULER_COUNT_SQL).first.values.first.to_i
           end
+
+          def now
+            Time.zone.parse(dml(NOW_SQL).first.values.first)
+          end
         end
 
         class ActiveRecordAdapter < AdapterBase

data/lib/que/scheduler/defined_job.rb

@@ -68,7 +68,7 @@ module Que
                 cron: v['cron'],
                 schedule_type: v['schedule_type'] || DefinedJob::SCHEDULE_TYPE_DEFAULT
               }.compact
-            )
+            ).freeze
           end
         end
       end
@@ -94,6 +94,7 @@ module Que
           else
             jobs_for_class << options
           end
+          options.freeze
         end
         jobs_for_class
       end

data/lib/que/scheduler/scheduler_job.rb

@@ -18,10 +18,12 @@ module Que
           scheduler_job_args = SchedulerJobArgs.build(options)
           logs = ["que-scheduler last ran at #{scheduler_job_args.last_run_time}."]
 
-          # It's possible one worker node has severe clock skew, and reports a time earlier than
-          # the last run. If so, log, and rescheduled with the same last run at.
+          # It's possible the DB time has been changed manaully to an earlier time than it was
+          # before. Whether this was a small amount of time (eg clock drift correction), or a major
+          # change like timezone, the business schedule semantics of this are unknowable, so log and
+          # rescheduled with the same last run at.
           if scheduler_job_args.as_time < scheduler_job_args.last_run_time
-            handle_clock_skew(scheduler_job_args, logs)
+            handle_db_clock_change_backwards(scheduler_job_args, logs)
           else
             # Otherwise, run as normal
             handle_normal_call(scheduler_job_args, logs)
@@ -33,6 +35,15 @@ module Que
         end
       end
 
+      def enqueue_required_jobs(result, logs)
+        result.missed_jobs.each do |job_class, options_array|
+          options_array.each do |options|
+            enqueue_new_job(job_class, options.dup, logs)
+          end
+        end
+        result.schedule_dictionary
+      end
+
       private
 
       def assert_one_scheduler_job
@@ -42,30 +53,30 @@ module Que
       end
 
       def handle_normal_call(scheduler_job_args, logs)
-        result = enqueue_required_jobs(scheduler_job_args, logs)
+        # Obtain the hash of missed jobs. Keys are the job classes, and the values are arrays
+        # each containing params to enqueue.
+        result = EnqueueingCalculator.parse(DefinedJob.defined_jobs, scheduler_job_args)
+        new_job_dictionary = enqueue_required_jobs(result, logs)
         enqueue_self_again(
           scheduler_job_args.as_time,
           scheduler_job_args.as_time,
-          result.schedule_dictionary
+          new_job_dictionary
         )
       end
 
-      def enqueue_required_jobs(scheduler_job_args, logs)
-        # Obtain the hash of missed jobs. Keys are the job classes, and the values are arrays
-        # each containing more arrays for the arguments of that instance.
-        result = EnqueueingCalculator.parse(DefinedJob.defined_jobs, scheduler_job_args)
-        result.missed_jobs.each do |job_class, args_arrays|
-          args_arrays.each do |args|
-            logs << "que-scheduler enqueueing #{job_class} with args: #{args}"
-            job_class.enqueue(*args)
-          end
+      def enqueue_new_job(job_class, options, logs)
+        logs << "que-scheduler enqueueing #{job_class} with options: #{options}"
+        args = options.delete(:args)
+        if args.is_a?(Hash)
+          job_class.enqueue(args.merge(options))
+        else
+          job_class.enqueue(*args, options)
         end
-        result
       end
 
-      def handle_clock_skew(scheduler_job_args, logs)
-        logs << 'que-scheduler detected worker with time older than last run. ' \
-                    'Rescheduling without enqueueing jobs.'
+      def handle_db_clock_change_backwards(scheduler_job_args, logs)
+        logs << 'que-scheduler detected the DB time is further back than the last run. ' \
+                'Rescheduling self again without enqueueing jobs to wait for the clock to catch up.'
         enqueue_self_again(
           scheduler_job_args.last_run_time,
           scheduler_job_args.as_time,

data/lib/que/scheduler/scheduler_job_args.rb

@@ -11,11 +11,12 @@ module Que
       property :as_time, required: true
 
       def self.build(options)
+        now = ::Que::Scheduler::Adapters::Orm.instance.now
         parsed =
           if options.nil?
-            # First ever run
+            # First ever run, there is nothing to do but reschedule self.
             {
-              last_run_time: Time.zone.now,
+              last_run_time: now,
               job_dictionary: []
             }
           else
@@ -25,7 +26,7 @@ module Que
               job_dictionary: options.fetch(:job_dictionary)
             }
           end
-        SchedulerJobArgs.new(parsed.merge(as_time: Time.zone.now))
+        SchedulerJobArgs.new(parsed.merge(as_time: now))
       end
     end
   end

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '1.0.3'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport