process: add source-map support to stack traces

PR-URL: #29564 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Oct 9, 2019 · ae8b2b4 · ae8b2b4
1 parent 9e5d691
commit ae8b2b4
Show file tree

Hide file tree

Showing 33 changed files with 729 additions and 22 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -135,6 +135,15 @@ added: v6.0.0
 Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
 `./configure --openssl-fips`.)
 
+### `--enable-source-maps`
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+Enable experimental Source Map V3 support for stack traces.
+
 ### `--es-module-specifier-resolution=mode`
 <!-- YAML
 added: v12.0.0
@@ -1007,6 +1016,7 @@ node --require "./a.js" --require "./b.js"
 Node.js options that are allowed are:
 <!-- node-options-node start -->
 * `--enable-fips`
+* `--enable-source-maps`
 * `--es-module-specifier-resolution`
 * `--experimental-exports`
 * `--experimental-loader`

diff --git a/lib/internal/bootstrap/pre_execution.js b/lib/internal/bootstrap/pre_execution.js
@@ -21,6 +21,15 @@ function prepareMainThreadExecution(expandArgv1 = false) {
       setupCoverageHooks(process.env.NODE_V8_COVERAGE);
   }
 
+  // If source-map support has been enabled, we substitute in a new
+  // prepareStackTrace method, replacing the default in errors.js.
+  if (getOptionValue('--enable-source-maps')) {
+    const { prepareStackTrace } =
+      require('internal/source_map/source_map_cache');
+    const { setPrepareStackTraceCallback } = internalBinding('errors');
+    setPrepareStackTraceCallback(prepareStackTrace);
+  }
+
   setupDebugEnv();
 
   // Only main thread receives signals.
@@ -119,7 +128,8 @@ function setupCoverageHooks(dir) {
   const cwd = require('internal/process/execution').tryGetCwd();
   const { resolve } = require('path');
   const coverageDirectory = resolve(cwd, dir);
-  const { sourceMapCacheToObject } = require('internal/source_map');
+  const { sourceMapCacheToObject } =
+    require('internal/source_map/source_map_cache');
 
   if (process.features.inspector) {
     internalBinding('profiler').setCoverageDirectory(coverageDirectory);

diff --git a/lib/internal/modules/cjs/loader.js b/lib/internal/modules/cjs/loader.js
@@ -31,7 +31,10 @@ const {
 } = primordials;
 
 const { NativeModule } = require('internal/bootstrap/loaders');
-const { maybeCacheSourceMap } = require('internal/source_map');
+const {
+  maybeCacheSourceMap,
+  rekeySourceMap
+} = require('internal/source_map/source_map_cache');
 const { pathToFileURL, fileURLToPath, URL } = require('internal/url');
 const { deprecate } = require('internal/util');
 const vm = require('vm');
@@ -52,6 +55,7 @@ const {
   loadNativeModule
 } = require('internal/modules/cjs/helpers');
 const { getOptionValue } = require('internal/options');
+const enableSourceMaps = getOptionValue('--enable-source-maps');
 const preserveSymlinks = getOptionValue('--preserve-symlinks');
 const preserveSymlinksMain = getOptionValue('--preserve-symlinks-main');
 const experimentalModules = getOptionValue('--experimental-modules');
@@ -708,7 +712,19 @@ Module._load = function(request, parent, isMain) {
 
   let threw = true;
   try {
-    module.load(filename);
+    // Intercept exceptions that occur during the first tick and rekey them
+    // on error instance rather than module instance (which will immediately be
+    // garbage collected).
+    if (enableSourceMaps) {
+      try {
+        module.load(filename);
+      } catch (err) {
+        rekeySourceMap(Module._cache[filename], err);
+        throw err; /* node-do-not-add-exception-line */
+      }
+    } else {
+      module.load(filename);
+    }
     threw = false;
   } finally {
     if (threw) {

diff --git a/lib/internal/modules/esm/translators.js b/lib/internal/modules/esm/translators.js
@@ -32,7 +32,7 @@ const {
 } = require('internal/errors').codes;
 const readFileAsync = promisify(fs.readFile);
 const JsonParse = JSON.parse;
-const { maybeCacheSourceMap } = require('internal/source_map');
+const { maybeCacheSourceMap } = require('internal/source_map/source_map_cache');
 
 const debug = debuglog('esm');