Merge pull request #1192 from gemini-testing/INFRADUTY-29746.migrate_sourcemap_lib

fix: incorrect err snippet position in esm files

Author: KuznetsovRoman

package-lock.json

@@ -104,7 +104,7 @@
     "sizzle": "2.3.6",
     "socket.io": "4.7.5",
     "socket.io-client": "4.7.5",
-    "source-map": "0.7.6",
+    "source-map-js": "1.2.1",
     "strftime": "0.10.2",
     "strip-ansi": "6.0.1",
     "temp": "0.8.3",

package.json

@@ -1,5 +1,6 @@
-import fs from "node:fs";
+import path from "node:path";
 import zlib from "node:zlib";
+import fs from "fs-extra";
 import { Compression, type SelectivityCompressionType } from "./types";
 import type { Readable, Transform, Writable } from "node:stream";
 
@@ -154,13 +155,15 @@ export const readJsonWithCompression = async <T>(
     return JSON.parse(fileData);
 };
 
-export const writeJsonWithCompression = (
+export const writeJsonWithCompression = async (
     jsonBasePath: string,
     data: unknown,
     preferredCompressionType: SelectivityCompressionType,
 ): Promise<void> => {
     const filePath = jsonBasePath + getCompressionPrefix(preferredCompressionType);
     const fileData = JSON.stringify(data, null, preferredCompressionType === "none" ? 2 : 0);
 
+    await fs.ensureDir(path.dirname(filePath));
+
     return writeCompressedTextFile(filePath, fileData, preferredCompressionType);
 };

src/browser/cdp/selectivity/json-utils.ts

@@ -1,5 +1,5 @@
 import { sortedIndex, memoize } from "lodash";
-import { SourceMapConsumer, type BasicSourceMapConsumer, type RawSourceMap } from "source-map";
+import { SourceMapConsumer, type RawSourceMap } from "source-map-js";
 import fs from "fs";
 import path from "path";
 import { URL } from "url";
@@ -89,7 +89,7 @@ export const extractSourceFilesDeps = async (
     const dependantSourceFiles = new Set<string>();
     const sourceMapsParsed = patchSourceMapSources(JSON.parse(sourceMaps), sourceRoot);
 
-    const consumer = (await new SourceMapConsumer(sourceMapsParsed)) as BasicSourceMapConsumer;
+    const consumer = new SourceMapConsumer(sourceMapsParsed);
 
     let sourceOffset = source.indexOf("\n");
     const offsetToLine = [0];

src/browser/cdp/selectivity/utils.ts

@@ -1,16 +1,16 @@
-import { SourceMapConsumer, type BasicSourceMapConsumer } from "source-map";
+import { RawSourceMap, SourceMapConsumer } from "source-map-js";
 import url from "url";
 import { JS_SOURCE_MAP_URL_COMMENT } from "./constants";
 import { getSourceCodeFile } from "./utils";
 import { softFileURLToPath } from "../utils/fs";
 import { transformCode } from "../utils/typescript";
 import type { SufficientStackFrame, ResolvedFrame } from "./types";
 
-export const extractSourceMaps = async (
-    fileContents: string,
-    fileName: string,
-): Promise<BasicSourceMapConsumer | null> => {
-    if (fileContents.indexOf(JS_SOURCE_MAP_URL_COMMENT) === -1) {
+export const extractSourceMaps = async (fileContents: string, fileName: string): Promise<SourceMapConsumer | null> => {
+    const hasNoSourceMaps = fileContents.indexOf(JS_SOURCE_MAP_URL_COMMENT) === -1;
+    const isEsmFile = fileName.startsWith("file://");
+
+    if (hasNoSourceMaps && !isEsmFile) {
         fileContents = transformCode(fileContents, { sourceFile: fileName, sourceMaps: true });
     }
 
@@ -27,16 +27,16 @@ export const extractSourceMaps = async (
             : fileContents.slice(sourceMapsStartIndex + JS_SOURCE_MAP_URL_COMMENT.length, sourceMapsEndIndex);
 
     const sourceMaps = await getSourceCodeFile(url.resolve(fileName, sourceMapUrl));
-    const consumer = (await new SourceMapConsumer(sourceMaps)) as BasicSourceMapConsumer;
+    const rawSourceMaps = JSON.parse(sourceMaps) as RawSourceMap;
 
-    consumer.file = consumer.file || fileName;
+    rawSourceMaps.file = rawSourceMaps.file || fileName;
 
-    return consumer;
+    return new SourceMapConsumer(rawSourceMaps);
 };
 
 export const resolveLocationWithSourceMap = (
     stackFrame: SufficientStackFrame,
-    sourceMaps: BasicSourceMapConsumer,
+    sourceMaps: SourceMapConsumer,
 ): ResolvedFrame => {
     const positions = sourceMaps.originalPositionFor({ line: stackFrame.lineNumber, column: stackFrame.columnNumber });
     const source = positions.source ? sourceMaps.sourceContentFor(positions.source) : null;
@@ -50,5 +50,5 @@ export const resolveLocationWithSourceMap = (
         throw new Error("Line and column could not be evaluated from the source map");
     }
 
-    return { file: softFileURLToPath(sourceMaps.file), source, location };
+    return { file: softFileURLToPath(sourceMaps.file as string), source, location };
 };

src/error-snippets/source-maps.ts

@@ -44,7 +44,7 @@ describe("CDP/Selectivity/Utils", () => {
         utils = proxyquire("src/browser/cdp/selectivity/utils", {
             fs: fsStub,
             path: pathStub,
-            "source-map": {
+            "source-map-js": {
                 SourceMapConsumer: SourceMapConsumerStub,
             },
             "../../../utils/fs": {
@@ -130,7 +130,7 @@ describe("CDP/Selectivity/Utils", () => {
     describe("patchSourceMapSources", () => {
         it("should patch webpack protocol sources", () => {
             const sourceMap = {
-                version: 3,
+                version: 3 as unknown as string,
                 sources: ["webpack://src/app.js", "webpack://src/utils.js", "regular/file.js"],
                 sourceRoot: "",
                 names: [],
@@ -146,7 +146,7 @@ describe("CDP/Selectivity/Utils", () => {
 
         it("should use existing sourceRoot if no custom sourceRoot provided", () => {
             const sourceMap = {
-                version: 3,
+                version: 3 as unknown as string,
                 sources: ["webpack:///src/app.js"],
                 sourceRoot: "/existing/root",
                 names: [],
@@ -161,7 +161,7 @@ describe("CDP/Selectivity/Utils", () => {
 
         it("should handle sources without webpack protocol", () => {
             const sourceMap = {
-                version: 3,
+                version: 3 as unknown as string,
                 sources: ["src/app.js", "lib/utils.js"],
                 sourceRoot: "",
                 names: [],
@@ -528,7 +528,7 @@ describe("CDP/Selectivity/Utils", () => {
             utils = proxyquire("src/browser/cdp/selectivity/utils", {
                 fs: fsStub,
                 path: { ...pathStub, join: pathJoinStub },
-                "source-map": {
+                "source-map-js": {
                     SourceMapConsumer: SourceMapConsumerStub,
                 },
                 "../../../utils/fs": {
@@ -609,7 +609,7 @@ describe("CDP/Selectivity/Utils", () => {
             utils = proxyquire("src/browser/cdp/selectivity/utils", {
                 fs: fsStub,
                 path: { ...pathStub, join: pathJoinStub },
-                "source-map": {
+                "source-map-js": {
                     SourceMapConsumer: SourceMapConsumerStub,
                 },
                 "../../../utils/fs": {

test/src/browser/cdp/selectivity/utils.ts

@@ -25,17 +25,27 @@ describe("error-snippets", () => {
         let fetchStub: SinonStub;
         let formatErrorSnippetStub: SinonStub;
         let findRelevantStackFrameStub: SinonStub;
+        let extractSourceMapsStub: SinonStub;
+        let resolveLocationWithSourceMap: SinonStub;
 
         beforeEach(() => {
             fsReadFileStub = sandbox.stub(fs, "readFile");
-            fetchStub = sandbox.stub(globalThis, "fetch");
-
+            fetchStub = sandbox.stub(globalThis, "fetch").resolves({
+                text: () => Promise.resolve("source code"),
+                headers: new Map() as unknown as Headers,
+            } as Response);
             formatErrorSnippetStub = sandbox.stub();
             findRelevantStackFrameStub = sandbox.stub();
+            extractSourceMapsStub = sandbox.stub().resolves(null);
+            resolveLocationWithSourceMap = sandbox.stub();
 
             extendWithCodeSnippet = proxyquire("../../../src/error-snippets", {
                 "./utils": { formatErrorSnippet: formatErrorSnippetStub },
                 "./frames": { findRelevantStackFrame: findRelevantStackFrameStub },
+                "./source-maps": {
+                    extractSourceMaps: extractSourceMapsStub,
+                    resolveLocationWithSourceMap: resolveLocationWithSourceMap,
+                },
             }).extendWithCodeSnippet;
         });
 
@@ -97,27 +107,35 @@ describe("error-snippets", () => {
             assert.equal(error, result);
         });
 
-        it("should return error with snippet for file path", async () => {
+        it("should return error with snippet for file path for esm file from stacktrace", async () => {
             const error = new Error("test error");
-            const stackFrame = { fileName: "/file/file1", lineNumber: 100, columnNumber: 500 };
+            const stackFrame = { fileName: "file:///file/file1", lineNumber: 100, columnNumber: 500 };
             findRelevantStackFrameStub.returns(stackFrame);
+            extractSourceMapsStub.resolves(null);
             formatErrorSnippetStub.returns("code snippet");
-            fsReadFileStub.resolves("source code");
+            fsReadFileStub.resolves("async function main() {}");
 
             const result = await extendWithCodeSnippet(error);
 
             assert.equal(result.snippet, "code snippet");
         });
 
-        it("should return error with snippet for network url", async () => {
+        it("should return error with snippet for network url from source maps", async () => {
             const error = new Error("test error");
             const stackFrame = { fileName: "http://localhost:3000/file/file1", lineNumber: 100, columnNumber: 500 };
+            const resolvedLocation = {
+                file: "file/file1",
+                source: "source code",
+                location: {},
+            };
             findRelevantStackFrameStub.returns(stackFrame);
-            formatErrorSnippetStub.returns("code snippet");
             fetchStub.withArgs("http://localhost:3000/file/file1").resolves({
                 text: () => Promise.resolve("source code"),
                 headers: new Map(),
             });
+            extractSourceMapsStub.resolves("source-maps");
+            resolveLocationWithSourceMap.withArgs(stackFrame, "source-maps").resolves(resolvedLocation);
+            formatErrorSnippetStub.withArgs(error, resolvedLocation).returns("code snippet");
 
             const result = await extendWithCodeSnippet(error);
 

test/src/error-snippets/index.ts

@@ -1,5 +1,5 @@
 import sinon, { type SinonStub } from "sinon";
-import { SourceMapConsumer, type BasicSourceMapConsumer, type NullableMappedPosition } from "source-map";
+import { MappedPosition, SourceMapConsumer } from "source-map-js";
 import { extractSourceMaps, resolveLocationWithSourceMap } from "./../../../src/error-snippets/source-maps";
 import type { SufficientStackFrame, ResolvedFrame } from "../../../src/error-snippets/types";
 
@@ -17,13 +17,28 @@ describe("error-snippets/source-maps", () => {
     describe("extractSourceMaps", () => {
         it("should return null if source maps comment is not present in file content", async () => {
             const fileContents = 'console.log("Hello, World!");';
-            const fileName = "test.js";
+            const fileName = "file://test.js";
 
             const result = await extractSourceMaps(fileContents, fileName);
 
             assert.isNull(result);
         });
 
+        it("should return null if file has esm path", async () => {
+            const inlineSourceMap =
+                "data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9";
+            const fileContents = `console.log("Hello, World!");\n//# sourceMappingURL=${inlineSourceMap}`;
+            const fileName = "file:///some/path/test.js";
+            fetchStub.withArgs(inlineSourceMap).resolves({
+                text: () => Promise.resolve('{"version":3,"sources":[],"names":[],"mappings":""}'),
+                headers: new Map(),
+            });
+
+            const result = await extractSourceMaps(fileContents, fileName);
+
+            assert.instanceOf(result, SourceMapConsumer);
+        });
+
         it("should return a SourceMapConsumer instance if source maps comment is present in file content", async () => {
             const inlineSourceMap =
                 "data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9";
@@ -42,14 +57,12 @@ describe("error-snippets/source-maps", () => {
 
     describe("resolveLocationWithSourceMap", () => {
         it("should throw an error when source is null", async () => {
-            const sourceMaps = (await new SourceMapConsumer(
-                JSON.stringify({
-                    version: 3,
-                    sources: [],
-                    names: [],
-                    mappings: "",
-                }),
-            )) as BasicSourceMapConsumer;
+            const sourceMaps = new SourceMapConsumer({
+                version: 3 as unknown as string,
+                sources: [],
+                names: [],
+                mappings: "",
+            });
             const stackFrame = { lineNumber: 5, columnNumber: 10 } as SufficientStackFrame;
 
             const fn = (): ResolvedFrame => resolveLocationWithSourceMap(stackFrame, sourceMaps);
@@ -58,16 +71,15 @@ describe("error-snippets/source-maps", () => {
         });
 
         it("should throw an error when line or column is null", async () => {
-            const sourceMaps = (await new SourceMapConsumer(
-                JSON.stringify({
-                    version: 3,
-                    sources: ["file1"],
-                    names: [],
-                    mappings: "",
-                    sourcesContent: ["content"],
-                }),
-            )) as BasicSourceMapConsumer;
-            sandbox.stub(sourceMaps, "originalPositionFor").returns({ source: "file1" } as NullableMappedPosition);
+            const sourceMaps = new SourceMapConsumer({
+                // Specification says it should be number
+                version: 3 as unknown as string,
+                sources: ["file1"],
+                names: [],
+                mappings: "",
+                sourcesContent: ["content"],
+            });
+            sandbox.stub(sourceMaps, "originalPositionFor").returns({ source: "file1" } as MappedPosition);
             const stackFrame = { lineNumber: 5, columnNumber: 10 } as SufficientStackFrame;
 
             const fn = (): ResolvedFrame => resolveLocationWithSourceMap(stackFrame, sourceMaps);
@@ -76,19 +88,17 @@ describe("error-snippets/source-maps", () => {
         });
 
         it("should return ResolvedFrame", async () => {
-            const sourceMaps = (await new SourceMapConsumer(
-                JSON.stringify({
-                    version: 3,
-                    sources: ["file1"],
-                    names: [],
-                    mappings: "AAAA;AACA",
-                    sourcesContent: ["content"],
-                }),
-            )) as BasicSourceMapConsumer;
-            sourceMaps.file = "file:///file1";
+            const sourceMaps = new SourceMapConsumer({
+                version: 3 as unknown as string,
+                sources: ["file1"],
+                names: [],
+                mappings: "AAAA;AACA",
+                sourcesContent: ["content"],
+                file: "file:///file1",
+            });
             sandbox
                 .stub(sourceMaps, "originalPositionFor")
-                .returns({ source: "file1", line: 100, column: 500 } as NullableMappedPosition);
+                .returns({ source: "file1", line: 100, column: 500 } as MappedPosition);
             const stackFrame = { lineNumber: 1, columnNumber: 1 } as SufficientStackFrame;
 
             const result = resolveLocationWithSourceMap(stackFrame, sourceMaps);