que-scheduler 3.4.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53cadc9fafa321124d4f52caa66503d8590cb1eaa11ee2ac86e0208c5d6a0fef
-  data.tar.gz: 2a5731c305089b58c3841f51b67c2dc698718e123a9b68395e92e1dfff37a693
+  metadata.gz: 78c9bc8d137dbe8a7c2428e50c615928c5d702d06432763b5346030fcbe81d5b
+  data.tar.gz: 3e639fd3f2263266fa25e25c637390f718e7751726feaefaa63f69cc91124f2d
 SHA512:
-  metadata.gz: '087a32c4e9245c3bbaa26fb0e891f2b232c2617bad351d354eb502c0edb853a32ec786601a71e796fe5baa1b13f3691f1dc1c17f55d1b1973648101cd60602c7'
-  data.tar.gz: 1ba223766fa1d52b79b7ebcdcd534da366636cc306f538e6bc067830a2999b57913c1ade0f5a381287883222aedadc4aa380f9fb479223838468f7df3dfa5d73
+  metadata.gz: b599d23b38d8263412e2a1fa7eb6621f564a628ae7b66800b0259667a76956e0a9e16824bd463a24edd0752119f30ec01ac3a1951e1d4abfc1d05ed1905745dc
+  data.tar.gz: 42691328a2727e14f15305e6baac0f0d7b3e4cb1d1a91c80d2ef1f7ab42db56e3bd1640884805adf381d65fbe2d6b3d7abbe2373e8ef49dfbeb737f790b76700

data/README.md

@@ -18,9 +18,9 @@ needs to be run, enqueueing those jobs, then enqueueing itself to check again la
     ```ruby
     gem 'que-scheduler'
     ```
-1. Specify a schedule in a yml file (see below). The default location that que-scheduler will 
-look for it is `config/que_schedule.yml`. They are essentially the same as resque-scheduler
-files, but with additional features.
+1. Specify a schedule in a yml file or programmatically (see below). The default location that 
+que-scheduler will look for it is `config/que_schedule.yml`. The format is 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. Note that this migration 
    will fail if Que is set to execute jobs synchronously, i.e. `Que::Job.run_synchronously = true`.
@@ -28,14 +28,18 @@ files, but with additional features.
     ```ruby
     class CreateQueSchedulerSchema < ActiveRecord::Migration
       def change
-        Que::Scheduler::Migrations.migrate!(version: 5)
+        Que::Scheduler::Migrations.migrate!(version: 6)
       end
     end
     ```
     
 ## Schedule configuration
 
-The schedule file is a list of que job classes with arguments and a schedule frequency (in crontab 
+The schedule file should be placed here: `config/que_schedule.yml`. Alternatively if you
+wish to generate the configuration dynamically, you can set it directly using an initializer
+(see "Gem configuration" below).
+
+The file is a list of que job classes with arguments and a schedule frequency (in crontab 
 syntax). The format is similar to the resque-scheduler format, though priorities must be supplied as
 integers, and job classes must be migrated from Resque to Que. Cron syntax can be anything
 understood by [fugit](https://github.com/floraison/fugit#fugitcron).
@@ -131,19 +135,34 @@ A job can have a `schedule_type` assigned to it. Valid values are:
 
 ## Gem configuration
 
-You can configure some aspects of the gem with an initializer. The default is given below.
+You can configure some aspects of the gem with a config block (eg in a Rails initializer). 
+The default is given below. You can omit any configuration sections you are not intending to change.
+It is quite likely you won't have to create this config at all.
 
 ```ruby
 Que::Scheduler.configure do |config|
   # The location of the schedule yaml file.
-  config.schedule_location = ENV.fetch('QUE_SCHEDULER_CONFIG_LOCATION', 'config/que_schedule.yml')
+  config.schedule_location = ENV.fetch("QUE_SCHEDULER_CONFIG_LOCATION", "config/que_schedule.yml")
+
+  # The schedule as a hash. You can use this if you want to build the schedule yourself at runtime.
+  # This will override the above value if provided.
+  config.schedule = {
+    SpecifiedByHashTestJob: {
+      cron: "02 11 * * *"
+    }
+  }
   
-  # Specify a transaction block adapter. By default, que-scheduler uses the one supplied by que.
-  # However, if, for example you rely on listeners to ActiveRecord's exact `transaction` method, or 
+  # The transaction block adapter. By default, que-scheduler uses the one supplied by que.
+  # However if, for example, you rely on listeners to ActiveRecord's exact `transaction` method, or 
   # Sequel's DB.after_commit helper, then you can supply it here.
   config.transaction_adapter = ::Que.method(:transaction)
-end
 
+  # Which queue name the que-scheduler job should self-schedule on. Typically this is the default
+  # queue of que, which has a different name in Que 0.x ("") and 1.x ("default").
+  # It *must* be the "highest throughput" queue - do not work the scheduler on a "long 
+  # running jobs" queue. It is very unlikely you will want to change this. 
+  config.que_scheduler_queue = ENV.fetch("QUE_SCHEDULER_QUEUE", "" or "default")
+end
 ```
 
 ## Scheduler Audit
@@ -155,20 +174,40 @@ migration tasks.
 Additionally, there is the audit table `que_scheduler_audit_enqueued`. This logs every job that 
 the scheduler enqueues.
 
+que-scheduler comes with the `QueSchedulerAuditClearDownJob` job built in that you can optionally
+schedule to clear down audit rows if you don't need to retain them indefinitely. You should add this
+to your own scheduler config yaml.
+
+For example:
+
+```yaml
+# This will clear down the oldest que-scheduler audit rows. Since que-scheduler
+# runs approximately every minute, 129600 is 90 days.
+Que::Scheduler::Jobs::QueSchedulerAuditClearDownJob:
+  cron: "0 0 * * *"
+  args:
+    retain_row_count: 129600
+```
+
+## Required migrations
+
 When there is a major version (breaking) change, a migration should be run in. The version of the 
-migration proceeds at a faster rate than the version of the gem. To run in all the migrations required
-up to a number, just migrate to that number with one line, and it will perform all the intermediary steps. 
+latest migration proceeds at a faster rate than the version of the gem. eg If the gem is on version
+3 then the migrations may be on version 6). 
+
+To run in all the migrations required up to a number, just migrate to that number with one line, and
+it will perform all the intermediary steps. 
 
 ie, This will perform all migrations necessary up to the latest version, skipping any already 
 performed.
 
-    ```ruby
-    class CreateQueSchedulerSchema < ActiveRecord::Migration
-      def change
-        Que::Scheduler::Migrations.migrate!(version: 5)
-      end
-    end
-    ```
+```ruby
+class CreateQueSchedulerSchema < ActiveRecord::Migration
+  def change
+    Que::Scheduler::Migrations.migrate!(version: 6)
+  end
+end
+```
 
 The changes in past migrations were: 
 
@@ -179,23 +218,7 @@ The changes in past migrations were:
 |    3    | Added the audit table `que_scheduler_audit_enqueued`.                           |
 |    4    | Updated the the audit tables to use bigints                                     |
 |    5    | Dropped an unnecessary index                                                    |
-
-## Built in optional job for audit clear down
-
-que-scheduler comes with the `QueSchedulerAuditClearDownJob` job built in that you can optionally
-schedule to clear down audit rows if you don't need to retain them indefinitely. You should add this
-to your own scheduler config yaml.
-
-For example:
-
-```yaml
-# This will clear down the oldest que-scheduler audit rows. Since que-scheduler
-# runs approximately every minute, 129600 is 90 days.
-Que::Scheduler::Jobs::QueSchedulerAuditClearDownJob:
-  cron: "0 0 * * *"
-  args:
-    retain_row_count: 129600
-```
+|    6    | Enforced single scheduler job at the trigger level                              |
 
 ## HA Redundancy and DB restores
 
@@ -210,8 +233,8 @@ in a coherent state with the rest of your database.
 ## Concurrent scheduler detection
 
 No matter how many tasks you have defined in your schedule, you will only ever need one que-scheduler
-job enqueued. que-scheduler knows this, and it will check before performing any operations that 
-there is only one of itself present.
+job enqueued. que-scheduler knows this, and there are DB constraints in place to ensure there is
+only ever exactly one scheduler job.
 
 It also follows que job design [best practices](https://github.com/chanks/que/blob/master/docs/writing_reliable_jobs.md),
 using ACID guarantees, to ensure that it will never run multiple times. If the scheduler crashes for any reason,
@@ -263,6 +286,10 @@ The scheduler will then continue to retry indefinitely.
 que-scheduler uses [semantic versioning](https://semver.org/), so major version changes will usually 
 require additional actions to be taken upgrading from one major version to another. 
 
+## Changelog
+
+A full changelog can be found here: [CHANGELOG.md](https://github.com/hlascelles/que-scheduler/blob/master/CHANGELOG.md)
+
 ## System requirements
 
 Your [postgres](https://www.postgresql.org/) database must be at least version 9.4.0.
@@ -273,8 +300,9 @@ This gem was inspired by the makers of the excellent [Que](https://github.com/ch
 
 ## Contributors
 
+* @bnauta
+* @JackDanger
 * @jish
 * @joehorsnell
-* @bnauta
-* @papodaca
 * @krzyzak
+* @papodaca

data/lib/que-scheduler.rb

@@ -1,3 +1,3 @@
 # rubocop:disable Naming/FileName
-require 'que/scheduler'
+require "que/scheduler"
 # rubocop:enable Naming/FileName

data/lib/que/scheduler.rb

@@ -1,8 +1,8 @@
-require 'que/scheduler/version'
-require 'que/scheduler/version_support'
-require 'que/scheduler/config'
-require 'que/scheduler/scheduler_job'
-require 'que/scheduler/db'
-require 'que/scheduler/audit'
-require 'que/scheduler/migrations'
-require 'que/scheduler/jobs/que_scheduler_audit_clear_down_job'
+require "que/scheduler/version"
+require "que/scheduler/version_support"
+require "que/scheduler/configuration"
+require "que/scheduler/scheduler_job"
+require "que/scheduler/db"
+require "que/scheduler/audit"
+require "que/scheduler/migrations"
+require "que/scheduler/jobs/que_scheduler_audit_clear_down_job"

data/lib/que/scheduler/audit.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'to_enqueue'
+require_relative "to_enqueue"
 
 module Que
   module Scheduler
     module Audit
-      TABLE_NAME = 'que_scheduler_audit'
-      ENQUEUED_TABLE_NAME = 'que_scheduler_audit_enqueued'
+      TABLE_NAME = "que_scheduler_audit"
+      ENQUEUED_TABLE_NAME = "que_scheduler_audit_enqueued"
       INSERT_AUDIT = %{
         INSERT INTO #{TABLE_NAME} (scheduler_job_id, executed_at)
         VALUES ($1::bigint, $2::timestamptz)

data/lib/que/scheduler/configuration.rb

@@ -0,0 +1,35 @@
+require "que"
+require_relative "version_support"
+
+module Que
+  module Scheduler
+    class Configuration
+      attr_accessor :schedule_location
+      attr_accessor :schedule
+      attr_accessor :transaction_adapter
+      attr_accessor :que_scheduler_queue
+    end
+
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+      end
+
+      def apply_defaults
+        configure do |config|
+          config.schedule_location =
+            ENV.fetch("QUE_SCHEDULER_CONFIG_LOCATION", "config/que_schedule.yml")
+          config.transaction_adapter = ::Que.method(:transaction)
+          config.que_scheduler_queue =
+            ENV.fetch("QUE_SCHEDULER_QUEUE", Que::Scheduler::VersionSupport.default_scheduler_queue)
+          config.schedule = nil
+        end
+      end
+    end
+  end
+end
+
+Que::Scheduler.apply_defaults

data/lib/que/scheduler/db.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'config'
+require_relative "configuration"
 
 module Que
   module Scheduler
     module Db
       SCHEDULER_COUNT_SQL =
         "SELECT COUNT(*) FROM que_jobs WHERE job_class = 'Que::Scheduler::SchedulerJob'"
-      NOW_SQL = 'SELECT now()'
+      NOW_SQL = "SELECT now()"
 
       class << self
         def count_schedulers

data/lib/que/scheduler/defined_job.rb

@@ -1,5 +1,5 @@
-require 'hashie'
-require 'fugit'
+require "hashie"
+require "fugit"
 
 # This is the definition of one scheduleable job in the que-scheduler config yml file.
 module Que
@@ -59,10 +59,10 @@ module Que
       # 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')
+          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')
+          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}")
@@ -71,10 +71,10 @@ module Que
       # rubocop:enable Style/GuardClause
 
       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?
+        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?
+        err_field(:cron, options, "cron must be present") if cron.nil?
       end
 
       def validate_job_class_related(options)
@@ -88,7 +88,7 @@ module Que
         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')
+           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
@@ -104,7 +104,7 @@ module Que
         end
       end
 
-      def err_field(field, options, reason = '')
+      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" \

data/lib/que/scheduler/enqueueing_calculator.rb

@@ -1,4 +1,4 @@
-require 'fugit'
+require "fugit"
 
 module Que
   module Scheduler

data/lib/que/scheduler/jobs/que_scheduler_audit_clear_down_job.rb

@@ -1,4 +1,4 @@
-require 'que'
+require "que"
 
 # This job can optionally be scheduled to clear down the que-scheduler audit log if it
 # isn't required in the long term.
@@ -21,8 +21,8 @@ module Que
           end
         end
 
-        DELETE_AUDIT_ENQUEUED_SQL = build_sql('que_scheduler_audit_enqueued').freeze
-        DELETE_AUDIT_SQL = build_sql('que_scheduler_audit').freeze
+        DELETE_AUDIT_ENQUEUED_SQL = build_sql("que_scheduler_audit_enqueued").freeze
+        DELETE_AUDIT_SQL = build_sql("que_scheduler_audit").freeze
 
         # Very low priority
         Que::Scheduler::VersionSupport.set_priority(self, 100)
@@ -36,7 +36,7 @@ module Que
             # This will delete all but `retain_row_count` oldest rows
             count = Que::Scheduler::VersionSupport.execute(DELETE_AUDIT_SQL, [retain_row_count])
             log = "#{self.class} cleared down #{count.first.fetch(:count)} rows"
-            ::Que.log(event: 'que-scheduler'.to_sym, message: log)
+            ::Que.log(event: "que-scheduler".to_sym, message: log)
           end
         end
       end

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

@@ -0,0 +1,7 @@
+DROP TRIGGER que_scheduler_prevent_job_deletion_trigger ON que_jobs;
+
+DROP FUNCTION que_scheduler_prevent_job_deletion();
+
+DROP FUNCTION que_scheduler_check_job_exists();
+
+DROP INDEX que_scheduler_job_in_que_jobs_unique_index;

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

@@ -0,0 +1,26 @@
+-- Ensure there is no more than one scheduler
+CREATE UNIQUE INDEX que_scheduler_job_in_que_jobs_unique_index ON que_jobs(job_class)
+WHERE job_class = 'Que::Scheduler::SchedulerJob';
+
+-- Ensure there is at least one scheduler
+CREATE OR REPLACE FUNCTION que_scheduler_check_job_exists() RETURNS bool AS $$
+SELECT EXISTS(SELECT * FROM que_jobs WHERE job_class = 'Que::Scheduler::SchedulerJob');
+$$ LANGUAGE SQL;
+
+CREATE OR REPLACE FUNCTION que_scheduler_prevent_job_deletion() RETURNS TRIGGER AS
+$BODY$
+DECLARE
+BEGIN
+    IF OLD.job_class = 'Que::Scheduler::SchedulerJob' THEN
+        IF NOT que_scheduler_check_job_exists() THEN
+            raise exception 'Deletion of que_scheduler job % prevented. Deleting the que_scheduler job is almost certainly a mistake.', OLD.job_id;
+        END IF;
+    END IF;
+    RETURN OLD;
+END;
+$BODY$
+LANGUAGE 'plpgsql';
+
+CREATE CONSTRAINT TRIGGER que_scheduler_prevent_job_deletion_trigger AFTER UPDATE OR DELETE ON que_jobs
+DEFERRABLE INITIALLY DEFERRED
+FOR EACH ROW EXECUTE PROCEDURE que_scheduler_prevent_job_deletion();

data/lib/que/scheduler/schedule.rb

@@ -1,20 +1,37 @@
-require_relative 'defined_job'
+require_relative "configuration"
+require_relative "defined_job"
 
 module Que
   module Scheduler
     class Schedule
       class << self
+        # The main method for determining the schedule. It has to evaluate the schedule as late as
+        # possible (ie just as it is about to be used) as we cannot guarantee we are in a Rails
+        # app with initializers. In a future release this may change to "fast fail" in Rails by
+        # checking the config up front.
         def schedule
           @schedule ||=
             begin
-              location = Que::Scheduler.configuration.schedule_location
-              from_file(location)
+              configuration = Que::Scheduler.configuration
+              if !configuration.schedule.nil?
+                # If an explicit schedule as a hash has been defined, use that.
+                from_hash(configuration.schedule)
+              elsif File.exist?(configuration.schedule_location)
+                # If the schedule is defined as a file location, then load it and return it.
+                from_file(configuration.schedule_location)
+              else
+                raise "No que-scheduler config set, or file found " \
+                      "at #{configuration.schedule_location}"
+              end
             end
         end
 
         def from_file(location)
-          yml = IO.read(location)
-          config_hash = YAML.safe_load(yml)
+          from_yaml(IO.read(location))
+        end
+
+        def from_yaml(config)
+          config_hash = YAML.safe_load(config)
           from_hash(config_hash)
         end
 
@@ -30,11 +47,11 @@ module Que
           # an array with one item which is that value (this includes if it is a hash). It could
           # also be a single nil value.
           args_array =
-            if !defined_job_hash.key?('args')
+            if !defined_job_hash.key?("args")
               # No args were requested
               []
             else
-              args = defined_job_hash['args']
+              args = defined_job_hash["args"]
               if args.is_a?(Array)
                 # An array of args was requested
                 args
@@ -47,12 +64,12 @@ module Que
 
           Que::Scheduler::DefinedJob.create(
             name: name,
-            job_class: defined_job_hash['class'] || name,
-            queue: defined_job_hash['queue'],
+            job_class: defined_job_hash["class"] || name,
+            queue: defined_job_hash["queue"],
             args_array: args_array,
-            priority: defined_job_hash['priority'],
-            cron: defined_job_hash['cron'],
-            schedule_type: defined_job_hash['schedule_type']&.to_sym
+            priority: defined_job_hash["priority"],
+            cron: defined_job_hash["cron"],
+            schedule_type: defined_job_hash["schedule_type"]&.to_sym
           )
         end
       end

data/lib/que/scheduler/scheduler_job.rb

@@ -1,11 +1,13 @@
-require 'que'
+require "que"
+require "active_support"
+require "active_support/core_ext/time"
 
-require_relative 'schedule'
-require_relative 'enqueueing_calculator'
-require_relative 'scheduler_job_args'
-require_relative 'state_checks'
-require_relative 'to_enqueue'
-require_relative 'version_support'
+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
 # jobs, then re-enqueues itself.
@@ -14,8 +16,8 @@ module Que
     class SchedulerJob < Que::Job
       SCHEDULER_FREQUENCY = 60
 
-      Que::Scheduler::VersionSupport.set_priority(self, 0)
-      Que::Scheduler::VersionSupport.apply_retry_semantics(self)
+      VersionSupport.set_priority(self, 0)
+      VersionSupport.apply_retry_semantics(self)
 
       def run(options = nil)
         Que::Scheduler::Db.transaction do
@@ -25,12 +27,13 @@ module Que
           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)
+          # Remove this job and schedule self again
+          destroy
           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
+          logs.each { |str| ::Que.log(event: "que-scheduler".to_sym, message: str) }
         end
       end
 
@@ -51,13 +54,13 @@ module Que
                 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?'
+                              "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)
         # Log last run...
-        job_id = Que::Scheduler::VersionSupport.job_attributes(self).fetch(:job_id)
+        job_id = VersionSupport.job_attributes(self).fetch(:job_id)
         Audit.append(job_id, scheduler_job_args.as_time, enqueued_jobs)
 
         # And rerun...
@@ -70,8 +73,8 @@ module Que
         )
 
         # rubocop:disable Style/GuardClause This reads better as a conditional
-        unless Que::Scheduler::VersionSupport.job_attributes(enqueued_job).fetch(:job_id)
-          raise 'SchedulerJob could not self-schedule. Has `.enqueue` been monkey patched?'
+        unless enqueued_job && VersionSupport.job_attributes(enqueued_job).fetch(:job_id)
+          raise "SchedulerJob could not self-schedule. Has `.enqueue` been monkey patched?"
         end
         # rubocop:enable Style/GuardClause
       end

data/lib/que/scheduler/scheduler_job_args.rb

@@ -1,6 +1,6 @@
-require 'hashie'
-require 'active_support'
-require 'active_support/time_with_zone'
+require "hashie"
+require "active_support"
+require "active_support/time_with_zone"
 
 # These are the args that are used for this particular run of the scheduler.
 module Que

data/lib/que/scheduler/state_checks.rb

@@ -1,6 +1,6 @@
-require_relative 'audit'
-require_relative 'db'
-require_relative 'migrations'
+require_relative "audit"
+require_relative "db"
+require_relative "migrations"
 
 module Que
   module Scheduler
@@ -8,7 +8,6 @@ module Que
       class << self
         def check
           assert_db_migrated
-          assert_one_scheduler_job
         end
 
         private
@@ -60,21 +59,6 @@ module Que
             synchronously. This will fail as que-scheduler needs the above tables to work.
           ERR
         end
-
-        def assert_one_scheduler_job
-          schedulers = Que::Scheduler::Db.count_schedulers
-          return if schedulers == 1
-
-          raise(<<-ERR)
-            Only one #{Que::Scheduler::SchedulerJob.name} should be enqueued. #{schedulers} were found.
-
-            que-scheduler works by running a self-enqueueing version of itself that determines which
-            jobs should be enqueued based on the provided config. If two or more que-schedulers were
-            to run at once, then duplicate jobs would occur.
-
-            To resolve this problem, please remove any duplicate scheduler jobs from the que_jobs table.
-          ERR
-        end
       end
     end
   end

data/lib/que/scheduler/to_enqueue.rb

@@ -1,4 +1,4 @@
-require 'que'
+require "que"
 
 # This module uses polymorphic dispatch to centralise the differences between supporting Que::Job
 # and other job systems.
@@ -23,13 +23,13 @@ module Que
         end
 
         def active_job_version
-          Gem.loaded_specs['activejob']&.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')
+          active_job_version && active_job_version > Gem::Version.create("5")
         end
 
         def active_job_version_supports_queues?
@@ -38,7 +38,7 @@ module Que
           # and readded in Rails 6.0.3
           # https://github.com/rails/rails/pull/38635
           ToEnqueue.active_job_version && ToEnqueue.active_job_version >=
-            Gem::Version.create('6.0.3')
+            Gem::Version.create("6.0.3")
         end
 
         private

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '3.4.0'.freeze
+    VERSION = "4.0.1".freeze
   end
 end

data/lib/que/scheduler/version_support.rb

@@ -1,4 +1,4 @@
-require 'que'
+require "que"
 
 # The purpose of this module is to centralise the differences when supporting both que 0.x and
 # 1.x with the same gem.
@@ -15,7 +15,7 @@ module Que
         # the top of all jobs it enqueues.
         def set_priority(context, priority)
           if zero_major?
-            context.instance_variable_set('@priority', priority)
+            context.instance_variable_set("@priority", priority)
           else
             context.priority = priority
           end
@@ -24,7 +24,7 @@ module Que
         # 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)
+            context.instance_variable_set("@retry_interval", RETRY_PROC)
           else
             context.maximum_retry_count = 1 << 128 # Heat death of universe
             context.retry_interval = RETRY_PROC
@@ -33,9 +33,9 @@ module Que
 
         def job_attributes(enqueued_job)
           if zero_major?
-            enqueued_job.attrs.transform_keys(&:to_sym)
+            enqueued_job.attrs.to_h.transform_keys(&:to_sym)
           else
-            enqueued_job.que_attrs.transform_keys(&:to_sym).tap do |hash|
+            enqueued_job.que_attrs.to_h.transform_keys(&:to_sym).tap do |hash|
               hash[:job_id] = hash.delete(:id)
             end
           end
@@ -48,7 +48,7 @@ module Que
         end
 
         def default_scheduler_queue
-          zero_major? ? '' : Que::DEFAULT_QUEUE
+          zero_major? ? "" : Que::DEFAULT_QUEUE
         end
 
         def running_synchronously?
@@ -56,18 +56,18 @@ module Que
         end
 
         def running_synchronously_code?
-          zero_major? ? 'Que.mode == :sync' : 'Que.run_synchronously = true'
+          zero_major? ? "Que.mode == :sync" : "Que.run_synchronously = true"
         end
 
         def zero_major?
           # This is the only way to handle beta releases too
-          @zero_major ||= Gem.loaded_specs['que'].version.to_s.split('.').first.to_i.zero?
+          @zero_major ||= Gem.loaded_specs["que"].version.to_s.split(".").first.to_i.zero?
         end
 
         private
 
         def normalise_array_of_hashes(array)
-          array.map { |row| row.transform_keys(&:to_sym) }
+          array.map { |row| row.to_h.transform_keys(&:to_sym) }
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,6 +112,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -319,7 +333,7 @@ files:
 - lib/que-scheduler.rb
 - lib/que/scheduler.rb
 - lib/que/scheduler/audit.rb
-- lib/que/scheduler/config.rb
+- lib/que/scheduler/configuration.rb
 - lib/que/scheduler/db.rb
 - lib/que/scheduler/defined_job.rb
 - lib/que/scheduler/enqueueing_calculator.rb
@@ -335,6 +349,8 @@ files:
 - lib/que/scheduler/migrations/4/up.sql
 - lib/que/scheduler/migrations/5/down.sql
 - lib/que/scheduler/migrations/5/up.sql
+- lib/que/scheduler/migrations/6/down.sql
+- lib/que/scheduler/migrations/6/up.sql
 - lib/que/scheduler/schedule.rb
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb

data/lib/que/scheduler/config.rb

@@ -1,27 +0,0 @@
-require 'que'
-require_relative 'version_support'
-
-module Que
-  module Scheduler
-    class << self
-      attr_accessor :configuration
-    end
-
-    def self.configure
-      self.configuration ||= Configuration.new
-      yield(configuration)
-    end
-
-    class Configuration
-      attr_accessor :schedule_location
-      attr_accessor :transaction_adapter
-      attr_accessor :que_scheduler_queue
-    end
-  end
-end
-
-Que::Scheduler.configure do |config|
-  config.schedule_location = ENV.fetch('QUE_SCHEDULER_CONFIG_LOCATION', 'config/que_schedule.yml')
-  config.transaction_adapter = ::Que.method(:transaction)
-  config.que_scheduler_queue = Que::Scheduler::VersionSupport.default_scheduler_queue
-end