Class: Resque::Scheduler

Inherits:
Object
  • Object
show all
Extended by:
Helpers
Defined in:
lib/resque/scheduler.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.mute ⇒ Object

If set, produces no output



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

def mute
  @mute
end

.verbose ⇒ Object

If true, logs more stuff…



13
14
15
 
# File 'lib/resque/scheduler.rb', line 13

def verbose
  @verbose
end

Class Method Details

.clear_schedule! ⇒ Object

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



164
165
166
167
168
169
 
# File 'lib/resque/scheduler.rb', line 164

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

.enqueue_delayed_items_for_timestamp(timestamp) ⇒ Object

Enqueues all delayed jobs for a timestamp



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/resque/scheduler.rb', line 115

def enqueue_delayed_items_for_timestamp(timestamp)
  item = nil
  begin
    handle_shutdown do
      if item = Resque.next_item_for_timestamp(timestamp)
        log "queuing #{item['class']} [delayed]"
        klass = constantize(item['class'])
        queue = item['queue'] || Resque.queue_from_class(klass)
        # Support custom job classes like job with status
        if (job_klass = item['custom_job_class']) && (job_klass != 'Resque::Job')
          # custom job classes not supporting the same API calls must implement the #schedule method
          constantize(job_klass).scheduled(queue, item['class'], *item['args'])
        else
          Resque::Job.create(queue, klass, *item['args'])
        end
      end
    end
  # continue processing until there are no more ready items in this timestamp
  end while !item.nil?
end

.enqueue_from_config(config) ⇒ Object

Enqueues a job based on a config hash



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

def enqueue_from_config(config)
  args = config['args'] || config[:args]
  klass_name = config['class'] || config[:class]
  klass = constantize(klass_name)
  params = args.nil? ? [] : Array(args)
  queue = config['queue'] || config[:queue] || Resque.queue_from_class(klass)
  # Support custom job classes like job with status
  if (job_klass = config['custom_job_class']) && (job_klass != 'Resque::Job')
    # custom job classes not supporting the same API calls must implement the #schedule method
    constantize(job_klass).scheduled(queue, klass_name, *params)
  else
    Resque::Job.create(queue, klass, *params)
  end        
end

.handle_delayed_items ⇒ Object

Handles queueing delayed items



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/resque/scheduler.rb', line 103

def handle_delayed_items
  item = nil
  if timestamp = Resque.next_delayed_timestamp
    procline "Processing Delayed Items"
    while !timestamp.nil?
      enqueue_delayed_items_for_timestamp(timestamp)
      timestamp = Resque.next_delayed_timestamp
    end
  end
end

.handle_shutdown ⇒ Object 



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

def handle_shutdown
  exit if @shutdown
  yield
  exit if @shutdown
end

.load_schedule! ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/resque/scheduler.rb', line 66

def load_schedule!
  log! "Schedule empty! Set Resque.schedule" if Resque.schedule.empty?
  
  @@scheduled_jobs = {}
  
  Resque.schedule.each do |name, config|
    load_schedule_job(name, config)
  end
  procline "Schedules Loaded"
end

.load_schedule_job(name, config) ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/resque/scheduler.rb', line 78

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)
    log! "Scheduling #{name} "
    if !config['cron'].nil? && config['cron'].length > 0
      @@scheduled_jobs[name] = rufus_scheduler.cron config['cron'] do
        log! "queuing #{config['class']} (#{name})"
        enqueue_from_config(config)
      end
    else
      log! "no cron found for #{config['class']} (#{name}) - skipping"
    end
  end
end

.log(msg) ⇒ Object 



222
223
224
225
 
# File 'lib/resque/scheduler.rb', line 222

def log(msg)
  # add "verbose" logic later
  log!(msg) if verbose
end

.log!(msg) ⇒ Object 



218
219
220
 
# File 'lib/resque/scheduler.rb', line 218

def log!(msg)
  puts "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")} #{msg}" unless mute
end

.poll_sleep ⇒ Object

Sleeps and returns true



205
206
207
208
209
210
 
# File 'lib/resque/scheduler.rb', line 205

def poll_sleep
  @sleeping = true
  handle_shutdown { sleep 5 }
  @sleeping = false
  true
end

.procline(string) ⇒ Object 



227
228
229
230
 
# File 'lib/resque/scheduler.rb', line 227

def procline(string)
  $0 = "resque-scheduler-#{ResqueScheduler::Version}: #{string}"
  log! $0
end

.rails_env_matches?(config) ⇒ Boolean

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

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/resque/scheduler.rb', line 98

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

.register_signal_handlers ⇒ Object

For all signals, set the shutdown flag and wait for current poll/enqueing to finish (should be almost istant). In the case of sleeping, exit immediately.



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

def register_signal_handlers
  trap("TERM") { shutdown }
  trap("INT") { shutdown }
  
  begin
    trap('QUIT') { shutdown   }
    trap('USR1') { kill_child }
    trap('USR2') { reload_schedule! }
  rescue ArgumentError
    warn "Signals QUIT and USR1 and USR2 not supported."
  end
end

.reload_schedule! ⇒ Object 



171
172
173
174
175
176
 
# File 'lib/resque/scheduler.rb', line 171

def reload_schedule!
  procline "Reloading Schedule"
  clear_schedule!
  Resque.reload_schedule!
  load_schedule!
end

.rufus_scheduler ⇒ Object 



158
159
160
 
# File 'lib/resque/scheduler.rb', line 158

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

.run ⇒ Object

Schedule all jobs and continually look for delayed jobs (never returns)



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/resque/scheduler.rb', line 29

def run
  $0 = "resque-scheduler: Starting"
  # trap signals
  register_signal_handlers

  # Load the schedule into rufus
  procline "Loading Schedule"
  load_schedule!

  # Now start the scheduling part of the loop.
  loop do
    handle_delayed_items
    update_schedule 
    poll_sleep
  end

  # never gets here.
end

.scheduled_jobs ⇒ Object

the Rufus::Scheduler jobs that are scheduled



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

def scheduled_jobs
  @@scheduled_jobs
end

.shutdown ⇒ Object

Sets the shutdown flag, exits if sleeping



213
214
215
216
 
# File 'lib/resque/scheduler.rb', line 213

def shutdown
  @shutdown = true
  exit if @sleeping
end

.unschedule_job(name) ⇒ Object 



196
197
198
199
200
201
202
 
# File 'lib/resque/scheduler.rb', line 196

def unschedule_job(name)
  if scheduled_jobs[name]
    log "Removing schedule #{name}"
    scheduled_jobs[name].unschedule
    @@scheduled_jobs.delete(name)
  end
end

.update_schedule ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/resque/scheduler.rb', line 178

def update_schedule
  if Resque.needs_updating?
    procline "Updating schedule"
    # A bit heavy handed here, but unload everything from Rufus and load in the new schedule
    # since the Resque.schedule (from redis) will always have the true schedule as setup by the user
    scheduled_jobs.each do |name, config|
      unschedule_job(name)
    end
    
    Resque.schedule.each do |name, config|
      load_schedule_job(name, config)
    end
  
    Resque.mark_schedules_as_updated
    procline "Schedules Loaded"
  end
end