Add forceExit CLI flag (#5195)

raphael-theriault-swi · lukastaegert · web-flow · commit 20a64a11d080 · 2023-11-03T05:26:00.000Z
* add forceExit flag

* reword forceExit docs

* add forceExit test

---------

Co-authored-by: Lukas Taegert-Atkinson &lt;lukastaegert@users.noreply.github.com&gt;
diff --git a/cli/cli.ts b/cli/cli.ts
@@ -23,5 +23,9 @@ if (command.help || (process.argv.length <= 2 && process.stdin.isTTY)) {
 		// do nothing
 	}
 
-	run(command);
+	const promise = run(command);
+	if (command.forceExit) {
+		// eslint-disable-next-line unicorn/no-process-exit
+		promise.then(() => process.exit());
+	}
 }
diff --git a/cli/help.md b/cli/help.md
@@ -40,6 +40,7 @@ Basic options:
 --failAfterWarnings         Exit with an error if the build produced warnings
 --filterLogs <filter>       Filter log messages
 --footer <text>             Code to insert at end of bundle (outside wrapper)
+--forceExit                 Force exit the process when done
 --no-freeze                 Do not freeze namespace objects
 --generatedCode <preset>    Which code features to use (es5/es2015)
 --generatedCode.arrowFunctions Use arrow functions in generated code
diff --git a/docs/command-line-interface/index.md b/docs/command-line-interface/index.md
@@ -390,6 +390,7 @@ Many options have command line equivalents. In those cases, any arguments passed
 --failAfterWarnings         Exit with an error if the build produced warnings
 --filterLogs <filter>       Filter log messages
 --footer <text>             Code to insert at end of bundle (outside wrapper)
+--forceExit                 Force exit the process when done
 --no-freeze                 Do not freeze namespace objects
 --generatedCode <preset>    Which code features to use (es5/es2015)
 --generatedCode.arrowFunctions Use arrow functions in generated code
@@ -556,6 +557,12 @@ There is also some advanced syntax available for more complex filters.
 
   will only display logs where the property `log.foo.bar` has the value `"value"`.
 
+### `--forceExit`
+
+Force exit the process when done. In some cases plugins or their dependencies might not cleanup properly and prevent the CLI process from exiting. The root cause can be hard to diagnose and this flag provides an escape hatch until it can be identified and resolved.
+
+Note that this might break certain workflows and won't always work properly.
+
 ### `-h`/`--help`
 
 Print the help document.
diff --git a/test/cli/samples/force-exit/_config.js b/test/cli/samples/force-exit/_config.js
@@ -0,0 +1,5 @@
+module.exports = defineTest({
+	description: 'force exits even with open handles',
+	command: 'rollup --config rollup.config.js --forceExit',
+	execute: true
+});
diff --git a/test/cli/samples/force-exit/main.js b/test/cli/samples/force-exit/main.js
diff --git a/test/cli/samples/force-exit/rollup.config.js b/test/cli/samples/force-exit/rollup.config.js
@@ -0,0 +1,16 @@
+module.exports = {
+	input: 'main.js',
+	output: {
+		format: 'cjs'
+	},
+	plugins: [
+		{
+			name: 'open-handles',
+			buildStart() {
+				setInterval(() => {
+					// hang forever
+				}, 2 ** 24);
+			}
+		}
+	]
+};

Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,9 @@ if (command.help \|\| (process.argv.length <= 2 && process.stdin.isTTY)) {`
`23`	`23`	`// do nothing`
`24`	`24`	`}`
`25`	`25`
`26`		`- run(command);`
	`26`	`+ const promise = run(command);`
	`27`	`+ if (command.forceExit) {`
	`28`	`+ // eslint-disable-next-line unicorn/no-process-exit`
	`29`	`+ promise.then(() => process.exit());`
	`30`	`+ }`
`27`	`31`	`}`