lib: add api to detect whether source-maps are enabled

Add `process.sourceMapsEnabled` to detect whether source-maps are enabled. Fixes: #46304 PR-URL: #46391 Reviewed-By: Chemi Atlow <[email protected]>
nodejs · Sep 10, 2023 · 11c85ff · 11c85ff
1 parent 6ee74be
commit 11c85ff
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 0 deletions.
diff --git a/doc/api/process.md b/doc/api/process.md
@@ -3517,6 +3517,19 @@ throw an error.
 Using this function is mutually exclusive with using the deprecated
 [`domain`][] built-in module.
 
+## `process.sourceMapsEnabled`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+* {boolean}
+
+The `process.sourceMapsEnabled` property returns whether the
+[Source Map v3][Source Map] support for stack traces is enabled.
+
 ## `process.stderr`
 
 * {Stream}

diff --git a/lib/internal/bootstrap/node.js b/lib/internal/bootstrap/node.js
@@ -326,13 +326,22 @@ process.emitWarning = emitWarning;
 
 {
   const {
+    getSourceMapsEnabled,
     setSourceMapsEnabled,
     maybeCacheGeneratedSourceMap,
   } = require('internal/source_map/source_map_cache');
   const {
     setMaybeCacheGeneratedSourceMap,
   } = internalBinding('errors');
 
+  ObjectDefineProperty(process, 'sourceMapsEnabled', {
+    __proto__: null,
+    enumerable: true,
+    configurable: true,
+    get() {
+      return getSourceMapsEnabled();
+    },
+  });
   process.setSourceMapsEnabled = setSourceMapsEnabled;
   // The C++ land calls back to maybeCacheGeneratedSourceMap()
   // when code is generated by user with eval() or new Function()

diff --git a/test/fixtures/source-map/output/source_map_disabled_by_api.js b/test/fixtures/source-map/output/source_map_disabled_by_api.js
@@ -2,9 +2,12 @@
 
 'use strict';
 require('../../../common');
+const assert = require('assert');
 Error.stackTraceLimit = 5;
 
+assert.strictEqual(process.sourceMapsEnabled, true);
 process.setSourceMapsEnabled(false);
+assert.strictEqual(process.sourceMapsEnabled, false);
 
 try {
   require('../enclosing-call-site-min.js');
@@ -17,6 +20,7 @@ delete require.cache[require
 
 // Re-enable.
 process.setSourceMapsEnabled(true);
+assert.strictEqual(process.sourceMapsEnabled, true);
 
 try {
   require('../enclosing-call-site-min.js');

diff --git a/test/fixtures/source-map/output/source_map_enabled_by_api.js b/test/fixtures/source-map/output/source_map_enabled_by_api.js
@@ -1,8 +1,11 @@
 'use strict';
 require('../../../common');
+const assert = require('assert');
 Error.stackTraceLimit = 5;
 
+assert.strictEqual(process.sourceMapsEnabled, false);
 process.setSourceMapsEnabled(true);
+assert.strictEqual(process.sourceMapsEnabled, true);
 
 try {
   require('../enclosing-call-site-min.js');
@@ -14,6 +17,7 @@ delete require.cache[require
   .resolve('../enclosing-call-site-min.js')];
 
 process.setSourceMapsEnabled(false);
+assert.strictEqual(process.sourceMapsEnabled, false);
 
 try {
   require('../enclosing-call-site-min.js');