src,lib: obtain sourceURL in magic comments from V8

Obtain sourceURL magic comments via V8 API to avoid a second round of
extraction of magic comments.

Updates source map snapshot normalization to allow testing full path
names inside the test outputs.

PR-URL: #58389
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Author: legendecas

lib/internal/main/embedding.js

@@ -56,6 +56,7 @@ function embedderRunCjs(content) {
     function: compiledWrapper,
     cachedDataRejected,
     sourceMapURL,
+    sourceURL,
   } = compileFunctionForCJSLoader(
     content,
     filename,
@@ -69,7 +70,7 @@ function embedderRunCjs(content) {
       content,
       customModule,
       false,  // isGeneratedSource
-      undefined,  // sourceURL, TODO(joyeecheung): should be extracted by V8
+      sourceURL,
       sourceMapURL,
     );
   }

lib/internal/modules/cjs/loader.js

@@ -1640,9 +1640,9 @@ function wrapSafe(filename, content, cjsModuleInstance, format) {
     );
 
     // Cache the source map for the module if present.
-    const { sourceMapURL } = script;
+    const { sourceMapURL, sourceURL } = script;
     if (sourceMapURL) {
-      maybeCacheSourceMap(filename, content, cjsModuleInstance, false, undefined, sourceMapURL);
+      maybeCacheSourceMap(filename, content, cjsModuleInstance, false, sourceURL, sourceMapURL);
     }
 
     return {
@@ -1667,7 +1667,7 @@ function wrapSafe(filename, content, cjsModuleInstance, format) {
 
   // Cache the source map for the module if present.
   if (result.sourceMapURL) {
-    maybeCacheSourceMap(filename, content, cjsModuleInstance, false, undefined, result.sourceMapURL);
+    maybeCacheSourceMap(filename, content, cjsModuleInstance, false, result.sourceURL, result.sourceMapURL);
   }
 
   return result;

lib/internal/modules/esm/translators.js

@@ -122,10 +122,10 @@ translators.set('module', function moduleStrategy(url, source, isMain) {
 function loadCJSModule(module, source, url, filename, isMain) {
   const compileResult = compileFunctionForCJSLoader(source, filename, false /* is_sea_main */, false);
 
-  const { function: compiledWrapper, sourceMapURL } = compileResult;
+  const { function: compiledWrapper, sourceMapURL, sourceURL } = compileResult;
   // Cache the source map for the cjs module if present.
   if (sourceMapURL) {
-    maybeCacheSourceMap(url, source, module, false, undefined, sourceMapURL);
+    maybeCacheSourceMap(url, source, module, false, sourceURL, sourceMapURL);
   }
 
   const cascadedLoader = require('internal/modules/esm/loader').getOrInitializeCascadedLoader();

lib/internal/modules/esm/utils.js

@@ -361,7 +361,7 @@ function compileSourceTextModule(url, source, cascadedLoader, context = kEmptyOb
 
   // Cache the source map for the module if present.
   if (wrap.sourceMapURL) {
-    maybeCacheSourceMap(url, source, wrap, false, undefined, wrap.sourceMapURL);
+    maybeCacheSourceMap(url, source, wrap, false, wrap.sourceURL, wrap.sourceMapURL);
   }
   return wrap;
 }

lib/internal/source_map/source_map_cache.js

@@ -139,7 +139,9 @@ function extractSourceMapURLMagicComment(content) {
 }
 
 /**
- * Caches the source map if it is present in the content, with the given filename, moduleInstance, and sourceURL.
+ * Caches the source map, with the given filename, moduleInstance, sourceURL and sourceMapURL.
+ * This function does not automatically extract the source map from the content. The caller should either
+ * extract the source map from the content via V8 API or use {@link extractSourceURLMagicComment} explicitly.
  * @param {string} filename - the actual filename
  * @param {string} content - the actual source content
  * @param {import('internal/modules/cjs/loader').Module | ModuleWrap} moduleInstance - a module instance that
@@ -162,20 +164,13 @@ function maybeCacheSourceMap(filename, content, moduleInstance, isGeneratedSourc
     return;
   }
 
-  if (sourceMapURL === undefined) {
-    sourceMapURL = extractSourceMapURLMagicComment(content);
-  }
-
   // Bail out when there is no source map url.
   if (typeof sourceMapURL !== 'string') {
     return;
   }
 
-  // FIXME: callers should obtain sourceURL from v8 and pass it
-  // rather than leaving it undefined and extract by regex.
-  if (sourceURL === undefined) {
-    sourceURL = extractSourceURLMagicComment(content);
-  }
+  // Normalize the sourceURL to a file URL if it is a path.
+  sourceURL = normalizeReferrerURL(sourceURL);
 
   const data = dataFromUrl(filename, sourceMapURL);
   // `data` could be null if the source map is invalid.
@@ -192,9 +187,6 @@ function maybeCacheSourceMap(filename, content, moduleInstance, isGeneratedSourc
 
   if (isGeneratedSource) {
     generatedSourceMapCache.set(filename, entry);
-    if (sourceURL) {
-      generatedSourceMapCache.set(sourceURL, entry);
-    }
     return;
   }
   // If it is not a generated source, we assume we are in a "cjs/esm"
@@ -215,8 +207,14 @@ function maybeCacheGeneratedSourceMap(content) {
   if (sourceURL === null) {
     return;
   }
+  const sourceMapURL = extractSourceMapURLMagicComment(content);
+  if (sourceMapURL === null) {
+    return;
+  }
+
   try {
-    maybeCacheSourceMap(sourceURL, content, null, true, sourceURL);
+    // Use the sourceURL as the filename, and do not create a duplicate entry.
+    maybeCacheSourceMap(sourceURL, content, null, true, undefined /** no duplicated sourceURL */, sourceMapURL);
   } catch (err) {
     // This can happen if the filename is not a valid URL.
     // If we fail to cache the source map, we should not fail the whole process.

src/env_properties.h

@@ -363,6 +363,7 @@
   V(sni_context_string, "sni_context")                                         \
   V(source_string, "source")                                                   \
   V(source_map_url_string, "sourceMapURL")                                     \
+  V(source_url_string, "sourceURL")                                            \
   V(specifier_string, "specifier")                                             \
   V(stack_string, "stack")                                                     \
   V(standard_name_string, "standardName")                                      \

src/module_wrap.cc

@@ -308,6 +308,13 @@ void ModuleWrap::New(const FunctionCallbackInfo<Value>& args) {
         return;
       }
 
+      if (that->Set(context,
+                    realm->env()->source_url_string(),
+                    module->GetUnboundModuleScript()->GetSourceURL())
+              .IsNothing()) {
+        return;
+      }
+
       if (that->Set(context,
                     realm->env()->source_map_url_string(),
                     module->GetUnboundModuleScript()->GetSourceMappingURL())

src/node_contextify.cc

@@ -1105,6 +1105,13 @@ void ContextifyScript::New(const FunctionCallbackInfo<Value>& args) {
     return;
   }
 
+  if (args.This()
+          ->Set(env->context(),
+                env->source_url_string(),
+                v8_script->GetSourceURL())
+          .IsNothing())
+    return;
+
   if (args.This()
           ->Set(env->context(),
                 env->source_map_url_string(),
@@ -1571,12 +1578,23 @@ MaybeLocal<Object> ContextifyFunction::CompileFunctionAndCacheResult(
   Local<Object> result = Object::New(isolate);
   if (result->Set(parsing_context, env->function_string(), fn).IsNothing())
     return {};
+
+  // ScriptOrigin::ResourceName() returns SourceURL magic comment content if
+  // present.
+  if (result
+          ->Set(parsing_context,
+                env->source_url_string(),
+                fn->GetScriptOrigin().ResourceName())
+          .IsNothing()) {
+    return {};
+  }
   if (result
           ->Set(parsing_context,
                 env->source_map_url_string(),
                 fn->GetScriptOrigin().SourceMapUrl())
-          .IsNothing())
+          .IsNothing()) {
     return {};
+  }
 
   std::unique_ptr<ScriptCompiler::CachedData> new_cached_data;
   if (produce_cached_data) {
@@ -1814,12 +1832,16 @@ static void CompileFunctionForCJSLoader(
   Local<Name> names[] = {
       env->cached_data_rejected_string(),
       env->source_map_url_string(),
+      env->source_url_string(),
       env->function_string(),
       FIXED_ONE_BYTE_STRING(isolate, "canParseAsESM"),
   };
   Local<Value> values[] = {
       Boolean::New(isolate, cache_rejected),
       fn.IsEmpty() ? undefined : fn->GetScriptOrigin().SourceMapUrl(),
+      // ScriptOrigin::ResourceName() returns SourceURL magic comment content if
+      // present.
+      fn.IsEmpty() ? undefined : fn->GetScriptOrigin().ResourceName(),
       fn.IsEmpty() ? undefined : fn.As<Value>(),
       Boolean::New(isolate, can_parse_as_esm),
   };

test/common/assertSnapshot.js

@@ -16,6 +16,10 @@ function replaceStackTrace(str, replacement = '$1*$7$8\n') {
   return str.replace(stackFramesRegexp, replacement);
 }
 
+function replaceInternalStackTrace(str) {
+  return str.replaceAll(/(\W+).*node:internal.*/g, '$1*');
+}
+
 function replaceWindowsLineEndings(str) {
   return str.replace(windowNewlineRegexp, '');
 }
@@ -24,8 +28,11 @@ function replaceWindowsPaths(str) {
   return common.isWindows ? str.replaceAll(path.win32.sep, path.posix.sep) : str;
 }
 
-function replaceFullPaths(str) {
-  return str.replaceAll('\\\'', "'").replaceAll(path.resolve(__dirname, '../..'), '');
+function transformProjectRoot(replacement = '') {
+  const projectRoot = path.resolve(__dirname, '../..');
+  return (str) => {
+    return str.replaceAll('\\\'', "'").replaceAll(projectRoot, replacement);
+  };
 }
 
 function transform(...args) {
@@ -94,11 +101,12 @@ async function spawnAndAssert(filename, transform = (x) => x, { tty = false, ...
 module.exports = {
   assertSnapshot,
   getSnapshotPath,
-  replaceFullPaths,
   replaceNodeVersion,
   replaceStackTrace,
+  replaceInternalStackTrace,
   replaceWindowsLineEndings,
   replaceWindowsPaths,
   spawnAndAssert,
   transform,
+  transformProjectRoot,
 };

test/fixtures/source-map/output/source_map_disabled_by_api.snapshot

@@ -1,12 +1,12 @@
 Error: an error!
-    at functionD (*enclosing-call-site-min.js:1:156)
-    at functionC (*enclosing-call-site-min.js:1:97)
-    at functionB (*enclosing-call-site-min.js:1:60)
-    at functionA (*enclosing-call-site-min.js:1:26)
-    at Object.<anonymous> (*enclosing-call-site-min.js:1:199)
+    at functionD (*/test/fixtures/source-map/enclosing-call-site-min.js:1:156)
+    at functionC (*/test/fixtures/source-map/enclosing-call-site-min.js:1:97)
+    at functionB (*/test/fixtures/source-map/enclosing-call-site-min.js:1:60)
+    at functionA (*/test/fixtures/source-map/enclosing-call-site-min.js:1:26)
+    at Object.<anonymous> (*/test/fixtures/source-map/enclosing-call-site-min.js:1:199)
 Error: an error!
-    at functionD (*enclosing-call-site.js:16:17)
-    at functionC (*enclosing-call-site.js:10:3)
-    at functionB (*enclosing-call-site.js:6:3)
-    at functionA (*enclosing-call-site.js:2:3)
-    at Object.<anonymous> (*enclosing-call-site.js:24:3)
+    at functionD (*/test/fixtures/source-map/enclosing-call-site.js:16:17)
+    at functionC (*/test/fixtures/source-map/enclosing-call-site.js:10:3)
+    at functionB (*/test/fixtures/source-map/enclosing-call-site.js:6:3)
+    at functionA (*/test/fixtures/source-map/enclosing-call-site.js:2:3)
+    at Object.<anonymous> (*/test/fixtures/source-map/enclosing-call-site.js:24:3)