que-scheduler 9.0.0 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43c9761073fc43892c380b61ea7aeadb456c19b1f3d992eca44f93b7ec41c757
-  data.tar.gz: e7897e20ca62c7183f6db25289dc1781e825193238b1a0687eabe2ced6a3dcf5
+  metadata.gz: ffc35188a40ca5e846bcaf011d61c3fdec92105055d04f8059dfabcc37fdd4f1
+  data.tar.gz: be97d1b4732e85f3557e5ec95290cce3b86a485d74c260d2288dfbae1d7e82dc
 SHA512:
-  metadata.gz: 3f5b2b777d5e52aff1d6422a84569b048db2b544e7b17457f1c413e5caa11d0505e90540a75264cd2fdecbdeb621a3f326f1591e5ff355169ecb1eba6b867d9d
-  data.tar.gz: 4b6ddb6b440fb761cecb48cdc815ecde9b1963535d2eb919b2f630ba899f54d6c21ace7c37a93258faa85c41f02164a0e52e1f8f5727a81e4148485b92811133
+  metadata.gz: bf1094a2a1472bd51606888d2cfed1c654a43b1a3241b80cfedac0eab173c12f14da792ad02602ca285d096acd4163b1c5033e8d443ac1087bbc8a015d2d3b89
+  data.tar.gz: e37d2e1e3f9bf23ed2234b65718174dba238eadcf7de890b1624800fd8cd32db015e0498fc5fe6194fb51403b1047743c771d24dc7682e327692620a9d57d5a4

data/README.md

@@ -28,7 +28,7 @@ resque-scheduler files, but with additional features.
     ```ruby
     class CreateQueSchedulerSchema < ActiveRecord::Migration[6.0]
       def change
-        Que::Scheduler::Migrations.migrate!(version: 8)
+        Que::Scheduler::Migrations.migrate!(version: 9)
         Que::Scheduler::Migrations.reenqueue_scheduler_if_missing
       end
     end
@@ -96,6 +96,10 @@ SendBilling:
 SendCoupons:
   cron: "0 7 * * * America/Los_Angeles"
 
+# Use a seconds field (see "Sub-minute schedules" below)
+HealthCheck:
+  cron: "*/15 * * * * *"
+
 # Altogether now
 all_options_job:
   cron: "0 0 * * *"
@@ -137,6 +141,19 @@ A job can have a `schedule_type` assigned to it. Valid values are:
   This feature ensures that jobs which *must run* for a certain cron match will always eventually 
   execute, even after a total system crash, or even a DB backup restore.
 
+## Sub-minute schedules
+
+The scheduler normally runs once a minute. If a job's cron has a seconds field and is due before the next
+minute, the scheduler runs early to enqueue it on time, and returns to once a minute when nothing is
+due sooner. Note:
+
+1. Que only picks up jobs scheduled in the future when it polls, every 5 seconds by default. For
+   finer precision, lower Que's `poll_interval`.
+1. Every scheduler run is a DB transaction and writes a row to the audit table, so frequent schedules
+   add load and audit rows. Consider scheduling the [audit clear down job](#scheduler-audit).
+1. As with any new job, a new schedule takes effect on the scheduler's next run after deploy, so
+   up to a minute later.
+
 ## Gem configuration
 
 You can configure some aspects of the gem with a config block (eg in a Rails initializer). 
@@ -216,7 +233,7 @@ performed.
 ```ruby
 class CreateQueSchedulerSchema < ActiveRecord::Migration[6.0]
   def change
-    Que::Scheduler::Migrations.migrate!(version: 8)
+    Que::Scheduler::Migrations.migrate!(version: 9)
     Que::Scheduler::Migrations.reenqueue_scheduler_if_missing
   end
 end
@@ -234,6 +251,7 @@ The changes in past migrations were:
 |    6    | Enforced single scheduler job at the trigger level                                  |
 |    7    | Prevent accidental deletion of scheduler job                                        |
 |    8    | Add primary key to audit. Note, this can be a slow migration if you have many rows! |
+|    9    | Index `que_scheduler_audit_enqueued.scheduler_job_id` to speed up audit clear down  |
 
 The changes to the DB ([DDL](https://en.wikipedia.org/wiki/Data_definition_language)) are all 
 captured in the structure.sql so will be re-run in correctly if squashed - except for the actual 

data/lib/que/scheduler/migrations/9/down.sql

@@ -0,0 +1 @@
+DROP INDEX que_scheduler_audit_enqueued_scheduler_job_id;

data/lib/que/scheduler/migrations/9/up.sql

@@ -0,0 +1 @@
+CREATE INDEX IF NOT EXISTS que_scheduler_audit_enqueued_scheduler_job_id ON que_scheduler_audit_enqueued USING btree (scheduler_job_id);

data/lib/que/scheduler/scheduler_job.rb

@@ -13,8 +13,8 @@ require_relative "to_enqueue"
 require_relative "db_support"
 require_relative "types"
 
-# The main job that runs every minute, determining what needs to be enqueued, enqueues the required
-# jobs, then re-enqueues itself.
+# The main job that runs every minute (or sooner if a job is due), determining what needs to be
+# enqueued, enqueues the required jobs, then re-enqueues itself.
 module Que
   module Scheduler
     class SchedulerJob < Que::Job
@@ -96,12 +96,11 @@ module Que
         Audit.append(job_id, scheduler_job_args.as_time, enqueued_jobs)
 
         # And rerun...
-        next_run_at = scheduler_job_args.as_time.beginning_of_minute + SCHEDULER_FREQUENCY
         enqueued_job = Que::Scheduler::DbSupport.enqueue_a_job(
           SchedulerJob,
           {
             queue: Que::Scheduler.configuration.que_scheduler_queue,
-            run_at: next_run_at,
+            run_at: next_run_at(scheduler_job_args.as_time),
           },
           [{ last_run_time: last_full_execution.iso8601, job_dictionary: job_dictionary }]
         )
@@ -110,6 +109,14 @@ module Que
 
         raise "SchedulerJob could not self-schedule. Has `.enqueue` been monkey patched?"
       end
+
+      # Run again at the next minute, or sooner if a job (eg a seconds cron) is due before then
+      sig { params(as_time: Types::TIME).returns(Types::TIME) }
+      private def next_run_at(as_time)
+        next_minute = as_time.beginning_of_minute + SCHEDULER_FREQUENCY
+        due_sooner = Scheduler.schedule.values.filter_map { it.next_run_time(as_time, next_minute) }
+        T.must([next_minute, *due_sooner].min)
+      end
     end
   end
 end

data/lib/que/scheduler/version.rb

@@ -2,6 +2,6 @@
 
 module Que
   module Scheduler
-    VERSION = "9.0.0".freeze
+    VERSION = "10.1.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 10.1.0
 platform: ruby
 authors:
 - Harry Lascelles
@@ -399,6 +399,8 @@ files:
 - lib/que/scheduler/migrations/7/up.sql
 - lib/que/scheduler/migrations/8/down.sql
 - lib/que/scheduler/migrations/8/up.sql
+- lib/que/scheduler/migrations/9/down.sql
+- lib/que/scheduler/migrations/9/up.sql
 - lib/que/scheduler/schedule.rb
 - lib/que/scheduler/schedule_type.rb
 - lib/que/scheduler/scheduler_job.rb