cogworker 0.5.0 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -56,9 +56,9 @@ module Cogworker
56
56
  def run
57
57
  until @manager.stopping?
58
58
  begin
59
- process_one
59
+ RedisErrors.recovered('Processor') unless process_one == :idle
60
60
  rescue StandardError => e
61
- Cogworker.logger.error { "Processor error: #{e.class}: #{e.message}" }
61
+ RedisErrors.report('Processor', e)
62
62
  sleep(ERROR_BACKOFF)
63
63
  end
64
64
  end
@@ -67,7 +67,7 @@ module Cogworker
67
67
  def process_one
68
68
  if @manager.quiet?
69
69
  sleep(0.5)
70
- return
70
+ return :idle # (no Redis call made)
71
71
  end
72
72
 
73
73
  work = begin
@@ -89,11 +89,13 @@ module Cogworker
89
89
  @manager.job_started(work.raw_job)
90
90
  @busy = true
91
91
  @ran = nil
92
+ @performed = false
92
93
  disposition = nil
93
94
  begin
94
95
  disposition = execute(work)
95
96
  ensure
96
97
  @busy = false
98
+ @manager.job_performed(work.raw_job) unless @performed
97
99
  @manager.processor_idle!
98
100
  # `execute` raising leaves `disposition` unset: before the job ran
99
101
  # that's a hand-back; once it ran, whatever its outcome dictates
@@ -155,7 +157,11 @@ module Cogworker
155
157
  @manager.settle_later(work.raw_job, [set, score, encoded]) if fetcher.is_a?(ReliableFetch)
156
158
  raise
157
159
  end
158
- best_effort('lock extension') { extend_locks_for_retry(job, delay) } if set == RedisKeys::RETRY
160
+ if set == RedisKeys::RETRY
161
+ best_effort('lock extension') { extend_locks_for_retry(job, delay) }
162
+ else
163
+ best_effort('lock release') { release_locks(payload) }
164
+ end
159
165
  reason = if set == RedisKeys::RETRY
160
166
  "retrying in #{delay}s (interruption #{count} of at most #{MAX_INTERRUPTS})"
161
167
  elsif out_of_retries
@@ -176,9 +182,11 @@ module Cogworker
176
182
  end
177
183
 
178
184
  def remember_for_dead(work, error)
179
- entry = JSON.generate('jid' => jid_of(work), 'error_class' => error.class.name.to_s,
180
- 'error_message' => JobUtil.error_message(error), 'failed_at' => Time.now.to_f,
181
- 'raw_payload' => JobUtil.safe_string(work.raw_job, 100_000))
185
+ # The original job's own fields where readable (so filing it releases
186
+ # its locks); just enough to show in Dead otherwise.
187
+ base = ReliableFetch.parse_hash(work.raw_job) || { 'raw_payload' => JobUtil.safe_string(work.raw_job, 100_000) }
188
+ entry = JSON.generate(base.merge('jid' => jid_of(work), 'error_class' => error.class.name.to_s,
189
+ 'error_message' => JobUtil.error_message(error), 'failed_at' => Time.now.to_f))
182
190
  @manager.settle_later(work.raw_job, [RedisKeys::DEAD, Time.now.to_f, entry])
183
191
  rescue StandardError
184
192
  nil
@@ -230,6 +238,8 @@ module Cogworker
230
238
  Cogworker.logger.info { "start: #{job['class']} jid=#{job['jid']}" }
231
239
  begin
232
240
  error = run_job(work, job)
241
+ @manager.job_performed(work.raw_job)
242
+ @performed = true
233
243
  @ran = error ? [:interrupt, job, error] : :acknowledge
234
244
  error ? finish_failure(job, error) : finish_success(job)
235
245
  ensure
@@ -286,7 +296,9 @@ module Cogworker
286
296
  Cogworker.config.redis { |c| c.incr(RedisKeys::STATS_FAILED) }
287
297
  Throughput.record('failed')
288
298
  end
289
- Cogworker.logger.warn { "fail: #{job['class']} jid=#{job['jid']}: #{error.class}: #{JobUtil.error_message(error)}" }
299
+ Cogworker.logger.warn do
300
+ "fail: #{job['class']} jid=#{job['jid']}: #{error.class}: #{JobUtil.error_message(error)}"
301
+ end
290
302
  route_failure(job, error) ? :acknowledge : [:interrupt, job, error]
291
303
  end
292
304
 
@@ -350,7 +362,12 @@ module Cogworker
350
362
  begin
351
363
  payload = JSON.generate(job)
352
364
  Cogworker.config.redis do |c|
353
- retrying ? c.zadd(RedisKeys::RETRY, Time.now.to_f + delay, payload) : c.zadd(RedisKeys::DEAD, Time.now.to_f, payload)
365
+ if retrying
366
+ c.zadd(RedisKeys::RETRY, Time.now.to_f + delay,
367
+ payload)
368
+ else
369
+ c.zadd(RedisKeys::DEAD, Time.now.to_f, payload)
370
+ end
354
371
  end
355
372
  rescue StandardError => e
356
373
  Cogworker.logger.error { "couldn't record failure of jid=#{job['jid']}: #{e.class}: #{e.message}" }
@@ -380,6 +397,13 @@ module Cogworker
380
397
  end
381
398
  end
382
399
 
400
+ # Into dead by way of `interrupt` — possibly with retries still left,
401
+ # so the middleware that normally releases a terminal failure's locks
402
+ # didn't: release them here (owner-checked).
403
+ def release_locks(job)
404
+ Cogworker.config.redis { |c| JobUtil.release_terminal_locks(c, job) }
405
+ end
406
+
383
407
  # Grows with the retry count, with jitter to avoid a thundering herd of
384
408
  # retries all landing on the same second.
385
409
  def retry_delay(count)
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Cogworker
4
+ # Telling "Redis is unavailable right now" from every other error, and
5
+ # keeping the log readable while it is.
6
+ #
7
+ # Unavailable means a lost connection, or one of the replies a server
8
+ # gives while it can't serve writes for a while — mid-failover (READONLY,
9
+ # MASTERDOWN), still loading its data (LOADING), or busy with a script
10
+ # (BUSY, TRYAGAIN). None of those say anything about the job, entry or key
11
+ # being worked on, so nothing should back off, count a failure, or give up
12
+ # on them; they just mean "try again shortly".
13
+ #
14
+ # `report` logs such errors once per `site` (a short name of the place
15
+ # they come from) as they start, then a one-line summary at most every
16
+ # SUMMARY_INTERVAL, and `recovered(site)` logs once that it's over. A 6
17
+ # minute outage used to produce thousands of identical lines. Any other
18
+ # error is logged in full, every time.
19
+ module RedisErrors
20
+ UNAVAILABLE_REPLIES = %w[READONLY LOADING MASTERDOWN TRYAGAIN BUSY].freeze
21
+ SUMMARY_INTERVAL = 60
22
+ SCRIPT_WRAPPED = /-(?:#{UNAVAILABLE_REPLIES.join('|')})(?=\s|\z)/
23
+
24
+ @mutex = Mutex.new
25
+ @outages = {} # site => { count:, since:, summarized_at:, error: }
26
+
27
+ class << self
28
+ def unavailable?(error)
29
+ return true if error.is_a?(Redis::BaseConnectionError)
30
+ # redis-rb 5's pub/sub path can surface redis-client's own error class.
31
+ return true if defined?(RedisClient::ConnectionError) && error.is_a?(RedisClient::ConnectionError)
32
+
33
+ return false unless error.is_a?(Redis::CommandError)
34
+
35
+ message = error.message.to_s
36
+ # The reply's code is its whole first word — BUSYKEY or BUSYGROUP
37
+ # aren't BUSY. Inside a script, Redis 6.x wraps the code instead:
38
+ # "ERR Error running script (...): ... -READONLY You can't ...".
39
+ UNAVAILABLE_REPLIES.include?(message[/\A\S+/]) ||
40
+ (message.include?('Error running script') && message.match?(SCRIPT_WRAPPED))
41
+ end
42
+
43
+ # Logs `error` at `site`; the block, if given, adds context to the
44
+ # first line (e.g. what was being done).
45
+ def report(site, error, &context)
46
+ detail = "#{error.class}: #{error.message}"
47
+ detail = "#{context.call} — #{detail}" if context
48
+ return Cogworker.logger.error { "#{site}: #{detail}" } unless unavailable?(error)
49
+
50
+ line = @mutex.synchronize { track(site, error, detail) }
51
+ Cogworker.logger.error { line } if line
52
+ end
53
+
54
+ # Call wherever `site` has just done its job: ends an outage there.
55
+ def recovered(site)
56
+ outage = @mutex.synchronize { @outages.delete(site) }
57
+ return unless outage
58
+
59
+ Cogworker.logger.warn do
60
+ "#{site}: Redis available again after #{outage[:count]} error(s) over #{(now - outage[:since]).round}s"
61
+ end
62
+ end
63
+
64
+ def reset!
65
+ @mutex.synchronize { @outages.clear }
66
+ end
67
+
68
+ private
69
+
70
+ def track(site, error, detail)
71
+ outage = @outages[site]
72
+ unless outage
73
+ @outages[site] = { count: 1, since: now, summarized_at: now, suppressed: 0 }
74
+ return "#{site}: Redis unavailable — #{detail} (repeats summarized every #{SUMMARY_INTERVAL}s)"
75
+ end
76
+
77
+ outage[:count] += 1
78
+ outage[:suppressed] += 1
79
+ return unless now - outage[:summarized_at] >= SUMMARY_INTERVAL
80
+
81
+ suppressed = outage[:suppressed]
82
+ outage[:summarized_at] = now
83
+ outage[:suppressed] = 0
84
+ "#{site}: Redis still unavailable — #{suppressed} more error(s) in the last #{SUMMARY_INTERVAL}s " \
85
+ "(latest: #{error.class}: #{error.message})"
86
+ end
87
+
88
+ def now
89
+ ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
90
+ end
91
+ end
92
+ end
93
+ end
@@ -26,6 +26,10 @@ module Cogworker
26
26
  # over by a process shutting down (JSON {set, score, payload} each) —
27
27
  # see ReliableFetch.park_unsettled / file_unsettled.
28
28
  UNSETTLED = 'cogworker:unsettled'
29
+ # queue => Redis time a live process last said it reads it (every
30
+ # heartbeat). Unlike QUEUES (the Web UI's listing, never pruned), this
31
+ # tells "nobody reads this queue any more" apart from "somebody does".
32
+ LIVE_QUEUES = 'cogworker:live_queues'
29
33
  QUEUES = 'cogworker:queues'
30
34
  SCHEDULE = 'cogworker:schedule'
31
35
  RETRY = 'cogworker:retry'
@@ -28,6 +28,9 @@ module Cogworker
28
28
  # on an idle process — the trade-off against how often idle processors
29
29
  # poll Redis (at 0.25s flat, 4 calls/s per thread).
30
30
  EMPTY_POLL_INTERVAL = 0.25
31
+ # A queue counts as read if a live process stamped it (every heartbeat)
32
+ # this recently.
33
+ LIVE_QUEUE_WINDOW = 2 * Heartbeat::TTL
31
34
  ORPHANINGS_TTL = 7 * 24 * 60 * 60
32
35
  MIN_REDIS_VERSION = Gem::Version.new('6.2')
33
36
 
@@ -67,6 +70,7 @@ module Cogworker
67
70
  end
68
71
  end
69
72
  redis.call("RPUSH", queue_prefix .. queue, job)
73
+ return queue
70
74
  end
71
75
  LUA
72
76
 
@@ -78,8 +82,9 @@ module Cogworker
78
82
  # refused; ARGV[8] = orphan-counter key prefix, ARGV[9] = its TTL,
79
83
  # ARGV[10] = config.max_orphanings, ARGV[11..] = jobs to drop or keep
80
84
  # (see below); KEYS[4] = REPEAT_ORPHANS, KEYS[5] = cogworker:dead.
81
- # Returns {moved, <jobs filed straight into dead, raw>...}, or {-1} if
82
- # the owner turned out to be alive.
85
+ # Returns {moved, failed, n, <n unlisted queue names>..., <jobs filed
86
+ # straight into dead, raw>...}, or {-1, 0, 0} if the owner turned out to
87
+ # be alive. KEYS[6] = cogworker:queues, KEYS[7] = LIVE_QUEUES.
83
88
  # Oldest first, so recovered jobs keep their order. The "is the owner
84
89
  # really dead?" check is made here, atomically with the requeue:
85
90
  # checked separately, an owner that
@@ -89,7 +94,7 @@ module Cogworker
89
94
  REQUEUE_SCRIPT = REQUEUE_JOB_FUNCTION + <<~LUA
90
95
  if ARGV[6] ~= "" then
91
96
  if redis.call("EXISTS", KEYS[2]) == 1 then
92
- return {-1}
97
+ return {-1, 0, 0}
93
98
  end
94
99
  -- A stamp that isn't a number counts as no stamp (the presence key
95
100
  -- alone then decides); TIME refused (ACL, proxy) falls back to the
@@ -101,7 +106,7 @@ module Cogworker
101
106
  local ok, time = pcall(redis.call, "TIME")
102
107
  if ok then now = tonumber(time[1]) end
103
108
  if now - last <= tonumber(ARGV[6]) then
104
- return {-1}
109
+ return {-1, 0, 0}
105
110
  end
106
111
  end
107
112
  end
@@ -114,9 +119,15 @@ module Cogworker
114
119
  local mark, payload = string.sub(ARGV[i], 1, 2), string.sub(ARGV[i], 3)
115
120
  if mark == "d:" then finished[payload] = true else keep[payload] = true end
116
121
  end
122
+ if redis.replicate_commands then redis.replicate_commands() end
123
+ local clock = tonumber(ARGV[7])
124
+ local clock_ok, clock_reply = pcall(redis.call, "TIME")
125
+ if clock_ok then clock = tonumber(clock_reply[1]) end
117
126
  local moved = 0
118
127
  local kept = {}
119
128
  local buried = {} -- filed straight into dead, raw: the caller completes them
129
+ local failed = 0 -- couldn't be requeued (kept, at the back): the caller logs them
130
+ local unlisted = {} -- queues requeued onto that no live process reads
120
131
  -- One pass over the list as it stands. Each job is peeked, written
121
132
  -- where it goes, and only then taken off: a script stopped by an
122
133
  -- error keeps the writes it made before it (Redis doesn't roll them
@@ -170,7 +181,20 @@ module Cogworker
170
181
  end
171
182
  end
172
183
  end
173
- local written = parked or pcall(requeue_job, job, ARGV[1], ARGV[2], ARGV[3], ARGV[4])
184
+ local written, queue = parked, nil
185
+ if not parked then
186
+ written, queue = pcall(requeue_job, job, ARGV[1], ARGV[2], ARGV[3], ARGV[4])
187
+ end
188
+ -- A queue no live process has said it reads lately (KEYS[7]): tell
189
+ -- the caller, since nothing may be reading it — and list it
190
+ -- (KEYS[6]) so the Web UI shows it.
191
+ if written and queue then
192
+ local seen = tonumber(redis.pcall("ZSCORE", KEYS[7], queue) or "")
193
+ if not seen or seen < clock - #{LIVE_QUEUE_WINDOW} then
194
+ redis.pcall("SADD", KEYS[6], queue)
195
+ unlisted[queue] = true
196
+ end
197
+ end
174
198
  redis.call("LPOP", KEYS[1])
175
199
  if written then
176
200
  if counter then
@@ -180,13 +204,17 @@ module Cogworker
180
204
  moved = moved + 1
181
205
  else
182
206
  redis.call("RPUSH", KEYS[1], job)
207
+ failed = failed + 1
183
208
  end
184
209
  end
185
210
  end
186
211
  for _, job in ipairs(kept) do
187
212
  redis.call("RPUSH", KEYS[1], job)
188
213
  end
189
- local reply = {moved}
214
+ local names = {}
215
+ for name in pairs(unlisted) do table.insert(names, name) end
216
+ local reply = {moved, failed, #names}
217
+ for _, name in ipairs(names) do table.insert(reply, name) end
190
218
  for _, job in ipairs(buried) do table.insert(reply, job) end
191
219
  return reply
192
220
  LUA
@@ -227,6 +255,7 @@ module Cogworker
227
255
  end
228
256
  redis.call("ZADD", KEYS[2], ARGV[2], ARGV[3])
229
257
  redis.call("LREM", KEYS[1], 1, ARGV[1])
258
+ if KEYS[3] then redis.pcall("DEL", KEYS[3]) end -- it ran to the end: its orphan count is moot
230
259
  return 1
231
260
  LUA
232
261
 
@@ -242,7 +271,8 @@ module Cogworker
242
271
  return 1
243
272
  LUA
244
273
 
245
- # KEYS[1] = UNSETTLED; ARGV[1] = one record (its head), ARGV[2..4] =
274
+ # KEYS[1] = UNSETTLED, KEYS[2] = the job's orphan counter; ARGV[1] = one
275
+ # record (its head), ARGV[2..4] =
246
276
  # set, score, payload. Filed, then removed.
247
277
  FILE_UNSETTLED_SCRIPT = <<~LUA
248
278
  if redis.call("LINDEX", KEYS[1], 0) ~= ARGV[1] then
@@ -250,6 +280,19 @@ module Cogworker
250
280
  end
251
281
  redis.call("ZADD", ARGV[2], ARGV[3], ARGV[4])
252
282
  redis.call("LPOP", KEYS[1])
283
+ redis.pcall("DEL", KEYS[2]) -- it ran to the end: its orphan count is moot
284
+ return 1
285
+ LUA
286
+
287
+ # KEYS[1] = cogworker:dead; ARGV[1] = an entry, ARGV[2] = score,
288
+ # ARGV[3] = its replacement. Swapped in one step: two commands could
289
+ # leave both in dead (and Retry on each from the Web UI ran it twice).
290
+ SWAP_DEAD_ENTRY_SCRIPT = <<~LUA
291
+ if not redis.call("ZSCORE", KEYS[1], ARGV[1]) then
292
+ return 0
293
+ end
294
+ redis.call("ZADD", KEYS[1], ARGV[2], ARGV[3])
295
+ redis.call("ZREM", KEYS[1], ARGV[1])
253
296
  return 1
254
297
  LUA
255
298
 
@@ -260,6 +303,9 @@ module Cogworker
260
303
  return 1
261
304
  LUA
262
305
 
306
+ @pending_raw_burials = []
307
+ @raw_burials_mutex = Mutex.new
308
+
263
309
  class << self
264
310
  # A connection error propagates: can't tell yet, so the caller
265
311
  # (Manager#fetch_class) resolves again on its next use, instead of
@@ -269,9 +315,9 @@ module Cogworker
269
315
  def supported?
270
316
  version = Cogworker.config.redis { |c| c.info('server')['redis_version'] }
271
317
  Gem::Version.new(version) >= MIN_REDIS_VERSION
272
- rescue Redis::BaseConnectionError
273
- raise
274
- rescue StandardError
318
+ rescue StandardError => e
319
+ raise if RedisErrors.unavailable?(e)
320
+
275
321
  true
276
322
  end
277
323
 
@@ -285,15 +331,28 @@ module Cogworker
285
331
  # failed: dropped from it (which is their ack) rather than requeued,
286
332
  # in the same atomic step. `keep:` — jobs left on the list untouched.
287
333
  def requeue_in_progress(identity, if_dead_for: nil, except: [], keep: [])
288
- moved, *buried = Cogworker.config.redis do |c|
334
+ moved, failed, unlisted_count, *rest = Cogworker.config.redis do |c|
289
335
  LuaScript.run(c, REQUEUE_SCRIPT,
290
336
  keys: [RedisKeys.in_progress(identity), RedisKeys.process(identity), RedisKeys::LAST_BEAT,
291
- RedisKeys::REPEAT_ORPHANS, RedisKeys::DEAD],
337
+ RedisKeys::REPEAT_ORPHANS, RedisKeys::DEAD, RedisKeys::QUEUES, RedisKeys::LIVE_QUEUES],
292
338
  argv: [*requeue_args, identity, if_dead_for.to_s, Time.now.to_i,
293
339
  RedisKeys::ORPHANINGS_PREFIX, ORPHANINGS_TTL, Cogworker.config.max_orphanings,
294
340
  *except.map { |raw| "d:#{raw}" }, *keep.map { |raw| "k:#{raw}" }])
295
341
  end
296
- complete_raw_burials(buried)
342
+ unlisted = rest.shift(unlisted_count)
343
+ complete_raw_burials(rest)
344
+ unless unlisted.empty?
345
+ Cogworker.logger.warn do
346
+ "requeued job(s) from #{identity} onto queue(s) no live process reads: #{unlisted.join(', ')} " \
347
+ '— make sure some worker reads them'
348
+ end
349
+ end
350
+ if failed.positive?
351
+ Cogworker.logger.error do
352
+ "#{failed} job(s) left in progress by #{identity} couldn't be put back on their queue " \
353
+ '(a key of the wrong type?) — kept, retried on the next pass'
354
+ end
355
+ end
297
356
  moved
298
357
  end
299
358
 
@@ -330,12 +389,14 @@ module Cogworker
330
389
 
331
390
  recover_identity(identity)
332
391
  rescue StandardError => e
333
- report[:connection_lost] = true if e.is_a?(Redis::BaseConnectionError)
334
- Cogworker.logger.error { "orphan recovery skipped #{identity}: #{e.class}: #{e.message}" }
392
+ report[:connection_lost] = true if RedisErrors.unavailable?(e)
393
+ RedisErrors.report('Orphan recovery', e) { "skipped #{identity}" }
335
394
  0
336
395
  end
337
- isolated('burying repeat orphans', nil) { bury_repeat_orphans }
338
- isolated('filing unsettled jobs', nil) { file_unsettled }
396
+ isolated('burying repeat orphans', nil, report) { bury_repeat_orphans }
397
+ isolated('completing dead entries', nil, report) { retry_raw_burials }
398
+ isolated('filing unsettled jobs', nil, report) { file_unsettled }
399
+ RedisErrors.recovered('Orphan recovery') unless report[:connection_lost]
339
400
  moved
340
401
  end
341
402
 
@@ -364,7 +425,11 @@ module Cogworker
364
425
  return 0 if moved.negative? # alive after all: keep its registration and last beat
365
426
 
366
427
  isolated("forgetting #{identity}", nil) { forget_if_empty(identity) } # its jobs are already back
367
- Cogworker.logger.warn { "requeued #{moved} job(s) left in progress by dead process #{identity}" } if moved.positive?
428
+ if moved.positive?
429
+ Cogworker.logger.warn do
430
+ "requeued #{moved} job(s) left in progress by dead process #{identity}"
431
+ end
432
+ end
368
433
  moved
369
434
  end
370
435
 
@@ -413,12 +478,16 @@ module Cogworker
413
478
  LuaScript.run(c, ACK_SCRIPT, keys: [key, RedisKeys::ORPHANINGS_PREFIX + jid.to_s], argv: [raw])
414
479
  else
415
480
  set, score, payload = how
416
- LuaScript.run(c, INTERRUPT_SCRIPT, keys: [key, set], argv: [raw, score, payload])
481
+ filed = LuaScript.run(c, INTERRUPT_SCRIPT, keys: [key, set, orphanings_key(raw)],
482
+ argv: [raw, score, payload])
483
+ released_if_dead(c, set, payload) if filed == 1
417
484
  end
418
485
  end
419
486
  yield raw if block_given?
420
487
  rescue StandardError => e
421
- Cogworker.logger.error { "still couldn't settle jid=#{parse_hash(raw)&.fetch('jid', nil)}: #{e.class}: #{e.message}" }
488
+ Cogworker.logger.error do
489
+ "still couldn't settle jid=#{parse_hash(raw)&.fetch('jid', nil)}: #{e.class}: #{e.message}"
490
+ end
422
491
  end
423
492
  end
424
493
 
@@ -437,7 +506,9 @@ module Cogworker
437
506
  end
438
507
  true
439
508
  rescue StandardError => e
440
- Cogworker.logger.error { "couldn't hand over unsettled jid=#{parse_hash(raw)&.fetch('jid', nil)}: #{e.class}: #{e.message}" }
509
+ Cogworker.logger.error do
510
+ "couldn't hand over unsettled jid=#{parse_hash(raw)&.fetch('jid', nil)}: #{e.class}: #{e.message}"
511
+ end
441
512
  false
442
513
  end.keys
443
514
  end
@@ -449,10 +520,12 @@ module Cogworker
449
520
  Cogworker.config.redis do |c|
450
521
  c.lrange(RedisKeys::UNSETTLED, 0, -1).each do |record|
451
522
  entry = parse_hash(record)
452
- next c.lrem(RedisKeys::UNSETTLED, 1, record) unless entry # unreadable: nothing to file
523
+ next quarantine_record(c, record) unless valid_unsettled?(entry)
453
524
 
454
- LuaScript.run(c, FILE_UNSETTLED_SCRIPT, keys: [RedisKeys::UNSETTLED],
455
- argv: [record, entry['set'], entry['score'], entry['payload']])
525
+ filed = LuaScript.run(c, FILE_UNSETTLED_SCRIPT,
526
+ keys: [RedisKeys::UNSETTLED, orphanings_key(entry['payload'])],
527
+ argv: [record, entry['set'], entry['score'], entry['payload']])
528
+ released_if_dead(c, entry['set'], entry['payload']) if filed == 1
456
529
  end
457
530
  end
458
531
  end
@@ -460,35 +533,76 @@ module Cogworker
460
533
  # Jobs REQUEUE_SCRIPT had to file in dead raw (its parking list
461
534
  # unusable): swapped for a proper dead entry, and given the usual
462
535
  # terminal-failure side effects. Best-effort, per job.
536
+ # A swap that fails (Redis away) is kept and retried on the next pass
537
+ # (`recover_orphans`) — left alone, the raw entry stayed in dead without
538
+ # its error, its job's locks held and its failure uncounted.
463
539
  def complete_raw_burials(raws)
464
540
  raws.each do |raw|
465
541
  job = (parse_hash(raw) || {}).merge(repeat_orphan_error)
466
542
  Cogworker.config.redis do |c|
467
- c.zadd(RedisKeys::DEAD, Time.now.to_f, JSON.generate(job))
468
- c.zrem(RedisKeys::DEAD, raw)
469
- buried_as_dead(c, job)
543
+ swapped = LuaScript.run(c, SWAP_DEAD_ENTRY_SCRIPT, keys: [RedisKeys::DEAD],
544
+ argv: [raw, Time.now.to_f, JSON.generate(job)])
545
+ buried_as_dead(c, job) if swapped == 1
470
546
  end
547
+ @raw_burials_mutex.synchronize { @pending_raw_burials.delete(raw) }
471
548
  rescue StandardError => e
472
- Cogworker.logger.error { "completing the dead entry of a repeat orphan failed: #{e.class}: #{e.message}" }
549
+ @raw_burials_mutex.synchronize { @pending_raw_burials << raw unless @pending_raw_burials.include?(raw) }
550
+ RedisErrors.report('Orphan recovery', e) { "a repeat orphan's dead entry not completed (will retry)" }
473
551
  end
474
552
  end
475
553
 
554
+ def retry_raw_burials
555
+ complete_raw_burials(@raw_burials_mutex.synchronize { @pending_raw_burials.dup })
556
+ end
557
+
476
558
  def repeat_orphan_error
477
559
  { 'error_class' => 'Cogworker::ProcessDied', 'failed_at' => Time.now.to_f,
478
560
  'error_message' => "its process died while running it more than #{Cogworker.config.max_orphanings} times " \
479
561
  '(killed for memory? SIGKILL?) — not retried again' }
480
562
  end
481
563
 
564
+ FILEABLE_SETS = [RedisKeys::RETRY, RedisKeys::DEAD, RedisKeys::SCHEDULE].freeze
565
+
566
+ # `set` must be one of ours to file into — not any key a damaged record
567
+ # names (another type's, which would fail every pass at that record).
568
+ # Filing a failure in dead outside the middleware chain: release its
569
+ # locks, as the chain would for a terminal failure.
570
+ def released_if_dead(conn, set, payload)
571
+ job = parse_hash(payload)
572
+ JobUtil.release_terminal_locks(conn, job) if set == RedisKeys::DEAD && job
573
+ end
574
+
575
+ def valid_unsettled?(entry)
576
+ entry.is_a?(Hash) && FILEABLE_SETS.include?(entry['set']) && entry['score'].is_a?(Numeric) &&
577
+ entry['payload'].is_a?(String)
578
+ end
579
+
580
+ # A record that can't be filed (unreadable, fields missing) is moved
581
+ # out of the way — kept for a human, like KeyGuard's quarantine —
582
+ # instead of stopping every pass at it, and everything behind it.
583
+ def quarantine_record(conn, record)
584
+ target = "#{KeyGuard::QUARANTINE_PREFIX}#{RedisKeys::UNSETTLED}:records"
585
+ conn.rpush(target, record)
586
+ conn.expire(target, KeyGuard::QUARANTINE_TTL)
587
+ conn.lrem(RedisKeys::UNSETTLED, 1, record)
588
+ Cogworker.logger.error { "unusable #{RedisKeys::UNSETTLED} record moved to #{target}: #{record.to_s[0, 200]}" }
589
+ end
590
+
482
591
  # What any other terminal failure does on its way to dead: counted as
483
592
  # failed, and its `until_executed` locks released (so the entry / the
484
593
  # unique key isn't blocked until the locks' TTL). Best-effort.
594
+ # Each step on its own, locks first: one failing (a key of the wrong
595
+ # type) must not leave the others undone.
485
596
  def buried_as_dead(conn, job)
486
- conn.incr(RedisKeys::STATS_FAILED)
487
- OwnedKey.delete(RedisKeys.unique_lock(UniqueJobs.digest(job)), job['jid'], conn) if UniqueJobs.until_executed?(job)
488
- Periodic::RunningLock.release(job['periodic_pjid'], job['jid'], conn) if job['periodic_pjid']
489
- conn.del(RedisKeys::ORPHANINGS_PREFIX + job['jid'].to_s)
490
- rescue StandardError => e
491
- Cogworker.logger.error { "after burying jid=#{job['jid']}: #{e.class}: #{e.message}" }
597
+ JobUtil.release_terminal_locks(conn, job)
598
+ BestEffort.call('Orphan counter') { conn.del(RedisKeys::ORPHANINGS_PREFIX + job['jid'].to_s) }
599
+ BestEffort.call('Stats') { conn.incr(RedisKeys::STATS_FAILED) }
600
+ BestEffort.call('Throughput') { Throughput.record('failed') }
601
+ end
602
+
603
+ def orphanings_key(raw)
604
+ jid = parse_hash(raw)&.fetch('jid', nil) # (nil for an unreadable payload: an unused key then)
605
+ "#{RedisKeys::ORPHANINGS_PREFIX}#{jid}"
492
606
  end
493
607
 
494
608
  def parse_hash(raw)
@@ -519,8 +633,8 @@ module Cogworker
519
633
  def isolated(what, fallback, report = nil)
520
634
  yield
521
635
  rescue StandardError => e
522
- report[:connection_lost] = true if report && e.is_a?(Redis::BaseConnectionError)
523
- Cogworker.logger.error { "orphan recovery: #{what} failed: #{e.class}: #{e.message}" }
636
+ report[:connection_lost] = true if report && RedisErrors.unavailable?(e)
637
+ RedisErrors.report('Orphan recovery', e) { "#{what} failed" }
524
638
  fallback
525
639
  end
526
640
 
@@ -561,14 +675,15 @@ module Cogworker
561
675
  def give_back(work)
562
676
  Cogworker.config.redis do |c|
563
677
  LuaScript.run(c, REQUEUE_ONE_SCRIPT, keys: [RedisKeys.in_progress(Cogworker.identity)],
564
- argv: [work.raw_job, *self.class.requeue_args])
678
+ argv: [work.raw_job, *self.class.requeue_args])
565
679
  end
566
680
  end
567
681
 
568
682
  def interrupt(work, set, score, payload)
569
683
  Cogworker.config.redis do |c|
570
- LuaScript.run(c, INTERRUPT_SCRIPT, keys: [RedisKeys.in_progress(Cogworker.identity), set],
571
- argv: [work.raw_job, score, payload])
684
+ LuaScript.run(c, INTERRUPT_SCRIPT, keys: [RedisKeys.in_progress(Cogworker.identity), set,
685
+ self.class.orphanings_key(work.raw_job)],
686
+ argv: [work.raw_job, score, payload])
572
687
  end
573
688
  end
574
689
 
@@ -578,7 +693,7 @@ module Cogworker
578
693
  jid = self.class.parse_hash(work.raw_job)&.fetch('jid', nil)
579
694
  Cogworker.config.redis do |c|
580
695
  LuaScript.run(c, ACK_SCRIPT, keys: [RedisKeys.in_progress(Cogworker.identity),
581
- RedisKeys::ORPHANINGS_PREFIX + jid.to_s],
696
+ RedisKeys::ORPHANINGS_PREFIX + jid.to_s],
582
697
  argv: [work.raw_job])
583
698
  end
584
699
  end