que-scheduler 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 198960bfd5797bdc85e0b320170350bb3a752e5c4ed90db31b86cf040b5dbd92
-  data.tar.gz: 3f7128c8d159d5007ae42e72eca65059fd5e3f7cc9d60706dd72d7ea5002e686
+  metadata.gz: fe4e2dccf7d28c0918286aff2764b770b5f7ce4ddfe3383e4db74e3b21531bcc
+  data.tar.gz: a0b4db17f63d630acd1ef5e401d897ca5df2995c1cf45489367541671a5039f8
 SHA512:
-  metadata.gz: db16c38be02a29d413687a3faaffd7749a88ca141bfcee724b0f1c410ddb4094ca6b92c73c878250d088cbaec5242dd8b755d3d3bf44dacd80dd921b710eb9bd
-  data.tar.gz: fd46b785a759e3435491e54015d7ffff61bcf8ad5b0bd782a505838c148e9c778d6c994aaad71697cbe815bd47dffa22dcc3e35de8dc312eebbcc85a2752e26a
+  metadata.gz: 358a0ed1b4e31f5dc355f11bfab0dd8765852857684f752bf8ab99ca805690ed3eb7b502d6f36f2683c2fdc1429eaff8d5d4faa00983c9175a6669cf1ff5ea5f
+  data.tar.gz: 29b612a226076216788cb914fbe7064c6840597962f718fd3635d85c23e4085aa2c497ec521e661c621631b7b36de9aae080538bc6b37ac93e489fad035ba583

data/README.md

@@ -162,6 +162,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
 ```
 

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"

data/lib/que/scheduler/configuration.rb

@@ -8,6 +8,7 @@ module Que
       attr_accessor :schedule
       attr_accessor :transaction_adapter
       attr_accessor :que_scheduler_queue
+      attr_accessor :time_zone
     end
 
     class << self
@@ -26,6 +27,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/defined_job.rb

@@ -89,7 +89,7 @@ module Que
            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
+          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 <= (

data/lib/que/scheduler/schedule.rb

@@ -41,7 +41,8 @@ module Que
           end.to_h
         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

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

@@ -105,7 +105,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.2".freeze
+    VERSION = "4.0.3".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -355,6 +355,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