-
Notifications
You must be signed in to change notification settings - Fork 236
/
scheduler.rb
343 lines (281 loc) · 9.92 KB
/
scheduler.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
require 'rufus/scheduler'
require 'thwait'
require 'sidekiq/util'
require 'sidekiq-scheduler/manager'
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
alias_method :params, :opts
end
class << self
# Set to enable or disable the scheduler.
attr_accessor :enabled
# Set to update the schedule in runtime in a given time period.
attr_accessor :dynamic
# Set to schedule jobs only when will be pushed to queues listened by sidekiq
attr_accessor :listened_queues_only
end
# the Rufus::Scheduler jobs that are scheduled
def self.scheduled_jobs
@@scheduled_jobs
end
def self.print_schedule
if self.rufus_scheduler
logger.info "Scheduling Info\tLast Run"
scheduler_jobs = self.rufus_scheduler.all_jobs
scheduler_jobs.each do |_, v|
logger.info "#{v.t}\t#{v.last}\t"
end
end
end
# Pulls the schedule from Sidekiq.schedule and loads it into the
# rufus scheduler instance
def self.load_schedule!
if enabled
logger.info 'Loading Schedule'
# Load schedule from redis for the first time if dynamic
if dynamic
Sidekiq.reload_schedule!
self.rufus_scheduler.every('5s') do
self.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'])
self.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
# modify interval type value to value with options if options available
def self.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
# Loads a job schedule into the Rufus::Scheduler and stores it in @@scheduled_jobs
def self.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? || self.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 = self.optionizate_interval_value(config_interval_type)
# We want rufus_scheduler to return a job object, not a job id
opts = { :job => true }
rufus_job = self.rufus_scheduler.send(interval_type, *args, opts) do |job, time|
config.delete(interval_type)
idempotent_job_enqueue(name, time, config)
update_job_next_time(name, job.next_time)
end
@@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
# 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
# Pushes job's next time execution
#
# @param [String] name The job's name
# @param [Time] next_time The job's next time execution
def self.update_job_next_time(name, next_time)
Sidekiq.redis { |r| r.hset(next_times_key, name, next_time) }
end
# Returns true if the given schedule config hash matches the current
# ENV['RAILS_ENV']
def self.rails_env_matches?(config)
config['rails_env'] && ENV['RAILS_ENV'] && config['rails_env'].gsub(/\s/, '').split(',').include?(ENV['RAILS_ENV'])
end
def self.handle_errors
begin
yield
rescue StandardError => e
logger.info "#{e.class.name}: #{e.message}"
end
end
# Enqueue a job based on a config hash
def self.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
def self.rufus_scheduler_options
@rufus_scheduler_options ||= {}
end
def self.rufus_scheduler_options=(options)
@rufus_scheduler_options = options
end
def self.rufus_scheduler
@rufus_scheduler ||= Rufus::Scheduler.new(rufus_scheduler_options)
end
# Stops old rufus scheduler and creates a new one. Returns the new
# rufus scheduler
def self.clear_schedule!
self.rufus_scheduler.stop
@rufus_scheduler = nil
@@scheduled_jobs = {}
self.rufus_scheduler
end
def self.reload_schedule!
if enabled
logger.info 'Reloading Schedule'
self.clear_schedule!
self.load_schedule!
else
logger.info 'SidekiqScheduler is disabled'
end
end
def self.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)
self.unschedule_job(schedule_name)
self.load_schedule_job(schedule_name, Sidekiq.schedule[schedule_name])
else
self.unschedule_job(schedule_name)
end
end
logger.info 'Schedules Loaded'
end
end
def self.unschedule_job(name)
if self.scheduled_jobs[name]
logger.debug "Removing schedule #{name}"
self.scheduled_jobs[name].unschedule
self.scheduled_jobs.delete(name)
end
end
def self.enque_with_active_job(config)
initialize_active_job(config['class'], config['args']).enqueue(config)
end
def self.enque_with_sidekiq(config)
Sidekiq::Client.push(config)
end
def self.initialize_active_job(klass, args)
if args.is_a?(Array)
klass.new(*args)
else
klass.new(args)
end
end
# Returns true if the enqueuing needs to be done for an ActiveJob
# class false otherwise.
#
# @param [Class] klass the class to check is decendant from ActiveJob
#
# @return [Boolean]
def self.active_job_enqueue?(klass)
defined?(ActiveJob::Enqueuing) && klass.included_modules.include?(ActiveJob::Enqueuing)
end
# Convert the given arguments in the format expected to be enqueued.
#
# @param [Hash] config the options to be converted
# @option config [String] class the job class
# @option config [Hash/Array] args the arguments to be passed to the job
# class
#
# @return [Hash]
def self.prepare_arguments(config)
config['class'] = config['class'].constantize if config['class'].is_a?(String)
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
# Returns true if a job's queue is being listened on by sidekiq
#
# @param [String] job_queue Job's queue name
#
# @return [Boolean]
def self.enabled_queue?(job_queue)
queues = Sidekiq.options[:queues]
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
# Returns the key of the Redis hash for job's execution times hash
#
def self.next_times_key
'sidekiq-scheduler:next_times'
end
end
end