redis_task_queue 0.6.0
redis_task_queue: ^0.6.0 copied to clipboard
A small Redis-backed task queue for server-side Dart. Enqueue or schedule jobs and process them in a worker with retries, a dead-letter list, and weighted queues.
0.6.0 #
- Breaking: a handler now takes the run's context as a second argument,
(Task task, TaskContext context). Existing handlers migrate by adding the parameter:(task) async { ... }becomes(task, _) async { ... }. - Handlers can see which run they are in.
TaskContextcarries the task'sid, thequeueit came from, the 1-basedattempt,maxAttempts(the first run plus its retries) andisLastAttempt, which is true on exactly the run whose failure dead-letters the task. Theidis the point. Delivery is at-least-once, so the package has always asked handlers to be idempotent, but until now it gave them nothing stable to deduplicate on: the id lived in the envelope and never reached the handler, which left callers inventing their own key inside the payload. It is assigned at enqueue and is unchanged across retries and crash recoveries, so it is the value to record with the effect.attemptandisLastAttemptcover the other half, taking a slower or safer path on a late try and getting one last chance to record something before the task is given up on. - Examples now demonstrate the delivery guarantees instead of describing them.
example/crash_recovery.dartkills a worker mid-task in a child process and shows the task completing after recovery.example/at_least_once.dartstages the same crash twice, with a careless handler and with one keyed offcontext.id, and counts the effect: applied twice, then once. There is also anexample/README.mdcovering the worker-id contract, the idempotency pattern, watching the dead-letter list, and where this queue does not fit.
0.5.0 #
- Crash-safe at-least-once delivery. The worker now claims a task by atomically
moving it (
LMOVE) onto a per-worker in-flight list and only removes it once the task is done, retried, or dead-lettered. A worker that dies mid-task leaves the envelope on its in-flight list and requeues it on its nextrun, so a crash, OOM kill, or lost node no longer loses the task in progress. Previously the worker popped withBRPOP, so a task being handled when the process died was gone. Delivery is at-least-once: a task can run again after a crash, so handlers must be idempotent. - New
workerIdonWorker.connect(default: the host name) names the in-flight list a restarted worker recovers from. Set it to something stable across restarts (a pod or service name); two workers must never share one. See the README's "Recovery and worker ids" for the one case this doesn't cover on its own (a worker that never restarts under the same id). - Real weighted fair scheduling. The worker draws each queue's turn in
proportion to its weight with a rotating cursor over the weighted order, so
{'critical': 6, 'default': 3, 'low': 1}is served roughly 6:3:1 under load and, unlike strict priority, a flood of critical jobs can't fully starvelow. The previousBRPOPover a repeated key list was really strict priority; the weights only set the order. - Docs: the flow and state diagrams now show the in-flight list and the crash-recovery path.
0.4.1 #
- Docs: replace the two README mermaid diagrams with rendered PNGs. pub.dev does not render mermaid, so the diagrams showed as raw source there; they now display as images on both pub.dev and GitHub.
0.4.0 #
- Add observability hooks to
Worker.connect.onErrorfires on every handler failure, with the 1-based attempt number and whether a retry follows;onDeadLetterfires when a task is given up on after its retries. Both default to null and are isolated, so a throwing callback cannot take the worker down. Before this, a handler exception was swallowed silently, which is rarely what a production queue wants. - Restore scheduled tasks (
enqueuewithprocessAtorprocessIn), which the 0.3.1 release removed by accident. 0.3.1 was published as a docs-only change but also dropped the 0.3.0 scheduling feature; if you schedule tasks for a future time, move to 0.4.0 (or pin 0.3.0) rather than 0.3.1.
0.3.0 #
- Scheduled tasks.
enqueuetakes an optionalprocessAt(an absolute time) orprocessIn(a delay from now), set at most one, to hold a task until a future time. - No new machinery: a scheduled task is scored into the same per-queue delayed sorted set the 0.2.0 retry backoff uses, and the same atomic Lua due-mover promotes it once due. The worker is unchanged.
- The inherited bounds apply: a due task starts up to about a second past its due time (the mover runs once per poll-loop pass), and only while a worker polling that queue is running.
enqueuewithout either parameter behaves exactly as in 0.2.0.
0.2.0 #
- Exponential backoff for retries. A failed task is no longer re-enqueued
immediately: it goes into a per-queue delayed sorted set
(
<prefix>:<queue>:delayed) scored with the time it becomes due, and waitsmin(cap, base * 2^(retry-1))plus jitter before being retried. - Configurable backoff on
Worker.connect:backoffBase(default 1s),backoffCap(default 60s), andbackoffJitter(default 0.1). - The worker's poll loop now runs a due-mover each pass that promotes delayed
tasks whose score has passed back onto their pending list. The move is a
single atomic Redis Lua script (
ZRANGEBYSCORE+ZREM+LPUSH), so a task can't be lost or duplicated, even with multiple workers. - Dead-letter behaviour is unchanged; weighted-queue behaviour is unchanged.
0.1.0 #
- Initial release.
- Enqueue tasks from a producer, process them in a worker.
- Retries with a dead-letter list after maxRetries.
- Weighted queues to avoid starvation.