sidekiq-scheduler 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e699dac84cd996f77b54a71564a2e888a5444c6d
-  data.tar.gz: 597847f71ef33050a54ded0d313204d3604f2742
+  metadata.gz: ae34c739c46b8fbf1ff40509dbdd8cca94f736c5
+  data.tar.gz: 4bfb4cc75fc85ee2cd5a3fee274820f14241f8eb
 SHA512:
-  metadata.gz: 933d343adcbb79210f95308de2b4612d4c0dd1185ea1b2b1d0fa9ae810b2e4a10031ef0d7b5ef90d95cf9168d742c9a9f4fa5369a87b3157397e9de0cc8b730f
-  data.tar.gz: 6813ae6ab82f3ffc24446734071114ad0ed446d15060bf8789b8ae98f6cfb44941c209bb9a1eb5875e8f6bc90a55a8050629ba15546c4972835f09421d63290a
+  metadata.gz: a922a153b0c8c6fbfc894557f5f90564a0120c66205e6ffffd9f520aa9fd1a4f4e40e4c677c20830e5224f1c9767daf757c1adcb8ed1dcf2ebcb21d0e57bf749
+  data.tar.gz: 40ad60c1df2b902a748d297a89d5571839f074e7407efc3f44d28a7f1cc240049d1e9cdd7e4ce40bedc485766aec5dfd799596821a3a48ffa812fb868ad9095c

data/README.md

@@ -117,10 +117,42 @@ The schedule is configured through the `:schedule` config entry in the sidekiq c
     args: ['*.pdf']
     description: "This job queues pdf content for indexing in solr"
 
+    # Enable the `metadata` argument which will pass a Hash containing the schedule metadata
+    # as the last argument of the `perform` method. `false` by default.
+    include_metadata: true
+
     # Enable / disable a job. All jobs are enabled by default.
     enabled: true
 ```
 
+### Schedule metadata
+You can configure Sidekiq-scheduler to pass an argument with metadata about the scheduling process
+to the worker's `perform` method.
+
+In the configuration file add the following on each worker class entry:
+
+```yaml
+
+  SampleWorker:
+    include_metadata: true
+```
+
+On your `perform` method, expect an additional argument:
+
+```ruby
+  def perform(args, ..., metadata)
+    # Do something with the metadata
+  end
+```
+
+The `metadata` hash contains the following keys:
+
+```ruby
+  metadata.keys =>
+    [
+      :scheduled_at # The epoch when the job was scheduled to run
+    ]
+```
 
 ## Schedule types
 

data/lib/sidekiq-scheduler/manager.rb

@@ -18,7 +18,7 @@ module SidekiqScheduler
       Sidekiq::Scheduler.enabled = options[:enabled]
       Sidekiq::Scheduler.dynamic = options[:dynamic]
       Sidekiq::Scheduler.listened_queues_only = options[:listened_queues_only]
-      Sidekiq.schedule = options[:schedule]
+      Sidekiq.schedule = options[:schedule] if Sidekiq::Scheduler.enabled
     end
 
     def stop

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,5 @@
 module SidekiqScheduler
 
-  VERSION = '2.1.1'
+  VERSION = '2.1.2'
 
 end

data/lib/sidekiq/scheduler.rb

@@ -124,7 +124,7 @@ module Sidekiq
         if registered
           logger.info "queueing #{config['class']} (#{job_name})"
 
-          handle_errors { enqueue_job(config) }
+          handle_errors { enqueue_job(config, time) }
 
           remove_elder_job_instances(job_name)
         else
@@ -157,13 +157,20 @@ module Sidekiq
       end
 
       # Enqueue a job based on a config hash
-      def enqueue_job(job_config)
+      #
+      # @param job_config [Hash] the job configuration
+      # @param time [Time] time the job is enqueued
+      def enqueue_job(job_config, time=Time.now)
         config = prepare_arguments(job_config.dup)
 
+        if config.delete('include_metadata')
+          config['args'] = arguments_with_metadata(config['args'], scheduled_at: time.to_f)
+        end
+
         if active_job_enqueue?(config['class'])
-          enque_with_active_job(config)
+          enqueue_with_active_job(config)
         else
-          enque_with_sidekiq(config)
+          enqueue_with_sidekiq(config)
         end
       end
 
@@ -222,11 +229,12 @@ module Sidekiq
         end
       end
 
-      def enque_with_active_job(config)
-        initialize_active_job(config['class'], config['args']).enqueue(config)
+      def enqueue_with_active_job(config)
+        # TODO Does ActiveJob really need to get the config data in the `enqueue` call?
+        initialize_active_job(config['class'], config['args']).enqueue(sanitize_job_config(config))
       end
 
-      def enque_with_sidekiq(config)
+      def enqueue_with_sidekiq(config)
         Sidekiq::Client.push(sanitize_job_config(config))
       end
 
@@ -385,6 +393,25 @@ module Sidekiq
         Sidekiq.redis { |r| r.hset(schedules_state_key, name, JSON.generate(state)) }
       end
 
+      # Adds a Hash with schedule metadata as the last argument to call the worker.
+      # It currently returns the schedule time as a Float number representing the milisencods
+      # since epoch.
+      #
+      # @example with hash argument
+      #   arguments_with_metadata({value: 1}, scheduled_at: Time.now)
+      #   #=> [{value: 1}, {scheduled_at: <miliseconds since epoch>}]
+      #
+      # @param args [Array|Hash]
+      # @param metadata [Hash]
+      # @return [Array] arguments with added metadata
+      def arguments_with_metadata(args, metadata)
+        if args.is_a? Array
+          [*args, metadata]
+        else
+          [args, metadata]
+        end
+      end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie