@contrast/core 1.34.1 → 1.35.1

package/lib/app-info.js

@@ -16,8 +16,9 @@
 'use strict';
 
 const os = require('os');
-const path = require('path');
 const fs = require('fs');
+const path = require('path');
+const semver = require('semver'); // eslint-disable-line node/no-extraneous-require
 const process = require('process');
 const { IntentionalError } = require('@contrast/common');
 const { findPackageJsonSync } = require('@contrast/find-package-json');
@@ -33,6 +34,7 @@ module.exports = function (core) {
   const { logger, config } = core;
   const { app_root, cmd_ignore_list, exclusive_entrypoint } = config.agent.node;
 
+  checkPreLoadFlag();
   const cmd = getCommand();
   const pkgInfo = getPackageInfo();
   const entrypoint = getEntrypoint();
@@ -55,7 +57,7 @@ module.exports = function (core) {
     app_dir: pkgInfo.dir,
     version: config.application.version || pkgInfo.packageData.version,
     serverVersion: config.server.version,
-    node_version: process.version,
+    nodeVersion: process.version,
     appPath: config.application.path || pkgInfo.dir,
     serverName: config.server.name,
     serverType: config.server.type,
@@ -67,6 +69,26 @@ module.exports = function (core) {
   return core.appInfo;
 
 
+  function checkPreLoadFlag() {
+    const { version, execArgv } = process;
+    [
+      { range: '>=18.19.0', flags: ['--import'] },
+      { range: '>=16.17.0 <18.19.0', flags: ['--loader'] },
+      { range: '<16.17.0', flags: ['-r', '--require'] }
+    ].forEach(({ range, flags }) => {
+      if (
+        semver.satisfies(version, range) &&
+        !execArgv.some((el, idx) => el === '@contrast/agent' && flags.includes(execArgv[idx - 1]))
+      ) {
+        logger.warn(
+          'For Node LTS %s, use %s command to run the agent. See: https://docs.contrastsecurity.com/en/install-node-js.html',
+          range,
+          flags
+        );
+      }
+    });
+  }
+
   /**
    * Generates a command string based on ARGV and process.argv0, which will be used
    * for the `appInfo.cmd` field. This function will throw if any of the config's

package/lib/app-info.test.js

@@ -23,7 +23,9 @@ describe('core app-info', function () {
       release: sinon.stub().returns('1.23.45'),
       hostname: sinon.stub().returns('hostname'),
     };
+  });
 
+  it('builds out app data from os and process information', function () {
     appInfo = proxyquire(
       './app-info',
       {
@@ -35,9 +37,7 @@ describe('core app-info', function () {
         }
       }
     )(core);
-  });
 
-  it('builds out app data from os and process information', function () {
     expect(appInfo).to.deep.include({
       os: {
         type: 'Linux',
@@ -48,7 +48,7 @@ describe('core app-info', function () {
       hostname: 'hostname',
       indexFile: __filename,
       serverVersion: undefined,
-      node_version: 'v14.17.5',
+      nodeVersion: 'v14.17.5',
       appPath: '/',
       serverName: 'zoing',
       serverType: 'Node.js',
@@ -79,4 +79,52 @@ describe('core app-info', function () {
 
     process.env.npm_package_json = npm_package_json;
   });
+
+  [
+    { version: 'v20.12.0', range: '>=18.19.0', badFlag: '-r', goodFlag: ['--import'] },
+    { version: 'v18.18.0', range: '>=16.17.0 <18.19.0', badFlag: '-r', goodFlag: ['--loader'] },
+    { version: 'v16.16.0', range: '<16.17.0', badFlag: '--loader', goodFlag: ['-r', '--require'] }
+  ].forEach(({ version, range, badFlag, goodFlag }) => {
+    it('logs a warning if non-recommended preload flag is used ', function() {
+      appInfo = proxyquire(
+        './app-info',
+        {
+          os,
+          process: {
+            ...process,
+            argv: ['node', __filename],
+            version,
+            execArgv: [badFlag, '@contrast/agent']
+          }
+        }
+      )(core);
+      expect(core.logger.warn).to.have.been.calledWith(
+        'For Node LTS %s, use %s command to run the agent. See: https://docs.contrastsecurity.com/en/install-node-js.html',
+        range,
+        goodFlag
+      );
+    });
+  });
+
+  [
+    { version: 'v20.12.0', goodFlag: '--import' },
+    { version: 'v18.18.0', goodFlag: '--loader' },
+    { version: 'v16.16.0', goodFlag: '--require' }
+  ].forEach(({ version, goodFlag }) => {
+    it('does not log a warning if recommended preload flag is used ', function() {
+      appInfo = proxyquire(
+        './app-info',
+        {
+          os,
+          process: {
+            ...process,
+            argv: ['node', __filename],
+            version,
+            execArgv: [goodFlag, '@contrast/agent']
+          }
+        }
+      )(core);
+      expect(core.logger.warn).not.to.have.been.called;
+    });
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/core",
-  "version": "1.34.1",
+  "version": "1.35.1",
   "description": "Preconfigured Contrast agent core services and models",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -16,9 +16,12 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.23.0",
+    "@contrast/common": "1.24.0",
+    "@contrast/config": "1.31.0",
     "@contrast/find-package-json": "^1.0.0",
     "@contrast/fn-inspect": "^4.3.0",
-    "axios": "^1.6.8"
+    "@contrast/logger": "1.8.5",
+    "@contrast/patcher": "1.7.5",
+    "axios": "^1.7.4"
   }
 }