From 614f48838626e2af8e3f2e76ee4a144af2d40f72 Mon Sep 17 00:00:00 2001
From: Tomi Turtiainen <10324676+tomi@users.noreply.github.com>
Date: Mon, 18 Dec 2023 14:04:19 +0200
Subject: [PATCH] feat(core): Add N8N_GRACEFUL_SHUTDOWN_TIMEOUT env var (#8068)

Add generic N8N_GRACEFUL_SHUTDOWN_TIMEOUT which controls how long n8n
process will wait for graceful exit before exitting forcefully. This
variables replaces the QUEUE_WORKER_TIMEOUT variable that was used for
worker process.

DEPRECATED: QUEUE_WORKER_TIMEOUT deprected

QUEUE_WORKER_TIMEOUT environment variable has been replaced with
N8N_GRACEFUL_SHUTDOWN_TIMEOUT.
---
 packages/cli/src/commands/BaseCommand.ts | 3 +--
 packages/cli/src/commands/worker.ts      | 8 +++++++-
 packages/cli/src/config/schema.ts        | 9 ++++++++-
 3 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/packages/cli/src/commands/BaseCommand.ts b/packages/cli/src/commands/BaseCommand.ts
index 6f2d03c482..1949bc6f69 100644
--- a/packages/cli/src/commands/BaseCommand.ts
+++ b/packages/cli/src/commands/BaseCommand.ts
@@ -42,9 +42,8 @@ export abstract class BaseCommand extends Command {
 
 	/**
 	 * How long to wait for graceful shutdown before force killing the process.
-	 * Subclasses can override this value.
 	 */
-	protected gracefulShutdownTimeoutInS: number = 30;
+	protected gracefulShutdownTimeoutInS: number = config.getEnv('generic.gracefulShutdownTimeout');
 
 	async init(): Promise<void> {
 		await initErrorHandling();
diff --git a/packages/cli/src/commands/worker.ts b/packages/cli/src/commands/worker.ts
index d868e5c323..31a862dfd8 100644
--- a/packages/cli/src/commands/worker.ts
+++ b/packages/cli/src/commands/worker.ts
@@ -264,7 +264,13 @@ export class Worker extends BaseCommand {
 	}
 
 	async init() {
-		this.gracefulShutdownTimeoutInS = config.getEnv('queue.bull.gracefulShutdownTimeout');
+		const configuredShutdownTimeout = config.getEnv('queue.bull.gracefulShutdownTimeout');
+		if (configuredShutdownTimeout) {
+			this.gracefulShutdownTimeoutInS = configuredShutdownTimeout;
+			this.logger.warn(
+				'QUEUE_WORKER_TIMEOUT has been deprecated. Rename it to N8N_GRACEFUL_SHUTDOWN_TIMEOUT.',
+			);
+		}
 		await this.initCrashJournal();
 
 		this.logger.debug('Starting n8n worker...');
diff --git a/packages/cli/src/config/schema.ts b/packages/cli/src/config/schema.ts
index af82b2484f..3673c3f864 100644
--- a/packages/cli/src/config/schema.ts
+++ b/packages/cli/src/config/schema.ts
@@ -439,7 +439,7 @@ export const schema = {
 				env: 'QUEUE_RECOVERY_INTERVAL',
 			},
 			gracefulShutdownTimeout: {
-				doc: 'How long should n8n wait for running executions before exiting worker process (seconds)',
+				doc: '[DEPRECATED] (Use N8N_GRACEFUL_SHUTDOWN_TIMEOUT instead) How long should n8n wait for running executions before exiting worker process (seconds)',
 				format: Number,
 				default: 30,
 				env: 'QUEUE_WORKER_TIMEOUT',
@@ -497,6 +497,13 @@ export const schema = {
 			default: 'dev',
 			env: 'N8N_RELEASE_TYPE',
 		},
+
+		gracefulShutdownTimeout: {
+			doc: 'How long should n8n process wait for components to shut down before exiting the process (seconds)',
+			format: Number,
+			default: 30,
+			env: 'N8N_GRACEFUL_SHUTDOWN_TIMEOUT',
+		},
 	},
 
 	// How n8n can be reached (Editor & REST-API)