FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

cli: add --trace-exit cli option · nodejs/node@8dc4e4e · GitHub

/ node Public

Commit 8dc4e4e

Browse files
legendecas
authored and
BethGriggs
committed
cli: add --trace-exit cli option
It could be convenient to trace abnormal exit of the Node.js processes that printing stacktrace on each `process.exit` call with a cli option. This also takes effects on worker threads. PR-URL: #30516 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 1bcbc70 commit 8dc4e4e

6 files changed

Lines changed: 92 additions & 0 deletions

File tree

‎doc/api/cli.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -796,6 +796,14 @@ added: v7.7.0
796796

797797
Enables the collection of trace event tracing information.
798798

799+
### `--trace-exit`
800+
<!-- YAML
801+
added: REPLACEME
802+
-->
803+
804+
Prints a stack trace whenever an environment is exited proactively,
805+
i.e. invoking `process.exit()`.
806+
799807
### `--trace-sync-io`
800808
<!-- YAML
801809
added: v2.1.0
@@ -1139,6 +1147,7 @@ Node.js options that are allowed are:
11391147
* `--trace-event-categories`
11401148
* `--trace-event-file-pattern`
11411149
* `--trace-events-enabled`
1150+
* `--trace-exit`
11421151
* `--trace-sync-io`
11431152
* `--trace-tls`
11441153
* `--trace-uncaught`

‎doc/node.1‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,10 @@ and
359359
.It Fl -trace-events-enabled
360360
Enable the collection of trace event tracing information.
361361
.
362+
.It Fl -trace-exit
363+
Prints a stack trace whenever an environment is exited proactively,
364+
i.e. invoking `process.exit()`.
365+
.
362366
.It Fl -trace-sync-io
363367
Print a stack trace whenever synchronous I/O is detected after the first turn of the event loop.
364368
.

‎src/env.cc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -931,6 +931,21 @@ void AsyncHooks::grow_async_ids_stack() {
931931
uv_key_t Environment::thread_local_env = {};
932932

933933
void Environment::Exit(int exit_code) {
934+
if (options()->trace_exit) {
935+
HandleScope handle_scope(isolate());
936+
937+
if (is_main_thread()) {
938+
fprintf(stderr, "(node:%d) ", uv_os_getpid());
939+
} else {
940+
fprintf(stderr, "(node:%d, thread:%llu) ", uv_os_getpid(), thread_id());
941+
}
942+
943+
fprintf(
944+
stderr, "WARNING: Exited the environment with code %d\n", exit_code);
945+
PrintStackTrace(
946+
isolate(),
947+
StackTrace::CurrentStackTrace(isolate(), 10, StackTrace::kDetailed));
948+
}
934949
if (is_main_thread()) {
935950
stop_sub_worker_contexts();
936951
DisposePlatform();

‎src/node_options.cc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,10 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
515515
"show stack traces on deprecations",
516516
&EnvironmentOptions::trace_deprecation,
517517
kAllowedInEnvironment);
518+
AddOption("--trace-exit",
519+
"show stack trace when an environment exits",
520+
&EnvironmentOptions::trace_exit,
521+
kAllowedInEnvironment);
518522
AddOption("--trace-sync-io",
519523
"show stack trace when use of sync IO is detected after the "
520524
"first tick",

‎src/node_options.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ class EnvironmentOptions : public Options {
142142
bool test_udp_no_try_send = false;
143143
bool throw_deprecation = false;
144144
bool trace_deprecation = false;
145+
bool trace_exit = false;
145146
bool trace_sync_io = false;
146147
bool trace_tls = false;
147148
bool trace_uncaught = false;

‎test/parallel/test-trace-exit.js‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
'use strict';
2+
const common = require('../common');
3+
const assert = require('assert');
4+
const { promisify } = require('util');
5+
const execFile = promisify(require('child_process').execFile);
6+
const { Worker, isMainThread, workerData } = require('worker_threads');
7+
8+
const variant = process.argv[process.argv.length - 1];
9+
switch (true) {
10+
case variant === 'main-thread': {
11+
return;
12+
}
13+
case variant === 'main-thread-exit': {
14+
return process.exit(0);
15+
}
16+
case variant.startsWith('worker-thread'): {
17+
const worker = new Worker(__filename, { workerData: variant });
18+
worker.on('error', common.mustNotCall());
19+
worker.on('exit', common.mustCall((code) => {
20+
assert.strictEqual(code, 0);
21+
}));
22+
return;
23+
}
24+
case !isMainThread: {
25+
if (workerData === 'worker-thread-exit') {
26+
process.exit(0);
27+
}
28+
return;
29+
}
30+
}
31+
32+
(async function() {
33+
for (const { execArgv, variant, warnings } of [
34+
{ execArgv: ['--trace-exit'], variant: 'main-thread-exit', warnings: 1 },
35+
{ execArgv: [], variant: 'main-thread-exit', warnings: 0 },
36+
{ execArgv: ['--trace-exit'], variant: 'main-thread', warnings: 0 },
37+
{ execArgv: [], variant: 'main-thread', warnings: 0 },
38+
{ execArgv: ['--trace-exit'], variant: 'worker-thread-exit', warnings: 1 },
39+
{ execArgv: [], variant: 'worker-thread-exit', warnings: 0 },
40+
{ execArgv: ['--trace-exit'], variant: 'worker-thread', warnings: 0 },
41+
{ execArgv: [], variant: 'worker-thread', warnings: 0 },
42+
]) {
43+
const { stdout, stderr } =
44+
await execFile(process.execPath, [...execArgv, __filename, variant]);
45+
assert.strictEqual(stdout, '');
46+
const actualWarnings =
47+
stderr.match(/WARNING: Exited the environment with code 0/g);
48+
if (warnings === 0) {
49+
assert.strictEqual(actualWarnings, null);
50+
return;
51+
}
52+
assert.strictEqual(actualWarnings.length, warnings);
53+
54+
if (variant.startsWith('worker')) {
55+
const workerIds = stderr.match(/\(node:\d+, thread:\d+)/g);
56+
assert.strictEqual(workerIds.length, warnings);
57+
}
58+
}
59+
})().then(common.mustCall());

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL