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

If set, will try to update the schulde in the loop



12
13
14
 
# File 'lib/sidekiq/scheduler.rb', line 12

def dynamic
  @dynamic
end

Class Method Details

.clear_schedule! ⇒ Object

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



129
130
131
132
133
134
 
# File 'lib/sidekiq/scheduler.rb', line 129

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



113
114
115
116
117
118
119
120
121
 
# File 'lib/sidekiq/scheduler.rb', line 113

def self.enqueue_from_config(job_config)
  args = job_config[:args] || job_config['args']
  args = args.is_a?(Hash) ? [args] : Array(args)
  
  klass_name = job_config[:class] || job_config['class']
  klass = klass_name.constantize rescue constantize(klass_name)

  Sidekiq::Client.push({ 'class' => klass, 'args' => args })
end

.handle_errors ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/sidekiq/scheduler.rb', line 104

def self.handle_errors
  begin
    yield
  rescue Exception => 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



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/sidekiq/scheduler.rb', line 32

def self.load_schedule!
  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'
end

.load_schedule_job(name, config) ⇒ Object

Loads a job schedule into the Rufus::Scheduler and stores it in @@scheduled_jobs



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

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}
    interval_types.each do |interval_type|
      if !config[interval_type].nil? && config[interval_type].length > 0
        args = self.optionizate_interval_value(config[interval_type])

        @@scheduled_jobs[name] = self.rufus_scheduler.send(interval_type, *args) 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



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/sidekiq/scheduler.rb', line 52

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 



20
21
22
23
24
25
26
27
28
 
# File 'lib/sidekiq/scheduler.rb', line 20

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 |k, 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) 


100
101
102
 
# File 'lib/sidekiq/scheduler.rb', line 100

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 



136
137
138
139
140
 
# File 'lib/sidekiq/scheduler.rb', line 136

def self.reload_schedule!
  logger.info 'Reloading Schedule'
  self.clear_schedule!
  self.load_schedule!
end

.rufus_scheduler ⇒ Object 



123
124
125
 
# File 'lib/sidekiq/scheduler.rb', line 123

def self.rufus_scheduler
  @rufus_scheduler ||= Rufus::Scheduler.start_new
end

.scheduled_jobs ⇒ Object

the Rufus::Scheduler jobs that are scheduled



16
17
18
 
# File 'lib/sidekiq/scheduler.rb', line 16

def self.scheduled_jobs
  @@scheduled_jobs
end

.unschedule_job(name) ⇒ Object 



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

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 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/sidekiq/scheduler.rb', line 142

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