que-scheduler 3.2.7 → 3.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1085b028076fd5380d046d26f49dbc42004e0a0c9a0576e8e92cff93726e980f
-  data.tar.gz: 61c315d358848616d9bdc74a6704a011e0ca6165ebd5fce104eeac7a1ad830ec
+  metadata.gz: c2a35cace72621c452055873ea88a13aba5d00a63933df91b2d4d60840f11337
+  data.tar.gz: 1b2d3bbb599260b37f8ca8c10a12bd03992b08ed74b0c75f47905b1f8238dfd5
 SHA512:
-  metadata.gz: b11700cb20b528d2cac6b00960736e1107277163d80b22f68eb498fe00b5530260c6f89e1f6c6981f982af33b73bf6d7ebf8fa9273e35fd6495fb8cb0f516aa1
-  data.tar.gz: aa6b0ca104cbe5daf013c748d854df1e9755a065a7183ef9182783d155707272fbd27d89b58c8097b16ba7368b42f3c68f5802756f4f012851c2392bc36a8640
+  metadata.gz: ab5ad0c46554887d523d7b9f90c8336da989489e76cc69a0bfe5465b66b34e7a7c3d0f2fc6c0dc026660926b51e4fff0fde029600b93e52386147565a4c10a2a
+  data.tar.gz: 7359bfdc4db605aea48c8bb87b1f02a8203dc103fa6e6c9ba5d6f33d051026c7e4abc7d4e5a503660d522d99f89c720455879a7b631929bd4e591961388afa75

data/README.md

@@ -22,7 +22,7 @@ needs to be run, enqueueing those jobs, then enqueueing itself to check again la
 look for it is `config/que_schedule.yml`. They are essentially the same as resque-scheduler
 files, but with additional features.
 
-1. Add a migration to start the job scheduler and prepare the audit table.
+1. Add a migration to start the job scheduler and prepare the audit table. Note that this migration will fail if Que is set to execute jobs synchronously, i.e. `Que::Job.run_synchronously = true`.
 
     ```ruby
     class CreateQueSchedulerSchema < ActiveRecord::Migration
@@ -234,3 +234,4 @@ This gem was inspired by the makers of the excellent [Que](https://github.com/ch
 
 * @jish
 * @joehorsnell
+* @bnauta

data/lib/que/scheduler/scheduler_job.rb

@@ -13,8 +13,8 @@ module Que
     class SchedulerJob < Que::Job
       SCHEDULER_FREQUENCY = 60
 
-      # Always highest possible priority.
       Que::Scheduler::VersionSupport.set_priority(self, 0)
+      Que::Scheduler::VersionSupport.apply_retry_semantics(self)
 
       def run(options = nil)
         Que::Scheduler::Db.transaction do

data/lib/que/scheduler/state_checks.rb

@@ -17,9 +17,22 @@ module Que
           db_version = Que::Scheduler::Migrations.db_version
           return if db_version == Que::Scheduler::Migrations::MAX_VERSION
 
+          sync_err =
+            if Que::Scheduler::VersionSupport.running_synchronously? && db_version.zero?
+              code = Que::Scheduler::VersionSupport.running_synchronously_code?
+              <<-ERR_SYNC
+                You currently have Que to run in synchronous mode using
+                #{code}, so it is most likely this error
+                has happened during an initial migration. You should disable synchronous mode and
+                try again. Note, que-scheduler uses "forward time" scheduled jobs, so will not work
+                in synchronous mode.
+
+              ERR_SYNC
+            end
+
           raise(<<-ERR)
             The que-scheduler db migration state was found to be #{db_version}. It should be #{Que::Scheduler::Migrations::MAX_VERSION}.
-
+            #{sync_err}
             que-scheduler adds some tables to the DB to provide an audit history of what was
             enqueued when, and with what options and arguments. The structure of these tables is
             versioned, and should match that version required by the gem.
@@ -42,6 +55,9 @@ module Que
                 Que::Scheduler::Migrations.migrate!(version: #{Que::Scheduler::Migrations::MAX_VERSION})
               end
             end
+
+            It is also possible that you are running a migration with Que set up to execute jobs
+            synchronously. This will fail as que-scheduler needs the above tables to work.
           ERR
         end
 

data/lib/que/scheduler/version.rb

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

data/lib/que/scheduler/version_support.rb

@@ -5,7 +5,14 @@ require 'que'
 module Que
   module Scheduler
     module VersionSupport
+      RETRY_PROC = proc { |count|
+        # Maximum one hour, otherwise use the default backoff
+        count > 7 ? (60 * 60) : ((count**4) + 3)
+      }
+
       class << self
+        # Ensure que-scheduler runs at the highest priority. This is because its priority is a
+        # the top of all jobs it enqueues.
         def set_priority(context, priority)
           if zero_major?
             context.instance_variable_set('@priority', priority)
@@ -14,6 +21,16 @@ module Que
           end
         end
 
+        # Ensure the job runs at least once an hour when it is backing off due to errors
+        def apply_retry_semantics(context)
+          if zero_major?
+            context.instance_variable_set('@retry_interval', RETRY_PROC)
+          else
+            context.maximum_retry_count = 1 << 128 # Heat death of universe
+            context.retry_interval = RETRY_PROC
+          end
+        end
+
         def job_attributes(enqueued_job)
           if zero_major?
             enqueued_job.attrs.transform_keys(&:to_sym)
@@ -31,11 +48,15 @@ module Que
         end
 
         def default_scheduler_queue
-          if zero_major?
-            ''
-          else
-            Que::DEFAULT_QUEUE
-          end
+          zero_major? ? '' : Que::DEFAULT_QUEUE
+        end
+
+        def running_synchronously?
+          zero_major? ? (Que.mode == :sync) : Que.run_synchronously
+        end
+
+        def running_synchronously_code?
+          zero_major? ? 'Que.mode == :sync' : 'Que.run_synchronously = true'
         end
 
         def zero_major?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.2.7
+  version: 3.2.8
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,16 +62,22 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: que
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +87,7 @@ dependencies:
         version: '0.12'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta3
+        version: 1.0.0.beta4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +97,7 @@ dependencies:
         version: '0.12'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta3
+        version: 1.0.0.beta4
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement