From 97774311d2de9b6540a7f2602cb66172c979ab49 Mon Sep 17 00:00:00 2001
From: Marco Ippolito <marcoippolito54@gmail.com>
Date: Mon, 28 Oct 2024 10:52:45 -0500
Subject: [PATCH] module: add module.mapCallSite()

---
 doc/api/module.md                            | 32 ++++++++++++++
 lib/internal/source_map/source_map_cache.js  | 46 +++++++++++++++++++-
 lib/module.js                                |  4 +-
 test/es-module/test-module-get-callsite.mjs  | 30 +++++++++++++
 test/fixtures/typescript/ts/test-callsite.ts |  9 ++++
 5 files changed, 118 insertions(+), 3 deletions(-)
 create mode 100644 test/es-module/test-module-get-callsite.mjs
 create mode 100644 test/fixtures/typescript/ts/test-callsite.ts

diff --git a/doc/api/module.md b/doc/api/module.md
index 1d9e0d6aa11829..a7688b56ea62f0 100644
--- a/doc/api/module.md
+++ b/doc/api/module.md
@@ -317,6 +317,37 @@ isBuiltin('fs'); // true
 isBuiltin('wss'); // false
 ```
 
+### `module.mapCallSite(callSite)`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1.1 - Active development
+
+* `callSite` {Object | Array} A [CallSite][] object or an array of CallSite objects.
+* Returns: {Object | Array} The original source code location(s) for the given CallSite object(s).
+
+Reconstructs the original source code location from a [CallSite][] object through the source map.
+
+```mjs
+import { mapCallSite } from 'node:module';
+import { getCallSite } from 'node:util';
+
+mapCallSite(getCallSite()); // Reconstructs the original source code location for the whole stack
+
+mapCallSite(getCallSite()[0]); // Reconstructs the original source code location for the first frame
+```
+
+```cjs
+const { mapCallSite } = require('node:module');
+const { getCallSite } = require('node:util');
+
+mapCallSite(getCallSite()); // Reconstructs the original source code location for the whole stack
+
+mapCallSite(getCallSite()[0]); // Reconstructs the original source code location for the first frame
+```
+
 ### `module.register(specifier[, parentURL][, options])`
 
 <!-- YAML
@@ -1397,6 +1428,7 @@ returned object contains the following keys:
 * columnNumber: {number} The 1-indexed columnNumber of the
   corresponding call site in the original source
 
+[CallSite]: util.md#utilgetcallsiteframes
 [CommonJS]: modules.md
 [Conditional exports]: packages.md#conditional-exports
 [Customization hooks]: #customization-hooks
diff --git a/lib/internal/source_map/source_map_cache.js b/lib/internal/source_map/source_map_cache.js
index dfb42f83f6f1b1..e836dbbde87526 100644
--- a/lib/internal/source_map/source_map_cache.js
+++ b/lib/internal/source_map/source_map_cache.js
@@ -1,6 +1,7 @@
 'use strict';
 
 const {
+  ArrayIsArray,
   ArrayPrototypePush,
   JSONParse,
   RegExpPrototypeExec,
@@ -15,7 +16,7 @@ let debug = require('internal/util/debuglog').debuglog('source_map', (fn) => {
   debug = fn;
 });
 
-const { validateBoolean } = require('internal/validators');
+const { validateBoolean, validateObject, validateString, validateNumber } = require('internal/validators');
 const {
   setSourceMapsEnabled: setSourceMapsNative,
 } = internalBinding('errors');
@@ -351,11 +352,54 @@ function findSourceMap(sourceURL) {
   return sourceMap;
 }
 
+function reconstructCallSite(callSite) {
+  const { scriptName, lineNumber, column } = callSite;
+  const sourceMap = findSourceMap(scriptName);
+  if (!sourceMap) return;
+  const entry = sourceMap.findEntry(lineNumber - 1, column - 1);
+  if (!entry?.originalSource) return;
+  return {
+    __proto__: null,
+    functionName: callSite.name,
+    lineNumber: entry.originalLine + 1,
+    column: entry.originalColumn + 1,
+    scriptName: entry.originalSource,
+  };
+}
+
+function validateCallSite(callSite) {
+  validateObject(callSite, 'callSites');
+  validateString(callSite.scriptName, 'callSites.scriptName');
+  validateString(callSite.functionName, 'callSites.functionName');
+  validateNumber(callSite.lineNumber, 'callSites.lineNumber');
+  validateNumber(callSite.column, 'callSites.column');
+}
+
+/**
+ *
+ * @param {object} callSites The call site object to map (ex `util.getCallSite()`)
+ * @returns {object | object[]} An object or array of objects with the reconstructed call site
+ */
+function mapCallSite(callSites) {
+  if (ArrayIsArray(callSites)) {
+    const result = [];
+    for (const callSite of callSites) {
+      validateCallSite(callSite);
+      const found = reconstructCallSite(callSite);
+      ArrayPrototypePush(result, found ?? callSite);
+    }
+    return result;
+  }
+  validateCallSite(callSites);
+  return reconstructCallSite(callSites) ?? callSites;
+}
+
 module.exports = {
   findSourceMap,
   getSourceMapsEnabled,
   setSourceMapsEnabled,
   maybeCacheSourceMap,
   maybeCacheGeneratedSourceMap,
+  mapCallSite,
   sourceMapCacheToObject,
 };
diff --git a/lib/module.js b/lib/module.js
index a0317d06e0edb0..26c0f36fb441b8 100644
--- a/lib/module.js
+++ b/lib/module.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const { findSourceMap } = require('internal/source_map/source_map_cache');
+const { findSourceMap, mapCallSite } = require('internal/source_map/source_map_cache');
 const { Module } = require('internal/modules/cjs/loader');
 const { register } = require('internal/modules/esm/loader');
 const { SourceMap } = require('internal/source_map/source_map');
@@ -24,5 +24,5 @@ Module.findPackageJSON = findPackageJSON;
 Module.flushCompileCache = flushCompileCache;
 Module.getCompileCacheDir = getCompileCacheDir;
 Module.stripTypeScriptTypes = stripTypeScriptTypes;
-
+Module.mapCallSite = mapCallSite;
 module.exports = Module;
diff --git a/test/es-module/test-module-get-callsite.mjs b/test/es-module/test-module-get-callsite.mjs
new file mode 100644
index 00000000000000..835c8bc692d050
--- /dev/null
+++ b/test/es-module/test-module-get-callsite.mjs
@@ -0,0 +1,30 @@
+import { spawnPromisified } from '../common/index.mjs';
+import * as fixtures from '../common/fixtures.mjs';
+import { strictEqual, match, throws, deepStrictEqual } from 'node:assert';
+import { test } from 'node:test';
+import { mapCallSite } from 'node:module';
+import { getCallSite } from 'node:util';
+
+test('module.mapCallSite', async () => {
+  throws(() => mapCallSite('not an object'), { code: 'ERR_INVALID_ARG_TYPE' });
+  deepStrictEqual(mapCallSite([]), []);
+  throws(() => mapCallSite({}), { code: 'ERR_INVALID_ARG_TYPE' });
+
+  const callSite = getCallSite();
+  deepStrictEqual(callSite, mapCallSite(callSite));
+  deepStrictEqual(callSite[0], mapCallSite(callSite[0]));
+});
+
+
+test('module.mapCallSite should reconstruct ts callsite', async () => {
+  const result = await spawnPromisified(process.execPath, [
+    '--no-warnings',
+    '--experimental-transform-types',
+    fixtures.path('typescript/ts/test-callsite.ts'),
+  ]);
+  const output = result.stdout.toString().trim();
+  strictEqual(result.stderr, '');
+  match(output, /lineNumber: 9/);
+  match(output, /column: 25/);
+  strictEqual(result.code, 0);
+});
diff --git a/test/fixtures/typescript/ts/test-callsite.ts b/test/fixtures/typescript/ts/test-callsite.ts
new file mode 100644
index 00000000000000..06fed9db3c67ea
--- /dev/null
+++ b/test/fixtures/typescript/ts/test-callsite.ts
@@ -0,0 +1,9 @@
+const { getCallSite } = require('node:util');
+const { mapCallSite } = require('node:module');
+
+interface CallSite {
+    A;
+    B;
+}
+
+console.log(mapCallSite(getCallSite()[0]));