-
-
Notifications
You must be signed in to change notification settings - Fork 273
/
ruby_reaper.rb
199 lines (175 loc) · 5.21 KB
/
ruby_reaper.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# frozen_string_literal: true
module SidekiqUniqueJobs
module Orphans
#
# Class DeleteOrphans provides deletion of orphaned digests
#
# @note this is a much slower version of the lua script but does not crash redis
#
# @author Mikael Henriksson <mikael@mhenrixon.com>
#
class RubyReaper < Reaper
#
# @!attribute [r] digests
# @return [SidekiqUniqueJobs::Digests] digest collection
attr_reader :digests
#
# @!attribute [r] scheduled
# @return [Redis::SortedSet] the Sidekiq ScheduleSet
attr_reader :scheduled
#
# @!attribute [r] retried
# @return [Redis::SortedSet] the Sidekiq RetrySet
attr_reader :retried
#
# Initialize a new instance of DeleteOrphans
#
# @param [Redis] conn a connection to redis
#
def initialize(conn)
super(conn)
@digests = SidekiqUniqueJobs::Digests.new
@scheduled = Redis::SortedSet.new(SCHEDULE)
@retried = Redis::SortedSet.new(RETRY)
end
#
# Delete orphaned digests
#
#
# @return [Integer] the number of reaped locks
#
def call
BatchDelete.call(orphans, conn)
end
#
# Find orphaned digests
#
#
# @return [Array<String>] an array of orphaned digests
#
def orphans
conn.zrevrange(digests.key, 0, -1).each_with_object([]) do |digest, result|
next if belongs_to_job?(digest)
result << digest
break if result.size >= reaper_count
end
end
#
# 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
#
#
# @param [String] digest the digest to search for
#
# @return [true] when either of the checks return true
# @return [false] when no job was found for this digest
#
def belongs_to_job?(digest)
scheduled?(digest) || retried?(digest) || enqueued?(digest) || active?(digest)
end
#
# Checks if the digest exists in the Sidekiq::ScheduledSet
#
# @param [String] digest the current digest
#
# @return [true] when digest exists in scheduled set
#
def scheduled?(digest)
in_sorted_set?(SCHEDULE, digest)
end
#
# Checks if the digest exists in the Sidekiq::RetrySet
#
# @param [String] digest the current digest
#
# @return [true] when digest exists in retry set
#
def retried?(digest)
in_sorted_set?(RETRY, digest)
end
#
# Checks if the digest exists in a Sidekiq::Queue
#
# @param [String] digest the current digest
#
# @return [true] when digest exists in any queue
#
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
def active?(digest) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
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
conn.exists(key)
conn.hgetall("#{key}:workers")
end
next unless valid
next unless workers.any?
workers.each_pair do |_tid, job|
item = load_json(job)
return true if item.dig(PAYLOAD, LOCK_DIGEST) == digest
return true if considered_active?(item[CREATED_AT])
end
end
false
end
end
def considered_active?(time_f)
(Time.now - reaper_timeout).to_f < time_f
end
#
# Loops through all the redis queues and yields them one by one
#
# @param [Redis] conn the connection to use for fetching queues
#
# @return [void]
#
# @yield queues one at a time
#
def queues(conn, &block)
conn.sscan_each("queues", &block)
end
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)
end
end
#
# Checks a sorted set for the existance of this digest
#
#
# @param [String] key the key for the sorted set
# @param [String] digest the digest to scan for
#
# @return [true] when found
# @return [false] when missing
#
def in_sorted_set?(key, digest)
conn.zscan_each(key, match: "*#{digest}*", count: 1).to_a.any?
end
end
end
end