Make source maps plain objects for use with t.valueToNode (#14283)

thebanjomatic · Adam J. Hines · nicolo-ribaudo · web-flow · commit b7631ffc6568 · 2022-02-17T16:50:57.000+01:00
Co-authored-by: Adam J. Hines &lt;ahines@factset.com&gt;
Co-authored-by: Nicolò Ribaudo &lt;nicolo.ribaudo@gmail.com&gt;
diff --git a/packages/babel-core/src/transformation/file/merge-map.ts b/packages/babel-core/src/transformation/file/merge-map.ts
@@ -38,7 +38,13 @@ export default function mergeSourceMap(
   if (typeof inputMap.sourceRoot === "string") {
     result.sourceRoot = inputMap.sourceRoot;
   }
-  return result;
+
+  // remapping returns a SourceMap class type, but this breaks code downstream in
+  // @babel/traverse and @babel/types that relies on data being plain objects.
+  // When it encounters the sourcemap type it outputs a "don't know how to turn
+  // this value into a node" error. As a result, we are converting the merged
+  // sourcemap to a plain js object.
+  return { ...result };
 }
 
 function rootless(map: SourceMap): SourceMap {
diff --git a/packages/babel-core/test/merge-map.js b/packages/babel-core/test/merge-map.js
@@ -0,0 +1,27 @@
+import _mergeSourceMap from "../lib/transformation/file/merge-map.js";
+const mergeSourceMap = _mergeSourceMap.default;
+
+describe("merge-map", () => {
+  it("returns a plain js object", () => {
+    const inputMap = {
+      file: "file.js",
+      mappings: [],
+      names: [],
+      sources: ["file.ts"],
+      version: 3,
+    };
+
+    const outputMap = {
+      file: "file.transpiled.js",
+      mappings: [],
+      names: [],
+      sources: ["file.js"],
+      version: 3,
+    };
+
+    const map = mergeSourceMap(inputMap, outputMap, "file.transpiled.js");
+    expect(typeof map).toBe("object");
+    expect(Object.prototype.toString.call(map)).toBe("[object Object]");
+    expect(Object.getPrototypeOf(map)).toBe(Object.prototype);
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,13 @@ export default function mergeSourceMap(`
`38`	`38`	`if (typeof inputMap.sourceRoot === "string") {`
`39`	`39`	`result.sourceRoot = inputMap.sourceRoot;`
`40`	`40`	`}`
`41`		`- return result;`
	`41`	`+`
	`42`	`+ // remapping returns a SourceMap class type, but this breaks code downstream in`
	`43`	`+ // @babel/traverse and @babel/types that relies on data being plain objects.`
	`44`	`+ // When it encounters the sourcemap type it outputs a "don't know how to turn`
	`45`	`+ // this value into a node" error. As a result, we are converting the merged`
	`46`	`+ // sourcemap to a plain js object.`
	`47`	`+ return { ...result };`
`42`	`48`	`}`
`43`	`49`
`44`	`50`	`function rootless(map: SourceMap): SourceMap {`