sidekiq-scheduler 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2b640d812a1bd5a97323ddcc891c3b4322bc5f8
-  data.tar.gz: 8d1d6592c877a503f3167fdb91cecced8bebead1
+  metadata.gz: 8d0589167bd1d704cc531881f41ce934e07e684a
+  data.tar.gz: 4a07798d84026cedbb746d6c455463ae796ca56f
 SHA512:
-  metadata.gz: 80c12e6687d4251e579d2d7e802e7721f7d9fe6288689f45684448243e2c0091742910a87b57ae306fe4fe0a5a925bbe1fa8b0e7a60c67be62be139e547d2028
-  data.tar.gz: 1d25189e230f7f93bc66fe347326e925c868f8bc967ce5f5211c05aa37ba2f54030732f236e0521621da06af63bd27192ed3beccb6a76baee46c82e4ab8f77e7
+  metadata.gz: 56218d97eb155af5fbf07e4ccbca6a5e76bfe5e23facefb8e685758d3f031b17ab6f66ed89132a8953a8b03ad3935132cb1eefedbf3adbb2d23168698c4b959a
+  data.tar.gz: 722247865b66c237efcea76d099207b746e5058adeb60a550a8090baec5c666dab01f7659a8c00d3021fa9138692eccde02b62343980b3da2f9cfab5b2d4a0de

data/README.md

@@ -56,7 +56,7 @@ You can add sidekiq-scheduler configuration options to sidekiq.yml config file.
 Available options are:
 
     :schedule: <the schedule to be run>
-    :dynamic: <if true the schedule can be modified in runtime>
+    :dynamic: <if true the schedule can be modified in runtime [false by default]>
     :enabled: <enables scheduler if true [true by default]>
     :scheduler:
       :listened_queues_only: <push jobs whose queue is being listened by sidekiq [false by default]>
@@ -187,16 +187,42 @@ For more information, see [this issue](https://github.com/Moove-it/sidekiq-sched
 
 ### Reloading the schedules
 
-The schedules can we updated from redis, every 5 seconds the redis is checked for schedule changes,
-to update an schedule you have to:
+Schedules are stored in Redis. To add / update an schedule, you have to:
 
- ```ruby
-   Sidekiq.set_schedule('some_name', { 'every' => ['1m'], 'class' => 'HardWorker' })
- ```
+```ruby
+Sidekiq.set_schedule('heartbeat', { 'every' => ['1m'], 'class' => 'HeartbeatWorker' })
+```
+
+When `:dynamic` flag is set to `true`, schedule changes are loaded every 5 seconds.
+
+You can set that flag in the following ways.
+
+- Yaml configuration:
+```
+:dynamic: true
+```
+
+- Initializer configuration:
+```ruby
+Sidekiq.configure_server do |config|
+  # ...
+
+  config.on(:startup) do
+    # ...
+    Sidekiq::Scheduler.dynamic = true
+  end
+end
+```
+
+If `:dynamic` flag is set to false, you have to reload the schedule manually in sidekiq
+side:
+```ruby
+Sidekiq::Scheduler.reload_schedule!
+```
 
- If the schedule did not exist it'll we created if it existed it'll be updated
+If the schedule did not exist it'll we created, if it existed it'll be updated
 
- ### Testing
+### Testing
 
  In your tests you can check that a schedule change has been set you have to:
  ```ruby

data/lib/sidekiq-scheduler/schedule.rb

@@ -37,7 +37,7 @@ module SidekiqScheduler
     # param, otherwise params is passed in as the only parameter to perform.
     def schedule=(schedule_hash)
       schedule_hash = prepare_schedule(schedule_hash)
-      to_remove = (get_all_schedules || {}).keys - schedule_hash.keys
+      to_remove = (get_all_schedules || {}).keys - schedule_hash.keys.map(&:to_s)
 
       schedule_hash.each do |name, job_spec|
         set_schedule(name, job_spec)

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,5 @@
 module SidekiqScheduler
 
-  VERSION = '2.0.6'
+  VERSION = '2.0.7'
 
 end

data/lib/sidekiq/scheduler.rb

@@ -7,6 +7,8 @@ module Sidekiq
   class Scheduler
     extend Sidekiq::Util
 
+    REGISTERED_JOBS_THRESHOLD_IN_SECONDS = 24 * 60 * 60
+
     # We expect rufus jobs to have #params
     Rufus::Scheduler::Job.module_eval do
 
@@ -100,18 +102,21 @@ module Sidekiq
       if config['rails_env'].nil? || self.rails_env_matches?(config)
         logger.info "Scheduling #{name} #{config}"
         interval_defined = false
-        interval_types = %w{cron every at in}
+        interval_types = %w{cron every at in interval}
         interval_types.each do |interval_type|
-          if !config[interval_type].nil? && config[interval_type].length > 0
-            args = self.optionizate_interval_value(config[interval_type])
+          config_interval_type = config[interval_type]
+
+          if !config_interval_type.nil? && config_interval_type.length > 0
+
+            args = self.optionizate_interval_value(config_interval_type)
 
             # We want rufus_scheduler to return a job object, not a job id
             opts = { :job => true }
 
-            @@scheduled_jobs[name] = self.rufus_scheduler.send(interval_type, *args, opts) do
-              logger.info "queueing #{config['class']} (#{name})"
+            @@scheduled_jobs[name] = self.rufus_scheduler.send(interval_type, *args, opts) do |job, time|
               config.delete(interval_type)
-              self.handle_errors { self.enqueue_job(config) }
+
+              idempotent_job_enqueue(name, time, config)
             end
 
             interval_defined = true
@@ -126,6 +131,25 @@ module Sidekiq
       end
     end
 
+    # Pushes the job into Sidekiq if not already pushed for the given time
+    #
+    # @param [String] job_name The job's name
+    # @param [Time] time The time when the job got cleared for triggering
+    # @param [Hash] config Job's config hash
+    def self.idempotent_job_enqueue(job_name, time, config)
+      registered = register_job_instance(job_name, time)
+
+      if registered
+        logger.info "queueing #{config['class']} (#{job_name})"
+
+        self.handle_errors { self.enqueue_job(config) }
+
+        remove_elder_job_instances(job_name)
+      else
+        logger.debug { "Ignoring #{job_name} job as it has been already enqueued" }
+      end
+    end
+
     # Returns true if the given schedule config hash matches the current
     # ENV['RAILS_ENV']
     def self.rails_env_matches?(config)
@@ -263,5 +287,38 @@ module Sidekiq
       queues.empty? || queues.include?(job_queue)
     end
 
+    # Registers a queued job instance
+    #
+    # @param [String] job_name The job's name
+    # @param [Time] time Time at which the job was cleared by the scheduler
+    #
+    # @return [Boolean] true if the job was registered, false when otherwise
+    def self.register_job_instance(job_name, time)
+      pushed_job_key = pushed_job_key(job_name)
+
+      registered, _ = Sidekiq.redis do |r|
+        r.pipelined do
+          r.zadd(pushed_job_key, time.to_i, time.to_i)
+          r.expire(pushed_job_key, REGISTERED_JOBS_THRESHOLD_IN_SECONDS)
+        end
+      end
+
+      registered
+    end
+
+    def self.remove_elder_job_instances(job_name)
+      Sidekiq.redis do |r|
+        r.zremrangebyscore(pushed_job_key(job_name), 0, Time.now.to_i - REGISTERED_JOBS_THRESHOLD_IN_SECONDS)
+      end
+    end
+
+    # Returns the key of the Redis sorted set used to store job enqueues
+    #
+    # @param [String] job_name The name of the job
+    #
+    # @return [String]
+    def self.pushed_job_key(job_name)
+      "sidekiq-scheduler:pushed:#{job_name}"
+    end
   end
 end

data/web/locales/es.yml

@@ -0,0 +1,9 @@
+es:
+  recurring_jobs: Tareas Recurrentes
+  name: Nombre
+  description: Descripción
+  interval: Intervalo
+  class: Clase
+  queue: Cola
+  arguments: Argumentos
+  enqueue_now: Encolar ahora

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -240,6 +240,7 @@ files:
 - lib/sidekiq/scheduler.rb
 - web/locales/cs.yml
 - web/locales/en.yml
+- web/locales/es.yml
 - web/views/recurring_jobs.erb
 homepage: https://github.com/moove-it/sidekiq-scheduler
 licenses:
@@ -261,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Light weight job scheduling extension for Sidekiq