que-scheduler 4.0.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78c9bc8d137dbe8a7c2428e50c615928c5d702d06432763b5346030fcbe81d5b
-  data.tar.gz: 3e639fd3f2263266fa25e25c637390f718e7751726feaefaa63f69cc91124f2d
+  metadata.gz: adf8110c30a79a8eeddb300dbfe79a1ac283080983dd41befc9a6769b66efcf6
+  data.tar.gz: 2c800a7070b326993bda2eefea85e151ea74e40a9eb6e653fdfd10e47db59eaa
 SHA512:
-  metadata.gz: b599d23b38d8263412e2a1fa7eb6621f564a628ae7b66800b0259667a76956e0a9e16824bd463a24edd0752119f30ec01ac3a1951e1d4abfc1d05ed1905745dc
-  data.tar.gz: 42691328a2727e14f15305e6baac0f0d7b3e4cb1d1a91c80d2ef1f7ab42db56e3bd1640884805adf381d65fbe2d6b3d7abbe2373e8ef49dfbeb737f790b76700
+  metadata.gz: a44603e489c6e9a7c7715ef3a53d7a5d4b4743d9e886be1b05daa37d4c3fa47666f80e896eab14d4e3f43ecda5b4cbc3e2532ed85bfe019bc330bb743cefe6e1
+  data.tar.gz: 5534d3ca737011e1a97cd4b909377a31e58f287d782cb5c4f1e09e96a6369a12838896270b89609db07be532eb78195524129aa47626fe87024ad3975820e4f7

data/README.md

@@ -2,7 +2,6 @@ que-scheduler
 ================
 
 [![Gem Version](https://badge.fury.io/rb/que-scheduler.svg)](https://badge.fury.io/rb/que-scheduler)
-[![Build status](https://gitlab.com/hlascelles/que-scheduler/badges/master/pipeline.svg)](https://gitlab.com/hlascelles/que-scheduler/pipelines)
 [![Coverage Status](https://coveralls.io/repos/github/hlascelles/que-scheduler/badge.svg?branch=master)](https://coveralls.io/github/hlascelles/que-scheduler?branch=master)
 [![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/710d2fc5202f95d76e8a/maintainability)](https://codeclimate.com/github/hlascelles/que-scheduler/maintainability)
 
@@ -107,7 +106,7 @@ DailyBatchReport:
   cron: "0 3 * * *"
   # This job will be run every day at 03:00 as normal.
   # However, the "schedule_type: every_event" setting below will ensure that if workers are offline
-  # for any amount of time then the bcaklog will always be enqueued on recovery.
+  # for any amount of time then the backlog will always be enqueued on recovery.
   # See "Schedule types" below for more information.
   schedule_type: every_event
 ```
@@ -162,6 +161,14 @@ Que::Scheduler.configure do |config|
   # 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")
+  
+  # If que-scheduler is being used with Rails, then it will inherit the time zone from that 
+  # framework, and you can leave the value as nil as shown below. However, if you are not using
+  # Rails, you may need to set the time zone here. If que-scheduler cannot determine the time zone
+  # it will yield an error prompting you for action.
+  # If you need to set a value, use the string representation:
+  # eg: config.time_zone = "Europe/London"
+  config.time_zone = nil
 end
 ```
 
@@ -220,6 +227,15 @@ The changes in past migrations were:
 |    5    | Dropped an unnecessary index                                                    |
 |    6    | Enforced single scheduler job at the trigger level                              |
 
+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 
+scheduling of the job itself (as that is [DML](https://en.wikipedia.org/wiki/Data_manipulation_language)).
+If you squash your migrations make sure this is added as the final line:
+
+```ruby
+Que::Scheduler::Migrations.reenqueue_scheduler_if_missing
+```
+
 ## HA Redundancy and DB restores
 
 Because of the way que-scheduler works, it requires no additional processes. It is, itself, a Que job.
@@ -292,7 +308,7 @@ A full changelog can be found here: [CHANGELOG.md](https://github.com/hlascelles
 
 ## System requirements
 
-Your [postgres](https://www.postgresql.org/) database must be at least version 9.4.0.
+Your [postgres](https://www.postgresql.org/) database must be at least version 9.5.0.
 
 ## Inspiration
 
@@ -301,8 +317,10 @@ This gem was inspired by the makers of the excellent [Que](https://github.com/ch
 ## Contributors
 
 * @bnauta
+* @bjeanes
 * @JackDanger
 * @jish
 * @joehorsnell
 * @krzyzak
 * @papodaca
+* @ajoneil

data/lib/que/scheduler/configuration.rb

@@ -4,10 +4,8 @@ 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
+      attr_accessor :schedule_location, :schedule, :transaction_adapter, :que_scheduler_queue,
+                    :time_zone
     end
 
     class << self
@@ -26,6 +24,7 @@ module Que
           config.que_scheduler_queue =
             ENV.fetch("QUE_SCHEDULER_QUEUE", Que::Scheduler::VersionSupport.default_scheduler_queue)
           config.schedule = nil
+          config.time_zone = nil
         end
       end
     end

data/lib/que/scheduler/db.rb

@@ -18,9 +18,11 @@ module Que
           Que::Scheduler::VersionSupport.execute(NOW_SQL).first.values.first
         end
 
+        # rubocop:disable Style/ExplicitBlockArgument
         def transaction
           Que::Scheduler.configuration.transaction_adapter.call { yield }
         end
+        # rubocop:enable Style/ExplicitBlockArgument
       end
     end
   end

data/lib/que/scheduler/defined_job.rb

@@ -86,10 +86,10 @@ module Que
         # 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? &&
+           Que::Scheduler::ToEnqueue.active_job_loaded? &&
            job_class < ::ActiveJob::Base &&
            Que::Scheduler::ToEnqueue.active_job_version < Gem::Version.create("6.0.3")
-          puts <<-ERR
+          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.

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

@@ -8,7 +8,7 @@ module Que
       class QueSchedulerAuditClearDownJob < Que::Job
         class << self
           def build_sql(table_name)
-            <<-SQL
+            <<~SQL
               WITH deleted AS (
                 DELETE FROM #{table_name}
                 WHERE scheduler_job_id <= (
@@ -28,7 +28,7 @@ module Que
         Que::Scheduler::VersionSupport.set_priority(self, 100)
 
         def run(options)
-          retain_row_count = options.fetch(:retain_row_count)
+          retain_row_count = options.symbolize_keys.fetch(:retain_row_count)
           Que::Scheduler::Db.transaction do
             # This may delete zero or more than `retain_row_count` depending on if anything was
             # scheduled in each of the past schedule runs
@@ -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", message: log)
           end
         end
       end

data/lib/que/scheduler/migrations.rb

@@ -41,6 +41,11 @@ module Que
           result.any?
         end
 
+        # This method is only intended for use in squashed migrations
+        def reenqueue_scheduler_if_missing
+          Que::Scheduler::SchedulerJob.enqueue if Que::Scheduler::Db.count_schedulers.zero?
+        end
+
         private
 
         def migrate_up(current, version)
@@ -54,7 +59,7 @@ module Que
         end
 
         def execute_step(number, direction)
-          sql = IO.read("#{__dir__}/migrations/#{number}/#{direction}.sql")
+          sql = File.read("#{__dir__}/migrations/#{number}/#{direction}.sql")
           Que::Scheduler::VersionSupport.execute(sql)
           return unless audit_table_exists?
 

data/lib/que/scheduler/schedule.rb

@@ -27,7 +27,7 @@ module Que
         end
 
         def from_file(location)
-          from_yaml(IO.read(location))
+          from_yaml(File.read(location))
         end
 
         def from_yaml(config)
@@ -36,21 +36,20 @@ module Que
         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
+          config_hash.to_h do |name, defined_job_hash|
+            name_str = name.to_s
+            [name_str, hash_item_to_defined_job(name_str, defined_job_hash)]
+          end
         end
 
-        def hash_item_to_defined_job(name, defined_job_hash)
+        def hash_item_to_defined_job(name, defined_job_hash_in)
+          defined_job_hash = defined_job_hash_in.stringify_keys
           # Que stores arguments as a json array. If the args we have to provide are already an
           # array we can can simply pass them through. If it is a single non-nil value, then we make
           # 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")
-              # No args were requested
-              []
-            else
+            if defined_job_hash.key?("args")
               args = defined_job_hash["args"]
               if args.is_a?(Array)
                 # An array of args was requested
@@ -60,11 +59,14 @@ module Que
                 # be enqueued as an array of 1 item
                 [args]
               end
+            else
+              # No args were requested
+              []
             end
 
           Que::Scheduler::DefinedJob.create(
             name: name,
-            job_class: defined_job_hash["class"] || name,
+            job_class: defined_job_hash["class"]&.to_s || name,
             queue: defined_job_hash["queue"],
             args_array: args_array,
             priority: defined_job_hash["priority"],

data/lib/que/scheduler/scheduler_job.rb

@@ -33,7 +33,7 @@ module Que
             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) }
+          logs.each { |str| ::Que.log(event: :"que-scheduler", message: str) }
         end
       end
 
@@ -50,11 +50,11 @@ module Que
       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}"
+                    "#{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?"
+                    "but it reported no job was scheduled. Has `enqueue` been overridden?"
                 end
       end
 

data/lib/que/scheduler/scheduler_job_args.rb

@@ -22,7 +22,8 @@ module Que
           else
             options = options.symbolize_keys
             {
-              last_run_time: Time.zone.parse(options.fetch(:last_run_time)),
+              last_run_time:
+                Que::Scheduler::TimeZone.time_zone.parse(options.fetch(:last_run_time)),
               job_dictionary: options.fetch(:job_dictionary),
             }
           end

data/lib/que/scheduler/state_checks.rb

@@ -19,7 +19,7 @@ module Que
           sync_err =
             if Que::Scheduler::VersionSupport.running_synchronously? && db_version.zero?
               code = Que::Scheduler::VersionSupport.running_synchronously_code?
-              <<-ERR_SYNC
+              <<~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

data/lib/que/scheduler/time_zone.rb

@@ -0,0 +1,61 @@
+module Que
+  module Scheduler
+    module TimeZone
+      BOTH_CONFIG_AND_TIME_DOT_ZONE_SET = <<~ERR.freeze
+        The que-scheduler config for time_zone has been set to a non-nil value, but
+        it appears to also have been set on Time.zone (possibly by Rails). Both of these
+        cannot be non-nil.
+        You should remove the time_zone config from the que-scheduler config block.
+      ERR
+
+      TIME_ZONE_COULD_NOT_BE_DETERMINED = <<~ERR.freeze
+        It appears Time.zone is nil. This prevents proper functioning of que-scheduler.
+
+        Resolving this issue depends on your application setup.
+
+        1) If you are using Rails, set the standard time_zone config
+           eg:
+           ```
+           # In application.rb
+           config.time_zone = "Europe/London"
+           ```
+
+        2) If you are not using Rails, set your time zone in the que-scheduler config:
+           eg:
+           ```
+           Que::Scheduler.configure do |config|
+             config.time_zone = "Europe/London"
+           end
+           ```
+      ERR
+
+      TIME_ZONE_CONFIG_IS_NOT_VALID = <<~ERR.freeze
+        The que-scheduler config for time_zone has been set to a non-nil value, but that value
+        does not yield a real time zone when passed to ActiveSupport::TimeZone.new
+      ERR
+
+      class << self
+        def time_zone
+          @time_zone ||=
+            begin
+              time_dot_zone = Time.zone
+              if time_dot_zone.present?
+                if Que::Scheduler.configuration.time_zone.present?
+                  raise BOTH_CONFIG_AND_TIME_DOT_ZONE_SET
+                end
+
+                time_dot_zone
+              elsif Que::Scheduler.configuration.time_zone
+                new_tz = ActiveSupport::TimeZone.new(Que::Scheduler.configuration.time_zone)
+                raise TIME_ZONE_CONFIG_IS_NOT_VALID unless new_tz
+
+                new_tz
+              else
+                raise TIME_ZONE_COULD_NOT_BE_DETERMINED
+              end
+            end
+        end
+      end
+    end
+  end
+end

data/lib/que/scheduler/to_enqueue.rb

@@ -22,14 +22,12 @@ module Que
           type_from_job_class(job_class).present?
         end
 
-        def active_job_version
-          Gem.loaded_specs["activejob"]&.version
+        def active_job_loaded?
+          !!active_job_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")
+        def active_job_version
+          Gem.loaded_specs["activejob"]&.version
         end
 
         def active_job_version_supports_queues?
@@ -56,7 +54,7 @@ module Que
               hash = {
                 ::Que::Job => QueJobType,
               }
-              hash[::ActiveJob::Base] = ActiveJobType if ToEnqueue.active_job_sufficient_version?
+              hash[::ActiveJob::Base] = ActiveJobType if ToEnqueue.active_job_loaded?
               hash
             end
         end
@@ -105,7 +103,13 @@ module Que
         scheduled_at =
           begin
             scheduled_at_float = data[:scheduled_at]
-            scheduled_at_float ? Time.zone.at(scheduled_at_float) : nil
+            # rubocop:disable Style/EmptyElse
+            if scheduled_at_float
+              Que::Scheduler::TimeZone.time_zone.at(scheduled_at_float)
+            else
+              nil
+            end
+            # rubocop:enable Style/EmptyElse
           end
 
         # Rails didn't support queues for ActiveJob for a while

data/lib/que/scheduler/version.rb

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

data/lib/que/scheduler/version_support.rb

@@ -61,7 +61,11 @@ module Que
 
         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 ||= que_version.split(".").first.to_i.zero?
+        end
+
+        def que_version
+          @que_version ||= Gem.loaded_specs["que"].version.to_s
         end
 
         private

data/lib/que/scheduler.rb

@@ -1,6 +1,7 @@
 require "que/scheduler/version"
 require "que/scheduler/version_support"
 require "que/scheduler/configuration"
+require "que/scheduler/time_zone"
 require "que/scheduler/scheduler_job"
 require "que/scheduler/db"
 require "que/scheduler/audit"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Harry Lascelles
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: fugit
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: que
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +73,7 @@ dependencies:
         version: '0.12'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta4
+        version: 1.0.0.beta5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -83,21 +83,27 @@ dependencies:
         version: '0.12'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta4
+        version: 1.0.0.beta5
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +147,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -210,6 +216,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -256,16 +276,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.84.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.84.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -355,6 +375,7 @@ files:
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb
 - lib/que/scheduler/state_checks.rb
+- lib/que/scheduler/time_zone.rb
 - lib/que/scheduler/to_enqueue.rb
 - lib/que/scheduler/version.rb
 - lib/que/scheduler/version_support.rb
@@ -367,7 +388,7 @@ metadata:
   changelog_uri: https://github.com/hlascelles/que-scheduler/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/hlascelles/que-scheduler/
   bug_tracker_uri: https://github.com/hlascelles/que-scheduler/issues
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -382,8 +403,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.2.7
+signing_key: 
 specification_version: 4
 summary: A cron scheduler for Que
 test_files: []