fix: Instrument based on source map paths (ESM)

src/hooks/libraries.ts

@@ -17,7 +17,7 @@ export default function librariesHook(mod: unknown, id: string) {
   // "node:console" and "console", for example, spreading around.
   const moduleId = id.replace(/^node:/, "");
   function wrapFunction(owner: FunctionOwner, key: string, klass?: string) {
-    if (config.getPackage(moduleId, true)?.exclude?.includes(key)) return;
+    if (config().getPackage(moduleId, true)?.exclude?.includes(key)) return;
 
     const f = owner[key] as F;
     if (!proxiedFunctions.has(f)) {
@@ -57,7 +57,7 @@ function createProxy(f: F, moduleId: string, klass?: string) {
 }
 
 librariesHook.applicable = function (id: string) {
-  return config.getPackage(id, true) != undefined;
+  return config().getPackage(id, true) != undefined;
 };
 
 const functionInfos = new Map<string, FunctionInfo>();
@@ -85,7 +85,7 @@ function getFunctionInfo(f: F, moduleId: string, klass?: string) {
       location: { path: `${moduleId}`, lineno: ++functionCount },
       klassOrFile: moduleId + (klass ? "." + klass : ""),
       static: false,
-      labels: config.getFunctionLabels(config.getPackage(moduleId, true), f.name),
+      labels: config().getFunctionLabels(config().getPackage(moduleId, true), f.name),
     };
     functionInfos.set(key, info);
   }

src/loader.ts

@@ -5,7 +5,7 @@ import type { NodeLoaderHooksAPI2 } from "ts-node";
 
 import config from "./config";
 import { warn } from "./message";
-import transform, { findHook } from "./transform";
+import transform, { findHook, getSourceMap, shouldMatchOriginalSourcePaths } from "./transform";
 import { readPkgUp } from "./util/readPkgUp";
 import { forceRequire } from "./register";
 
@@ -21,7 +21,7 @@ export const resolve: NodeLoaderHooksAPI2["resolve"] = async function resolve(
   // their import name here (i.e. url: "json5"). Then it gets resolved
   // to a path (i.e. result.path: ".../node_modules/json5/lib/index.js")
   // and passed to the load function.
-  if (config.getPackage(url, true) != undefined) forceRequire(url);
+  if (config().getPackage(url, true) != undefined) forceRequire(url);
 
   return result;
 };
@@ -43,10 +43,13 @@ export const load: NodeLoaderHooksAPI2["load"] = async function load(url, contex
       context.format = "commonjs";
   }
 
-  const hook = findHook(urlObj);
+  const original = await defaultLoad(url, context, defaultLoad);
+  const sourceMap =
+    original.source && shouldMatchOriginalSourcePaths(urlObj)
+      ? getSourceMap(urlObj, original.source.toString())
+      : undefined;
+  const hook = findHook(urlObj, sourceMap);
   if (hook) {
-    const original = await defaultLoad(url, context, defaultLoad);
-
     if (original.source) {
       const xformed = transform(original.source.toString(), new URL(url));
 
@@ -65,5 +68,5 @@ export const load: NodeLoaderHooksAPI2["load"] = async function load(url, contex
   if (["node:http", "node:https", "http", "https", ...config().prismaClientModuleIds].includes(url))
     forceRequire(url);
 
-  return defaultLoad(url, context, defaultLoad);
+  return original;
 };

src/recorder.ts

@@ -39,7 +39,7 @@ const funToPackage = new WeakMap<FunctionInfo, Package | undefined>();
 
 function getPackage(funInfo: FunctionInfo, isLibrary: boolean) {
   if (!funToPackage.has(funInfo))
-    funToPackage.set(funInfo, config.getPackage(funInfo.location?.path, isLibrary));
+    funToPackage.set(funInfo, config().getPackage(funInfo.location?.path, isLibrary));
   return funToPackage.get(funInfo);
 }
 

src/transform.ts

@@ -109,7 +109,7 @@ export class CustomSourceMapConsumer extends SourceMapConsumer {
   }
 }
 
-function getSourceMap(fileUrl: URL, code: string): CustomSourceMapConsumer | undefined {
+export function getSourceMap(fileUrl: URL, code: string): CustomSourceMapConsumer | undefined {
   const sourceMappingUrl = code.match(/\/\/# sourceMappingURL=(.*)/)?.[1];
   if (!sourceMappingUrl) return;
 

test/__snapshots__/sourceMapPath.test.ts.snap

@@ -69,3 +69,73 @@ exports[`mapping a bundled script 1`] = `
   "version": "1.12",
 }
 `;
+
+exports[`mapping an bundled ESM script 1`] = `
+{
+  "classMap": [
+    {
+      "children": [
+        {
+          "children": [
+            {
+              "location": "original.mjs:3",
+              "name": "foo",
+              "static": true,
+              "type": "function",
+            },
+          ],
+          "name": "original",
+          "type": "class",
+        },
+      ],
+      "name": "appmap-node",
+      "type": "package",
+    },
+  ],
+  "events": [
+    {
+      "defined_class": "original",
+      "event": "call",
+      "id": 1,
+      "lineno": 3,
+      "method_id": "foo",
+      "parameters": [
+        {
+          "class": "String",
+          "name": "msg",
+          "value": "'hello'",
+        },
+      ],
+      "path": "original.mjs",
+      "static": true,
+      "thread_id": 0,
+    },
+    {
+      "elapsed": 31.337,
+      "event": "return",
+      "id": 2,
+      "parent_id": 1,
+      "thread_id": 0,
+    },
+  ],
+  "metadata": {
+    "app": "appmap-node",
+    "client": {
+      "name": "appmap-node",
+      "url": "https://github.com/getappmap/appmap-node",
+      "version": "test node-appmap version",
+    },
+    "language": {
+      "engine": "Node.js",
+      "name": "javascript",
+      "version": "test node version",
+    },
+    "name": "test process recording",
+    "recorder": {
+      "name": "process",
+      "type": "process",
+    },
+  },
+  "version": "1.12",
+}
+`;

test/jest.test.ts

@@ -1,4 +1,4 @@
-import { format } from "node:util";
+import { format, inspect } from "node:util";
 
 import { integrationTest, readAppmaps, runAppmapNode, runAppmapNodeWithOptions } from "./helpers";
 
@@ -29,6 +29,11 @@ integrationTest("mapping Jest tests with process recording active", () => {
     ([, a]) => a.metadata?.recorder.type == "process",
   );
   if (processMaps.length != 1)
-    throw new Error(format("expected one process appmap, got: ", Object.fromEntries(processMaps)));
+    throw new Error(
+      format(
+        "expected one process appmap, got: ",
+        inspect(Object.fromEntries(processMaps), undefined, Infinity),
+      ),
+    );
   expect(appmapsArray.filter((a) => a.metadata?.recorder.type == "tests").length).toEqual(4);
 });

test/sourceMapPath.test.ts

@@ -4,3 +4,8 @@ integrationTest("mapping a bundled script", () => {
   expect(runAppmapNode("./built/index.js").status).toBe(0);
   expect(readAppmap()).toMatchSnapshot();
 });
+
+integrationTest("mapping an bundled ESM script", () => {
+  expect(runAppmapNode("./built/index-esm.mjs").status).toBe(0);
+  expect(readAppmap()).toMatchSnapshot();
+});

test/sourceMapPath/README.md

@@ -1,5 +1,6 @@
-To recreate index.js & index.js.map:
+To recreate index.js, index.js.map, index-esm.mjs and index-esm.mjs.map:
 
 ```
 $ yarn esbuild original.mjs --bundle --platform=node --sourcemap --outfile=built/index.js
+$ yarn esbuild original.mjs --bundle --platform=node --sourcemap --outfile=built/index-esm.mjs --format=esm
 ```

test/sourceMapPath/appmap.yml

@@ -6,4 +6,5 @@ packages:
       - node_modules
       - .yarn
       - built
-      - bar
+      - bar
+language: javascript

test/sourceMapPath/built/.eslintrc.json

@@ -1,3 +1,3 @@
 {
-  "ignorePatterns": ["index.js"]
+  "ignorePatterns": ["index.js", "index-esm.mjs"]
 }