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
|
from datetime import datetime, timedelta, timezone
from rq import Queue
from rq.job import Job, JobStatus, Retry
from rq.registry import FailedJobRegistry, StartedJobRegistry
from rq.worker import Worker
from tests import RQTestCase
from tests.fixtures import div_by_zero, say_hello
def return_retry(max: int = 1, interval: int = 0):
return Retry(max=max, interval=interval)
class TestRetry(RQTestCase):
"""Tests from test_retry.py"""
def test_persistence_of_retry_data(self):
"""Retry related data is stored and restored properly"""
job = Job.create(func=say_hello, connection=self.connection)
job.retries_left = 3
job.retry_intervals = [1, 2, 3]
job.save()
job.retries_left = None
job.retry_intervals = None
job.refresh()
self.assertEqual(job.retries_left, 3)
self.assertEqual(job.retry_intervals, [1, 2, 3])
def test_retry_class(self):
"""Retry parses `max` and `interval` correctly"""
retry = Retry(max=1)
self.assertEqual(retry.max, 1)
self.assertEqual(retry.intervals, [0])
self.assertRaises(ValueError, Retry, max=0)
retry = Retry(max=2, interval=5)
self.assertEqual(retry.max, 2)
self.assertEqual(retry.intervals, [5])
retry = Retry(max=3, interval=[5, 10])
self.assertEqual(retry.max, 3)
self.assertEqual(retry.intervals, [5, 10])
# interval can't be negative
self.assertRaises(ValueError, Retry, max=1, interval=-5)
self.assertRaises(ValueError, Retry, max=1, interval=[1, -5])
def test_get_retry_interval(self):
"""get_retry_interval() returns the right retry interval"""
job = Job.create(func=say_hello, connection=self.connection)
# Handle case where self.retry_intervals is None
job.retries_left = 2
self.assertEqual(job.get_retry_interval(), 0)
# Handle the most common case
job.retry_intervals = [1, 2]
self.assertEqual(job.get_retry_interval(), 1)
job.retries_left = 1
self.assertEqual(job.get_retry_interval(), 2)
# Handle cases where number of retries > length of interval
job.retries_left = 4
job.retry_intervals = [1, 2, 3]
self.assertEqual(job.get_retry_interval(), 1)
job.retries_left = 3
self.assertEqual(job.get_retry_interval(), 1)
job.retries_left = 2
self.assertEqual(job.get_retry_interval(), 2)
job.retries_left = 1
self.assertEqual(job.get_retry_interval(), 3)
def test_job_retry(self):
"""job.retry() works properly"""
queue = Queue(connection=self.connection)
retry = Retry(max=3, interval=5)
job = queue.enqueue(div_by_zero, retry=retry)
with self.connection.pipeline() as pipeline:
job.retry(queue, pipeline)
pipeline.execute()
self.assertEqual(job.retries_left, 2)
# status should be scheduled since it's retried with 5 seconds interval
self.assertEqual(job.get_status(), JobStatus.SCHEDULED)
retry = Retry(max=3)
job = queue.enqueue(div_by_zero, retry=retry)
with self.connection.pipeline() as pipeline:
job.retry(queue, pipeline)
pipeline.execute()
self.assertEqual(job.retries_left, 2)
# status should be queued
self.assertEqual(job.get_status(), JobStatus.QUEUED)
def test_retry_interval(self):
"""Retries with intervals are scheduled"""
connection = self.connection
queue = Queue(connection=connection)
retry = Retry(max=1, interval=5)
job = queue.enqueue(div_by_zero, retry=retry)
worker = Worker([queue])
registry = queue.scheduled_job_registry
# If job if configured to retry with interval, it will be scheduled,
# not directly put back in the queue
queue.empty()
worker.handle_job_failure(job, queue)
job.refresh()
self.assertEqual(job.get_status(), JobStatus.SCHEDULED)
self.assertEqual(job.retries_left, 0)
self.assertEqual(len(registry), 1)
self.assertEqual(queue.job_ids, [])
# Scheduled time is roughly 5 seconds from now
scheduled_time = registry.get_scheduled_time(job)
now = datetime.now(timezone.utc)
self.assertTrue(now + timedelta(seconds=4) < scheduled_time < now + timedelta(seconds=10))
def test_cleanup_handles_retries(self):
"""Expired jobs should also be retried"""
queue = Queue(connection=self.connection)
registry = StartedJobRegistry(connection=self.connection)
failed_job_registry = FailedJobRegistry(connection=self.connection)
job = queue.enqueue(say_hello, retry=Retry(max=1))
# Add job to StartedJobRegistry with past expiration time
self.connection.zadd(registry.key, {job.id: 2})
registry.cleanup()
self.assertEqual(len(queue), 2)
self.assertEqual(job.get_status(), JobStatus.QUEUED)
self.assertNotIn(job, failed_job_registry)
self.connection.zadd(registry.key, {job.id: 2})
# Job goes to FailedJobRegistry because it's only retried once
registry.cleanup()
self.assertEqual(len(queue), 2)
self.assertEqual(job.get_status(), JobStatus.FAILED)
self.assertIn(job, failed_job_registry)
def test_retry_get_interval(self):
"""Retry.get_interval() returns the right retry interval"""
self.assertEqual(Retry.get_interval(0, [1, 2, 3]), 1)
self.assertEqual(Retry.get_interval(1, [1, 2, 3]), 2)
self.assertEqual(Retry.get_interval(3, [1, 2, 3]), 3)
self.assertEqual(Retry.get_interval(4, [1, 2, 3]), 3)
self.assertEqual(Retry.get_interval(5, [1, 2, 3]), 3)
# Handle case where interval is None
self.assertEqual(Retry.get_interval(1, None), 0)
self.assertEqual(Retry.get_interval(2, None), 0)
# Handle case where interval is a single integer
self.assertEqual(Retry.get_interval(1, 3), 3)
self.assertEqual(Retry.get_interval(2, 3), 3)
class TestWorkerRetry(RQTestCase):
"""Tests from test_job_retry.py"""
def test_retry(self):
"""Worker processes retry correctly when job returns Retry"""
queue = Queue(connection=self.connection)
job = queue.enqueue(return_retry)
worker = Worker([queue], connection=self.connection)
worker.work(max_jobs=1)
# A result with type `RETRIED` should be created
# skip on Redis < 5
if job.supports_redis_streams:
result = job.latest_result()
self.assertEqual(result.type, result.Type.RETRIED)
self.assertEqual(job.get_status(), JobStatus.QUEUED)
def test_job_handle_retry(self):
"""job._handle_retry_result() increments job.number_of_retries"""
queue = Queue(connection=self.connection)
job = queue.enqueue(return_retry)
pipeline = self.connection.pipeline()
# job._handle_retry_result() should increment job.number_of_retries
job._handle_retry_result(queue, pipeline)
pipeline.execute()
job = Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.number_of_retries, 1)
pipeline = self.connection.pipeline()
job._handle_retry_result(queue, pipeline)
pipeline.execute()
self.assertEqual(job.number_of_retries, 2)
def test_worker_handles_max_retry(self):
"""Job fails after maximum retries are exhausted"""
queue = Queue(connection=self.connection)
job = queue.enqueue(return_retry, max=2)
worker = Worker([queue], connection=self.connection)
worker.work(max_jobs=1)
# A result with type `RETRIED` should be created,
# job should be back in the queue
if job.supports_redis_streams:
result = job.latest_result()
self.assertEqual(result.type, result.Type.RETRIED)
self.assertIn(job.id, queue.get_job_ids())
# Second retry
worker.work(max_jobs=1)
if job.supports_redis_streams:
result = job.latest_result()
self.assertEqual(result.type, result.Type.RETRIED)
self.assertIn(job.id, queue.get_job_ids())
# Third execution would fail since max number of retries is 2
worker.work(max_jobs=1)
if job.supports_redis_streams:
result = job.latest_result()
self.assertEqual(result.type, result.Type.FAILED)
self.assertNotIn(job.id, queue.get_job_ids())
def test_worker_handles_retry_interval(self):
"""Worker handles retry with interval correctly"""
queue = Queue(connection=self.connection)
job = queue.enqueue(return_retry, max=1, interval=10)
worker = Worker([queue], connection=self.connection)
worker.work(max_jobs=1)
now = datetime.now(timezone.utc)
# Job should be scheduled for retry
self.assertEqual(job.get_status(), JobStatus.SCHEDULED)
self.assertNotIn(job.id, queue.get_job_ids())
registry = queue.scheduled_job_registry
self.assertIn(job.id, registry)
scheduled_time = registry.get_scheduled_time(job)
# Ensure that job is scheduled roughly 5 seconds from now
self.assertTrue(now + timedelta(seconds=7) < scheduled_time < now + timedelta(seconds=13))
job = queue.enqueue(return_retry, max=1, interval=30)
worker = Worker([queue], connection=self.connection)
worker.work(max_jobs=1)
now = datetime.now(timezone.utc)
# Job should be scheduled for retry
self.assertEqual(job.get_status(), JobStatus.SCHEDULED)
self.assertNotIn(job.id, queue.get_job_ids())
registry = queue.scheduled_job_registry
self.assertIn(job.id, registry)
scheduled_time = registry.get_scheduled_time(job)
# Ensure that job is scheduled roughly 5 seconds from now
self.assertTrue(now + timedelta(seconds=27) < scheduled_time < now + timedelta(seconds=33))
|
