que-scheduler 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a243842a2035934a0aa1ee9d28f7620a376491b5
-  data.tar.gz: 43cc12d4246e4f74d32f17497fbe43957bc7a7af
+  metadata.gz: 50f99770c888127c3d20b6d5a9072fd529c3a6be
+  data.tar.gz: 3fedea8f36b9a322b4cc1b09b05eb1fab35789e8
 SHA512:
-  metadata.gz: 8f8398000dcd8cf65c1dff98928752fb58e9b548f05b6ea66eb3f2714fe7d58706b57d489a6719b944e1ec48b722c6fed73678e46e957c212ebef5b49b2e7a4c
-  data.tar.gz: baff4c34fce9a3bd4649e32490bc47a7b409d22871f8e0f57fe02432657fad0861e89650cc153deae3d1b39304d6bc66cae1e645618db170e2903595de214a38
+  metadata.gz: 5c406a1a4d22830795836f2bde623ed6b438f0c9e09fdc5bfaf15d5df3bd1385e924e208058241df8a06dc614ea10746d85e13e8d1d9c80022e972fade58c4be
+  data.tar.gz: '08cae05d301b647f98b85ffbf1512709b0c134d5432c73c02a3620e5f3914ecc56ce32ae8fb7b71c2cf6d6bca3d6a6873f8ed310aee7bbd0b8dcbfac6a441583'

data/lib/que/scheduler/defined_job.rb

@@ -1,10 +1,14 @@
 require 'hashie'
 require 'fugit'
+require 'backports/2.4.0/hash/compact'
 
 # This is the definition of one scheduleable job in the que-scheduler config yml file.
 module Que
   module Scheduler
     class DefinedJob < Hashie::Dash
+      QUE_SCHEDULER_CONFIG_LOCATION =
+        ENV.fetch('QUE_SCHEDULER_CONFIG_LOCATION', 'config/que_schedule.yml')
+
       include Hashie::Extensions::Dash::PropertyTranslation
 
       SCHEDULE_TYPES = [
@@ -13,8 +17,7 @@ module Que
       ].freeze
 
       def self.err_field(f, v)
-        suffix = 'in que-scheduler config ' \
-                 "#{Que::Scheduler::ScheduleParser::QUE_SCHEDULER_CONFIG_LOCATION}"
+        suffix = "in que-scheduler config #{QUE_SCHEDULER_CONFIG_LOCATION}"
         raise "Invalid #{f} '#{v}' #{suffix}"
       end
 
@@ -38,6 +41,62 @@ module Que
         next_run = next_time.to_local_time.in_time_zone(next_time.zone)
         next_run <= to ? next_run : nil
       end
+
+      # Given the last scheduler run time, and this run time, return all
+      # the instances that should be enqueued for the job class.
+      def calculate_missed_runs(last_run_time, as_time)
+        missed_times = []
+        last_time = last_run_time
+        while (next_run = next_run_time(last_time, as_time))
+          missed_times << next_run
+          last_time = next_run
+        end
+
+        generate_required_jobs_list(missed_times)
+      end
+
+      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: v['schedule_type'] || DefinedJob::SCHEDULE_TYPE_DEFAULT
+              }.compact
+            )
+          end
+        end
+      end
+
+      private
+
+      # Given the timestamps of the missed events, generate a list of jobs
+      # that can be enqueued as an array of arrays of args.
+      def generate_required_jobs_list(missed_times)
+        jobs_for_class = []
+
+        unless missed_times.empty?
+          options = {
+            args: args,
+            queue: queue,
+            priority: priority
+          }.compact
+
+          if schedule_type == DefinedJob::SCHEDULE_TYPE_EVERY_EVENT
+            missed_times.each do |time_missed|
+              jobs_for_class << options.merge(args: [time_missed] + (args || []))
+            end
+          else
+            jobs_for_class << options
+          end
+        end
+        jobs_for_class
+      end
     end
   end
 end

data/lib/que/scheduler/engine.rb

@@ -7,7 +7,7 @@ module Que
     class Engine < ::Rails::Engine
       config.after_initialize do
         # Trigger a load of the schedule to ensure fast fail if it is invalid.
-        ScheduleParser.defined_jobs
+        ::Que::Scheduler::DefinedJob.defined_jobs
       end
     end
   end

data/lib/que/scheduler/enqueueing_calculator.rb

@@ -1,11 +1,10 @@
 require 'fugit'
-require 'backports/2.4.0/hash/compact'
 
 module Que
   module Scheduler
-    EnqueueingCalculatorResult = Struct.new(:missed_jobs, :schedule_dictionary)
-
     class EnqueueingCalculator
+      Result = Struct.new(:missed_jobs, :schedule_dictionary)
+
       class << self
         def parse(scheduler_config, scheduler_job_args)
           missed_jobs = {}
@@ -24,51 +23,13 @@ module Que
             next unless scheduler_job_args.job_dictionary.include?(job_name)
 
             # This has been seen before. We should check if we have missed any executions.
-            missed = calculate_missed_runs(
-              desc, scheduler_job_args.last_run_time, scheduler_job_args.as_time
+            missed = desc.calculate_missed_runs(
+              scheduler_job_args.last_run_time, scheduler_job_args.as_time
             )
             missed_jobs[desc.job_class] = missed unless missed.empty?
           end
 
-          EnqueueingCalculatorResult.new(missed_jobs, schedule_dictionary)
-        end
-
-        private
-
-        # Given a job description, the last scheduler run time, and this run time, return all
-        # the instances that should be enqueued for that job class.
-        def calculate_missed_runs(desc, last_run_time, as_time)
-          missed_times = []
-          last_time = last_run_time
-          while (next_run = desc.next_run_time(last_time, as_time))
-            missed_times << next_run
-            last_time = next_run
-          end
-
-          generate_required_jobs_list(desc, missed_times)
-        end
-
-        # Given a job description, and the timestamps of the missed events, generate a list of jobs
-        # that can be enqueued as an array of arrays of args.
-        def generate_required_jobs_list(desc, missed_times)
-          jobs_for_class = []
-
-          unless missed_times.empty?
-            options = {
-              args: desc.args,
-              queue: desc.queue,
-              priority: desc.priority
-            }.compact
-
-            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
-            else
-              jobs_for_class << options
-            end
-          end
-          jobs_for_class
+          Result.new(missed_jobs, schedule_dictionary)
         end
       end
     end

data/lib/que/scheduler/scheduler_job.rb

@@ -1,6 +1,6 @@
 require 'que'
 
-require_relative 'schedule_parser'
+require_relative 'defined_job'
 require_relative 'enqueueing_calculator'
 require_relative 'scheduler_job_args'
 
@@ -10,13 +10,13 @@ module Que
       SCHEDULER_COUNT_SQL = "SELECT COUNT(*) FROM que_jobs WHERE job_class = '#{name}'".freeze
       SCHEDULER_FREQUENCY = 60
 
-      # Highest possible priority.
+      # Always highest possible priority.
       @priority = 0
 
       def run(options = nil)
         ::ActiveRecord::Base.transaction do
           assert_one_scheduler_job
-          scheduler_job_args = SchedulerJobArgs.prepare_scheduler_job_args(options)
+          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
@@ -54,7 +54,7 @@ module Que
       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(ScheduleParser.defined_jobs, scheduler_job_args)
+        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}"

data/lib/que/scheduler/scheduler_job_args.rb

@@ -8,7 +8,7 @@ module Que
       property :job_dictionary, required: true
       property :as_time, required: true
 
-      def self.prepare_scheduler_job_args(options)
+      def self.build(options)
         parsed =
           if options.nil?
             # First ever run

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -92,7 +92,6 @@ files:
 - lib/que/scheduler/defined_job.rb
 - lib/que/scheduler/engine.rb
 - lib/que/scheduler/enqueueing_calculator.rb
-- lib/que/scheduler/schedule_parser.rb
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb
 - lib/que/scheduler/version.rb

data/lib/que/scheduler/schedule_parser.rb

@@ -1,31 +0,0 @@
-require 'yaml'
-require 'backports/2.4.0/hash/compact'
-
-require_relative 'defined_job'
-
-module Que
-  module Scheduler
-    module ScheduleParser
-      QUE_SCHEDULER_CONFIG_LOCATION =
-        ENV.fetch('QUE_SCHEDULER_CONFIG_LOCATION', 'config/que_schedule.yml')
-
-      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: v['schedule_type'] || DefinedJob::SCHEDULE_TYPE_DEFAULT
-              }.compact
-            )
-          end
-        end
-      end
-    end
-  end
-end