que-scheduler 3.2.8 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a35cace72621c452055873ea88a13aba5d00a63933df91b2d4d60840f11337
-  data.tar.gz: 1b2d3bbb599260b37f8ca8c10a12bd03992b08ed74b0c75f47905b1f8238dfd5
+  metadata.gz: 5707036df23117e995d696388d17bfc0488eef9c7ba30211b1a3700e6f0fb94f
+  data.tar.gz: 3133e78529f3658c9509e0a1240189424caefc8219b7da035530e68fdbfb38c6
 SHA512:
-  metadata.gz: ab5ad0c46554887d523d7b9f90c8336da989489e76cc69a0bfe5465b66b34e7a7c3d0f2fc6c0dc026660926b51e4fff0fde029600b93e52386147565a4c10a2a
-  data.tar.gz: 7359bfdc4db605aea48c8bb87b1f02a8203dc103fa6e6c9ba5d6f33d051026c7e4abc7d4e5a503660d522d99f89c720455879a7b631929bd4e591961388afa75
+  metadata.gz: 4609167d5adfc2e7b9c583d3cbece89dd34e8624512b0c8c257804c05934964a343336b192944ce2790fde4f4b6029173df2f76d28fe7daee72e0a1ae473bad2
+  data.tar.gz: d55658a7923c50010a8a38713dc25c0f08d182004cb5156a336921f55b35e91631edb042f5e76f194d58ed04245ea8f08c78dd64386c2479ee4bdb8ba9a4512a

data/README.md

@@ -235,3 +235,4 @@ This gem was inspired by the makers of the excellent [Que](https://github.com/ch
 * @jish
 * @joehorsnell
 * @bnauta
+* @papodaca

data/lib/que/scheduler/audit.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'to_enqueue'
+
 module Que
   module Scheduler
     module Audit
@@ -24,11 +26,10 @@ module Que
         def append(scheduler_job_id, executed_at, enqueued_jobs)
           ::Que::Scheduler::VersionSupport.execute(INSERT_AUDIT, [scheduler_job_id, executed_at])
           enqueued_jobs.each do |j|
-            attrs = Que::Scheduler::VersionSupport.job_attributes(j)
             inserted = ::Que::Scheduler::VersionSupport.execute(
               INSERT_AUDIT_ENQUEUED,
               [scheduler_job_id] +
-                attrs.values_at(:job_class, :queue, :priority, :args, :job_id, :run_at)
+                j.values_at(:job_class, :queue, :priority, :args, :job_id, :run_at)
             )
             raise "Cannot save audit row #{scheduler_job_id} #{executed_at} #{j}" if inserted.empty?
           end

data/lib/que/scheduler/defined_job.rb

@@ -10,23 +10,23 @@ module Que
 
       DEFINED_JOB_TYPES = [
         DEFINED_JOB_TYPE_DEFAULT = :default,
-        DEFINED_JOB_TYPE_EVERY_EVENT = :every_event
+        DEFINED_JOB_TYPE_EVERY_EVENT = :every_event,
       ].freeze
 
-      property :name, required: true
-      property :job_class, required: true, transform_with: lambda { |v|
-        job_class = Object.const_get(v)
-        job_class < Que::Job ? job_class : err_field(:job_class, v)
-      }
-      property :cron, required: true, transform_with: lambda { |v|
-        Fugit::Cron.parse(v) || err_field(:cron, v)
-      }
-      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 :name
+      property :job_class, transform_with: ->(v) { Object.const_get(v) }
+      property :cron, transform_with: ->(v) { Fugit::Cron.parse(v) }
+      property :queue
+      property :priority
       property :args
-      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) }
-      }
+      property :schedule_type, default: DEFINED_JOB_TYPE_DEFAULT
+
+      class << self
+        def create(options)
+          defined_job = new(options.compact)
+          defined_job.freeze.tap { |dj| dj.validate(options) }
+        end
+      end
 
       # Given a "last time", return the next Time the event will occur, or nil if it
       # is after "to".
@@ -49,22 +49,67 @@ module Que
         generate_to_enqueue_list(missed_times)
       end
 
-      class << self
-        private
+      def validate(options)
+        validate_fields_presence(options)
+        validate_fields_types(options)
+        validate_job_class_related(options)
+      end
+
+      private
 
-        def err_field(field, value)
-          schedule = Que::Scheduler.configuration.schedule_location
-          raise "Invalid #{field} '#{value}' in que-scheduler schedule #{schedule}"
+      # rubocop:disable Style/GuardClause This reads better as a conditional
+      def validate_fields_types(options)
+        unless queue.nil? || queue.is_a?(String)
+          err_field(:queue, options, 'queue must be a string')
+        end
+        unless priority.nil? || priority.is_a?(Integer)
+          err_field(:priority, options, 'priority must be an integer')
+        end
+        unless DEFINED_JOB_TYPES.include?(schedule_type)
+          err_field(:schedule_type, options, "Not in #{DEFINED_JOB_TYPES}")
         end
       end
+      # rubocop:enable Style/GuardClause
 
-      private
+      def validate_fields_presence(options)
+        err_field(:name, options, 'name must be present') if name.nil?
+        err_field(:job_class, options, 'job_class must be present') if job_class.nil?
+        # An invalid cron is nil
+        err_field(:cron, options, 'cron must be present') if cron.nil?
+      end
+
+      def validate_job_class_related(options)
+        # Only support known job engines
+        unless Que::Scheduler::ToEnqueue.valid_job_class?(job_class)
+          err_field(:job_class, options, "Job #{job_class} was not a supported job type")
+        end
+
+        # queue name is only supported for a subrange of ActiveJob versions. Print this out as a
+        # warning.
+        if queue &&
+           Que::Scheduler::ToEnqueue.active_job_sufficient_version? &&
+           job_class < ::ActiveJob::Base &&
+           Que::Scheduler::ToEnqueue.active_job_version < Gem::Version.create('6.0.3')
+          puts <<-ERR
+            WARNING from que-scheduler....
+            Between versions 4.2.3 and 6.0.2 (inclusive) Rails did not support setting queue names
+            on que jobs with ActiveJob, so que-scheduler cannot support it.
+            See removed in Rails 4.2.3
+              https://github.com/rails/rails/pull/19498
+            And readded in Rails 6.0.3
+              https://github.com/rails/rails/pull/38635
+
+            Please remove all "queue" keys from ActiveJobs defined in the que-scheduler.yml config.
+            Specifically #{queue} for job #{name}.
+          ERR
+        end
+      end
 
-      class ToEnqueue < Hashie::Dash
-        property :args, required: true, default: []
-        property :queue
-        property :priority
-        property :job_class, required: true
+      def err_field(field, options, reason = '')
+        schedule = Que::Scheduler.configuration.schedule_location
+        value = options[field]
+        raise "Invalid #{field} '#{value}' for '#{name}' in que-scheduler schedule #{schedule}.\n" \
+              "#{reason}"
       end
 
       def generate_to_enqueue_list(missed_times)
@@ -75,10 +120,10 @@ module Que
 
         if schedule_type == DefinedJob::DEFINED_JOB_TYPE_EVERY_EVENT
           missed_times.map do |time_missed|
-            ToEnqueue.new(options.merge(args: [time_missed] + args_array))
+            ToEnqueue.create(options.merge(args: [time_missed] + args_array))
           end
         else
-          [ToEnqueue.new(options.merge(args: args_array))]
+          [ToEnqueue.create(options.merge(args: args_array))]
         end
       end
     end

data/lib/que/scheduler/schedule.rb

@@ -27,17 +27,15 @@ module Que
         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
+          Que::Scheduler::DefinedJob.create(
+            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']&.to_sym
+          )
         end
       end
     end

data/lib/que/scheduler/scheduler_job.rb

@@ -4,6 +4,7 @@ require_relative 'schedule'
 require_relative 'enqueueing_calculator'
 require_relative 'scheduler_job_args'
 require_relative 'state_checks'
+require_relative 'to_enqueue'
 require_relative 'version_support'
 
 # The main job that runs every minute, determining what needs to be enqueued, enqueues the required
@@ -22,13 +23,11 @@ module Que
 
           scheduler_job_args = SchedulerJobArgs.build(options)
           logs = ["que-scheduler last ran at #{scheduler_job_args.last_run_time}."]
-
           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
           )
-
           # Only now we're sure nothing errored, log the results
           logs.each { |str| ::Que.log(event: 'que-scheduler'.to_sym, message: str) }
           destroy
@@ -37,31 +36,23 @@ module Que
 
       def enqueue_required_jobs(result, logs)
         result.missed_jobs.map do |to_enqueue|
-          job_class = to_enqueue.job_class
-          args = to_enqueue.args
-          remaining_hash = to_enqueue.except(:job_class, :args)
-          enqueued_job =
-            if args.is_a?(Hash)
-              job_class.enqueue(args.merge(remaining_hash))
-            else
-              job_class.enqueue(*args, remaining_hash)
-            end
-          check_enqueued_job(enqueued_job, job_class, args, logs)
+          to_enqueue.enqueue.tap do |enqueued_job|
+            check_enqueued_job(to_enqueue, enqueued_job, logs)
+          end
         end.compact
       end
 
       private
 
-      def check_enqueued_job(enqueued_job, job_class, args, logs)
-        if enqueued_job.is_a?(Que::Job)
-          job_id = Que::Scheduler::VersionSupport.job_attributes(enqueued_job).fetch(:job_id)
-          logs << "que-scheduler enqueueing #{job_class} #{job_id} with args: #{args}"
-          enqueued_job
-        else
-          # This can happen if a middleware nixes the enqueue call
-          logs << "que-scheduler called enqueue on #{job_class} but did not receive a #{Que::Job}"
-          nil
-        end
+      def check_enqueued_job(to_enqueue, enqueued_job, logs)
+        logs << if enqueued_job.present?
+                  "que-scheduler enqueueing #{enqueued_job.job_class} " \
+                              "#{enqueued_job.job_id} with args: #{enqueued_job.args}"
+                else
+                  # This can happen if a middleware nixes the enqueue call
+                  "que-scheduler called enqueue on #{to_enqueue.job_class} " \
+                              'but it reported no job was scheduled. Has `enqueue` been overridden?'
+                end
       end
 
       def enqueue_self_again(scheduler_job_args, last_full_execution, job_dictionary, enqueued_jobs)
@@ -79,7 +70,7 @@ module Que
         )
 
         # rubocop:disable Style/GuardClause This reads better as a conditional
-        unless check_enqueued_job(enqueued_job, SchedulerJob, {}, [])
+        unless Que::Scheduler::VersionSupport.job_attributes(enqueued_job).fetch(:job_id)
           raise 'SchedulerJob could not self-schedule. Has `.enqueue` been monkey patched?'
         end
         # rubocop:enable Style/GuardClause

data/lib/que/scheduler/to_enqueue.rb

@@ -0,0 +1,150 @@
+require 'que'
+
+# This module uses polymorphic dispatch to centralise the differences between supporting Que::Job
+# and other job systems.
+module Que
+  module Scheduler
+    class ToEnqueue < Hashie::Dash
+      property :args, required: true, default: []
+      property :queue
+      property :priority
+      property :run_at, required: true
+      property :job_class, required: true
+
+      class << self
+        def create(options)
+          type_from_job_class(options.fetch(:job_class)).new(
+            options.merge(run_at: Que::Scheduler::Db.now)
+          )
+        end
+
+        def valid_job_class?(job_class)
+          type_from_job_class(job_class).present?
+        end
+
+        def active_job_version
+          Gem.loaded_specs['activejob']&.version
+        end
+
+        def active_job_sufficient_version?
+          # ActiveJob 4.x does not support job_ids correctly
+          # https://github.com/rails/rails/pull/20056/files
+          active_job_version && active_job_version > Gem::Version.create('5')
+        end
+
+        private
+
+        def type_from_job_class(job_class)
+          types.each do |type, implementation|
+            return implementation if job_class < type
+          end
+          nil
+        end
+
+        def types
+          @types ||=
+            begin
+              hash = {
+                ::Que::Job => QueJobType,
+              }
+              hash[::ActiveJob::Base] = ActiveJobType if ToEnqueue.active_job_sufficient_version?
+              hash
+            end
+        end
+      end
+    end
+
+    # For jobs of type Que::Job
+    class QueJobType < ToEnqueue
+      def enqueue
+        job_settings = to_h.slice(:queue, :priority, :run_at).compact
+        job =
+          if args.is_a?(Hash)
+            job_class.enqueue(**args.merge(job_settings))
+          else
+            job_class.enqueue(*args, **job_settings)
+          end
+
+        return nil if job.nil? || !job # nil in Rails < 6.1, false after.
+
+        # Now read the just inserted job back out of the DB to get the actual values that will
+        # be used when the job is worked.
+        values = Que::Scheduler::VersionSupport.job_attributes(job).slice(
+          :args, :queue, :priority, :run_at, :job_class, :job_id
+        )
+        EnqueuedJobType.new(values)
+      end
+    end
+
+    # For jobs of type ActiveJob
+    class ActiveJobType < ToEnqueue
+      def enqueue
+        job = enqueue_active_job
+
+        return nil if job.nil? || !job # nil in Rails < 6.1, false after.
+
+        enqueued_values = calculate_enqueued_values(job)
+        EnqueuedJobType.new(enqueued_values)
+      end
+
+      private
+
+      def calculate_enqueued_values(job)
+        # Now read the just inserted job back out of the DB to get the actual values that will
+        # be used when the job is worked.
+        data = JSON.parse(job.to_json, symbolize_names: true)
+
+        # ActiveJob scheduled_at is returned as a float, where we want a Time for consistency
+        scheduled_at =
+          begin
+            scheduled_at_float = data[:scheduled_at]
+            scheduled_at_float ? Time.zone.at(scheduled_at_float) : nil
+          end
+
+        # Rails doesn't support queues for ActiveJob
+        # https://github.com/rails/rails/pull/19498
+        used_queue = nil
+
+        # We can't get the priority out of the DB, as the returned `job` doesn't give us access
+        # to the underlying ActiveJob that was scheduled. We have no option but to assume
+        # it was what we told it to use. If no priority was specified, we must assume it was
+        # the Que default, which is 100 t.ly/1jRK5
+        assume_used_priority = priority.nil? ? 100 : priority
+
+        {
+          args: data.fetch(:arguments),
+          queue: used_queue,
+          priority: assume_used_priority,
+          run_at: scheduled_at,
+          job_class: job_class.to_s,
+          job_id: data.fetch(:provider_job_id),
+        }
+      end
+
+      def enqueue_active_job
+        job_settings = {
+          priority: priority,
+          wait_until: run_at,
+        }.compact
+
+        job_class_set = job_class.set(**job_settings)
+        if args.is_a?(Hash)
+          job_class_set.perform_later(**args)
+        else
+          job_class_set.perform_later(*args)
+        end
+      end
+    end
+
+    # A value object returned after a job has been enqueued. This is necessary as Que (normal) and
+    # ActiveJob return very different objects from the `enqueue` call.
+    class EnqueuedJobType < Hashie::Dash
+      property :args
+      property :queue
+      property :priority
+      property :run_at, required: true
+      property :job_class, required: true
+      property :job_id, required: true
+    end
+  end
+end

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '3.2.8'.freeze
+    VERSION = '3.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.2.8
+  version: 3.3.0
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -228,16 +228,16 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -256,16 +256,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: 0.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: 0.80.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -336,6 +336,7 @@ files:
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb
 - lib/que/scheduler/state_checks.rb
+- lib/que/scheduler/to_enqueue.rb
 - lib/que/scheduler/version.rb
 - lib/que/scheduler/version_support.rb
 homepage: https://github.com/hlascelles/que-scheduler
@@ -362,8 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A cron scheduler for Que