@contrast/agent 4.32.1 → 4.32.3

package/lib/hooks/module/helpers.js

@@ -12,6 +12,8 @@ Copyright: 2023 Contrast Security, Inc
   engineered, modified, repackaged, sold, redistributed or otherwise used in a
   way not consistent with the End User License Agreement.
 */
+'use strict';
+
 const fs = require('fs');
 const os = require('os');
 const makeDir = require('make-dir');
@@ -64,10 +66,13 @@ module.exports.cache = async function cache(agent, filename, result) {
   const cachedFilename = getCachedFilename(agent, filename);
 
   try {
-    await makeDir(path.dirname(cachedFilename), {
-      recursive: true
-    });
+    await makeDir(path.dirname(cachedFilename), { recursive: true });
     await writeFile(cachedFilename, result, 'utf8');
+
+    logger.trace('Cache entry created: %o', {
+      filename,
+      cachedFilename,
+    });
   } catch (err) {
     logger.warn('Unable to cache rewrite results for %s: %o', filename, err);
   }
@@ -84,9 +89,9 @@ module.exports.cache = async function cache(agent, filename, result) {
 module.exports.cacheWithSourceMap = async function cacheWithSourceMap(
   agent,
   filename,
-  result
+  result,
 ) {
-  if (!agent.config.agent.node.rewrite_cache.enable) return null;
+  if (!agent.config.agent.node.rewrite_cache.enable) return;
   // if this is the result of the estools rewriter, we want to use
   // the normal caching functionality
   if (!result.code) {
@@ -97,12 +102,18 @@ module.exports.cacheWithSourceMap = async function cacheWithSourceMap(
 
   try {
     await makeDir(path.dirname(cachedFilename), {
-      recursive: true
+      recursive: true,
     });
     await Promise.all([
       writeFile(cachedFilename, result.code, 'utf8'),
-      writeFile(`${cachedFilename}.map`, JSON.stringify(result.map), 'utf8')
+      writeFile(`${cachedFilename}.map`, JSON.stringify(result.map), 'utf8'),
     ]);
+
+    logger.trace('Cache entry created: %o', {
+      filename,
+      cachedFilename,
+      map: true,
+    });
   } catch (err) {
     logger.warn('Unable to cache rewrite results for %s: %o', filename, err);
   }
@@ -121,19 +132,42 @@ module.exports.find = function find(agent, filename) {
   const cachedFilename = getCachedFilename(agent, filename);
 
   try {
+    const time = mtime(filename);
+    const cachedTime = mtime(cachedFilename);
+
     // if the file being loaded is newer than our cache entry, recompile
-    if (mtime(filename) > mtime(cachedFilename)) return undefined;
+    if (time > cachedTime) {
+      logger.trace('Cache invalid, falling back to compiling: %o', {
+        sourceFilename: filename,
+        cachedFilename,
+        sourceTime: time,
+        cachedTime,
+      });
+      return;
+    }
+
     // otherwise we can simply return the content of the cached file
+    logger.trace('Cache valid: %o', {
+      sourceFilename: filename,
+      cachedFilename,
+      sourceTime: time,
+      cachedTime,
+    });
     return fs.readFileSync(cachedFilename, 'utf8');
   } catch (err) {
     // statSync throws when file is not found, any error not ENOENT is bad
-    if (err.code !== 'ENOENT')
+    if (err.code !== 'ENOENT') {
       logger.error(
         'An unexpected error occurred, falling back to compiling %s: %o',
         filename,
-        err
+        err,
       );
+    }
 
+    logger.trace('Cache miss, falling back to compiling: %o', {
+      filename,
+      cachedFilename,
+    });
     return undefined;
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agent",
-  "version": "4.32.1",
+  "version": "4.32.3",
   "description": "Node.js security instrumentation by Contrast Security",
   "keywords": [
     "security",