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
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
# frozen_string_literal: true
require "spec_helper"
RSpec.describe Gitlab::Database::Migrations::SidekiqHelpers do
let(:model) do
ActiveRecord::Migration.new.extend(described_class)
end
describe "sidekiq migration helpers", :redis do
let(:worker) do
Class.new do
include Sidekiq::Worker
sidekiq_options queue: "test"
def self.name
"WorkerClass"
end
end
end
let(:worker_two) do
Class.new do
include Sidekiq::Worker
sidekiq_options queue: "test_two"
def self.name
"WorkerTwoClass"
end
end
end
let(:same_queue_different_worker) do
Class.new do
include Sidekiq::Worker
sidekiq_options queue: "test"
def self.name
"SameQueueDifferentWorkerClass"
end
end
end
let(:unrelated_worker) do
Class.new do
include Sidekiq::Worker
sidekiq_options queue: "unrelated"
def self.name
"UnrelatedWorkerClass"
end
end
end
before do
stub_const(worker.name, worker)
stub_const(worker_two.name, worker_two)
stub_const(unrelated_worker.name, unrelated_worker)
stub_const(same_queue_different_worker.name, same_queue_different_worker)
end
describe "#sidekiq_remove_jobs", :clean_gitlab_redis_queues do
def clear_queues
Sidekiq::Queue.new("test").clear
Sidekiq::Queue.new("test_two").clear
Sidekiq::Queue.new("unrelated").clear
Sidekiq::RetrySet.new.clear
Sidekiq::ScheduledSet.new.clear
end
around do |example|
clear_queues
Sidekiq::Testing.disable!(&example)
clear_queues
end
context "when the constant is not defined" do
it "doesn't try to delete it" do
my_non_constant = +"SomeThingThatIsNotAConstant"
expect(Sidekiq::Queue).not_to receive(:new).with(any_args)
model.sidekiq_remove_jobs(job_klasses: [my_non_constant])
end
end
context "when the constant is defined" do
it "will use it find job instances to delete" do
my_constant = worker.name
expect(Sidekiq::Queue)
.to receive(:new)
.with(worker.queue)
.and_call_original
model.sidekiq_remove_jobs(job_klasses: [my_constant])
end
end
it "removes all related job instances from the job classes' queues" do
worker.perform_async
worker_two.perform_async
same_queue_different_worker.perform_async
unrelated_worker.perform_async
worker_queue = Sidekiq::Queue.new(worker.queue)
worker_two_queue = Sidekiq::Queue.new(worker_two.queue)
unrelated_queue = Sidekiq::Queue.new(unrelated_worker.queue)
expect(worker_queue.size).to eq(2)
expect(worker_two_queue.size).to eq(1)
expect(unrelated_queue.size).to eq(1)
model.sidekiq_remove_jobs(job_klasses: [worker.name, worker_two.name])
expect(worker_queue.size).to eq(1)
expect(worker_two_queue.size).to eq(0)
expect(worker_queue.map(&:klass)).not_to include(worker.name)
expect(worker_queue.map(&:klass)).to include(
same_queue_different_worker.name
)
expect(worker_two_queue.map(&:klass)).not_to include(worker_two.name)
expect(unrelated_queue.size).to eq(1)
end
context "when job instances are in the scheduled set" do
it "removes all related job instances from the scheduled set" do
worker.perform_in(1.hour)
worker_two.perform_in(1.hour)
unrelated_worker.perform_in(1.hour)
scheduled = Sidekiq::ScheduledSet.new
expect(scheduled.size).to eq(3)
expect(scheduled.map(&:klass)).to include(
worker.name,
worker_two.name,
unrelated_worker.name
)
model.sidekiq_remove_jobs(job_klasses: [worker.name, worker_two.name])
expect(scheduled.size).to eq(1)
expect(scheduled.map(&:klass)).not_to include(worker.name)
expect(scheduled.map(&:klass)).not_to include(worker_two.name)
expect(scheduled.map(&:klass)).to include(unrelated_worker.name)
end
end
context "when job instances are in the retry set" do
include_context "when handling retried jobs"
it "removes all related job instances from the retry set" do
retry_in(worker, 1.hour)
retry_in(worker, 2.hours)
retry_in(worker, 3.hours)
retry_in(worker_two, 4.hours)
retry_in(unrelated_worker, 5.hours)
retries = Sidekiq::RetrySet.new
expect(retries.size).to eq(5)
expect(retries.map(&:klass)).to include(
worker.name,
worker_two.name,
unrelated_worker.name
)
model.sidekiq_remove_jobs(job_klasses: [worker.name, worker_two.name])
expect(retries.size).to eq(1)
expect(retries.map(&:klass)).not_to include(worker.name)
expect(retries.map(&:klass)).not_to include(worker_two.name)
expect(retries.map(&:klass)).to include(unrelated_worker.name)
end
end
# Imitate job deletion returning zero and then non zero.
context "when job fails to be deleted" do
let(:job_double) do
instance_double(
"Sidekiq::JobRecord",
klass: worker.name
)
end
context "and does not work enough times in a row before max attempts" do
it "tries the max attempts without succeeding" do
worker.perform_async
allow(job_double).to receive(:delete).and_return(true)
# Scheduled set runs last so only need to stub out its values.
allow(Sidekiq::ScheduledSet)
.to receive(:new)
.and_return([job_double])
expect(model.sidekiq_remove_jobs(job_klasses: [worker.name]))
.to eq(
{
attempts: 5,
success: false
}
)
end
end
context "and then it works enough times in a row before max attempts" do
it "succeeds" do
worker.perform_async
# attempt 1: false will increment the streak once to 1
# attempt 2: true resets it back to 0
# attempt 3: false will increment the streak once to 1
# attempt 4: false will increment the streak once to 2, loop breaks
allow(job_double).to receive(:delete).and_return(false, true, false)
worker.perform_async
# Scheduled set runs last so only need to stub out its values.
allow(Sidekiq::ScheduledSet)
.to receive(:new)
.and_return([job_double])
expect(model.sidekiq_remove_jobs(job_klasses: [worker.name]))
.to eq(
{
attempts: 4,
success: true
}
)
end
end
end
end
describe "#sidekiq_queue_length" do
context "when queue is empty" do
it "returns zero" do
Sidekiq::Testing.disable! do
expect(model.sidekiq_queue_length("test")).to eq 0
end
end
end
context "when queue contains jobs" do
it "returns correct size of the queue" do
Sidekiq::Testing.disable! do
worker.perform_async("Something", [1])
worker.perform_async("Something", [2])
expect(model.sidekiq_queue_length("test")).to eq 2
end
end
end
end
describe "#sidekiq_queue_migrate" do
it "migrates jobs from one sidekiq queue to another" do
Sidekiq::Testing.disable! do
worker.perform_async("Something", [1])
worker.perform_async("Something", [2])
expect(model.sidekiq_queue_length("test")).to eq 2
expect(model.sidekiq_queue_length("new_test")).to eq 0
model.sidekiq_queue_migrate("test", to: "new_test")
expect(model.sidekiq_queue_length("test")).to eq 0
expect(model.sidekiq_queue_length("new_test")).to eq 2
end
end
end
end
end
|