Skip to content

Commit 5ce717b

Browse files
MoonBallthedull
authored andcommitted
esm: make process.exit() default to exit code 0
Due to a bug in top-level await implementation, it used to default to exit code 13. PR-URL: nodejs#41388 Fixes: nodejs#40808 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com>
1 parent caae8dd commit 5ce717b

File tree

7 files changed

+51
-9
lines changed

7 files changed

+51
-9
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
'use strict';
2+
3+
// Handle a Promise from running code that potentially does Top-Level Await.
4+
// In that case, it makes sense to set the exit code to a specific non-zero
5+
// value if the main code never finishes running.
6+
function handleProcessExit() {
7+
process.exitCode ??= 13;
8+
}
9+
10+
module.exports = {
11+
handleProcessExit,
12+
};

lib/internal/modules/run_main.js

+5-9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ const CJSLoader = require('internal/modules/cjs/loader');
88
const { Module, toRealPath, readPackageScope } = CJSLoader;
99
const { getOptionValue } = require('internal/options');
1010
const path = require('path');
11+
const {
12+
handleProcessExit,
13+
} = require('internal/modules/esm/handle_process_exit');
1114

1215
function resolveMainPath(main) {
1316
// Note extension resolution for the main entry point can be deprecated in a
@@ -53,18 +56,11 @@ function runMainESM(mainPath) {
5356
}
5457

5558
async function handleMainPromise(promise) {
56-
// Handle a Promise from running code that potentially does Top-Level Await.
57-
// In that case, it makes sense to set the exit code to a specific non-zero
58-
// value if the main code never finishes running.
59-
function handler() {
60-
if (process.exitCode === undefined)
61-
process.exitCode = 13;
62-
}
63-
process.on('exit', handler);
59+
process.on('exit', handleProcessExit);
6460
try {
6561
return await promise;
6662
} finally {
67-
process.off('exit', handler);
63+
process.off('exit', handleProcessExit);
6864
}
6965
}
7066

lib/internal/process/per_thread.js

+6
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ const {
4848
} = require('internal/validators');
4949
const constants = internalBinding('constants').os.signals;
5050

51+
const {
52+
handleProcessExit,
53+
} = require('internal/modules/esm/handle_process_exit');
54+
5155
const kInternal = Symbol('internal properties');
5256

5357
function assert(x, msg) {
@@ -175,6 +179,8 @@ function wrapProcessMethods(binding) {
175179
memoryUsage.rss = rss;
176180

177181
function exit(code) {
182+
process.off('exit', handleProcessExit);
183+
178184
if (code || code === 0)
179185
process.exitCode = code;
180186

test/es-module/test-esm-tla-unfinished.mjs

+18
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,21 @@ import fixtures from '../common/fixtures.js';
8080
assert.deepStrictEqual([status, stdout], [1, '']);
8181
assert.match(stderr, /Error: Xyz/);
8282
}
83+
84+
{
85+
// Calling process.exit() in .mjs should return status 0
86+
const { status, stdout, stderr } = child_process.spawnSync(
87+
process.execPath,
88+
[fixtures.path('es-modules/tla/process-exit.mjs')],
89+
{ encoding: 'utf8' });
90+
assert.deepStrictEqual([status, stdout, stderr], [0, '', '']);
91+
}
92+
93+
{
94+
// Calling process.exit() in worker thread shouldn't influence main thread
95+
const { status, stdout, stderr } = child_process.spawnSync(
96+
process.execPath,
97+
[fixtures.path('es-modules/tla/unresolved-with-worker-process-exit.mjs')],
98+
{ encoding: 'utf8' });
99+
assert.deepStrictEqual([status, stdout, stderr], [13, '', '']);
100+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
process.exit();
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { Worker, isMainThread } from 'worker_threads';
2+
3+
if (isMainThread) {
4+
new Worker(new URL(import.meta.url));
5+
await new Promise(() => {});
6+
} else {
7+
process.exit();
8+
}

test/parallel/test-bootstrap-modules.js

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ const expectedModules = new Set([
7979
'NativeModule internal/modules/esm/resolve',
8080
'NativeModule internal/modules/esm/initialize_import_meta',
8181
'NativeModule internal/modules/esm/translators',
82+
'NativeModule internal/modules/esm/handle_process_exit',
8283
'NativeModule internal/process/esm_loader',
8384
'NativeModule internal/options',
8485
'NativeModule internal/perf/event_loop_delay',

0 commit comments

Comments
 (0)