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

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, 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



56
57
58
59
60
61
62
63
64
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 56

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.



25
26
27
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 25

def digests
  @digests
end

#retried ⇒ Object (readonly)

Returns the value of attribute retried.



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

def retried
  @retried
end

#scheduled ⇒ Object (readonly)

Returns the value of attribute scheduled.



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

def scheduled
  @scheduled
end

#start_source ⇒ Object (readonly)

Returns the value of attribute start_source.



44
45
46
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 44

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)



38
39
40
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 38

def start_time
  @start_time
end

#timeout_ms ⇒ Object (readonly)

Returns the value of attribute timeout_ms.



49
50
51
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 49

def timeout_ms
  @timeout_ms
end

Instance Method Details

#active?(digest) ⇒ Boolean

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

Returns:

  • (Boolean) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 185

def active?(digest) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
  Sidekiq.redis do |conn|
    procs = conn.sscan_each("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}:workers")
      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



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

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



72
73
74
75
76
77
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 72

def call
  return if queues_very_full?

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

#considered_active?(time_f) ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 224

def considered_active?(time_f)
  (Time.now - reaper_timeout).to_f < time_f
end

#elapsed_ms ⇒ Object 



124
125
126
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 124

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



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 173

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 241

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 



79
80
81
82
83
84
85
86
87
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 79

def expired_digests
  max_score = (start_time - reaper_timeout).to_f

  if VersionCheck.satisfied?(redis_version, ">= 6.2.0") && VersionCheck.satisfied?(::Redis::VERSION, ">= 4.6.0")
    conn.zrange(EXPIRING_DIGESTS, 0, max_score, byscore: true)
  else
    conn.zrangebyscore(EXPIRING_DIGESTS, 0, max_score)
  end
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



292
293
294
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 292

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

#match?(key_one, key_two) ⇒ Boolean

Returns:

  • (Boolean) 


218
219
220
221
222
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 218

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

#orphans ⇒ Array<String>

Find orphaned digests

Returns:

  • (Array<String>) —

    an array of orphaned digests



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 95

def orphans # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
  page = 0
  per = reaper_count * 2
  orphans = []
  results = conn.zrange(digests.key, page * per, (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 = conn.zrange(digests.key, page * per, (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



237
238
239
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 237

def queues(conn, &block)
  conn.sscan_each("queues", &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) 


270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 270

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



162
163
164
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 162

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



151
152
153
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 151

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

#timeout? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb', line 120

def timeout?
  elapsed_ms >= timeout_ms
end