Home > OS >  How to gracefully shutdown bullmq when running inside an express server?
How to gracefully shutdown bullmq when running inside an express server?

Time:02-18

  • I have an express app which uses bullmq queues, schedulers and workers. Even after pressing Ctrl C I can still see the node process running inside my Activity manager but my server on the terminal shuts down. I know this because the bullmq task starts outputting console.log statements even after the server is down to the terminal.

This is what my server.js file looks like

// eslint-disable-next-line import/first
import http from 'http';
import { app } from './app';
import { sessionParser } from './session';
import { websocketServer } from './ws';
import 'jobs/repeatable';

const server = http.createServer(app);

server.on('upgrade', (request, socket, head) => {
  sessionParser(request, {}, () => {
    websocketServer.handleUpgrade(request, socket, head, (ws) => {
      websocketServer.emit('connection', ws, request);
    });
  });
});

server.on('listening', () => {
  websocketServer.emit('listening');
});

server.on('close', () => {
  websocketServer.emit('close');
});

// https://stackoverflow.com/questions/18692536/node-js-server-close-event-doesnt-appear-to-fire
process.on('SIGINT', () => {
  server.close();
});

export { server };

Notice that I have a SIGINT handler defined above. Is this the reason my jobs are not exiting? Do I have to manually close every queue, worker and scheduler inside my SIGINT? My jobs/repeatable.js file looks as shown below

const { scheduleJobs } = require('jobs');

if (process.env.ENABLE_JOB_QUEUE === 'true') {
  scheduleJobs();
}

Here is my jobs.js file

import { scheduleDeleteExpiredTokensJob } from './delete-expired-tokens';
import { scheduleDeleteNullVotesJob } from './delete-null-votes';

export async function scheduleJobs() {
  await scheduleDeleteExpiredTokensJob();
  await scheduleDeleteNullVotesJob();
}

Here is my delete-expired-tokens.js file, other one is quite similar

import { processor as deleteExpiredTokensProcessor } from './processor';
import { queue as deleteExpiredTokensQueue } from './queue';
import { scheduler as deleteExpiredTokensScheduler } from './scheduler';
import { worker as deleteExpiredTokensWorker } from './worker';

export async function scheduleDeleteExpiredTokensJob() {
  const jobId = process.env.QUEUE_DELETE_EXPIRED_TOKENS_JOB_ID;
  const jobName = process.env.QUEUE_DELETE_EXPIRED_TOKENS_JOB_NAME;
  await deleteExpiredTokensQueue.add(jobName, null, {
    repeat: {
      cron: process.env.QUEUE_DELETE_EXPIRED_TOKENS_FREQUENCY,
      jobId,
    },
  });
}

export {
  deleteExpiredTokensProcessor,
  deleteExpiredTokensQueue,
  deleteExpiredTokensScheduler,
  deleteExpiredTokensWorker,
};

How do I shutdown bullmq task queues gracefully?

CodePudding user response:

You have to call the close() method on the workers:

server.on('close', async () => {
  websocketServer.emit('close');
  // Close the workers
  await worker.close()
});

Docs

  • Related