WakaQ

Features

Installing

npm i --save wakaq

Using

import{Duration}from'ts-duration';import{CronTask,WakaQ,WakaQueue,WakaQWorker}from'wakaq';import{z}from'zod';import{prisma}from'./db';exportconstwakaq=newWakaQ({/* Raise SoftTimeout in a task if it runs longer than 14 minutes. Can also be set per     task or queue. If no soft timeout set, tasks can run forever.  */softTimeout:Duration.minute(14),/* SIGKILL a task if it runs longer than 15 minutes. Can also be set per queue or     when enqueuing a task.  */hardTimeout:Duration.minute(15),/* Number of worker processes. Must be an int or str which evaluates to an     int. The variable "cores" is replaced with the number of processors on     the current machine.  */concurrency:'cores*4',/* List your queues and their priorities.  */queues:[newWakaQueue('high priority'),newWakaQueue('default'),],/* Redis normally doesn't use TLS, but some cloud providers need it.  */tls:process.env.NODE_ENV=='production' ?{cert:'',key:''} :undefined,/* If the task soft timeouts, retry up to 3 times. Max retries comes first     from the task decorator if set, next from the Queue's maxRetries,     lastly from the option below. If No maxRetries is found, the task     is not retried on a soft timeout.  */maxRetries:3,/* Schedule two tasks, the first runs every minute, the second once every ten minutes.     To run scheduled tasks you must keep `npm run scheduler` running as a daemon.  */schedules:[// Runs myTask once every 5 minutes.newCronTask('*/5 * * * *','myTask'),],});exportconstcreateUserInBackground=wakaq.task(async(firstName:string)=>{constname=z.string().safeParse(firstName);if(!result.success){thrownewError(result.error.message);}awaitprisma.User.create({data:{firstName:result.data},});},{name:'createUserInBackground'},);

{"scripts": {"worker":"tsx scripts/wakaqWorker.ts","scheduler":"tsx scripts/wakaqScheduler.ts","info":"tsx scripts/wakaqInfo.ts","purge":"tsx scripts/wakaqPurge.ts"  }}

import{WakaQWorker}from'wakaq';import{wakaq}from'../app.js';// Can't use tsx directly because it breaks IPC (https://github.com/esbuild-kit/tsx/issues/201)awaitnewWakaQWorker(wakaq,['node','--no-warnings=ExperimentalWarning','--import','tsx','scripts/wakaqChild.ts']).start();process.exit(0);

import{WakaQScheduler}from'wakaq';import{wakaq}from'../app.js';awaitnewWakaQScheduler(wakaq).start();process.exit(0);

import{WakaQChildWorker}from'wakaq';import{wakaq}from'../app.js';// import your tasks so they're registered// also make sure to enable tsc option verbatimModuleSyntaxawaitnewWakaQChildWorker(wakaq).start();process.exit(0);

import{inspect}from'wakaq';import{wakaq}from'../app.js';console.log(JSON.stringify(awaitinspect(awaitwakaq.connect()),null,2));wakaq.disconnect();

import{numPendingTasksInQueue,numPendingEtaTasksInQueue,purgeQueue,purgeEtaQueue}from'wakaq';import{wakaq}from'../app.js';constqueueName=process.argv.slice(2)[0];constqueue=wakaq.queuesByName.get(queueName??'');if(!queue){thrownewError(`Queue not found:${queueName}`);}awaitwakaq.connect();letcount=awaitnumPendingTasksInQueue(wakaq,queue);awaitpurgeQueue(wakaq,queue);count+=awaitnumPendingEtaTasksInQueue(wakaq,queue);awaitpurgeEtaQueue(wakaq,queue);console.log(`Purged${count} tasks from${queue.name}`);wakaq.disconnect();

Deploying

Optimizing

Running as a Daemon

[Unit]Description=WakaQ Worker Service[Service]WorkingDirectory=/opt/yourappExecStart=npm run workerRemainAfterExit=noRestart=alwaysRestartSec=30sKillSignal=SIGINTLimitNOFILE=99999[Install]WantedBy=multi-user.target

systemctl daemon-reload && systemctl enable wakaqworker