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

Add `process.getSourceMapsEnabled` to detect whether source-maps are enabled. Fixes: nodejs#46304
sapphi-red · Jan 28, 2023 · 7d1f4f8 · 7d1f4f8
1 parent 47cd966
commit 7d1f4f8
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 6 deletions.
diff --git a/doc/api/process.md b/doc/api/process.md
@@ -2009,6 +2009,19 @@ if (process.getgroups) {
 This function is only available on POSIX platforms (i.e. not Windows or
 Android).
 
+## `process.getSourceMapsEnabled()`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+* Returns: {boolean}
+
+The `process.getSourceMapsEnabled()` method returns whether the
+[Source Map v3][Source Map] support for stack traces is enabled.
+
 ## `process.getuid()`
 
 <!-- YAML

diff --git a/lib/internal/process/pre_execution.js b/lib/internal/process/pre_execution.js
@@ -578,11 +578,11 @@ function initializeESMLoader() {
 }
 
 function initializeSourceMapsHandlers() {
-  const { setSourceMapsEnabled, getSourceMapsEnabled } =
+  const { initializeSourceMapsEnabled, setSourceMapsEnabled, getSourceMapsEnabled } =
     require('internal/source_map/source_map_cache');
+  process.getSourceMapsEnabled = getSourceMapsEnabled;
   process.setSourceMapsEnabled = setSourceMapsEnabled;
-  // Initialize the environment flag of source maps.
-  getSourceMapsEnabled();
+  initializeSourceMapsEnabled();
 }
 
 function initializeFrozenIntrinsics() {

diff --git a/lib/internal/source_map/source_map_cache.js b/lib/internal/source_map/source_map_cache.js
@@ -52,10 +52,12 @@ const { fileURLToPath, pathToFileURL, URL } = require('internal/url');
 let SourceMap;
 
 let sourceMapsEnabled;
+
+function initializeSourceMapsEnabled() {
+  setSourceMapsEnabled(getOptionValue('--enable-source-maps'));
+}
+
 function getSourceMapsEnabled() {
-  if (sourceMapsEnabled === undefined) {
-    setSourceMapsEnabled(getOptionValue('--enable-source-maps'));
-  }
   return sourceMapsEnabled;
 }
 
@@ -340,6 +342,7 @@ function findSourceMap(sourceURL) {
 
 module.exports = {
   findSourceMap,
+  initializeSourceMapsEnabled,
   getSourceMapsEnabled,
   setSourceMapsEnabled,
   maybeCacheSourceMap,

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

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