Class: Sidekiq::Scheduler

Inherits:
Object
  • Object
show all
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 enabled)

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.dynamic ⇒ Object

Set to update the schedule in runtime in a given time period.



27
28
29
 
# File 'lib/sidekiq/scheduler.rb', line 27

def dynamic
  @dynamic
end

.enabled ⇒ Object

Set to enable or disable the scheduler.



24
25
26
 
# File 'lib/sidekiq/scheduler.rb', line 24

def enabled
  @enabled
end

.listened_queues_only ⇒ Object

Set to schedule jobs only when will be pushed to queues listened by sidekiq



30
31
32
 
# File 'lib/sidekiq/scheduler.rb', line 30

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.

Parameters:

  • klass (Class) —

    the class to check is decendant from ActiveJob

Returns:

  • (Boolean) 


261
262
263
264
 
# File 'lib/sidekiq/scheduler.rb', line 261

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



198
199
200
201
202
203
 
# File 'lib/sidekiq/scheduler.rb', line 198

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

Parameters:

  • job_queue (String) —

    Job’s queue name

Returns:

  • (Boolean) 


297
298
299
300
301
 
# File 'lib/sidekiq/scheduler.rb', line 297

def enabled_queue?(job_queue)
  queues = Sidekiq.options[:queues]

  queues.empty? || queues.include?(job_queue)
end

.enque_with_active_job(config) ⇒ Object 



239
240
241
 
# File 'lib/sidekiq/scheduler.rb', line 239

def enque_with_active_job(config)
  initialize_active_job(config['class'], config['args']).enqueue(config)
end

.enque_with_sidekiq(config) ⇒ Object 



243
244
245
 
# File 'lib/sidekiq/scheduler.rb', line 243

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



174
175
176
177
178
179
180
181
182
 
# File 'lib/sidekiq/scheduler.rb', line 174

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 



165
166
167
168
169
170
171
 
# File 'lib/sidekiq/scheduler.rb', line 165

def handle_errors
  begin
    yield
  rescue StandardError => e
    logger.info "#{e.class.name}: #{e.message}"
  end
end

.idempotent_job_enqueue(job_name, time, config) ⇒ Object

Pushes the job into Sidekiq if not already pushed for the given time

Parameters:

  • job_name (String) —

    The job’s name

  • time (Time) —

    The time when the job got cleared for triggering

  • config (Hash) —

    Job’s config hash



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/sidekiq/scheduler.rb', line 135

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 



247
248
249
250
251
252
253
 
# File 'lib/sidekiq/scheduler.rb', line 247

def initialize_active_job(klass, args)
  if args.is_a?(Array)
    klass.new(*args)
  else
    klass.new(args)
  end
end

.job_enabled?(name) ⇒ Boolean

Returns:

  • (Boolean) 


351
352
353
354
 
# File 'lib/sidekiq/scheduler.rb', line 351

def job_enabled?(name)
  job = Sidekiq.schedule[name]
  schedule_state(name).fetch('enabled', job.fetch('enabled', true)) if job
end

.load_schedule! ⇒ Object

Pulls the schedule from Sidekiq.schedule and loads it into the rufus scheduler instance



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
80
 
# File 'lib/sidekiq/scheduler.rb', line 49

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



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
128
 
# File 'lib/sidekiq/scheduler.rb', line 98

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 ⇒ String

Returns the key of the Redis hash for job’s execution times hash

Returns:

  • (String) —

    with the key



340
341
342
 
# File 'lib/sidekiq/scheduler.rb', line 340

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



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/sidekiq/scheduler.rb', line 83

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.

Parameters:

  • config (Hash) —

    the options to be converted

Options Hash (config):

  • class (String) —

    the job class

  • args (Hash/Array) —

    the arguments to be passed to the job class

Returns:

  • (Hash) 


274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/sidekiq/scheduler.rb', line 274

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 



37
38
39
40
41
42
43
44
45
 
# File 'lib/sidekiq/scheduler.rb', line 37

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

Parameters:

  • job_name (String) —

    The name of the job

Returns:

  • (String) 


333
334
335
 
# File 'lib/sidekiq/scheduler.rb', line 333

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

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/sidekiq/scheduler.rb', line 161

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

Parameters:

  • job_name (String) —

    The job’s name

  • time (Time) —

    Time at which the job was cleared by the scheduler

Returns:

  • (Boolean) —

    true if the job was registered, false when otherwise



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/sidekiq/scheduler.rb', line 309

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 



205
206
207
208
209
210
211
212
213
 
# File 'lib/sidekiq/scheduler.rb', line 205

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 



322
323
324
325
326
 
# File 'lib/sidekiq/scheduler.rb', line 322

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 



192
193
194
 
# File 'lib/sidekiq/scheduler.rb', line 192

def rufus_scheduler
  @rufus_scheduler ||= new_rufus_scheduler
end

.rufus_scheduler_options ⇒ Object 



184
185
186
 
# File 'lib/sidekiq/scheduler.rb', line 184

def rufus_scheduler_options
  @rufus_scheduler_options ||= {}
end

.rufus_scheduler_options=(options) ⇒ Object 



188
189
190
 
# File 'lib/sidekiq/scheduler.rb', line 188

def rufus_scheduler_options=(options)
  @rufus_scheduler_options = options
end

.scheduled_jobs ⇒ Object

the Rufus::Scheduler jobs that are scheduled



33
34
35
 
# File 'lib/sidekiq/scheduler.rb', line 33

def scheduled_jobs
  @@scheduled_jobs
end

.schedules_state_key ⇒ String

Returns the Redis’s key for saving schedule states.

Returns:

  • (String) —

    with the key



347
348
349
 
# File 'lib/sidekiq/scheduler.rb', line 347

def schedules_state_key
  'sidekiq-scheduler:states'
end

.toggle_job_enabled(name) ⇒ Object 



356
357
358
359
360
 
# File 'lib/sidekiq/scheduler.rb', line 356

def toggle_job_enabled(name)
  state = schedule_state(name)
  state['enabled'] = !job_enabled?(name)
  set_schedule_state(name, state)
end

.try_to_constantize(klass) ⇒ Object 



286
287
288
289
290
 
# File 'lib/sidekiq/scheduler.rb', line 286

def try_to_constantize(klass)
  klass.is_a?(String) ? klass.constantize : klass
rescue NameError
  klass
end

.unschedule_job(name) ⇒ Object 



231
232
233
234
235
236
237
 
# File 'lib/sidekiq/scheduler.rb', line 231

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

Parameters:

  • name (String) —

    The job’s name

  • next_time (Time) —

    The job’s next time execution



153
154
155
156
157
 
# File 'lib/sidekiq/scheduler.rb', line 153

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 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/sidekiq/scheduler.rb', line 215

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