baqueue 1.1.0__tar.gz → 1.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {baqueue-1.1.0/baqueue.egg-info → baqueue-1.2.0}/PKG-INFO +39 -2
- {baqueue-1.1.0 → baqueue-1.2.0}/README.md +38 -1
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/__init__.py +1 -1
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/cli.py +29 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/config.py +3 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/drivers/base.py +9 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/drivers/memory_driver.py +26 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/drivers/postgres_driver.py +27 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/drivers/redis_driver.py +82 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/drivers/sqlite_driver.py +30 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/supervisor.py +37 -1
- {baqueue-1.1.0 → baqueue-1.2.0/baqueue.egg-info}/PKG-INFO +39 -2
- {baqueue-1.1.0 → baqueue-1.2.0}/LICENSE +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/MANIFEST.in +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/balancer.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/batch.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/dashboard/__init__.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/dashboard/api.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/dashboard/server.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/dashboard/static/app.js +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/dashboard/static/index.html +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/dashboard/static/style.css +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/drivers/__init__.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/events.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/job.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/pruner.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/queue.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/retry.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/scheduler.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/serializer.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue/worker.py +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue.egg-info/SOURCES.txt +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue.egg-info/dependency_links.txt +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue.egg-info/entry_points.txt +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue.egg-info/requires.txt +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/baqueue.egg-info/top_level.txt +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/pyproject.toml +0 -0
- {baqueue-1.1.0 → baqueue-1.2.0}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: baqueue
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.2.0
|
|
4
4
|
Summary: A powerful Python queue management package inspired by Laravel Horizon
|
|
5
5
|
Author: Basalam, BaQueue Contributors
|
|
6
6
|
License: MIT
|
|
@@ -75,6 +75,7 @@ A powerful Python queue management package. Multi-driver support, batch jobs, sc
|
|
|
75
75
|
- [Dispatch Jobs](#dispatch-jobs)
|
|
76
76
|
- [Batch Jobs](#batch-jobs)
|
|
77
77
|
- [Run Workers](#run-workers)
|
|
78
|
+
- [Stuck Job Recovery](#stuck-job-recovery)
|
|
78
79
|
- [Pruning](#pruning)
|
|
79
80
|
- [Auto-pruning](#auto-pruning-runs-alongside-baqueue-work)
|
|
80
81
|
- [Manual pruning](#manual-pruning)
|
|
@@ -95,6 +96,7 @@ A powerful Python queue management package. Multi-driver support, batch jobs, sc
|
|
|
95
96
|
## Features
|
|
96
97
|
- **Multi-driver**: SQLite (default), Redis, PostgreSQL, or In-Memory
|
|
97
98
|
- **Auto-balancing**: Dynamically scale workers based on queue pressure
|
|
99
|
+
- **Stuck-job recovery**: Jobs left in `processing` for more than 1 hour are requeued automatically
|
|
98
100
|
- **Auto-pruning**: Completed jobs are deleted about 5 seconds after they finish; failed/cancelled jobs are kept up to 1 day — all configurable
|
|
99
101
|
- **Disk-full cleanup**: Storage-full/OOM driver errors trigger emergency cleanup of terminal jobs and old metrics, then retry once
|
|
100
102
|
- **Pruning**: Remove old jobs by status, tag, or age
|
|
@@ -213,6 +215,41 @@ Or via CLI:
|
|
|
213
215
|
baqueue work -q emails -q payments -w 3 -b auto
|
|
214
216
|
```
|
|
215
217
|
|
|
218
|
+
#### Stuck Job Recovery
|
|
219
|
+
|
|
220
|
+
When `baqueue work` is running, the supervisor also checks for jobs that were
|
|
221
|
+
claimed by a worker but never finished. By default, any job that has stayed in
|
|
222
|
+
`processing` for more than 1 hour is moved back to `pending`, so another worker
|
|
223
|
+
can pick it up and run it again.
|
|
224
|
+
|
|
225
|
+
This is intended for worker crashes, process restarts, or other cases where a
|
|
226
|
+
job was left in-flight. The original claim still counts as an attempt; when the
|
|
227
|
+
job is picked up again, its attempt counter continues from there.
|
|
228
|
+
|
|
229
|
+
Configure it from Python:
|
|
230
|
+
|
|
231
|
+
```python
|
|
232
|
+
supervisor = Supervisor(
|
|
233
|
+
driver=Queue.get_driver(),
|
|
234
|
+
config=SupervisorConfig(
|
|
235
|
+
queues=["emails"],
|
|
236
|
+
recover_stuck_jobs=True,
|
|
237
|
+
stuck_processing_seconds=3600,
|
|
238
|
+
stuck_check_interval_seconds=60,
|
|
239
|
+
),
|
|
240
|
+
)
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
Or from the CLI:
|
|
244
|
+
|
|
245
|
+
```bash
|
|
246
|
+
baqueue work --stuck-job-timeout-seconds 7200
|
|
247
|
+
baqueue work --no-stuck-job-recovery
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
If you intentionally run jobs for longer than 1 hour, increase
|
|
251
|
+
`stuck_processing_seconds` above your longest expected runtime.
|
|
252
|
+
|
|
216
253
|
### Pruning
|
|
217
254
|
|
|
218
255
|
#### Auto-pruning (runs alongside `baqueue work`)
|
|
@@ -509,7 +546,7 @@ Coverage includes:
|
|
|
509
546
|
- `Queue` facade — push / later / bulk / prune / `retry_failed`
|
|
510
547
|
- Cross-driver contract tests (memory + sqlite, parameterized)
|
|
511
548
|
- Worker lifecycle: success / failure / retry / timeout
|
|
512
|
-
- Supervisor pool + delayed-job promotion
|
|
549
|
+
- Supervisor pool + delayed-job promotion + stuck-job recovery
|
|
513
550
|
- Scheduler interval dispatch
|
|
514
551
|
- Pruner by status / tag / age
|
|
515
552
|
- Batch builder + completion callbacks
|
|
@@ -23,6 +23,7 @@ A powerful Python queue management package. Multi-driver support, batch jobs, sc
|
|
|
23
23
|
- [Dispatch Jobs](#dispatch-jobs)
|
|
24
24
|
- [Batch Jobs](#batch-jobs)
|
|
25
25
|
- [Run Workers](#run-workers)
|
|
26
|
+
- [Stuck Job Recovery](#stuck-job-recovery)
|
|
26
27
|
- [Pruning](#pruning)
|
|
27
28
|
- [Auto-pruning](#auto-pruning-runs-alongside-baqueue-work)
|
|
28
29
|
- [Manual pruning](#manual-pruning)
|
|
@@ -43,6 +44,7 @@ A powerful Python queue management package. Multi-driver support, batch jobs, sc
|
|
|
43
44
|
## Features
|
|
44
45
|
- **Multi-driver**: SQLite (default), Redis, PostgreSQL, or In-Memory
|
|
45
46
|
- **Auto-balancing**: Dynamically scale workers based on queue pressure
|
|
47
|
+
- **Stuck-job recovery**: Jobs left in `processing` for more than 1 hour are requeued automatically
|
|
46
48
|
- **Auto-pruning**: Completed jobs are deleted about 5 seconds after they finish; failed/cancelled jobs are kept up to 1 day — all configurable
|
|
47
49
|
- **Disk-full cleanup**: Storage-full/OOM driver errors trigger emergency cleanup of terminal jobs and old metrics, then retry once
|
|
48
50
|
- **Pruning**: Remove old jobs by status, tag, or age
|
|
@@ -161,6 +163,41 @@ Or via CLI:
|
|
|
161
163
|
baqueue work -q emails -q payments -w 3 -b auto
|
|
162
164
|
```
|
|
163
165
|
|
|
166
|
+
#### Stuck Job Recovery
|
|
167
|
+
|
|
168
|
+
When `baqueue work` is running, the supervisor also checks for jobs that were
|
|
169
|
+
claimed by a worker but never finished. By default, any job that has stayed in
|
|
170
|
+
`processing` for more than 1 hour is moved back to `pending`, so another worker
|
|
171
|
+
can pick it up and run it again.
|
|
172
|
+
|
|
173
|
+
This is intended for worker crashes, process restarts, or other cases where a
|
|
174
|
+
job was left in-flight. The original claim still counts as an attempt; when the
|
|
175
|
+
job is picked up again, its attempt counter continues from there.
|
|
176
|
+
|
|
177
|
+
Configure it from Python:
|
|
178
|
+
|
|
179
|
+
```python
|
|
180
|
+
supervisor = Supervisor(
|
|
181
|
+
driver=Queue.get_driver(),
|
|
182
|
+
config=SupervisorConfig(
|
|
183
|
+
queues=["emails"],
|
|
184
|
+
recover_stuck_jobs=True,
|
|
185
|
+
stuck_processing_seconds=3600,
|
|
186
|
+
stuck_check_interval_seconds=60,
|
|
187
|
+
),
|
|
188
|
+
)
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
Or from the CLI:
|
|
192
|
+
|
|
193
|
+
```bash
|
|
194
|
+
baqueue work --stuck-job-timeout-seconds 7200
|
|
195
|
+
baqueue work --no-stuck-job-recovery
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
If you intentionally run jobs for longer than 1 hour, increase
|
|
199
|
+
`stuck_processing_seconds` above your longest expected runtime.
|
|
200
|
+
|
|
164
201
|
### Pruning
|
|
165
202
|
|
|
166
203
|
#### Auto-pruning (runs alongside `baqueue work`)
|
|
@@ -457,7 +494,7 @@ Coverage includes:
|
|
|
457
494
|
- `Queue` facade — push / later / bulk / prune / `retry_failed`
|
|
458
495
|
- Cross-driver contract tests (memory + sqlite, parameterized)
|
|
459
496
|
- Worker lifecycle: success / failure / retry / timeout
|
|
460
|
-
- Supervisor pool + delayed-job promotion
|
|
497
|
+
- Supervisor pool + delayed-job promotion + stuck-job recovery
|
|
461
498
|
- Scheduler interval dispatch
|
|
462
499
|
- Pruner by status / tag / age
|
|
463
500
|
- Batch builder + completion callbacks
|
|
@@ -103,6 +103,18 @@ def cli(ctx: click.Context, config: str | None, verbose: bool) -> None:
|
|
|
103
103
|
"--no-disk-full-cleanup", is_flag=True,
|
|
104
104
|
help="Disable automatic emergency cleanup when the driver returns a disk-full error.",
|
|
105
105
|
)
|
|
106
|
+
@click.option(
|
|
107
|
+
"--no-stuck-job-recovery", is_flag=True,
|
|
108
|
+
help="Disable automatic recovery of jobs stuck in processing.",
|
|
109
|
+
)
|
|
110
|
+
@click.option(
|
|
111
|
+
"--stuck-job-timeout-seconds", type=int, default=None,
|
|
112
|
+
help="Requeue processing jobs older than N seconds (default 3600).",
|
|
113
|
+
)
|
|
114
|
+
@click.option(
|
|
115
|
+
"--stuck-job-check-interval-seconds", type=int, default=None,
|
|
116
|
+
help="How often stuck-job recovery runs, in seconds (default 60).",
|
|
117
|
+
)
|
|
106
118
|
@click.pass_context
|
|
107
119
|
def work(
|
|
108
120
|
ctx: click.Context,
|
|
@@ -119,6 +131,9 @@ def work(
|
|
|
119
131
|
prune_other_seconds: int | None,
|
|
120
132
|
prune_interval_seconds: int | None,
|
|
121
133
|
no_disk_full_cleanup: bool,
|
|
134
|
+
no_stuck_job_recovery: bool,
|
|
135
|
+
stuck_job_timeout_seconds: int | None,
|
|
136
|
+
stuck_job_check_interval_seconds: int | None,
|
|
122
137
|
) -> None:
|
|
123
138
|
"""Start processing jobs."""
|
|
124
139
|
config: BaQueueConfig = ctx.obj["config"]
|
|
@@ -143,6 +158,13 @@ def work(
|
|
|
143
158
|
sleep=sleep,
|
|
144
159
|
timeout=timeout,
|
|
145
160
|
max_jobs_per_worker=max_jobs,
|
|
161
|
+
recover_stuck_jobs=not no_stuck_job_recovery,
|
|
162
|
+
stuck_processing_seconds=(
|
|
163
|
+
3600 if stuck_job_timeout_seconds is None else stuck_job_timeout_seconds
|
|
164
|
+
),
|
|
165
|
+
stuck_check_interval_seconds=(
|
|
166
|
+
60 if stuck_job_check_interval_seconds is None else stuck_job_check_interval_seconds
|
|
167
|
+
),
|
|
146
168
|
)
|
|
147
169
|
|
|
148
170
|
_validate_driver(driver)
|
|
@@ -162,6 +184,13 @@ def work(
|
|
|
162
184
|
click.echo(
|
|
163
185
|
f" Disk-full cleanup: {'enabled' if config.auto_cleanup_on_disk_full else 'disabled'}"
|
|
164
186
|
)
|
|
187
|
+
if supervisor_config.recover_stuck_jobs:
|
|
188
|
+
click.echo(
|
|
189
|
+
f" Stuck-job recovery: processing>{supervisor_config.stuck_processing_seconds}s, "
|
|
190
|
+
f"every {supervisor_config.stuck_check_interval_seconds}s"
|
|
191
|
+
)
|
|
192
|
+
else:
|
|
193
|
+
click.echo(" Stuck-job recovery: disabled")
|
|
165
194
|
click.echo()
|
|
166
195
|
|
|
167
196
|
_run_async(_run_worker, config, supervisor_config)
|
|
@@ -28,6 +28,9 @@ class SupervisorConfig(BaseModel):
|
|
|
28
28
|
sleep: float = 1.0 # seconds to sleep when queue is empty
|
|
29
29
|
timeout: int = 60 # max job execution time in seconds
|
|
30
30
|
memory_limit: int = 128 # MB
|
|
31
|
+
recover_stuck_jobs: bool = True
|
|
32
|
+
stuck_processing_seconds: int = 3600
|
|
33
|
+
stuck_check_interval_seconds: int = 60
|
|
31
34
|
|
|
32
35
|
|
|
33
36
|
class ScheduleEntry(BaseModel):
|
|
@@ -112,6 +112,15 @@ class BaseDriver(ABC):
|
|
|
112
112
|
"""Release a job back onto the queue (for retries)."""
|
|
113
113
|
...
|
|
114
114
|
|
|
115
|
+
@abstractmethod
|
|
116
|
+
async def requeue_stuck_jobs(
|
|
117
|
+
self,
|
|
118
|
+
older_than_seconds: float,
|
|
119
|
+
queue: str | None = None,
|
|
120
|
+
) -> int:
|
|
121
|
+
"""Move stale processing jobs back to pending. Returns count requeued."""
|
|
122
|
+
...
|
|
123
|
+
|
|
115
124
|
@abstractmethod
|
|
116
125
|
async def delete(self, job_id: str) -> None: ...
|
|
117
126
|
|
|
@@ -107,6 +107,32 @@ class MemoryDriver(BaseDriver):
|
|
|
107
107
|
self._queues[payload.queue].append(payload.id)
|
|
108
108
|
self._jobs[payload.id] = payload
|
|
109
109
|
|
|
110
|
+
async def requeue_stuck_jobs(
|
|
111
|
+
self,
|
|
112
|
+
older_than_seconds: float,
|
|
113
|
+
queue: str | None = None,
|
|
114
|
+
) -> int:
|
|
115
|
+
cutoff = _now_ts() - older_than_seconds
|
|
116
|
+
now = _now_ts()
|
|
117
|
+
count = 0
|
|
118
|
+
async with self._lock:
|
|
119
|
+
for payload in self._jobs.values():
|
|
120
|
+
if queue and payload.queue != queue:
|
|
121
|
+
continue
|
|
122
|
+
if payload.status != "processing":
|
|
123
|
+
continue
|
|
124
|
+
started = payload.started_at or payload.updated_at
|
|
125
|
+
if started is None or started > cutoff:
|
|
126
|
+
continue
|
|
127
|
+
payload.status = "pending"
|
|
128
|
+
payload.started_at = None
|
|
129
|
+
payload.delay_until = None
|
|
130
|
+
payload.updated_at = now
|
|
131
|
+
if payload.id not in self._queues[payload.queue]:
|
|
132
|
+
self._queues[payload.queue].append(payload.id)
|
|
133
|
+
count += 1
|
|
134
|
+
return count
|
|
135
|
+
|
|
110
136
|
async def delete(self, job_id: str) -> None:
|
|
111
137
|
async with self._lock:
|
|
112
138
|
self._jobs.pop(job_id, None)
|
|
@@ -317,6 +317,33 @@ class PostgresDriver(BaseDriver):
|
|
|
317
317
|
|
|
318
318
|
await self._with_disk_full_recovery(_do)
|
|
319
319
|
|
|
320
|
+
async def requeue_stuck_jobs(
|
|
321
|
+
self,
|
|
322
|
+
older_than_seconds: float,
|
|
323
|
+
queue: str | None = None,
|
|
324
|
+
) -> int:
|
|
325
|
+
now = _now_ts()
|
|
326
|
+
cutoff = now - older_than_seconds
|
|
327
|
+
conditions = ["status='processing'", "COALESCE(started_at, updated_at) <= $2"]
|
|
328
|
+
params: list[Any] = [now, cutoff]
|
|
329
|
+
idx = 3
|
|
330
|
+
if queue:
|
|
331
|
+
conditions.append(f"queue=${idx}")
|
|
332
|
+
params.append(queue)
|
|
333
|
+
where = " AND ".join(conditions)
|
|
334
|
+
|
|
335
|
+
async def _do():
|
|
336
|
+
async with self._pool.acquire() as conn:
|
|
337
|
+
return await conn.execute(
|
|
338
|
+
f"""UPDATE {self._jobs_table}
|
|
339
|
+
SET status='pending', started_at=NULL, delay_until=NULL, updated_at=$1
|
|
340
|
+
WHERE {where}""",
|
|
341
|
+
*params,
|
|
342
|
+
)
|
|
343
|
+
|
|
344
|
+
result = await self._with_disk_full_recovery(_do)
|
|
345
|
+
return int(result.split()[-1])
|
|
346
|
+
|
|
320
347
|
async def delete(self, job_id: str) -> None:
|
|
321
348
|
async def _do():
|
|
322
349
|
async with self._pool.acquire() as conn:
|
|
@@ -296,6 +296,88 @@ class RedisDriver(BaseDriver):
|
|
|
296
296
|
await pipe.execute()
|
|
297
297
|
await self._with_disk_full_recovery(_do)
|
|
298
298
|
|
|
299
|
+
async def _requeue_stuck_job(self, job_id: str, cutoff: float) -> int:
|
|
300
|
+
from redis.exceptions import WatchError
|
|
301
|
+
|
|
302
|
+
job_key = self._key("job", job_id)
|
|
303
|
+
|
|
304
|
+
async def _attempt() -> int:
|
|
305
|
+
pipe = self._redis.pipeline()
|
|
306
|
+
try:
|
|
307
|
+
await pipe.watch(job_key)
|
|
308
|
+
raw = await pipe.hget(job_key, "data")
|
|
309
|
+
if not raw:
|
|
310
|
+
return 0
|
|
311
|
+
|
|
312
|
+
payload = JobPayload.from_json(raw)
|
|
313
|
+
if payload.status != "processing":
|
|
314
|
+
return 0
|
|
315
|
+
started = payload.started_at or payload.updated_at
|
|
316
|
+
if started is None or started > cutoff:
|
|
317
|
+
return 0
|
|
318
|
+
|
|
319
|
+
payload.status = "pending"
|
|
320
|
+
payload.started_at = None
|
|
321
|
+
payload.delay_until = None
|
|
322
|
+
payload.updated_at = _now_ts()
|
|
323
|
+
|
|
324
|
+
pipe.multi()
|
|
325
|
+
pipe.hset(job_key, mapping={"data": payload.to_json()})
|
|
326
|
+
pipe.zrem(self._key("delayed"), job_id)
|
|
327
|
+
pipe.lrem(self._key("queue", payload.queue), 0, job_id)
|
|
328
|
+
pipe.rpush(self._key("queue", payload.queue), job_id)
|
|
329
|
+
self._index_status_change(
|
|
330
|
+
pipe,
|
|
331
|
+
job_id,
|
|
332
|
+
payload.queue,
|
|
333
|
+
"processing",
|
|
334
|
+
"pending",
|
|
335
|
+
payload.created_at,
|
|
336
|
+
)
|
|
337
|
+
await pipe.execute()
|
|
338
|
+
return 1
|
|
339
|
+
finally:
|
|
340
|
+
await pipe.reset()
|
|
341
|
+
|
|
342
|
+
for _ in range(5):
|
|
343
|
+
try:
|
|
344
|
+
return int(await self._with_disk_full_recovery(_attempt) or 0)
|
|
345
|
+
except WatchError:
|
|
346
|
+
continue
|
|
347
|
+
return 0
|
|
348
|
+
|
|
349
|
+
async def requeue_stuck_jobs(
|
|
350
|
+
self,
|
|
351
|
+
older_than_seconds: float,
|
|
352
|
+
queue: str | None = None,
|
|
353
|
+
) -> int:
|
|
354
|
+
cutoff = _now_ts() - older_than_seconds
|
|
355
|
+
index = self._index_key(queue, "processing")
|
|
356
|
+
ids = await self._redis.zrange(index, 0, -1)
|
|
357
|
+
if not ids:
|
|
358
|
+
return 0
|
|
359
|
+
|
|
360
|
+
pipe = self._redis.pipeline()
|
|
361
|
+
for jid in ids:
|
|
362
|
+
pipe.hget(self._key("job", jid), "data")
|
|
363
|
+
raws = await pipe.execute()
|
|
364
|
+
|
|
365
|
+
count = 0
|
|
366
|
+
for jid, raw in zip(ids, raws):
|
|
367
|
+
if not raw:
|
|
368
|
+
continue
|
|
369
|
+
try:
|
|
370
|
+
job = JobPayload.from_json(raw)
|
|
371
|
+
except (TypeError, ValueError, json.JSONDecodeError):
|
|
372
|
+
continue
|
|
373
|
+
if queue and job.queue != queue:
|
|
374
|
+
continue
|
|
375
|
+
started = job.started_at or job.updated_at
|
|
376
|
+
if started is None or started > cutoff:
|
|
377
|
+
continue
|
|
378
|
+
count += await self._requeue_stuck_job(jid, cutoff)
|
|
379
|
+
return count
|
|
380
|
+
|
|
299
381
|
async def delete(self, job_id: str) -> None:
|
|
300
382
|
raw = await self._redis.hget(self._key("job", job_id), "data")
|
|
301
383
|
|
|
@@ -369,6 +369,36 @@ class SqliteDriver(BaseDriver):
|
|
|
369
369
|
c.commit()
|
|
370
370
|
await self._execute_with_retry(_do)
|
|
371
371
|
|
|
372
|
+
async def requeue_stuck_jobs(
|
|
373
|
+
self,
|
|
374
|
+
older_than_seconds: float,
|
|
375
|
+
queue: str | None = None,
|
|
376
|
+
) -> int:
|
|
377
|
+
now = _now_ts()
|
|
378
|
+
cutoff = now - older_than_seconds
|
|
379
|
+
conditions = ["status='processing'", "COALESCE(started_at, updated_at) <= ?"]
|
|
380
|
+
params: list[Any] = [cutoff]
|
|
381
|
+
if queue:
|
|
382
|
+
conditions.append("queue=?")
|
|
383
|
+
params.append(queue)
|
|
384
|
+
params.insert(0, now)
|
|
385
|
+
where = " AND ".join(conditions)
|
|
386
|
+
result = [0]
|
|
387
|
+
|
|
388
|
+
async with self._lock:
|
|
389
|
+
def _do():
|
|
390
|
+
c = self._get_conn()
|
|
391
|
+
cur = c.execute(
|
|
392
|
+
f"""UPDATE jobs
|
|
393
|
+
SET status='pending', started_at=NULL, delay_until=NULL, updated_at=?
|
|
394
|
+
WHERE {where}""",
|
|
395
|
+
params,
|
|
396
|
+
)
|
|
397
|
+
c.commit()
|
|
398
|
+
result[0] = cur.rowcount
|
|
399
|
+
await self._execute_with_retry(_do)
|
|
400
|
+
return result[0]
|
|
401
|
+
|
|
372
402
|
async def delete(self, job_id: str) -> None:
|
|
373
403
|
async with self._lock:
|
|
374
404
|
def _do():
|
|
@@ -43,6 +43,7 @@ class Supervisor:
|
|
|
43
43
|
self._heartbeat_task: asyncio.Task | None = None
|
|
44
44
|
self._balance_task: asyncio.Task | None = None
|
|
45
45
|
self._pruner_task: asyncio.Task | None = None
|
|
46
|
+
self._stuck_recovery_task: asyncio.Task | None = None
|
|
46
47
|
|
|
47
48
|
@property
|
|
48
49
|
def is_running(self) -> bool:
|
|
@@ -80,6 +81,8 @@ class Supervisor:
|
|
|
80
81
|
await self._report_stats()
|
|
81
82
|
self._delayed_task = asyncio.create_task(self._poll_delayed())
|
|
82
83
|
self._heartbeat_task = asyncio.create_task(self._heartbeat_loop())
|
|
84
|
+
if self.config.recover_stuck_jobs and self.config.stuck_processing_seconds > 0:
|
|
85
|
+
self._stuck_recovery_task = asyncio.create_task(self._recover_stuck_loop())
|
|
83
86
|
|
|
84
87
|
if self.balancer:
|
|
85
88
|
self._balance_task = asyncio.create_task(self._balance_loop())
|
|
@@ -112,9 +115,17 @@ class Supervisor:
|
|
|
112
115
|
self._balance_task.cancel()
|
|
113
116
|
if self._pruner_task:
|
|
114
117
|
self._pruner_task.cancel()
|
|
118
|
+
if self._stuck_recovery_task:
|
|
119
|
+
self._stuck_recovery_task.cancel()
|
|
115
120
|
|
|
116
121
|
aux_tasks = [
|
|
117
|
-
t for t in (
|
|
122
|
+
t for t in (
|
|
123
|
+
self._delayed_task,
|
|
124
|
+
self._heartbeat_task,
|
|
125
|
+
self._balance_task,
|
|
126
|
+
self._pruner_task,
|
|
127
|
+
self._stuck_recovery_task,
|
|
128
|
+
)
|
|
118
129
|
if t is not None
|
|
119
130
|
]
|
|
120
131
|
if aux_tasks:
|
|
@@ -123,6 +134,7 @@ class Supervisor:
|
|
|
123
134
|
self._heartbeat_task = None
|
|
124
135
|
self._balance_task = None
|
|
125
136
|
self._pruner_task = None
|
|
137
|
+
self._stuck_recovery_task = None
|
|
126
138
|
|
|
127
139
|
for task in self._tasks:
|
|
128
140
|
task.cancel()
|
|
@@ -187,6 +199,30 @@ class Supervisor:
|
|
|
187
199
|
logger.exception("Error in balance loop")
|
|
188
200
|
await asyncio.sleep(5)
|
|
189
201
|
|
|
202
|
+
async def _recover_stuck_loop(self) -> None:
|
|
203
|
+
"""Periodically requeue jobs left in processing after a worker crash."""
|
|
204
|
+
interval = max(1.0, float(self.config.stuck_check_interval_seconds))
|
|
205
|
+
while self._running:
|
|
206
|
+
try:
|
|
207
|
+
await self._recover_stuck_once()
|
|
208
|
+
except Exception:
|
|
209
|
+
logger.exception("Error recovering stuck processing jobs")
|
|
210
|
+
await asyncio.sleep(interval)
|
|
211
|
+
|
|
212
|
+
async def _recover_stuck_once(self) -> int:
|
|
213
|
+
timeout = float(self.config.stuck_processing_seconds)
|
|
214
|
+
if timeout <= 0:
|
|
215
|
+
return 0
|
|
216
|
+
total = 0
|
|
217
|
+
for queue in dict.fromkeys(self.config.queues):
|
|
218
|
+
total += await self.driver.requeue_stuck_jobs(timeout, queue=queue)
|
|
219
|
+
if total:
|
|
220
|
+
logger.warning(
|
|
221
|
+
"Requeued %d stuck processing job(s) older than %.0fs",
|
|
222
|
+
total, timeout,
|
|
223
|
+
)
|
|
224
|
+
return total
|
|
225
|
+
|
|
190
226
|
async def _heartbeat_loop(self) -> None:
|
|
191
227
|
while self._running:
|
|
192
228
|
await self._report_stats()
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: baqueue
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.2.0
|
|
4
4
|
Summary: A powerful Python queue management package inspired by Laravel Horizon
|
|
5
5
|
Author: Basalam, BaQueue Contributors
|
|
6
6
|
License: MIT
|
|
@@ -75,6 +75,7 @@ A powerful Python queue management package. Multi-driver support, batch jobs, sc
|
|
|
75
75
|
- [Dispatch Jobs](#dispatch-jobs)
|
|
76
76
|
- [Batch Jobs](#batch-jobs)
|
|
77
77
|
- [Run Workers](#run-workers)
|
|
78
|
+
- [Stuck Job Recovery](#stuck-job-recovery)
|
|
78
79
|
- [Pruning](#pruning)
|
|
79
80
|
- [Auto-pruning](#auto-pruning-runs-alongside-baqueue-work)
|
|
80
81
|
- [Manual pruning](#manual-pruning)
|
|
@@ -95,6 +96,7 @@ A powerful Python queue management package. Multi-driver support, batch jobs, sc
|
|
|
95
96
|
## Features
|
|
96
97
|
- **Multi-driver**: SQLite (default), Redis, PostgreSQL, or In-Memory
|
|
97
98
|
- **Auto-balancing**: Dynamically scale workers based on queue pressure
|
|
99
|
+
- **Stuck-job recovery**: Jobs left in `processing` for more than 1 hour are requeued automatically
|
|
98
100
|
- **Auto-pruning**: Completed jobs are deleted about 5 seconds after they finish; failed/cancelled jobs are kept up to 1 day — all configurable
|
|
99
101
|
- **Disk-full cleanup**: Storage-full/OOM driver errors trigger emergency cleanup of terminal jobs and old metrics, then retry once
|
|
100
102
|
- **Pruning**: Remove old jobs by status, tag, or age
|
|
@@ -213,6 +215,41 @@ Or via CLI:
|
|
|
213
215
|
baqueue work -q emails -q payments -w 3 -b auto
|
|
214
216
|
```
|
|
215
217
|
|
|
218
|
+
#### Stuck Job Recovery
|
|
219
|
+
|
|
220
|
+
When `baqueue work` is running, the supervisor also checks for jobs that were
|
|
221
|
+
claimed by a worker but never finished. By default, any job that has stayed in
|
|
222
|
+
`processing` for more than 1 hour is moved back to `pending`, so another worker
|
|
223
|
+
can pick it up and run it again.
|
|
224
|
+
|
|
225
|
+
This is intended for worker crashes, process restarts, or other cases where a
|
|
226
|
+
job was left in-flight. The original claim still counts as an attempt; when the
|
|
227
|
+
job is picked up again, its attempt counter continues from there.
|
|
228
|
+
|
|
229
|
+
Configure it from Python:
|
|
230
|
+
|
|
231
|
+
```python
|
|
232
|
+
supervisor = Supervisor(
|
|
233
|
+
driver=Queue.get_driver(),
|
|
234
|
+
config=SupervisorConfig(
|
|
235
|
+
queues=["emails"],
|
|
236
|
+
recover_stuck_jobs=True,
|
|
237
|
+
stuck_processing_seconds=3600,
|
|
238
|
+
stuck_check_interval_seconds=60,
|
|
239
|
+
),
|
|
240
|
+
)
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
Or from the CLI:
|
|
244
|
+
|
|
245
|
+
```bash
|
|
246
|
+
baqueue work --stuck-job-timeout-seconds 7200
|
|
247
|
+
baqueue work --no-stuck-job-recovery
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
If you intentionally run jobs for longer than 1 hour, increase
|
|
251
|
+
`stuck_processing_seconds` above your longest expected runtime.
|
|
252
|
+
|
|
216
253
|
### Pruning
|
|
217
254
|
|
|
218
255
|
#### Auto-pruning (runs alongside `baqueue work`)
|
|
@@ -509,7 +546,7 @@ Coverage includes:
|
|
|
509
546
|
- `Queue` facade — push / later / bulk / prune / `retry_failed`
|
|
510
547
|
- Cross-driver contract tests (memory + sqlite, parameterized)
|
|
511
548
|
- Worker lifecycle: success / failure / retry / timeout
|
|
512
|
-
- Supervisor pool + delayed-job promotion
|
|
549
|
+
- Supervisor pool + delayed-job promotion + stuck-job recovery
|
|
513
550
|
- Scheduler interval dispatch
|
|
514
551
|
- Pruner by status / tag / age
|
|
515
552
|
- Batch builder + completion callbacks
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|