Class: Delayed::Periodic

Inherits:
Object
  • Object
show all
Defined in:
lib/delayed/periodic.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, cron_line, job_args, block) ⇒ Periodic

Returns a new instance of Periodic.



42
43
44
45
46
47
 
# File 'lib/delayed/periodic.rb', line 42

def initialize(name, cron_line, job_args, block)
  @name = name
  @cron = Fugit.do_parse_cron(cron_line)
  @job_args = { :priority => Delayed::LOW_PRIORITY }.merge(job_args.symbolize_keys)
  @block = block
end

Instance Attribute Details

#cron ⇒ Object (readonly)

Returns the value of attribute cron.



5
6
7
 
# File 'lib/delayed/periodic.rb', line 5

def cron
  @cron
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/delayed/periodic.rb', line 5

def name
  @name
end

Class Method Details

.add_overrides(overrides) ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/delayed/periodic.rb', line 15

def self.add_overrides(overrides)
  overrides.each do |name, cron_line|
    # throws error if the line is malformed
    Fugit.do_parse_cron(cron_line)
  end
  self.overrides.merge!(overrides)
end

.audit_queue ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/delayed/periodic.rb', line 29

def self.audit_queue
  # we used to queue up a job in a strand here, and perform the audit inside that job
  # however, now that we're using singletons for scheduling periodic jobs,
  # it's fine to just do the audit in-line here without risk of creating duplicates
  perform_audit!
end

.cron(job_name, cron_line, job_args = {}, &block) ⇒ Object

Raises:

  • (ArgumentError) 


23
24
25
26
27
 
# File 'lib/delayed/periodic.rb', line 23

def self.cron(job_name, cron_line, job_args = {}, &block)
  raise ArgumentError, "job #{job_name} already scheduled!" if self.scheduled[job_name]
  cron_line = overrides[job_name] || cron_line
  self.scheduled[job_name] = self.new(job_name, cron_line, job_args, block)
end

.now ⇒ Object 



72
73
74
 
# File 'lib/delayed/periodic.rb', line 72

def self.now
  Time.zone.now
end

.perform_audit! ⇒ Object

make sure all periodic jobs are scheduled for their next run in the job queue this auditing should run on the strand



38
39
40
 
# File 'lib/delayed/periodic.rb', line 38

def self.perform_audit!
  self.scheduled.each { |name, periodic| periodic.enqueue }
end

Instance Method Details

#encode_with(coder) ⇒ Object 



7
8
9
 
# File 'lib/delayed/periodic.rb', line 7

def encode_with(coder)
  coder.scalar("!ruby/Delayed::Periodic", @name)
end

#enqueue ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/delayed/periodic.rb', line 49

def enqueue
  Delayed::Job.enqueue(self, @job_args.merge(:max_attempts => 1,
                                             :run_at => @cron.next_time(Delayed::Periodic.now).utc.to_time,
                                             :singleton => tag,
                                             on_conflict: :patient))
end

#perform ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/delayed/periodic.rb', line 56

def perform
  @block.call()
ensure
  begin
    enqueue
  rescue
    # double fail! the auditor will have to catch this.
    Rails.logger.error "Failure enqueueing periodic job! #{@name} #{$!.inspect}"
  end
end

#tag ⇒ Object Also known as: display_name 



67
68
69
 
# File 'lib/delayed/periodic.rb', line 67

def tag
  "periodic: #{@name}"
end