Class: Sidekiq::Scheduler
- Inherits:
-
Object
- Object
- Sidekiq::Scheduler
- Extended by:
- Util
- Defined in:
- lib/sidekiq/scheduler.rb
Constant Summary collapse
- REGISTERED_JOBS_THRESHOLD_IN_SECONDS =
24 * 60 * 60
- RUFUS_METADATA_KEYS =
%w(description at cron every in interval)
Class Attribute Summary collapse
-
.dynamic ⇒ Object
Set to update the schedule in runtime in a given time period.
-
.enabled ⇒ Object
Set to enable or disable the scheduler.
-
.listened_queues_only ⇒ Object
Set to schedule jobs only when will be pushed to queues listened by sidekiq.
Class Method Summary collapse
-
.active_job_enqueue?(klass) ⇒ Boolean
Returns true if the enqueuing needs to be done for an ActiveJob class false otherwise.
-
.clear_schedule! ⇒ Object
Stops old rufus scheduler and creates a new one.
-
.enabled_queue?(job_queue) ⇒ Boolean
Returns true if a job’s queue is being listened on by sidekiq.
- .enque_with_active_job(config) ⇒ Object
- .enque_with_sidekiq(config) ⇒ Object
-
.enqueue_job(job_config) ⇒ Object
Enqueue a job based on a config hash.
- .handle_errors ⇒ Object
-
.idempotent_job_enqueue(job_name, time, config) ⇒ Object
Pushes the job into Sidekiq if not already pushed for the given time.
- .initialize_active_job(klass, args) ⇒ Object
-
.load_schedule! ⇒ Object
Pulls the schedule from Sidekiq.schedule and loads it into the rufus scheduler instance.
-
.load_schedule_job(name, config) ⇒ Object
Loads a job schedule into the Rufus::Scheduler and stores it in @@scheduled_jobs.
-
.next_times_key ⇒ Object
Returns the key of the Redis hash for job’s execution times hash.
-
.optionizate_interval_value(value) ⇒ Object
modify interval type value to value with options if options available.
-
.prepare_arguments(config) ⇒ Hash
Convert the given arguments in the format expected to be enqueued.
- .print_schedule ⇒ Object
-
.pushed_job_key(job_name) ⇒ String
Returns the key of the Redis sorted set used to store job enqueues.
-
.rails_env_matches?(config) ⇒ Boolean
Returns true if the given schedule config hash matches the current ENV.
-
.register_job_instance(job_name, time) ⇒ Boolean
Registers a queued job instance.
- .reload_schedule! ⇒ Object
- .remove_elder_job_instances(job_name) ⇒ Object
- .rufus_scheduler ⇒ Object
- .rufus_scheduler_options ⇒ Object
- .rufus_scheduler_options=(options) ⇒ Object
-
.scheduled_jobs ⇒ Object
the Rufus::Scheduler jobs that are scheduled.
- .try_to_constantize(klass) ⇒ Object
- .unschedule_job(name) ⇒ Object
-
.update_job_next_time(name, next_time) ⇒ Object
Pushes job’s next time execution.
- .update_schedule ⇒ Object
Class Attribute Details
.dynamic ⇒ Object
Set to update the schedule in runtime in a given time period.
26 27 28 |
# File 'lib/sidekiq/scheduler.rb', line 26 def dynamic @dynamic end |
.enabled ⇒ Object
Set to enable or disable the scheduler.
23 24 25 |
# File 'lib/sidekiq/scheduler.rb', line 23 def enabled @enabled end |
.listened_queues_only ⇒ Object
Set to schedule jobs only when will be pushed to queues listened by sidekiq
29 30 31 |
# File 'lib/sidekiq/scheduler.rb', line 29 def listened_queues_only @listened_queues_only end |
Class Method Details
.active_job_enqueue?(klass) ⇒ Boolean
Returns true if the enqueuing needs to be done for an ActiveJob
class false otherwise.
260 261 262 263 |
# File 'lib/sidekiq/scheduler.rb', line 260 def active_job_enqueue?(klass) klass.is_a?(Class) && defined?(ActiveJob::Enqueuing) && klass.included_modules.include?(ActiveJob::Enqueuing) end |
.clear_schedule! ⇒ Object
Stops old rufus scheduler and creates a new one. Returns the new rufus scheduler
197 198 199 200 201 202 |
# File 'lib/sidekiq/scheduler.rb', line 197 def clear_schedule! rufus_scheduler.stop @rufus_scheduler = nil @@scheduled_jobs = {} rufus_scheduler end |
.enabled_queue?(job_queue) ⇒ Boolean
Returns true if a job’s queue is being listened on by sidekiq
296 297 298 299 300 |
# File 'lib/sidekiq/scheduler.rb', line 296 def enabled_queue?(job_queue) queues = Sidekiq.[:queues] queues.empty? || queues.include?(job_queue) end |
.enque_with_active_job(config) ⇒ Object
238 239 240 |
# File 'lib/sidekiq/scheduler.rb', line 238 def enque_with_active_job(config) initialize_active_job(config['class'], config['args']).enqueue(config) end |
.enque_with_sidekiq(config) ⇒ Object
242 243 244 |
# File 'lib/sidekiq/scheduler.rb', line 242 def enque_with_sidekiq(config) Sidekiq::Client.push(sanitize_job_config(config)) end |
.enqueue_job(job_config) ⇒ Object
Enqueue a job based on a config hash
173 174 175 176 177 178 179 180 181 |
# File 'lib/sidekiq/scheduler.rb', line 173 def enqueue_job(job_config) config = prepare_arguments(job_config.dup) if active_job_enqueue?(config['class']) enque_with_active_job(config) else enque_with_sidekiq(config) end end |
.handle_errors ⇒ Object
164 165 166 167 168 169 170 |
# File 'lib/sidekiq/scheduler.rb', line 164 def handle_errors begin yield rescue StandardError => e logger.info "#{e.class.name}: #{e.}" end end |
.idempotent_job_enqueue(job_name, time, config) ⇒ Object
Pushes the job into Sidekiq if not already pushed for the given time
134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/sidekiq/scheduler.rb', line 134 def idempotent_job_enqueue(job_name, time, config) registered = register_job_instance(job_name, time) if registered logger.info "queueing #{config['class']} (#{job_name})" handle_errors { enqueue_job(config) } remove_elder_job_instances(job_name) else logger.debug { "Ignoring #{job_name} job as it has been already enqueued" } end end |
.initialize_active_job(klass, args) ⇒ Object
246 247 248 249 250 251 252 |
# File 'lib/sidekiq/scheduler.rb', line 246 def initialize_active_job(klass, args) if args.is_a?(Array) klass.new(*args) else klass.new(args) end end |
.load_schedule! ⇒ Object
Pulls the schedule from Sidekiq.schedule and loads it into the rufus scheduler instance
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/sidekiq/scheduler.rb', line 48 def load_schedule! if enabled logger.info 'Loading Schedule' # Load schedule from redis for the first time if dynamic if dynamic Sidekiq.reload_schedule! rufus_scheduler.every('5s') do update_schedule end end logger.info 'Schedule empty! Set Sidekiq.schedule' if Sidekiq.schedule.empty? @@scheduled_jobs = {} Sidekiq.schedule.each do |name, config| if !listened_queues_only || enabled_queue?(config['queue']) load_schedule_job(name, config) else logger.info { "Ignoring #{name}, job's queue is not enabled." } end end Sidekiq.redis { |r| r.del(:schedules_changed) } logger.info 'Schedules Loaded' else logger.info 'SidekiqScheduler is disabled' end end |
.load_schedule_job(name, config) ⇒ Object
Loads a job schedule into the Rufus::Scheduler and stores it in @@scheduled_jobs
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/sidekiq/scheduler.rb', line 97 def load_schedule_job(name, config) # If rails_env is set in the config, enforce ENV['RAILS_ENV'] as # required for the jobs to be scheduled. If rails_env is missing, the # job should be scheduled regardless of what ENV['RAILS_ENV'] is set # to. if config['rails_env'].nil? || rails_env_matches?(config) logger.info "Scheduling #{name} #{config}" interval_defined = false interval_types = %w{cron every at in interval} interval_types.each do |interval_type| config_interval_type = config[interval_type] if !config_interval_type.nil? && config_interval_type.length > 0 args = optionizate_interval_value(config_interval_type) rufus_job = new_job(name, interval_type, config, args) @@scheduled_jobs[name] = rufus_job update_job_next_time(name, rufus_job.next_time) interval_defined = true break end end unless interval_defined logger.info "no #{interval_types.join(' / ')} found for #{config['class']} (#{name}) - skipping" end end end |
.next_times_key ⇒ Object
Returns the key of the Redis hash for job’s execution times hash
338 339 340 |
# File 'lib/sidekiq/scheduler.rb', line 338 def next_times_key 'sidekiq-scheduler:next_times' end |
.optionizate_interval_value(value) ⇒ Object
modify interval type value to value with options if options available
82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/sidekiq/scheduler.rb', line 82 def optionizate_interval_value(value) args = value if args.is_a?(::Array) return args.first if args.size > 2 || !args.last.is_a?(::Hash) # symbolize keys of hash for options args[1] = args[1].inject({}) do |m, i| key, value = i m[(key.to_sym rescue key) || key] = value m end end args end |
.prepare_arguments(config) ⇒ Hash
Convert the given arguments in the format expected to be enqueued.
273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/sidekiq/scheduler.rb', line 273 def prepare_arguments(config) config['class'] = try_to_constantize(config['class']) if config['args'].is_a?(Hash) config['args'].symbolize_keys! if config['args'].respond_to?(:symbolize_keys!) else config['args'] = Array(config['args']) end config end |
.print_schedule ⇒ Object
36 37 38 39 40 41 42 43 44 |
# File 'lib/sidekiq/scheduler.rb', line 36 def print_schedule if rufus_scheduler logger.info "Scheduling Info\tLast Run" scheduler_jobs = rufus_scheduler.all_jobs scheduler_jobs.each do |_, v| logger.info "#{v.t}\t#{v.last}\t" end end end |
.pushed_job_key(job_name) ⇒ String
Returns the key of the Redis sorted set used to store job enqueues
332 333 334 |
# File 'lib/sidekiq/scheduler.rb', line 332 def pushed_job_key(job_name) "sidekiq-scheduler:pushed:#{job_name}" end |
.rails_env_matches?(config) ⇒ Boolean
Returns true if the given schedule config hash matches the current ENV
160 161 162 |
# File 'lib/sidekiq/scheduler.rb', line 160 def rails_env_matches?(config) config['rails_env'] && ENV['RAILS_ENV'] && config['rails_env'].gsub(/\s/, '').split(',').include?(ENV['RAILS_ENV']) end |
.register_job_instance(job_name, time) ⇒ Boolean
Registers a queued job instance
308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/sidekiq/scheduler.rb', line 308 def 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 |
.reload_schedule! ⇒ Object
204 205 206 207 208 209 210 211 212 |
# File 'lib/sidekiq/scheduler.rb', line 204 def reload_schedule! if enabled logger.info 'Reloading Schedule' clear_schedule! load_schedule! else logger.info 'SidekiqScheduler is disabled' end end |
.remove_elder_job_instances(job_name) ⇒ Object
321 322 323 324 325 |
# File 'lib/sidekiq/scheduler.rb', line 321 def 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 |
.rufus_scheduler ⇒ Object
191 192 193 |
# File 'lib/sidekiq/scheduler.rb', line 191 def rufus_scheduler @rufus_scheduler ||= new_rufus_scheduler end |
.rufus_scheduler_options ⇒ Object
183 184 185 |
# File 'lib/sidekiq/scheduler.rb', line 183 def @rufus_scheduler_options ||= {} end |
.rufus_scheduler_options=(options) ⇒ Object
187 188 189 |
# File 'lib/sidekiq/scheduler.rb', line 187 def () @rufus_scheduler_options = end |
.scheduled_jobs ⇒ Object
the Rufus::Scheduler jobs that are scheduled
32 33 34 |
# File 'lib/sidekiq/scheduler.rb', line 32 def scheduled_jobs @@scheduled_jobs end |
.try_to_constantize(klass) ⇒ Object
285 286 287 288 289 |
# File 'lib/sidekiq/scheduler.rb', line 285 def try_to_constantize(klass) klass.is_a?(String) ? klass.constantize : klass rescue NameError klass end |
.unschedule_job(name) ⇒ Object
230 231 232 233 234 235 236 |
# File 'lib/sidekiq/scheduler.rb', line 230 def unschedule_job(name) if scheduled_jobs[name] logger.debug "Removing schedule #{name}" scheduled_jobs[name].unschedule scheduled_jobs.delete(name) end end |
.update_job_next_time(name, next_time) ⇒ Object
Pushes job’s next time execution
152 153 154 155 156 |
# File 'lib/sidekiq/scheduler.rb', line 152 def update_job_next_time(name, next_time) Sidekiq.redis do |r| next_time ? r.hset(next_times_key, name, next_time) : r.hdel(next_times_key, name) end end |
.update_schedule ⇒ Object
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/sidekiq/scheduler.rb', line 214 def update_schedule if Sidekiq.redis { |r| r.scard(:schedules_changed) } > 0 logger.info 'Updating schedule' Sidekiq.reload_schedule! while schedule_name = Sidekiq.redis { |r| r.spop(:schedules_changed) } if Sidekiq.schedule.keys.include?(schedule_name) unschedule_job(schedule_name) load_schedule_job(schedule_name, Sidekiq.schedule[schedule_name]) else unschedule_job(schedule_name) end end logger.info 'Schedules Loaded' end end |