Class: Sidekiq::Scheduler

Inherits:
Object
  • Object
show all
Extended by:
Util
Defined in:
lib/sidekiq/scheduler.rb

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.



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

def dynamic
  @dynamic
end

.enabled ⇒ Object

Set to enable or disable the scheduler.



20
21
22
 
# File 'lib/sidekiq/scheduler.rb', line 20

def enabled
  @enabled
end

Class Method Details

.clear_schedule! ⇒ Object

Stops old rufus scheduler and creates a new one. Returns the new rufus scheduler



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

def self.clear_schedule!
  self.rufus_scheduler.stop
  @rufus_scheduler = nil
  @@scheduled_jobs = {}
  self.rufus_scheduler
end

.enqueue_from_config(job_config) ⇒ Object

Enqueue a job based on a config hash



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/sidekiq/scheduler.rb', line 132

def self.enqueue_from_config(job_config)
  config = job_config.dup

  config['class'] = if config['class'].is_a?(String)
                      config['class'].constantize
                    else
                      config['class']
                    end
  config['args'] = Array(config['args'])

   Sidekiq::Client.push(config)
end

.handle_errors ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/sidekiq/scheduler.rb', line 123

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

.load_schedule! ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/sidekiq/scheduler.rb', line 44

def self.load_schedule!
  if enabled
    logger.info 'Loading Schedule'

    # Need to load the schedule from redis for the first time if dynamic
    Sidekiq.reload_schedule! if dynamic

    logger.info 'Schedule empty! Set Sidekiq.schedule' if Sidekiq.schedule.empty?

    @@scheduled_jobs = {}

    Sidekiq.schedule.each do |name, config|
      self.load_schedule_job(name, config)
    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



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

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} "
    interval_defined = false
    interval_types = %w{cron every at in}
    interval_types.each do |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})"
          config.delete(interval_type)
          self.handle_errors { self.enqueue_from_config(config) }
        end

        interval_defined = true

        break
      end
    end

    unless interval_defined
      logger.info "no #{interval_types.join(' / ')} found for #{config['class']} (#{name}) - skipping"
    end
  end
end

.optionizate_interval_value(value) ⇒ Object

modify interval type value to value with options if options available



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/sidekiq/scheduler.rb', line 68

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

.print_schedule ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/sidekiq/scheduler.rb', line 32

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

.rails_env_matches?(config) ⇒ Boolean

Returns true if the given schedule config hash matches the current ENV

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/sidekiq/scheduler.rb', line 119

def self.rails_env_matches?(config)
  config['rails_env'] && ENV['RAILS_ENV'] && config['rails_env'].gsub(/\s/, '').split(',').include?(ENV['RAILS_ENV'])
end

.reload_schedule! ⇒ Object 



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

def self.reload_schedule!
  if enabled
    logger.info 'Reloading Schedule'
    self.clear_schedule!
    self.load_schedule!
  else
    logger.info 'SidekiqScheduler is disabled'
  end
end

.rufus_scheduler ⇒ Object 



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

def self.rufus_scheduler
  @rufus_scheduler ||= Rufus::Scheduler.new rufus_scheduler_options
end

.rufus_scheduler_options ⇒ Object 



145
146
147
 
# File 'lib/sidekiq/scheduler.rb', line 145

def self.rufus_scheduler_options
  @rufus_scheduler_options ||= {}
end

.rufus_scheduler_options=(options) ⇒ Object 



149
150
151
 
# File 'lib/sidekiq/scheduler.rb', line 149

def self.rufus_scheduler_options=(options)
  @rufus_scheduler_options = options
end

.scheduled_jobs ⇒ Object

the Rufus::Scheduler jobs that are scheduled



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

def self.scheduled_jobs
  @@scheduled_jobs
end

.unschedule_job(name) ⇒ Object 



192
193
194
195
196
197
198
 
# File 'lib/sidekiq/scheduler.rb', line 192

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

.update_schedule ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/sidekiq/scheduler.rb', line 176

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