Class: SidekiqUniqueJobs::Orphans::RubyReaper

Inherits:
Reaper
  • Object
show all
Includes:
Timing
Defined in:
lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

Overview

Note:

this is a much slower version of the lua script but does not crash redis

Class DeleteOrphans provides deletion of orphaned digests

rubocop:disable Metrics/ClassLength

Author:

Constant Summary collapse

SIDEKIQ_BEAT_PAUSE =

Returns a best guess of Sidekiq::Launcher::BEAT_PAUSE.

Returns:

  • (Integer) —

    a best guess of Sidekiq::Launcher::BEAT_PAUSE

10
RUN_SUFFIX =

Returns the suffix for :RUN locks.

Returns:

  • (String) —

    the suffix for :RUN locks

":RUN"
MAX_QUEUE_LENGTH =

Returns the maximum combined length of sidekiq queues for running the reaper.

Returns:

  • (Integer) —

    the maximum combined length of sidekiq queues for running the reaper

1000

Constants inherited from Reaper

SidekiqUniqueJobs::Orphans::Reaper::REAPERS

Instance Attribute Summary collapse

Attributes inherited from Reaper

#conn

Instance Method Summary collapse

Methods included from Timing

clock_stamp, now_f, time_source, timed

Methods inherited from Reaper

call, #config, #reaper, #reaper_count, #reaper_timeout

Methods included from JSON

dump_json, load_json, safe_load_json

Methods included from Logging

#build_message, included, #log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger, #logging_context, #with_configured_loggers_context, #with_logging_context

Methods included from Script::Caller

call_script, debug_lua, do_call, extract_args, max_history, normalize_argv, now_f, redis_version

Methods included from Connection

included, #redis

Constructor Details

#initialize(conn) ⇒ RubyReaper

Initialize a new instance of DeleteOrphans

Parameters:

  • conn (Redis) —

    a connection to redis



59
60
61
62
63
64
65
66
67
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 59

def initialize(conn)
  super(conn)
  @digests      = SidekiqUniqueJobs::Digests.new
  @scheduled    = Redis::SortedSet.new(SCHEDULE)
  @retried      = Redis::SortedSet.new(RETRY)
  @start_time   = Time.now
  @start_source = time_source.call
  @timeout_ms   = SidekiqUniqueJobs.config.reaper_timeout * 1000
end

Instance Attribute Details

#digests ⇒ Object (readonly)

Returns the value of attribute digests.



28
29
30
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 28

def digests
  @digests
end

#retried ⇒ Object (readonly)

Returns the value of attribute retried.



36
37
38
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 36

def retried
  @retried
end

#scheduled ⇒ Object (readonly)

Returns the value of attribute scheduled.



32
33
34
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 32

def scheduled
  @scheduled
end

#start_source ⇒ Object (readonly)

Returns the value of attribute start_source.



47
48
49
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 47

def start_source
  @start_source
end

#start_time ⇒ Integer (readonly)

Returns The clock stamp this execution started represented as integer (used for redis compatibility as it is more accurate than time).

Returns:

  • (Integer) —

    The clock stamp this execution started represented as integer (used for redis compatibility as it is more accurate than time)



41
42
43
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 41

def start_time
  @start_time
end

#timeout_ms ⇒ Object (readonly)

Returns the value of attribute timeout_ms.



52
53
54
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 52

def timeout_ms
  @timeout_ms
end

Instance Method Details

#active?(digest) ⇒ Boolean

rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

Returns:

  • (Boolean) 


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 200

def active?(digest) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
  Sidekiq.redis do |conn|
    procs = conn.sscan("processes").to_a
    return false if procs.empty?

    procs.sort.each do |key|
      valid, workers = conn.pipelined do |pipeline|
        # TODO: Remove the if statement in the future
        if pipeline.respond_to?(:exists?)
          pipeline.exists?(key)
        else
          pipeline.exists(key)
        end
        pipeline.hgetall("#{key}:work")
      end

      next unless valid
      next unless workers.any?

      workers.each_pair do |_tid, job|
        next unless (item = safe_load_json(job))

        payload = safe_load_json(item[PAYLOAD])

        return true if match?(digest, payload[LOCK_DIGEST])
        return true if considered_active?(payload[CREATED_AT])
      end
    end

    false
  end
end

#belongs_to_job?(digest) ⇒ true, false

Checks if the digest has a matching job.

1. It checks the scheduled set
2. It checks the retry set
3. It goes through all queues

Parameters:

  • digest (String) —

    the digest to search for

Returns:

  • (true) —

    when either of the checks return true

  • (false) —

    when no job was found for this digest



155
156
157
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 155

def belongs_to_job?(digest)
  scheduled?(digest) || retried?(digest) || enqueued?(digest) || active?(digest)
end

#call ⇒ Integer

Delete orphaned digests

Returns:

  • (Integer) —

    the number of reaped locks



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 75

def call
  return if queues_very_full?

  BatchDelete.call(expired_digests, conn)
  BatchDelete.call(orphans, conn)

  # orphans.each_slice(500) do |chunk|
  #   conn.pipelined do |pipeline|
  #     chunk.each do |digest|
  #       next if belongs_to_job?(digest)

  #       pipeline.zadd(ORPHANED_DIGESTS, now_f, digest)
  #     end
  #   end
  # end
end

#considered_active?(time_f) ⇒ Boolean

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 239

def considered_active?(time_f)
  max_score < time_f
end

#elapsed_ms ⇒ Object 



139
140
141
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 139

def elapsed_ms
  time_source.call - start_source
end

#enqueued?(digest) ⇒ true

Checks if the digest exists in a Sidekiq::Queue

Parameters:

  • digest (String) —

    the current digest

Returns:

  • (true) —

    when digest exists in any queue



188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 188

def enqueued?(digest)
  Sidekiq.redis do |conn|
    queues(conn) do |queue|
      entries(conn, queue) do |entry|
        return true if entry.include?(digest)
      end
    end

    false
  end
end

#entries(conn, queue, &block) ⇒ Object

rubocop:disable Metrics/MethodLength



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 256

def entries(conn, queue, &block) # rubocop:disable Metrics/MethodLength
  queue_key    = "queue:#{queue}"
  initial_size = conn.llen(queue_key)
  deleted_size = 0
  page         = 0
  page_size    = 50

  loop do
    range_start = (page * page_size) - deleted_size

    range_end   = range_start + page_size - 1
    entries     = conn.lrange(queue_key, range_start, range_end)
    page       += 1

    break if entries.empty?

    entries.each(&block)

    deleted_size = initial_size - conn.llen(queue_key)

    # The queue is growing, not shrinking, just keep looping
    deleted_size = 0 if deleted_size.negative?
  end
end

#expired_digests ⇒ Object 



92
93
94
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 92

def expired_digests
  conn.zrange(EXPIRING_DIGESTS, 0, max_score, "byscore")
end

#in_sorted_set?(key, digest) ⇒ true, false

Checks a sorted set for the existance of this digest

Parameters:

  • key (String) —

    the key for the sorted set

  • digest (String) —

    the digest to scan for

Returns:

  • (true) —

    when found

  • (false) —

    when missing



307
308
309
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 307

def in_sorted_set?(key, digest)
  conn.zscan(key, match: "*#{digest}*", count: 1).to_a.any?
end

#match?(key_one, key_two) ⇒ Boolean

Returns:

  • (Boolean) 


233
234
235
236
237
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 233

def match?(key_one, key_two)
  return false if key_one.nil? || key_two.nil?

  key_one.delete_suffix(RUN_SUFFIX) == key_two.delete_suffix(RUN_SUFFIX)
end

#max_score ⇒ Object 



100
101
102
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 100

def max_score
  (start_time - reaper_timeout - SIDEKIQ_BEAT_PAUSE).to_f
end

#orphaned_digests ⇒ Object 



96
97
98
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 96

def orphaned_digests
  conn.zrange(ORPHANED_DIGESTS, 0, max_score, "byscore")
end

#orphans ⇒ Array<String>

Find orphaned digests

Returns:

  • (Array<String>) —

    an array of orphaned digests



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 110

def orphans # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
  orphans = []
  page    = 0
  per     = reaper_count * 2
  results = digests.byscore(0, max_score, offset: page * per, count: (page + 1) * per)

  while results.size.positive?
    results.each do |digest|
      break if timeout?
      next if belongs_to_job?(digest)

      orphans << digest
      break if orphans.size >= reaper_count
    end

    break if timeout?
    break if orphans.size >= reaper_count

    page += 1
    results = digests.byscore(0, max_score, offset: page * per, count: (page + 1) * per)
  end

  orphans
end

#queues(conn) { ... } ⇒ void

This method returns an undefined value.

Loops through all the redis queues and yields them one by one

Parameters:

  • conn (Redis) —

    the connection to use for fetching queues

Yields:

  • queues one at a time



252
253
254
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 252

def queues(conn, &block)
  conn.sscan("queues").each(&block)
end

#queues_very_full? ⇒ Boolean

If sidekiq queues are very full, it becomes highly inefficient for the reaper because it must check every queued job to verify a digest is safe to delete The reaper checks queued jobs in batches of 50, adding 2 reads per digest With a queue length of 1,000 jobs, that’s over 20 extra reads per digest.

Returns:

  • (Boolean) 


285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 285

def queues_very_full?
  total_queue_size = 0
  Sidekiq.redis do |conn|
    queues(conn) do |queue|
      total_queue_size += conn.llen("queue:#{queue}")

      return true if total_queue_size > MAX_QUEUE_LENGTH
    end
  end
  false
end

#retried?(digest) ⇒ true

Checks if the digest exists in the Sidekiq::RetrySet

Parameters:

  • digest (String) —

    the current digest

Returns:

  • (true) —

    when digest exists in retry set



177
178
179
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 177

def retried?(digest)
  in_sorted_set?(RETRY, digest)
end

#scheduled?(digest) ⇒ true

Checks if the digest exists in the Sidekiq::ScheduledSet

Parameters:

  • digest (String) —

    the current digest

Returns:

  • (true) —

    when digest exists in scheduled set



166
167
168
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 166

def scheduled?(digest)
  in_sorted_set?(SCHEDULE, digest)
end

#timeout? ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 135

def timeout?
  elapsed_ms >= timeout_ms
end