@contrast/agentify 1.33.0 → 1.35.0

package/lib/index.js

@@ -65,6 +65,8 @@ module.exports = function init(core = {}) {
   core.startTime = process.hrtime.bigint();
   if (!core.Perf) {
     core.Perf = require('@contrast/perf');
+    // add a filename, maybe derived from logging directory, if desired.
+    core.Perf.setInterval();
   }
 
   let _callback;

package/lib/sources.js

@@ -31,7 +31,16 @@ module.exports = function(core) {
     return function around(next, data) {
       const { args: [event, req, res] } = data;
 
-      if (event !== 'request') return next();
+      if (event !== 'request') {
+        if (event === 'listening') {
+          // take a snapshot of Perf.all at this point. this will get logged
+          // at some point on the perf interval timer.
+          core.Perf.mark('listening');
+        }
+        return next();
+      }
+      // let's count requests.
+      core.Perf.requestCount += 1;
 
       const store = {
         sourceInfo: {

package/lib/utils.js

@@ -33,6 +33,7 @@ const { primordials: { StringPrototypeSlice, StringPrototypeSplit, StringPrototy
  * @param {string} core.nodeEngines
  */
 function preStartupValidation(core) {
+  assertNoExperimentalFeatureFlags();
   assertSupportedNodeVersion(core.nodeEngines || nodeEngines);
   assertSupportedPreloadUsage();
 }
@@ -56,6 +57,22 @@ function assertSupportedNodeVersion(engines) {
   }
 }
 
+/**
+ * Checks that no experimental feature flags are used.
+ * @throws {Error}
+ */
+function assertNoExperimentalFeatureFlags() {
+  const {
+    execArgv,
+    env: { NODE_OPTIONS },
+  } = process;
+
+  if (execArgv.some(arg => arg.includes('--experimental')) || NODE_OPTIONS?.includes('--experimental')) {
+    const msg = 'Contrast Agent does not support experimental features.';
+    throw new Error(msg);
+  }
+}
+
 /**
  * Checks that the correct preload flag is used given running node version.
  * @throws {Error}
@@ -151,5 +168,6 @@ module.exports = {
   assertValidOpts,
   assertSupportedNodeVersion,
   assertSupportedPreloadUsage,
+  assertNoExperimentalFeatureFlags,
   preStartupValidation,
 };

package/lib/utils.test.js

@@ -0,0 +1,110 @@
+'use strict';
+
+const { expect } = require('chai');
+const sinon = require('sinon');
+
+const {
+  assertValidOpts,
+  assertSupportedNodeVersion,
+  assertSupportedPreloadUsage,
+  assertNoExperimentalFeatureFlags,
+} = require('./utils');
+
+describe('preStartupValidation', function() {
+
+  describe('assertValidOpts', function() {
+    it('Does not validate when noValidate is true', function() {
+      const opts = {
+        noValidate: true
+      };
+      expect(assertValidOpts(opts)).to.be.undefined;
+    });
+
+    it('Throws an error if install order is incorrect', function() {
+      const opts = {
+        installOrder: [
+          'telemetry',
+          'reporter',
+          'startupValidation'
+        ]
+      };
+      expect(() => assertValidOpts(opts)).to.throw('The \'installOrder\' option must include \'reporter\' as first element. found \'telemetry\'');
+    });
+  });
+
+  describe('assertSupportedNodeVersion', function() {
+
+    let engines;
+    beforeEach(function() {
+      engines = '>=16.9.1 <17 || >=18.7.0 <19 || >=20.6.0 <21 || >= 22.5.1 <23';
+    });
+
+    it('Does not throw an error if process.version is supported', function() {
+      sinon.stub(process, 'version').value('v22.9.0');
+      expect(assertSupportedNodeVersion(engines)).to.be.undefined;
+    });
+
+    it('Throws an error if process.version is unsupported', function() {
+      sinon.stub(process, 'version').value('v14.0.0');
+      expect(() => assertSupportedNodeVersion(engines)).to.throw('Contrast only officially supports Node LTS versions between 16.9.1 and 17, 18.7.0 and 19, 20.6.0 and 21, 22.5.1 and 23, but detected v14.0.0');
+    });
+
+  });
+
+  describe('assertSupportedPreloadUsage', function() {
+
+    it('does not throw an err if --import flag is used (>= 18.19.0)', function() {
+      sinon.stub(process, 'execArgv').value(['--import', '@contrast/agent']);
+      sinon.stub(process, 'version').value('v22.9.0');
+      expect(assertSupportedPreloadUsage()).to.be.true;
+    });
+
+    it('throws an err if --import flag is used (<= 18.19.0)', function() {
+      sinon.stub(process, 'execArgv').value(['--import', '@contrast/agent']);
+      sinon.stub(process, 'version').value('v18.18.0');
+      expect(() => assertSupportedPreloadUsage()).to.throw('Contrast requires that Node LTS versions >= 18.19.0 use the --import flag for ESM support');
+    });
+
+    it('throws an err if --loader flag is used (>= 18.19.0)', function() {
+      sinon.stub(process, 'execArgv').value(['--loader', '@contrast/agent']);
+      sinon.stub(process, 'version').value('v18.20.0');
+      expect(() => assertSupportedPreloadUsage()).to.throw('Contrast requires that Node versions less than 18.19.0 use the --loader flag for ESM support');
+    });
+
+  });
+
+  describe('assertNoExperimentalFeatureFlags', function() {
+    describe('process.execArgv', function() {
+      it('Does not throw an error if no experimental feature flag is used', function() {
+        sinon.stub(process, 'execArgv').value(['--import', '@contrast/agent']);
+        expect(assertNoExperimentalFeatureFlags()).to.be.undefined;
+      });
+
+      it('Throws an error if an experimental feature flag is used', function() {
+        sinon.stub(process, 'execArgv').value(['--experimental-feature', '--import', '@contrast/agent']);
+        expect(() => assertNoExperimentalFeatureFlags()).to.throw('Contrast Agent does not support experimental features.');
+      });
+    });
+
+    describe('NODE_OPTIONS', function() {
+
+      const origNodeOptions = process.env?.NODE_OPTIONS;
+
+      afterEach(function() {
+        process.env.NODE_OPTIONS = origNodeOptions;
+      });
+
+      it('Does not throw an error if no experimental feature flag is used', function() {
+        process.env.NODE_OPTIONS = '--import @contrast/agent';
+        expect(assertNoExperimentalFeatureFlags()).to.be.undefined;
+      });
+
+      it('Throws an error if an experimental feature flag is used', function() {
+        process.env.NODE_OPTIONS = '--experimental-feature --import @contrast/agent';
+        expect(() => assertNoExperimentalFeatureFlags()).to.throw('Contrast Agent does not support experimental features.');
+      });
+    });
+
+  });
+
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agentify",
-  "version": "1.33.0",
+  "version": "1.35.0",
   "description": "Configures Contrast agent services and instrumentation within an application",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -18,20 +18,20 @@
   },
   "dependencies": {
     "@contrast/common": "1.26.0",
-    "@contrast/config": "1.34.0",
-    "@contrast/core": "1.38.0",
-    "@contrast/deadzones": "1.8.0",
-    "@contrast/dep-hooks": "1.6.0",
-    "@contrast/esm-hooks": "2.12.0",
+    "@contrast/config": "1.35.0",
+    "@contrast/core": "1.40.0",
+    "@contrast/deadzones": "1.10.0",
+    "@contrast/dep-hooks": "1.8.0",
+    "@contrast/esm-hooks": "2.14.0",
     "@contrast/find-package-json": "^1.1.0",
-    "@contrast/instrumentation": "1.16.0",
-    "@contrast/logger": "1.11.0",
-    "@contrast/metrics": "1.14.0",
-    "@contrast/patcher": "1.10.0",
-    "@contrast/perf": "1.1.0",
-    "@contrast/reporter": "1.33.0",
-    "@contrast/rewriter": "1.14.0",
-    "@contrast/scopes": "1.7.0",
+    "@contrast/instrumentation": "1.18.0",
+    "@contrast/logger": "1.13.0",
+    "@contrast/metrics": "1.16.0",
+    "@contrast/patcher": "1.12.0",
+    "@contrast/perf": "1.2.0",
+    "@contrast/reporter": "1.35.0",
+    "@contrast/rewriter": "1.16.0",
+    "@contrast/scopes": "1.9.0",
     "semver": "^7.6.0"
   }
 }