Skip to content

Commit

Permalink
fix(core): Ensure graceful shutdown for workers (n8n-io#9547)
Browse files Browse the repository at this point in the history
  • Loading branch information
ivov authored May 31, 2024
1 parent c5e0cf0 commit 7fc00d8
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 7 deletions.
7 changes: 5 additions & 2 deletions packages/cli/src/Queue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,11 @@ export class Queue {
return await this.jobQueue.client.ping();
}

async pause(isLocal?: boolean): Promise<void> {
return await this.jobQueue.pause(isLocal);
async pause({
isLocal,
doNotWaitActive,
}: { isLocal?: boolean; doNotWaitActive?: boolean } = {}): Promise<void> {
return await this.jobQueue.pause(isLocal, doNotWaitActive);
}

getBullObjectInstance(): JobQueue {
Expand Down
20 changes: 15 additions & 5 deletions packages/cli/src/commands/worker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,23 +63,23 @@ export class Worker extends BaseCommand {
async stopProcess() {
this.logger.info('Stopping n8n...');

// Stop accepting new jobs
await Worker.jobQueue.pause(true);
// Stop accepting new jobs, `doNotWaitActive` allows reporting progress
await Worker.jobQueue.pause({ isLocal: true, doNotWaitActive: true });

try {
await this.externalHooks?.run('n8n.stop', []);

const hardStopTime = Date.now() + this.gracefulShutdownTimeoutInS;
const hardStopTimeMs = Date.now() + this.gracefulShutdownTimeoutInS * 1000;

// Wait for active workflow executions to finish
let count = 0;
while (Object.keys(Worker.runningJobs).length !== 0) {
if (count++ % 4 === 0) {
const waitLeft = Math.ceil((hardStopTime - Date.now()) / 1000);
const waitLeft = Math.ceil((hardStopTimeMs - Date.now()) / 1000);
this.logger.info(
`Waiting for ${
Object.keys(Worker.runningJobs).length
} active executions to finish... (wait ${waitLeft} more seconds)`,
} active executions to finish... (max wait ${waitLeft} more seconds)`,
);
}

Expand Down Expand Up @@ -483,6 +483,16 @@ export class Worker extends BaseCommand {
await this.setupHealthMonitor();
}

if (process.stdout.isTTY) {
process.stdin.setRawMode(true);
process.stdin.resume();
process.stdin.setEncoding('utf8');

process.stdin.on('data', (key: string) => {
if (key.charCodeAt(0) === 3) process.kill(process.pid, 'SIGINT'); // ctrl+c
});
}

// Make sure that the process does not close
await new Promise(() => {});
}
Expand Down

0 comments on commit 7fc00d8

Please sign in to comment.