From d8ce9a0e234660d268f60fb55b156aebfaf29310 Mon Sep 17 00:00:00 2001
From: legendecas <legendecas@gmail.com>
Date: Sun, 17 Nov 2019 20:02:01 +0800
Subject: [PATCH] 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: https://github.com/nodejs/node/pull/30516
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
---
 doc/api/cli.md                   |  9 +++++
 doc/node.1                       |  4 +++
 src/env.cc                       | 15 ++++++++
 src/node_options.cc              |  4 +++
 src/node_options.h               |  1 +
 test/parallel/test-trace-exit.js | 59 ++++++++++++++++++++++++++++++++
 6 files changed, 92 insertions(+)
 create mode 100644 test/parallel/test-trace-exit.js

diff --git a/doc/api/cli.md b/doc/api/cli.md
index 3e7ccc1133c858..37065087e17f53 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -784,6 +784,14 @@ added: v7.7.0
 
 Enables the collection of trace event tracing information.
 
+### `--trace-exit`
+<!-- YAML
+added: REPLACEME
+-->
+
+Prints a stack trace whenever an environment is exited proactively,
+i.e. invoking `process.exit()`.
+
 ### `--trace-sync-io`
 <!-- YAML
 added: v2.1.0
@@ -1112,6 +1120,7 @@ Node.js options that are allowed are:
 * `--trace-event-categories`
 * `--trace-event-file-pattern`
 * `--trace-events-enabled`
+* `--trace-exit`
 * `--trace-sync-io`
 * `--trace-tls`
 * `--trace-uncaught`
diff --git a/doc/node.1 b/doc/node.1
index 5ea38be56e9f37..255f6746abf3f3 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -355,6 +355,10 @@ and
 .It Fl -trace-events-enabled
 Enable the collection of trace event tracing information.
 .
+.It Fl -trace-exit
+Prints a stack trace whenever an environment is exited proactively,
+i.e. invoking `process.exit()`.
+.
 .It Fl -trace-sync-io
 Print a stack trace whenever synchronous I/O is detected after the first turn of the event loop.
 .
diff --git a/src/env.cc b/src/env.cc
index bf3420f826f02a..f3d71c61c09fce 100644
--- a/src/env.cc
+++ b/src/env.cc
@@ -940,6 +940,21 @@ void AsyncHooks::grow_async_ids_stack() {
 uv_key_t Environment::thread_local_env = {};
 
 void Environment::Exit(int exit_code) {
+  if (options()->trace_exit) {
+    HandleScope handle_scope(isolate());
+
+    if (is_main_thread()) {
+      fprintf(stderr, "(node:%d) ", uv_os_getpid());
+    } else {
+      fprintf(stderr, "(node:%d, thread:%llu) ", uv_os_getpid(), thread_id());
+    }
+
+    fprintf(
+        stderr, "WARNING: Exited the environment with code %d\n", exit_code);
+    PrintStackTrace(
+        isolate(),
+        StackTrace::CurrentStackTrace(isolate(), 10, StackTrace::kDetailed));
+  }
   if (is_main_thread()) {
     stop_sub_worker_contexts();
     DisposePlatform();
diff --git a/src/node_options.cc b/src/node_options.cc
index 831540f993fcb5..ff3bf9b4edd876 100644
--- a/src/node_options.cc
+++ b/src/node_options.cc
@@ -480,6 +480,10 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
             "show stack traces on deprecations",
             &EnvironmentOptions::trace_deprecation,
             kAllowedInEnvironment);
+  AddOption("--trace-exit",
+            "show stack trace when an environment exits",
+            &EnvironmentOptions::trace_exit,
+            kAllowedInEnvironment);
   AddOption("--trace-sync-io",
             "show stack trace when use of sync IO is detected after the "
             "first tick",
diff --git a/src/node_options.h b/src/node_options.h
index c3ef78fd5bca0c..633d57253696d7 100644
--- a/src/node_options.h
+++ b/src/node_options.h
@@ -141,6 +141,7 @@ class EnvironmentOptions : public Options {
   bool test_udp_no_try_send = false;
   bool throw_deprecation = false;
   bool trace_deprecation = false;
+  bool trace_exit = false;
   bool trace_sync_io = false;
   bool trace_tls = false;
   bool trace_uncaught = false;
diff --git a/test/parallel/test-trace-exit.js b/test/parallel/test-trace-exit.js
new file mode 100644
index 00000000000000..237512ac273db1
--- /dev/null
+++ b/test/parallel/test-trace-exit.js
@@ -0,0 +1,59 @@
+'use strict';
+const common = require('../common');
+const assert = require('assert');
+const { promisify } = require('util');
+const execFile = promisify(require('child_process').execFile);
+const { Worker, isMainThread, workerData } = require('worker_threads');
+
+const variant = process.argv[process.argv.length - 1];
+switch (true) {
+  case variant === 'main-thread': {
+    return;
+  }
+  case variant === 'main-thread-exit': {
+    return process.exit(0);
+  }
+  case variant.startsWith('worker-thread'): {
+    const worker = new Worker(__filename, { workerData: variant });
+    worker.on('error', common.mustNotCall());
+    worker.on('exit', common.mustCall((code) => {
+      assert.strictEqual(code, 0);
+    }));
+    return;
+  }
+  case !isMainThread: {
+    if (workerData === 'worker-thread-exit') {
+      process.exit(0);
+    }
+    return;
+  }
+}
+
+(async function() {
+  for (const { execArgv, variant, warnings } of [
+    { execArgv: ['--trace-exit'], variant: 'main-thread-exit', warnings: 1 },
+    { execArgv: [], variant: 'main-thread-exit', warnings: 0 },
+    { execArgv: ['--trace-exit'], variant: 'main-thread', warnings: 0 },
+    { execArgv: [], variant: 'main-thread', warnings: 0 },
+    { execArgv: ['--trace-exit'], variant: 'worker-thread-exit', warnings: 1 },
+    { execArgv: [], variant: 'worker-thread-exit', warnings: 0 },
+    { execArgv: ['--trace-exit'], variant: 'worker-thread', warnings: 0 },
+    { execArgv: [], variant: 'worker-thread', warnings: 0 },
+  ]) {
+    const { stdout, stderr } =
+      await execFile(process.execPath, [...execArgv, __filename, variant]);
+    assert.strictEqual(stdout, '');
+    const actualWarnings =
+      stderr.match(/WARNING: Exited the environment with code 0/g);
+    if (warnings === 0) {
+      assert.strictEqual(actualWarnings, null);
+      return;
+    }
+    assert.strictEqual(actualWarnings.length, warnings);
+
+    if (variant.startsWith('worker')) {
+      const workerIds = stderr.match(/\(node:\d+, thread:\d+)/g);
+      assert.strictEqual(workerIds.length, warnings);
+    }
+  }
+})().then(common.mustCall());