Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
fastify-queue
Advanced tools
Plugin to easily intergrate BullMQ into fastify through file based Queue/Worker creation.
Weekly downloads
Readme
Plugin to easily intergrate BullMQ into fastify through file based Queue/Worker creation.
npm i fastify-queue
npm i bullmq
import fp from 'fastify-plugin';
import queue, { FastifyQueueOptions } from 'fastify-queue';
import * as IORedis from 'ioredis';
export default fp<FastifyQueueOptions>(async (fastify, opts) => {
const connection = new IORedis({
maxRetriesPerRequest: null,
enableReadyCheck: false,
});
fastify.register(queue, {
bullPath: '*/bull/**/*.js',
connection: connection,
});
});
bullPath
The bullPath
is a glob path and it specifies in which directory your worker functions and queues can be found.
For example with the folder structure below, we would create a Queue
with the name of user
and auth
.
src
- bull
- user
profile.worker.ts
- auth
auth.worker.ts
The name of the file inside the subdiretories is irrelevant. The name of the Queue is based on the subdirectories name.
If the file inside the subdiretories do not export a default function, it will just create a Queue
with the name of the subdiretory. If a defualt function export exists it will be used as the Worker
.
This is an example for a Worker function that accepts a fastify instance and a BullMQ
job. Needs to be the default export.
import { FastifyInstance } from 'fastify';
import { Job } from 'bullmq';
interface AuthData {
id: string;
username?: string;
email?: string;
}
const authWorker = async (
fastify: FastifyInstance,
job: Job<AuthData, any, string>
) => {
const { id, email, username } = job.data;
switch (job.name) {
case 'create':
break;
case 'update':
// handle jobs based on job name
break;
case 'delete':
break;
default:
break;
}
};
export default authWorker;
You can export two addittional variables besides your Worker Function named queueConfig
and workerConfig
. They are of type QueueOptions and WorkerOptions and if exist, can be used to configure addtional options supported by BullMQ
.
export const queueConfig: QueueOptions = {
defaultJobOptions: {
removeOnComplete: true,
},
};
export const workerConfig: WorkerOptions = {
autorun: true,
// connection would override default connection defined in plugin options
};
In order to have typing for the fastify instance, you should follow the example below: This is the typing for the folder structure above if each file exports a worker function
declare module 'fastify' {
export interface FastifyInstance {
queues: {
profile: Queue<ProfileData, any, string>;
auth: Queue<AuthData, any, string>;
};
workers: {
profile: Queue<ProfileData, any, string>;
auth: Worker<AuthData, any, string>;
};
}
}
FAQs
Plugin to easily intergrate BullMQ into fastify through file based Queue/Worker creation.
The npm package fastify-queue receives a total of 153 weekly downloads. As such, fastify-queue popularity was classified as not popular.
We found that fastify-queue demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.