Fix stack traces when --enable-source-maps is enabled (#140)

---------

Co-authored-by: Carles Capell <107924659+CarlesDD@users.noreply.github.com>

Author: Ugaitz Urien

.eslintignore

@@ -2,3 +2,5 @@ samples
 test/resources/**
 index.d.ts
 wasm
+integration-test/requires/error-typescript.js
+integration-test/requires/error-typescript.ts

integration-test/init-rewriter.js

@@ -0,0 +1,77 @@
+'use strict'
+
+const rewriterPackage = process.env.NPM_REWRITER === 'true' ? '@datadog/wasm-js-rewriter' : '../'
+const { addEditedFile } = require('./edited-files-cache')
+const { Rewriter, getPrepareStackTrace } = require(rewriterPackage)
+const path = require('path')
+const Module = require('module')
+
+let rewriter
+let originalPrepareStackTrace = Error.prepareStackTrace
+
+const CSI_METHODS = [
+  { src: 'plusOperator', operator: true },
+  { src: 'substring' },
+  { src: 'trim' },
+  { src: 'trimStart' },
+  { src: 'trimEnd' },
+  { src: 'trimLeft' },
+  { src: 'trimRight' },
+  { src: 'toLowerCase' },
+  { src: 'toLocaleLowerCase' },
+  { src: 'toUpperCase' },
+  { src: 'toLocaleUpperCase' },
+  { src: 'replace' },
+  { src: 'replaceAll' },
+  { src: 'slice' },
+  { src: 'concat' }
+]
+
+function isFlagPresent (flag) {
+  return process.env.NODE_OPTIONS?.includes(flag) ||
+    process.execArgv?.some(arg => arg.includes(flag))
+}
+
+function initRewriter () {
+  rewriter = new Rewriter({
+    csiMethods: CSI_METHODS,
+    telemetryVerbosity: 'Debug',
+    chainSourceMap: isFlagPresent('--enable-source-maps')
+  })
+
+  if (rewriter) {
+    Object.defineProperty(global.Error, 'prepareStackTrace', getPrepareStackTraceAccessor())
+    Module.prototype._compile = getCompileMethodFn(Module.prototype._compile)
+  }
+}
+
+function getPrepareStackTraceAccessor () {
+  let actual = getPrepareStackTrace(originalPrepareStackTrace)
+  return {
+    get () {
+      return actual
+    },
+    set (value) {
+      actual = getPrepareStackTrace(value)
+      originalPrepareStackTrace = value
+    }
+  }
+}
+
+function getCompileMethodFn (compileMethod) {
+  return function (content, filename) {
+    try {
+      if (filename.indexOf(path.join('integration-test', 'requires')) > -1) {
+        const response = rewriter.rewrite(content, filename, ['iast'])
+        content = response.content
+        addEditedFile(filename)
+      }
+    } catch (e) {
+      // eslint-disable-next-line no-console
+      console.error(e)
+    }
+    return compileMethod.apply(this, [content, filename])
+  }
+}
+
+initRewriter()

integration-test/requires/error-typescript.js

@@ -0,0 +1,5 @@
+function main (arg: string) {
+  console.log(new Error('Error: ' + arg))
+}
+
+main('arg')

integration-test/requires/error-typescript.js.map

@@ -5,74 +5,13 @@
 
 'use strict'
 
+require('./init-rewriter')
+
 const chai = require('chai')
 const sinon = require('sinon')
 const sinonChai = require('sinon-chai')
-const rewriterPackage = process.env.NPM_REWRITER === 'true' ? '@datadog/wasm-js-rewriter' : '../'
-const { Rewriter, getPrepareStackTrace } = require(rewriterPackage)
-const path = require('path')
-const Module = require('module')
-const { addEditedFile } = require('./edited-files-cache')
-let rewriter
-let originalPrepareStackTrace = Error.prepareStackTrace
 
 chai.use(sinonChai)
 
 global.expect = chai.expect
 global.sinon = sinon
-
-const CSI_METHODS = [
-  { src: 'plusOperator', operator: true },
-  { src: 'substring' },
-  { src: 'trim' },
-  { src: 'trimStart' },
-  { src: 'trimEnd' },
-  { src: 'trimLeft' },
-  { src: 'trimRight' },
-  { src: 'toLowerCase' },
-  { src: 'toLocaleLowerCase' },
-  { src: 'toUpperCase' },
-  { src: 'toLocaleUpperCase' },
-  { src: 'replace' },
-  { src: 'replaceAll' },
-  { src: 'slice' },
-  { src: 'concat' }
-]
-
-initRewriter()
-
-function initRewriter () {
-  rewriter = new Rewriter({ csiMethods: CSI_METHODS, telemetryVerbosity: 'Debug' })
-  if (rewriter) {
-    Object.defineProperty(global.Error, 'prepareStackTrace', getPrepareStackTraceAccessor())
-    Module.prototype._compile = getCompileMethodFn(Module.prototype._compile)
-  }
-}
-function getPrepareStackTraceAccessor () {
-  let actual = getPrepareStackTrace(originalPrepareStackTrace)
-  return {
-    get () {
-      return actual
-    },
-    set (value) {
-      actual = getPrepareStackTrace(value)
-      originalPrepareStackTrace = value
-    }
-  }
-}
-
-function getCompileMethodFn (compileMethod) {
-  return function (content, filename) {
-    try {
-      if (filename.indexOf(path.join('integration-test', 'requires')) > -1) {
-        const response = rewriter.rewrite(content, filename, ['iast'])
-        content = response.content
-        addEditedFile(filename)
-      }
-    } catch (e) {
-      // eslint-disable-next-line no-console
-      console.error(e)
-    }
-    return compileMethod.apply(this, [content, filename])
-  }
-}

integration-test/requires/error-typescript.ts

@@ -1,4 +1,8 @@
 /* eslint no-unused-expressions: 0 */
+'use strict'
+
+const childProcess = require('child_process')
+const path = require('path')
 const { isFileEdited } = require('./edited-files-cache')
 
 describe('Test stack traces', () => {
@@ -33,4 +37,15 @@ describe('Test stack traces', () => {
       expect(isFileEdited('errors.js')).to.be.true
     })
   })
+
+  describe('When sourcemaps are enabled', () => {
+    it('should calculate stack traces correctly', () => {
+      const result = childProcess.execSync(
+        'node --enable-source-maps --require ./init-rewriter.js ./requires/error-typescript.js',
+        {
+          cwd: __dirname
+        }).toString()
+      expect(result).to.contain(`${path.join('requires', 'error-typescript.ts')}:2:15`)
+    })
+  })
 })

integration-test/setup.js

@@ -4,6 +4,12 @@ const kSymbolPrepareStackTrace = Symbol('_ddiastPrepareStackTrace')
 
 const evalRegex = /.*\(((?:.:[/\\]?)?[/\\].*):(\d*):(\d*)\)/g
 
+function isFlagPresent (flag) {
+  return process.env.NODE_OPTIONS?.includes(flag) ||
+    process.execArgv?.some(arg => arg.includes(flag))
+}
+
+const sourceMapsEnabled = isFlagPresent('--enable-source-maps')
 class WrappedCallSite {
   constructor (callSite) {
     if (callSite.isEval()) {
@@ -33,6 +39,18 @@ class WrappedCallSite {
     this.lineNumber = line
     this.columnNumber = column
     this.callSite = callSite
+
+    // Automatically support methods that are added in newer versions of Node.js
+    const callSiteProto = Object.getPrototypeOf(callSite)
+    const originalCallSiteMethods = Object.getOwnPropertyNames(callSiteProto)
+
+    originalCallSiteMethods.forEach(method => {
+      if (method === 'constructor') return
+      if (this[method]) return
+      if (typeof callSiteProto[method] !== 'function') return
+
+      this[method] = function (...args) { return this.callSite[method](...args) }
+    })
   }
 
   getThis () {
@@ -56,6 +74,10 @@ class WrappedCallSite {
   }
 
   getFileName () {
+    return sourceMapsEnabled ? this.callSite.getFileName() : this.source
+  }
+
+  getTranslatedFileName () {
     return this.source
   }
 
@@ -64,14 +86,26 @@ class WrappedCallSite {
   }
 
   getLineNumber () {
+    return sourceMapsEnabled ? this.callSite.getLineNumber() : this.lineNumber
+  }
+
+  getTranslatedLineNumber () {
     return this.lineNumber
   }
 
   getColumnNumber () {
+    return sourceMapsEnabled ? this.callSite.getColumnNumber() : this.columnNumber
+  }
+
+  getTranslatedColumnNumber () {
     return this.columnNumber
   }
 
   getEvalOrigin () {
+    return sourceMapsEnabled ? this.callSite.getEvalOrigin() : (this.evalOrigin || this.callSite.getEvalOrigin())
+  }
+
+  getTranslatedEvalOrigin () {
     return this.evalOrigin || this.callSite.getEvalOrigin()
   }