lib: codify findSourceMap return value when not found

legendecas · RafaelGSS · commit b8f08e5e7e83 · 2022-09-05T11:32:58.000-03:00
Return `undefined` when no source map is found for the given filename on `findSourceMap`. PR-URL: #44397 Fixes: #44391 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
diff --git a/doc/api/module.md b/doc/api/module.md
@@ -160,7 +160,8 @@ added:
 -->
 
 * `path` {string}
-* Returns: {module.SourceMap}
+* Returns: {module.SourceMap|undefined} Returns `module.SourceMap` if a source
+  map is found, `undefined` otherwise.
 
 `path` is the resolved path for the file for which a corresponding source map
 should be fetched.
diff --git a/lib/internal/source_map/prepare_stack_trace.js b/lib/internal/source_map/prepare_stack_trace.js
@@ -195,7 +195,7 @@ function getOriginalSource(payload, originalSourcePath) {
 
 function getSourceMapErrorSource(fileName, lineNumber, columnNumber) {
   const sm = findSourceMap(fileName);
-  if (sm === null) {
+  if (sm === undefined) {
     return;
   }
   const {
diff --git a/lib/internal/source_map/source_map_cache.js b/lib/internal/source_map/source_map_cache.js
@@ -297,7 +297,7 @@ function findSourceMap(sourceURL) {
   if (sourceMap && sourceMap.data) {
     return new SourceMap(sourceMap.data);
   }
-  return null;
+  return undefined;
 }
 
 module.exports = {
diff --git a/test/parallel/test-source-map-api.js b/test/parallel/test-source-map-api.js
@@ -21,6 +21,19 @@ const { readFileSync } = require('fs');
   );
 }
 
+// `findSourceMap()` should return undefined when no source map is found.
+{
+  const files = [
+    __filename,
+    '',
+    'invalid-file',
+  ];
+  for (const file of files) {
+    const sourceMap = findSourceMap(file);
+    assert.strictEqual(sourceMap, undefined);
+  }
+}
+
 // findSourceMap() can lookup source-maps based on URIs, in the
 // non-exceptional case.
 {

Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ function getOriginalSource(payload, originalSourcePath) {`
`195`	`195`
`196`	`196`	`function getSourceMapErrorSource(fileName, lineNumber, columnNumber) {`
`197`	`197`	`const sm = findSourceMap(fileName);`
`198`		`- if (sm === null) {`
	`198`	`+ if (sm === undefined) {`
`199`	`199`	`return;`
`200`	`200`	`}`
`201`	`201`	`const {`
Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,7 @@ function findSourceMap(sourceURL) {`
`297`	`297`	`if (sourceMap && sourceMap.data) {`
`298`	`298`	`return new SourceMap(sourceMap.data);`
`299`	`299`	`}`
`300`		`- return null;`
	`300`	`+ return undefined;`
`301`	`301`	`}`
`302`	`302`
`303`	`303`	`module.exports = {`