que-scheduler 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f254bc8751dac98fee9686fd5c239e9e57582fb
-  data.tar.gz: 4aa6fddb651b9f99b02bb75fcd2a2e8aa4f904f4
+  metadata.gz: 2b504deabde4b9902e95944af14f2bd0820c6e7e
+  data.tar.gz: 9cecf4a0dcf0f6497096d0dfe5824c1452447c53
 SHA512:
-  metadata.gz: 68aa99ec22631df458f58dc2c76bd57ecbf580982e7cb4389e703cdfcb90a4850099ca7a958ae96c80f089804d0ed200419536e123639efc56000da51ab8614c
-  data.tar.gz: f3a19e704d97f15b84d0b550c2220a2beeb475b36d9bb8c499794f0f655cd42922d9a9472e09be93462705d7022e85b6ba81ca44fa95131346d3ab5d04b2b4c3
+  metadata.gz: f2ebae7e9453682a6ed07f84b46523e1a617df42d9ed1aca8f60abb314080a5285067c56bcbaafa6d908d5adf26e90ba810afa90d31c7ac9a5c8a6f36ab8d009
+  data.tar.gz: 3b6425695eaaa1519a8cb4ec579bb40e9eb5a3a4514ffc5bc74218f884f43cb0ee884b2c329753107f56fe1f0d0743bca7a975a5c41e175e9cb86da9e0c5fdd3

data/README.md

@@ -183,6 +183,34 @@ As of migration `4`, two elements are added to the DB for que-scheduler to run.
   `que_scheduler_audit_enqueued`. The first tracks when the scheduler calculated what was necessary to run 
   (if anything). The second then logs every job that the scheduler enqueues. 
 
+## Testing Configuration
+
+You can add tests to validate your configuration during the spec phase. This will perform a variety 
+of sanity checks and ensure that:
+
+1. The yml is present and valid
+1. The job classes exist and are descendants of Que::Job
+1. The cron fields are present and valid
+1. The queues (if present) are strings
+1. The priorities (if present) are integers
+1. The schedule_types are known
+
+```ruby
+
+  describe 'check que_schedule.yml' do
+    it 'loads the schedule from the default location' do
+      # Will raise an error if any config is invalid
+      expect(Que::Scheduler.schedule).not_to be nil
+    end
+  end
+```
+
+## Error Notification
+
+If there is an error during scheduling, que-scheduler will report it using the [standard que error
+notifier](https://github.com/chanks/que/blob/master/docs/error_handling.md#error-notifications).
+The scheduler will then continue to retry indefinitely.
+
 ## Upgrading
 
 que-scheduler uses [semantic versioning](https://semver.org/), so major version changes will usually 

data/lib/que/scheduler/defined_job.rb

@@ -8,9 +8,9 @@ module Que
     class DefinedJob < Hashie::Dash
       include Hashie::Extensions::Dash::PropertyTranslation
 
-      SCHEDULE_TYPES = [
-        SCHEDULE_TYPE_DEFAULT = :default,
-        SCHEDULE_TYPE_EVERY_EVENT = :every_event
+      DEFINED_JOB_TYPES = [
+        DEFINED_JOB_TYPE_DEFAULT = :default,
+        DEFINED_JOB_TYPE_EVERY_EVENT = :every_event
       ].freeze
 
       property :name, required: true
@@ -24,8 +24,8 @@ 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 :schedule_type, default: SCHEDULE_TYPE_DEFAULT, transform_with: lambda { |v|
-        v.to_sym.tap { |vs| SCHEDULE_TYPES.include?(vs) || err_field(:schedule_type, v) }
+      property :schedule_type, default: DEFINED_JOB_TYPE_DEFAULT, transform_with: lambda { |v|
+        v.to_sym.tap { |vs| DEFINED_JOB_TYPES.include?(vs) || err_field(:schedule_type, v) }
       }
 
       # Given a "last time", return the next Time the event will occur, or nil if it
@@ -50,23 +50,6 @@ module Que
       end
 
       class << self
-        def defined_jobs
-          schedule_string = IO.read(Que::Scheduler.configuration.schedule_location)
-          @defined_jobs ||= YAML.safe_load(schedule_string).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'],
-              }.compact
-            ).freeze
-          end
-        end
-
         private
 
         def err_field(field, value)
@@ -90,7 +73,7 @@ module Que
         options = to_h.slice(:args, :queue, :priority, :job_class).compact
         args_array = args.is_a?(Array) ? args : Array(args)
 
-        if schedule_type == DefinedJob::SCHEDULE_TYPE_EVERY_EVENT
+        if schedule_type == DefinedJob::DEFINED_JOB_TYPE_EVERY_EVENT
           missed_times.map do |time_missed|
             ToEnqueue.new(options.merge(args: [time_missed] + args_array))
           end

data/lib/que/scheduler/migrations.rb

@@ -13,6 +13,9 @@ module Que
 
       class << self
         def migrate!(version:)
+          # Like que, Do not migrate test DBs.
+          return if defined?(Que::Testing)
+
           Que::Scheduler::Db.transaction do
             current = db_version
             if current < version

data/lib/que/scheduler/schedule.rb

@@ -0,0 +1,51 @@
+require_relative 'defined_job'
+
+module Que
+  module Scheduler
+    class Schedule
+      class << self
+        def schedule
+          @schedule ||=
+            begin
+              location = Que::Scheduler.configuration.schedule_location
+              from_file(location)
+            end
+        end
+
+        def from_file(location)
+          yml = IO.read(location)
+          config_hash = YAML.safe_load(yml)
+          from_hash(config_hash)
+        end
+
+        def from_hash(config_hash)
+          config_hash.map do |name, defined_job_hash|
+            [name, hash_item_to_defined_job(name, defined_job_hash)]
+          end.to_h
+        end
+
+        private
+
+        def hash_item_to_defined_job(name, defined_job_hash)
+          Que::Scheduler::DefinedJob.new(
+            {
+              name: name,
+              job_class: defined_job_hash['class'] || name,
+              queue: defined_job_hash['queue'],
+              args: defined_job_hash['args'],
+              priority: defined_job_hash['priority'],
+              cron: defined_job_hash['cron'],
+              schedule_type: defined_job_hash['schedule_type'],
+            }.compact
+          ).freeze
+        end
+      end
+    end
+
+    class << self
+      def schedule
+        Schedule.schedule
+      end
+    end
+  end
+end

data/lib/que/scheduler/scheduler_job.rb

@@ -1,6 +1,6 @@
 require 'que'
 
-require_relative 'defined_job'
+require_relative 'schedule'
 require_relative 'enqueueing_calculator'
 require_relative 'scheduler_job_args'
 require_relative 'state_checks'
@@ -22,7 +22,7 @@ module Que
           scheduler_job_args = SchedulerJobArgs.build(options)
           logs = ["que-scheduler last ran at #{scheduler_job_args.last_run_time}."]
 
-          result = EnqueueingCalculator.parse(DefinedJob.defined_jobs, scheduler_job_args)
+          result = EnqueueingCalculator.parse(Scheduler.schedule.values, scheduler_job_args)
           enqueued_jobs = enqueue_required_jobs(result, logs)
           enqueue_self_again(
             scheduler_job_args, scheduler_job_args.as_time, result.job_dictionary, enqueued_jobs

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '3.2.1'.freeze
+    VERSION = '3.2.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-01 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -328,6 +328,7 @@ files:
 - lib/que/scheduler/migrations/3/up.sql
 - lib/que/scheduler/migrations/4/down.sql
 - lib/que/scheduler/migrations/4/up.sql
+- lib/que/scheduler/schedule.rb
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb
 - lib/que/scheduler/state_checks.rb