Class: Zhong::Job

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/zhong/job.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(job_name, config = {}, callbacks = {}, &block) ⇒ Job

Returns a new instance of Job.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/zhong/job.rb', line 8

def initialize(job_name, config = {}, callbacks = {}, &block)
  @name = job_name
  @category = config[:category]
  @logger = config[:logger]
  @config = config
  @callbacks = callbacks

  @at = config[:at] ? At.parse(config[:at], grace: config.fetch(:grace, 15.minutes)) : nil
  @every = config[:every] ? Every.parse(config[:every]) : nil

  raise "must specific either `at` or `every` for job: #{self}" unless @at || @every

  @block = block

  @if = config[:if]
  @long_running_timeout = config[:long_running_timeout]
  @running = false
  @first_run = true
  @last_ran = nil
  @id = Digest::SHA256.hexdigest(@name)
end

Instance Attribute Details

#at ⇒ Object (readonly)

Returns the value of attribute at.



6
7
8
 
# File 'lib/zhong/job.rb', line 6

def at
  @at
end

#category ⇒ Object (readonly)

Returns the value of attribute category.



6
7
8
 
# File 'lib/zhong/job.rb', line 6

def category
  @category
end

#every ⇒ Object (readonly)

Returns the value of attribute every.



6
7
8
 
# File 'lib/zhong/job.rb', line 6

def every
  @every
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



6
7
8
 
# File 'lib/zhong/job.rb', line 6

def id
  @id
end

#last_ran ⇒ Object (readonly)

Returns the value of attribute last_ran.



6
7
8
 
# File 'lib/zhong/job.rb', line 6

def last_ran
  @last_ran
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



6
7
8
 
# File 'lib/zhong/job.rb', line 6

def name
  @name
end

Instance Method Details

#clear ⇒ Object 



124
125
126
 
# File 'lib/zhong/job.rb', line 124

def clear
  redis.del(last_ran_key)
end

#desired_at_key ⇒ Object 



132
133
134
 
# File 'lib/zhong/job.rb', line 132

def desired_at_key
  "zhong:at:#{self}"
end

#disable ⇒ Object 



98
99
100
101
102
 
# File 'lib/zhong/job.rb', line 98

def disable
  fire_callbacks(:before_disable, self)
  redis.set(disabled_key, "true")
  fire_callbacks(:after_disable, self)
end

#disabled? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/zhong/job.rb', line 110

def disabled?
  !redis.get(disabled_key).nil?
end

#disabled_key ⇒ Object 



136
137
138
 
# File 'lib/zhong/job.rb', line 136

def disabled_key
  "zhong:disabled:#{self}"
end

#enable ⇒ Object 



104
105
106
107
108
 
# File 'lib/zhong/job.rb', line 104

def enable
  fire_callbacks(:before_enable, self)
  redis.del(disabled_key)
  fire_callbacks(:after_enable, self)
end

#last_ran_key ⇒ Object 



128
129
130
 
# File 'lib/zhong/job.rb', line 128

def last_ran_key
  "zhong:last_ran:#{self}"
end

#lock_key ⇒ Object 



140
141
142
 
# File 'lib/zhong/job.rb', line 140

def lock_key
  "zhong:lock:#{self}"
end

#next_at ⇒ Object 



118
119
120
121
122
 
# File 'lib/zhong/job.rb', line 118

def next_at
  every_time = @every.next_at(@last_ran) if @last_ran && @every
  at_time = @at.next_at(Time.now) if @at
  [every_time, at_time, Time.now].compact.max || "now"
end

#refresh_last_ran ⇒ Object 



93
94
95
96
 
# File 'lib/zhong/job.rb', line 93

def refresh_last_ran
  last_ran_val = redis.get(last_ran_key)
  @last_ran = last_ran_val ? Time.at(last_ran_val.to_i) : nil
end

#run(time = Time.now, error_handler = nil) ⇒ Object 



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
 
# File 'lib/zhong/job.rb', line 40

def run(time = Time.now, error_handler = nil)
  return unless run?(time)

  locked = false
  errored = false
  ran = false

  begin
    redis_lock.lock do
      locked = true
      @running = true

      refresh_last_ran

      # we need to check again, as another process might have acquired
      # the lock right before us and obviated our need to do anything
      break unless run?(time)

      if disabled?
        logger.info "not running, disabled: #{self}"
        break
      end

      logger.info "running: #{self}"

      if @block
        begin
          @block.call
          ran = true
        rescue => boom
          logger.error "#{self} failed: #{boom}"
          error_handler.call(boom, self) if error_handler
        end
      end

      ran!(time)
    end
  rescue Suo::LockClientError => boom
    logger.error "unable to run due to client error: #{boom}"
    errored = true
  end

  @running = false

  logger.info "unable to acquire exclusive run lock: #{self}" if !locked && !errored

  ran
end

#run?(time = Time.now) ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
34
35
36
37
38
 
# File 'lib/zhong/job.rb', line 30

def run?(time = Time.now)
  if @first_run
    clear_last_ran_if_at_changed if @at
    refresh_last_ran
    @first_run = false
  end

  run_every?(time) && run_at?(time) && run_if?(time)
end

#running? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/zhong/job.rb', line 89

def running?
  @running
end

#to_s ⇒ Object 



114
115
116
 
# File 'lib/zhong/job.rb', line 114

def to_s
  @to_s ||= [@category, @name].compact.join(".").freeze
end