@contrast/agent 4.25.6-beta.0 → 4.26.0

package/lib/assess/models/call-context.js

@@ -21,6 +21,7 @@ const stackFactory = require('../../core/stacktrace').singleton;
 const { PROXY_TARGET } = require('../../../lib/constants');
 const TagRange = require('../models/tag-range');
 const distringuish = require('@contrast/distringuish');
+const agent = require('../../agent');
 
 /**
  * Holds information about the call context of a function
@@ -153,13 +154,36 @@ function valueString(value) {
   return type;
 }
 
-function create(params) {
+const appendStack = agent.config.assess.enable_lazy_stacktraces ?
+    (instance, snapshot) => {
+      let stack;
+      // This enables the lazy generation of a stacktrace which is a performance
+      // improvement, but the snapshot method call is in a closure which creates
+      // a memory leak in longer running tests
+      Object.defineProperty(instance, 'stack', {
+        enumerable: true,
+        configurable: true,
+        get() {
+          if (!stack) {
+            stack = snapshot();
+          }
+          return stack;
+        },
+        set(value) {
+          stack = value;
+        }
+      });
+    } : (instance, snapshot) => {
+      instance.stack = snapshot();
+    };
+
+function create (params) {
   const instance = new CallContext(params);
   const snapshot = params.stacktrace || stackFactory.createSnapshot({
     constructorOpt: params.hooked
   });
 
-  instance.stack = typeof snapshot === 'function' ? snapshot() : snapshot;
+  appendStack(instance, snapshot);
 
   return instance;
 }

package/lib/assess/models/index.js

@@ -12,6 +12,8 @@ Copyright: 2022 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 CallContext = require('./call-context');
 const Signature = require('./signature');
 const BaseEvent = require('./base-event');

package/lib/core/config/options.js

@@ -761,6 +761,13 @@ const assess = [
     fn: castBoolean,
     desc: 'When set to `false` won\'t track the source events lazily but will track the first up to 250 source events',
   },
+  {
+    name: 'assess.enable_lazy_stacktraces',
+    arg: '[false]',
+    default: false,
+    fn: castBoolean,
+    desc: 'When set to `true` it will evaluate stacktraces lazily, this improves performance, but causes a memory leak if used in a longer running application',
+  },
 ];
 
 const protect = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agent",
-  "version": "4.25.6-beta.0",
+  "version": "4.26.0",
   "description": "Node.js security instrumentation by Contrast Security",
   "keywords": [
     "security",
@@ -138,7 +138,7 @@
     "dustjs-linkedin": "^3.0.1",
     "ejs": "^3.1.7",
     "escape-html": "^1.0.3",
-    "eslint": "^8.9.0",
+    "eslint": "^8.26.0",
     "eslint-plugin-mocha": "^10.0.3",
     "eslint-plugin-node": "^11.1.0",
     "express": "file:test/mock/express",
@@ -158,7 +158,7 @@
     "lint-staged": "^12.0.2",
     "madge": "^4.0.1",
     "marsdb": "file:test/mock/marsdb",
-    "mocha": "^9.2.0",
+    "mocha": "^9.2.2",
     "mochawesome": "^7.0.1",
     "mock-fs": "^5.1.2",
     "mongodb": "file:test/mock/mongodb",