@contrast/agentify 1.42.1 → 1.42.2

package/lib/rewrite-hooks.js

@@ -31,8 +31,6 @@ module.exports = function init(core) {
 
   core.rewriteHooks = {
     install() {
-      if (!core.config.agent.node.rewrite.enable) return;
-
       // don't define this prior to install(), since it will interfere with other
       // components that also need to instrument it e.g. dep-hooks.
       _compile = Module.prototype._compile;
@@ -44,6 +42,10 @@ module.exports = function init(core) {
        * @param {string} filename The file path of the module
        */
       Module.prototype._compile = function (content, filename) {
+        if (!core.config.agent.node.rewrite.enable) {
+          return Reflect.apply(_compile, this, [content, filename]);
+        }
+
         /** @type {import('@contrast/rewriter').RewriteOpts} */
         const options = {
           filename,
@@ -57,9 +59,9 @@ module.exports = function init(core) {
           return Reflect.apply(_compile, this, [content, filename]);
         }
 
-        const result = core.rewriter.rewriteSync(content, options);
 
         try {
+          const result = core.rewriter.rewriteSync(content, options);
           const compiled = Reflect.apply(_compile, this, [result.code, filename]);
 
           if (core.config.agent.node.rewrite.cache.enable) {
@@ -70,7 +72,7 @@ module.exports = function init(core) {
         } catch (err) {
           core.logger.warn(
             { err },
-            'Failed to compile rewritten code for %s, compiling original code.',
+            'Failed to rewrite code for %s, continuing with original code.',
             filename,
           );
 

package/lib/rewrite-hooks.test.js

@@ -12,7 +12,7 @@ const deadzonedFilePath = require.resolve('../test/node_modules/bcryptjs/dist/bc
 const testFileContent = readFileSync(testFilePath).toString();
 
 describe('agentify rewrite-hooks', function () {
-  let core, complileSpy, rewriteHooks;
+  let core, compileSpy, rewriteHooks;
 
   beforeEach(function () {
     core = mocks.core();
@@ -20,9 +20,10 @@ describe('agentify rewrite-hooks', function () {
     core.config = mocks.config();
     core.rewriter = mocks.rewriter();
 
-    complileSpy = sinon.spy(Module.prototype, '_compile');
+    compileSpy = sinon.spy(Module.prototype, '_compile');
 
     rewriteHooks = require('./rewrite-hooks')(core);
+    rewriteHooks.install();
   });
 
   afterEach(function () {
@@ -32,7 +33,6 @@ describe('agentify rewrite-hooks', function () {
 
   it('rewrites code when the cache returns no results expected', function () {
     core.rewriter.cache.readSync.returns(undefined);
-    rewriteHooks.install();
 
     require(testFilePath);
     expect(core.rewriter.rewriteSync).to.have.been.calledWith(testFileContent, {
@@ -42,7 +42,7 @@ describe('agentify rewrite-hooks', function () {
       wrap: true,
     });
     expect(core.logger.warn).not.to.have.been.called;
-    expect(complileSpy).to.have.been.calledWith(
+    expect(compileSpy).to.have.been.calledWith(
       core.rewriter.rewriteSync.getCall(0).returnValue.code,
       testFilePath,
     );
@@ -50,26 +50,23 @@ describe('agentify rewrite-hooks', function () {
 
   it('does not not rewrite code when rewrite.enable is false', function () {
     core.config.agent.node.rewrite.enable = false;
-    rewriteHooks.install();
+    core.config.agent.node.rewrite.cache.enable = false;
 
     require(testFilePath);
     expect(core.rewriter.rewriteSync).not.to.have.been.called;
+    expect(compileSpy).to.have.been.calledWith(testFileContent, testFilePath);
   });
 
   it('does not not rewrite code when the cache returns results', function () {
-    rewriteHooks.install();
-
     require(testFilePath);
     expect(core.rewriter.rewriteSync).not.to.have.been.called;
-    expect(complileSpy).to.have.been.calledWith(
+    expect(compileSpy).to.have.been.calledWith(
       core.rewriter.cache.readSync.getCall(0).returnValue,
       testFilePath,
     );
   });
 
-  it('logs a debug message when a file is rewrite-deadzoned', function() {
-    rewriteHooks.install();
-
+  it('logs a debug message when a file is rewrite-deadzoned', function () {
     require(deadzonedFilePath);
 
     expect(core.logger.debug).calledWith(
@@ -84,8 +81,6 @@ describe('agentify rewrite-hooks', function () {
       code: content.replace('const variable', 'const variable const a'),
     }));
 
-    rewriteHooks.install();
-
     require(testFilePath);
     expect(core.rewriter.rewriteSync).to.have.been.calledWith(testFileContent, {
       filename: testFilePath,
@@ -99,10 +94,10 @@ describe('agentify rewrite-hooks', function () {
           message: 'Missing initializer in const declaration',
         }),
       },
-      'Failed to compile rewritten code for %s, compiling original code.',
+      'Failed to rewrite code for %s, continuing with original code.',
       testFilePath,
     );
-    expect(complileSpy).to.have.been.calledWith(
+    expect(compileSpy).to.have.been.calledWith(
       testFileContent,
       testFilePath,
     );
@@ -113,8 +108,6 @@ describe('agentify rewrite-hooks', function () {
     const testFilePath = require.resolve('../test/resources/file-bad');
     const testFileContent = readFileSync(testFilePath).toString();
 
-    rewriteHooks.install();
-
     expect(() => require(testFilePath)).to.throw('Unexpected identifier');
     expect(core.rewriter.rewriteSync).to.have.been.calledWith(testFileContent, {
       filename: testFilePath,
@@ -128,10 +121,10 @@ describe('agentify rewrite-hooks', function () {
           message: sinon.match('Unexpected identifier'),
         }),
       },
-      'Failed to compile rewritten code for %s, compiling original code.',
+      'Failed to rewrite code for %s, continuing with original code.',
       testFilePath,
     );
-    expect(complileSpy).to.have.been.calledWith(
+    expect(compileSpy).to.have.been.calledWith(
       testFileContent,
       testFilePath,
     );

package/lib/utils.js

@@ -15,6 +15,7 @@
 
 'use strict';
 
+const { platform, arch } = require('os');
 const path = require('path');
 const process = require('process');
 const semver = require('semver');
@@ -36,6 +37,7 @@ function preStartupValidation(core) {
   assertNoExperimentalFeatureFlags();
   assertSupportedNodeVersion(core.nodeEngines || nodeEngines);
   assertSupportedPreloadUsage();
+  assertEnvironmentMatchesBuild();
 }
 
 /**
@@ -57,6 +59,25 @@ function assertSupportedNodeVersion(engines) {
   }
 }
 
+/**
+ * Checks that some of our precompiled dependencies are included and callable.
+ * This should ensure that we're running in the same environment that we were
+ * installed in.
+ * @throws {Error}
+ */
+function assertEnvironmentMatchesBuild() {
+  try {
+    /* eslint-disable node/no-extraneous-require */
+    // since swc is a codependency of the agent it should always be present but
+    // doesn't necessarily need to be included in this module's dependencies.
+    require('@swc/core').parseSync('');
+  } catch (cause) {
+    throw (cause.message === 'Bindings not found.') ?
+      new Error(`Contrast cannot detect the correct precompiled dependencies for the current environment: ${platform()}-${arch()}. This typically occurs when deploying an installation from one environment to a different execution environment.`, { cause })
+      : cause;
+  }
+}
+
 /**
  * Checks that no experimental feature flags are used.
  * @throws {Error}
@@ -169,5 +190,6 @@ module.exports = {
   assertSupportedNodeVersion,
   assertSupportedPreloadUsage,
   assertNoExperimentalFeatureFlags,
+  assertEnvironmentMatchesBuild,
   preStartupValidation,
 };

package/lib/utils.test.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const { expect } = require('chai');
+const proxyquire = require('proxyquire');
 const sinon = require('sinon');
 
 const {
@@ -10,17 +11,17 @@ const {
   assertNoExperimentalFeatureFlags,
 } = require('./utils');
 
-describe('preStartupValidation', function() {
+describe('preStartupValidation', function () {
 
-  describe('assertValidOpts', function() {
-    it('Does not validate when noValidate is true', 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() {
+    it('Throws an error if install order is incorrect', function () {
       const opts = {
         installOrder: [
           'telemetry',
@@ -32,40 +33,40 @@ describe('preStartupValidation', function() {
     });
   });
 
-  describe('assertSupportedNodeVersion', function() {
+  describe('assertSupportedNodeVersion', function () {
 
     let engines;
-    beforeEach(function() {
+    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() {
+    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() {
+    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() {
+  describe('assertSupportedPreloadUsage', function () {
 
-    it('does not throw an err if --import flag is used (>= 18.19.0)', 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() {
+    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() {
+    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');
@@ -73,33 +74,33 @@ describe('preStartupValidation', function() {
 
   });
 
-  describe('assertNoExperimentalFeatureFlags', function() {
-    describe('process.execArgv', function() {
-      it('Does not throw an error if no experimental feature flag is used', function() {
+  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() {
+      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() {
+    describe('NODE_OPTIONS', function () {
 
       const origNodeOptions = process.env?.NODE_OPTIONS;
 
-      afterEach(function() {
+      afterEach(function () {
         process.env.NODE_OPTIONS = origNodeOptions;
       });
 
-      it('Does not throw an error if no experimental feature flag is used', function() {
+      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() {
+      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.');
       });
@@ -107,4 +108,24 @@ describe('preStartupValidation', function() {
 
   });
 
+  describe('assertEnvironmentMatchesBuild', function () {
+    let swcMock, utils;
+
+    beforeEach(function () {
+      swcMock = { parseSync: sinon.stub() };
+
+      utils = proxyquire('./utils', {
+        '@swc/core': swcMock,
+      });
+    });
+
+    it('does not throw when dependencies are present and callable', function () {
+      expect(() => utils.assertEnvironmentMatchesBuild()).not.to.throw();
+    });
+
+    it('throws when a dependency is missing or throws', function () {
+      swcMock.parseSync.throws(new Error('Bindings not found.'));
+      expect(() => utils.assertEnvironmentMatchesBuild()).to.throw();
+    });
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agentify",
-  "version": "1.42.1",
+  "version": "1.42.2",
   "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)",
@@ -22,7 +22,7 @@
     "@contrast/core": "1.45.1",
     "@contrast/deadzones": "1.17.1",
     "@contrast/dep-hooks": "1.14.1",
-    "@contrast/esm-hooks": "2.19.1",
+    "@contrast/esm-hooks": "2.19.2",
     "@contrast/find-package-json": "^1.1.0",
     "@contrast/instrumentation": "1.24.1",
     "@contrast/logger": "1.18.1",
@@ -30,7 +30,7 @@
     "@contrast/patcher": "1.17.1",
     "@contrast/perf": "1.3.1",
     "@contrast/reporter": "1.41.1",
-    "@contrast/rewriter": "1.21.1",
+    "@contrast/rewriter": "1.21.2",
     "@contrast/scopes": "1.15.1",
     "on-finished": "^2.4.1",
     "semver": "^7.6.0"