Preserve legacy prop ordering in sourcemaps

babel · Apr 27, 2022 · accb758 · accb758
1 parent 6163af9
commit accb758
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 9 deletions.
diff --git a/...babel-cli/test/fixtures/babel/dir --out-dir --source-maps inline/out-files/lib/bar/bar.js b/...babel-cli/test/fixtures/babel/dir --out-dir --source-maps inline/out-files/lib/bar/bar.js
diff --git a/...ges/babel-cli/test/fixtures/babel/dir --out-dir --source-maps inline/out-files/lib/foo.js b/...ges/babel-cli/test/fixtures/babel/dir --out-dir --source-maps inline/out-files/lib/foo.js
diff --git a/...es/babel-cli/test/fixtures/babel/dir --out-dir --source-maps/out-files/lib/bar/bar.js.map b/...es/babel-cli/test/fixtures/babel/dir --out-dir --source-maps/out-files/lib/bar/bar.js.map
diff --git a/packages/babel-cli/test/fixtures/babel/dir --out-dir --source-maps/out-files/lib/foo.js.map b/packages/babel-cli/test/fixtures/babel/dir --out-dir --source-maps/out-files/lib/foo.js.map
diff --git a/packages/babel-cli/test/fixtures/babel/stdin --source-maps inline/stdout.txt b/packages/babel-cli/test/fixtures/babel/stdin --source-maps inline/stdout.txt
@@ -3,6 +3,6 @@
 arr.map(function (x) {
   return x * x;
 });
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJhcnIiLCJtYXAiLCJ4Il0sInNvdXJjZXMiOlsic3RkaW4iXSwic291cmNlc0NvbnRlbnQiOlsiYXJyLm1hcCh4ID0+IHggKiB4KTsiXSwibWFwcGluZ3MiOiI7O0FBQUFBLEdBQUcsQ0FBQ0MsR0FBSixDQUFRLFVBQUFDLENBQUM7QUFBQSxTQUFJQSxDQUFDLEdBQUdBLENBQVI7QUFBQSxDQUFUIn0=
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInN0ZGluIl0sIm5hbWVzIjpbImFyciIsIm1hcCIsIngiXSwibWFwcGluZ3MiOiI7O0FBQUFBLEdBQUcsQ0FBQ0MsR0FBSixDQUFRLFVBQUFDLENBQUM7QUFBQSxTQUFJQSxDQUFDLEdBQUdBLENBQVI7QUFBQSxDQUFUIiwic291cmNlc0NvbnRlbnQiOlsiYXJyLm1hcCh4ID0+IHggKiB4KTsiXX0=
 
 //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3Rkb3V0IiwibmFtZXMiOltdLCJzb3VyY2VzIjpbXSwic291cmNlc0NvbnRlbnQiOltdLCJtYXBwaW5ncyI6IiJ9
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/inline/output.js b/packages/babel-core/test/fixtures/transformation/source-maps/inline/output.js
diff --git a/packages/babel-generator/src/source-map.ts b/packages/babel-generator/src/source-map.ts
@@ -14,9 +14,28 @@ import type {
 } from "@jridgewell/gen-mapping";
 
 /**
- * Build a sourcemap.
+ * The old source-map library has a particular field order, and babel consumers
+ * may have tests written that depend on that ordering.
  */
+function legacyPropOrder(map: DecodedSourceMap): DecodedSourceMap;
+function legacyPropOrder(map: EncodedSourceMap): EncodedSourceMap;
+function legacyPropOrder(
+  map: DecodedSourceMap | EncodedSourceMap,
+): DecodedSourceMap | EncodedSourceMap {
+  return {
+    version: map.version,
+    sources: map.sources,
+    names: map.names,
+    mappings: map.mappings as any,
+    file: map.file,
+    sourceRoot: map.sourceRoot,
+    sourcesContent: map.sourcesContent,
+  };
+}
 
+/**
+ * Build a sourcemap.
+ */
 export default class SourceMap {
   private _map: GenMapping;
   private _rawMappings: Mapping[] | undefined;
@@ -55,11 +74,13 @@ export default class SourceMap {
    * Get the sourcemap.
    */
   get(): EncodedSourceMap {
-    return encodedMap(this._map);
+    const map = encodedMap(this._map);
+    return !process.env.BABEL_8_BREAKING ? legacyPropOrder(map) : map;
   }
 
   getDecoded(): DecodedSourceMap {
-    return decodedMap(this._map);
+    const map = decodedMap(this._map);
+    return !process.env.BABEL_8_BREAKING ? legacyPropOrder(map) : map;
   }
 
   getRawMappings(): Mapping[] {