@contrast/rewriter 1.39.0 → 1.40.0

package/lib/cache.js

@@ -141,52 +141,6 @@ module.exports.Cache = class Cache {
     }
   }
 
-  /**
-   * Asynchronously looks up and returns the source map for a previously rewritten file.
-   * @param {string} filename
-   * @returns {Promise<string | undefined>}
-   */
-  async readMap(filename) {
-    const filenameCached = this.getCachedFilename(filename);
-    const sourceMap = `${filenameCached}.map`;
-
-    try {
-      return fsPromises.readFile(sourceMap, 'utf8');
-    } catch (err) {
-      // @ts-expect-error ts treats errors poorly.
-      if (err.code !== 'ENOENT') {
-        this.logger.warn(
-          { err, filename, filenameCached, sourceMap },
-          'An unexpected error occurred finding source map.'
-        );
-      }
-      return undefined;
-    }
-  }
-
-
-  /**
-   * Synchronously looks up and returns the source map for a previously rewritten file.
-   * @param {string} filename
-   * @returns {string | undefined}
-   */
-  readMapSync(filename) {
-    const filenameCached = this.getCachedFilename(filename);
-    const sourceMap = `${filenameCached}.map`;
-    try {
-      return fs.readFileSync(sourceMap, 'utf8');
-    } catch (err) {
-      // @ts-expect-error ts treats errors poorly.
-      if (err.code !== 'ENOENT') {
-        this.logger.warn(
-          { err, filename, filenameCached, sourceMap },
-          'An unexpected error occurred finding source map.'
-        );
-      }
-      return undefined;
-    }
-  }
-
   /**
    * Looks up and returns the string content of a previously rewritten file
    * synchronously. Used when we need to block on cache lookups.

package/lib/index.js

@@ -15,8 +15,7 @@
 // @ts-check
 'use strict';
 const { arch, platform } = require('node:os');
-// @ts-expect-error
-const { SourceMapConsumer: SourceMapConsumerSync } = require('@contrast/synchronous-source-maps');
+const { findSourceMap } = require('node:module');
 const { parseSync, transform, transformSync } = require('@swc/core');
 // @ts-expect-error `@contrast/agent-swc-plugin` .d.ts file doesn't exist.
 const { defaultRewriter, defaultUnwriter } = require('@contrast/agent-swc-plugin');
@@ -70,7 +69,7 @@ class Rewriter {
    */
   swcOptions(opts) {
     const nodeCfg = this.core.config.agent.node;
-    const sourceMaps = nodeCfg.source_maps.enable;
+    const sourceMaps = nodeCfg.source_maps.inline ? 'inline' : nodeCfg.source_maps.enable;
     const minify = opts.minify && nodeCfg.source_maps.enable && nodeCfg.rewrite.minify;
     opts.minify = minify;
     return {
@@ -110,22 +109,23 @@ class Rewriter {
    * - result.map.sources array
    * @param {RewriteOpts} rewriteOpts
    * @param {import('@swc/core').Output} result
+   * @returns {import('@swc/core').Output}
    */
-  adjustMap(rewriteOpts, result) {
+  adjustResult(rewriteOpts, result) {
     if (rewriteOpts.filename && result.map) {
       const map = JSON.parse(result.map);
       const cachedFilename = this.cache.getCachedFilename(rewriteOpts.filename);
-      const absoluteCachedMapName = `${cachedFilename}.map`;
-      const origMapURL = `${primordials.PathBasename(rewriteOpts.filename)}.map`;
-      const comment = `${MAGIC_COMMENT_PREFIX}${origMapURL}`;
 
       // 1) magic comment
       // https://github.com/nodejs/node/blob/main/lib/internal/source_map/source_map_cache.js#L134-L136
-      const i = result.code.lastIndexOf(comment);
+      const i = result.code.lastIndexOf(MAGIC_COMMENT_PREFIX);
       if (i >= 0) {
         let code = primordials.StringPrototypeSubstr.call(result.code, 0, i);
-        code += `${MAGIC_COMMENT_PREFIX}${absoluteCachedMapName}`;
+        code += `${MAGIC_COMMENT_PREFIX}${cachedFilename}.map`;
         result.code = code;
+      } else {
+        // if the comment is missing entirely, add it
+        result.code += `${MAGIC_COMMENT_PREFIX}${cachedFilename}.map`;
       }
       // 2) map.sources array
       for (let i = 0; i < map.sources?.length; i++) {
@@ -140,6 +140,8 @@ class Rewriter {
       // reasign modified map
       result.map = primordials.JSONStringify(map);
     }
+
+    return result;
   }
 
   /**
@@ -153,9 +155,8 @@ class Rewriter {
   async rewrite(content, opts = {}) {
     const rewriteOpts = this.swcOptions(opts);
     this.logger.trace({ opts }, 'rewriting %s', opts.filename);
-    const ret = await transform(content, rewriteOpts);
-    this.adjustMap(rewriteOpts, ret);
-    return ret;
+    const result = await transform(content, rewriteOpts);
+    return this.adjustResult(rewriteOpts, result);
   }
 
   /**
@@ -171,8 +172,7 @@ class Rewriter {
     const rewriteOpts = this.swcOptions(opts);
     this.logger.trace({ opts }, 'rewriting %s', opts.filename);
     const result = transformSync(content, rewriteOpts);
-    this.adjustMap(rewriteOpts, result);
-    return result;
+    return this.adjustResult(rewriteOpts, result);
   }
 
   /**
@@ -198,18 +198,11 @@ class Rewriter {
   }
 
   /**
-   * TODO implement for async scenarios using newer versions of source-map
-   * @param {function} func
-   */
-  async funcInfo(func) {
-    throw new Error('funcInfo is not implemented');
-  }
-
-  /**
-   * @param {function} func
+   * @param {Function} func
+   * @returns {any} replace with {import('@contrast/fn-inspect').FuncInfo} once exported from fn-inspect
    */
   funcInfoSync(func) {
-    /** @type any */
+    /** @type {any} {import('@contrast/fn-inspect').FuncInfo} */
     const fnInfo = funcInfo(func);
 
     if (
@@ -219,17 +212,20 @@ class Rewriter {
       !this.core.config.agent.node.source_maps.enable
     ) return fnInfo;
 
-    const map = this.cache.readMapSync(fnInfo.file);
-    if (!map) return fnInfo;
+    try {
+      const map = findSourceMap(fnInfo.file);
+      if (!map) return fnInfo;
 
-    const orig = new SourceMapConsumerSync(map).originalPositionFor({
-      line: fnInfo.lineNumber + 1,
-      column: fnInfo.column,
-    });
-    if (orig) {
-      fnInfo.file = orig.source ? primordials.PathResolve(fnInfo.file, '..', orig.source) : fnInfo.file;
-      fnInfo.lineNumber = orig.line;
-      fnInfo.column = orig.column;
+      const entry = map.findEntry(fnInfo.lineNumber, fnInfo.column);
+      if (entry) {
+        fnInfo.file = entry.originalSource ? primordials.PathResolve(fnInfo.file, '..', entry.originalSource) : fnInfo.file;
+
+        // fn-inspect and source map entries are 0 indexed, but stack traces display 1-indexed lines and columns.
+        fnInfo.lineNumber = entry.originalLine + 1;
+        fnInfo.column = entry.originalColumn + 1;
+      }
+    } catch (err) {
+      this.logger.debug({ err, fnInfo }, 'findSourceMap failed for %s', fnInfo.file);
     }
 
     return fnInfo;

package/lib/rewrite-is-deadzoned.js

@@ -60,12 +60,20 @@ const DEADZONED_PATHS = [
   'moment-timezone',
   'node-forge',
   'node-webpack',
+  `@opentelemetry${sep}api`,
+  `@opentelemetry${sep}core`,
+  `@opentelemetry${sep}instrumentation`,
+  `@opentelemetry${sep}resources`,
+  `@opentelemetry${sep}sdk-metrics`,
+  `@opentelemetry${sep}sdk-trace-base`,
+  `@opentelemetry${sep}sdk-trace-node`,
   'pem',
   'react',
   'react-dom', // doesn't this cover the next line?
   //'react-dom/server',
   'requirejs',
   'semver',
+  '@sentry',
   'strong-remoting',
   'type-is',
   'uglify-js',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/rewriter",
-  "version": "1.39.0",
+  "version": "1.40.0",
   "description": "A transpilation tool mainly used for instrumentation",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -21,12 +21,11 @@
   },
   "dependencies": {
     "@contrast/agent-swc-plugin": "3.2.0",
-    "@contrast/common": "1.41.0",
-    "@contrast/config": "1.57.0",
-    "@contrast/core": "1.62.0",
+    "@contrast/common": "1.41.1",
+    "@contrast/config": "1.58.0",
+    "@contrast/core": "1.63.0",
     "@contrast/fn-inspect": "^5.0.2",
-    "@contrast/logger": "1.35.0",
-    "@contrast/synchronous-source-maps": "^1.1.5",
+    "@contrast/logger": "1.36.0",
     "@swc/core": "1.13.3"
   }
 }