Issue 2686

src/compiler.ts

@@ -93,7 +93,8 @@ import {
   PropertyPrototype,
   IndexSignature,
   File,
-  mangleInternalName
+  mangleInternalName,
+  DebugLocation
 } from "./program";
 
 import {
@@ -9830,8 +9831,7 @@ export class Compiler extends DiagnosticEmitter {
     let targetFunction = this.currentFlow.targetFunction;
     let source = range.source;
     if (source.debugInfoIndex < 0) source.debugInfoIndex = this.module.addDebugInfoFile(source.normalizedPath);
-    range.debugInfoRef = expr;
-    targetFunction.debugLocations.push(range);
+    targetFunction.debugLocations.push(new DebugLocation(expr, range));
   }
 
   /** Checks whether a particular function signature is supported. */

src/diagnostics.ts

@@ -45,7 +45,6 @@ export const enum DiagnosticCategory {
 export class Range {
 
   source!: Source;
-  debugInfoRef: usize = 0;
 
   constructor(public start: i32, public end: i32) {}
 

src/program.ts

@@ -118,7 +118,8 @@ import {
   Module,
   FunctionRef,
   MemorySegment,
-  getFunctionName
+  getFunctionName,
+  ExpressionRef
 } from "./module";
 
 import {
@@ -421,6 +422,13 @@ export namespace OperatorKind {
     return OperatorKind.Invalid;
   }
 }
+/** DebugLocation for debug info generation */
+export class DebugLocation {
+  /** Constructs a new Debug Location*/
+  constructor(
+    public expressionRef: ExpressionRef,
+    public range: Range) {}
+}
 
 /** Represents an AssemblyScript program. */
 export class Program extends DiagnosticEmitter {
@@ -3745,7 +3753,7 @@ export class Function extends TypedElement {
   /** Default control flow. */
   flow!: Flow;
   /** Remembered debug locations. */
-  debugLocations: Range[] = [];
+  debugLocations: DebugLocation[] = [];
   /** Function reference, if compiled. */
   ref: FunctionRef = 0;
   /** Varargs stub for calling with omitted arguments. */
@@ -3912,13 +3920,14 @@ export class Function extends TypedElement {
 
   addDebugInfo(module: Module, ref: FunctionRef): void {
     if (this.program.options.sourceMap) {
-      let debugLocations = this.debugLocations;
-      for (let i = 0, k = debugLocations.length; i < k; ++i) {
-        let range = debugLocations[i];
-        let source = range.source;
+      const debugLocations = this.debugLocations;
+      for (let i = 0; i < debugLocations.length; ++i) {
+        const debugLocation = debugLocations[i];
+        const range = debugLocation.range;
+        const source = range.source;
         module.setDebugLocation(
           ref,
-          range.debugInfoRef,
+          debugLocation.expressionRef,
           source.debugInfoIndex,
           source.lineAt(range.start),
           source.columnAt() - 1 // source maps are 0-based

tests/compiler.js

@@ -12,6 +12,7 @@ import { coreCount, threadCount } from "../util/cpu.js";
 import { diff } from "../util/text.js";
 import { Rtrace } from "../lib/rtrace/index.js";
 import asc from "../dist/asc.js";
+import {exec} from "child_process";
 
 const dirname = path.dirname(fileURLToPath(import.meta.url));
 const require = createRequire(import.meta.url);
@@ -143,7 +144,10 @@ async function runTest(basename) {
   // Makes sure to reset the environment after
   function prepareResult(code, message = null) {
     if (v8_no_flags) v8.setFlagsFromString(v8_no_flags);
-    if (!args.createBinary) fs.unlink(path.join(basedir, basename + ".debug.wasm"), err => { /* nop */ });
+    if (!args.createBinary) {
+      fs.unlink(path.join(basedir, basename + ".debug.wasm"), err => { /* nop */ });
+      fs.unlink(path.join(basedir, basename + ".debug.wasm.map"), err => { /* nop */ });
+    }
     return { code, message };
   }
 
@@ -253,6 +257,40 @@ async function runTest(basename) {
       }
       compareFixture.end(SUCCESS);
     }
+
+    // compare fixture source map
+    const sourcemapCompareFixture = section("compare fixture source map");
+    const debugWasmPath = path.join(basedir, basename + ".debug.wasm");
+    const debugSourceMapPath = path.join(basedir, basename + ".debug.wasm.map");
+    const sourceMapFixturePath = path.join(basedir, basename + ".debug.sourcemap.wat");
+
+    if (fs.existsSync(debugSourceMapPath) && fs.existsSync(sourceMapFixturePath)) {
+      const sourceMapCmd = `node node_modules/.bin/wasm-opt ${debugWasmPath} -ism ${debugSourceMapPath} --print`;
+      exec(sourceMapCmd, (err, stdout, stderr) => {
+        const actual = stdout.toString().replace(/\r\n/g, "\n");
+        if (args.create) {
+          fs.writeFileSync(sourceMapFixturePath, actual, { encoding: "utf8" });
+          console.log("  " + stdoutColors.yellow("Created fixture"));
+          sourcemapCompareFixture.end(SKIPPED);
+        } else {
+          const expected = fs.readFileSync(sourceMapFixturePath, { encoding: "utf8" }).replace(/\r\n/g, "\n");
+          if (args.noDiff) {
+            if (expected != actual) {
+              compareFixture.end(FAILURE);
+              return prepareResult(FAILURE, "fixture mismatch");
+            }
+          } else {
+            let diffs = diff(basename + ".debug.sourcemap.wat", expected, actual);
+            if (diffs !== null) {
+              console.log(diffs);
+              compareFixture.end(FAILURE);
+              return prepareResult(FAILURE, "fixture mismatch");
+            }
+          }
+          compareFixture.end(SUCCESS);
+        }
+      });
+    }
   }
 
   stdout.length = 0;