@contrast/agent 4.21.1 → 4.22.0

package/bin/VERSION

@@ -1 +1 @@
-2.28.20
+2.28.22

package/lib/reporter/speedracer/index.js

@@ -16,7 +16,6 @@ Copyright: 2022 Contrast Security, Inc
 
 const cp = require('child_process');
 const fs = require('fs');
-const os = require('os');
 const path = require('path');
 // according to https://nodejs.org/api/process.html#process_process the process
 // global can be required.  We're only doing so here so we can mock it out in tests
@@ -37,6 +36,21 @@ const SuccessConnectionState = require('./success-connection-state');
 
 const RESEND_WAIT_MS = 100;
 
+/**
+ * We might have the /bin/* files in /target directory if we're in
+ * development. Packaged/installed agents will have the executables in a
+ * top-level directory, e.g. /node_modules/@contrast/agent/bin/*
+ * @returns {'target' | '.'}
+ */
+const maybeTargetDir = () => {
+  try {
+    fs.statSync(path.resolve(__dirname, '..', '..', '..', 'target'));
+    return 'target';
+  } catch (error) {
+    return '.';
+  }
+};
+
 class Speedracer {
   constructor({ agent, logger }) {
     this.agent = agent;
@@ -155,7 +169,35 @@ class Speedracer {
     this.logger.info('starting contrast-service');
     this.startTime = Date.now();
 
-    this.serviceProcess = cp.spawn(this.startCommand, this.startOptions);
+    const speedracerPath = path.resolve(
+      __dirname,
+      '..',
+      '..',
+      '..',
+      maybeTargetDir(),
+      'bin',
+      `contrast-service-${process.platform}-${process.arch}`
+    );
+
+    try {
+      fs.statSync(speedracerPath);
+    } catch (error) {
+      this.logger.error(
+        'unable to locate a speedracer binary for the current platform (%s) and architecture (%s)',
+        process.platform,
+        process.arch
+      );
+      return Promise.reject();
+    }
+
+    this.serviceProcess = cp.spawn(speedracerPath, {
+      env: {
+        ...process.env,
+        CONTRAST_CONFIG_PATH: this.agent.config.configFile
+      },
+      stdio: 'ignore',
+      windowsHide: true
+    });
 
     this.serviceProcess.on('error', (err) => {
       this.serviceProcess = null;
@@ -262,39 +304,6 @@ class Speedracer {
     }
   }
 
-  /**
-   * The start command for spawning the speedracer
-   */
-  get startCommand() {
-    return path.resolve(
-      __dirname,
-      path.join(
-        '..',
-        '..',
-        '..',
-        utils.maybeTargetDir(),
-        'bin',
-        utils.getOsDir(),
-        'contrast-service'
-      )
-    );
-  }
-
-  /**
-   * The start options for spawning the speedracer child process. We provide the
-   * service the location of our config file via environment variable.
-   */
-  get startOptions() {
-    return {
-      env: {
-        ...process.env,
-        CONTRAST_CONFIG_PATH: this.agent.config.configFile
-      },
-      stdio: 'ignore',
-      windowsHide: true
-    };
-  }
-
   /**
    * GRPC is enabled when `agent.service.grpc` is not false, e.g., undefined
    * defaults to enabled, and `agent.service.socket` is not configured
@@ -314,39 +323,4 @@ class Speedracer {
   }
 }
 
-const utils = {
-  /**
-   * We might have the /bin/* files in /target directory if we're in
-   * development. Packaged/installed agents will have the executables in a
-   * top-level directory, e.g. /node_modules/@contrast/agent/bin/*
-   * @returns {String}
-   */
-  maybeTargetDir() {
-    try {
-      fs.statSync(
-        path.resolve(__dirname, path.join('..', '..', '..', 'target'))
-      );
-      return 'target';
-    } catch (error) {
-      return '';
-    }
-  },
-  /**
-   * Map platform values to folder names based on OS. The folder names are
-   * determined by the packaging of the S-R artifacts and how they unzip.
-   * @returns {String}
-   */
-  getOsDir() {
-    switch (os.platform()) {
-      case 'linux':
-        return 'linux';
-      case 'darwin':
-        return 'mac';
-      case 'win32':
-        return 'windows';
-    }
-  }
-};
-
 module.exports = Speedracer;
-module.exports.utils = utils;

package/lib/util/heap-dump.js

@@ -12,51 +12,63 @@ Copyright: 2022 Contrast Security, Inc
   engineered, modified, repackaged, sold, redistributed or otherwise used in a
   way not consistent with the End User License Agreement.
 */
-const path = require('path');
+'use strict';
+
 const fs = require('fs');
+const path = require('path');
+const v8 = require('v8');
 const logger = require('../core/logger')('contrast:heapDump');
-const heapUtil = module.exports;
-let heapdump;
 
 /**
- * setup n heap dumps to be created every n seconds after n seconds.
+ * @param {string} localPath location from config.path
+ */
+const writeHeapSnapshot = function writeHeapSnapshot(localPath) {
+  const dumpPath = path.join(process.cwd(), localPath);
+
+  fs.mkdir(dumpPath, { recursive: true }, (err) => {
+    if (err) {
+      logger.error('Unable to create directory for heap snapshots: %o', err);
+      return;
+    }
+
+    // create dump at ${path}/${time}.heapdump
+    const filename = path.format({
+      dir: dumpPath,
+      name: `${Date.now()}-contrast`,
+      ext: '.heapsnapshot',
+    });
+
+    logger.info('Writing heap snapshot at %s', filename);
+    v8.writeHeapSnapshot(filename);
+  });
+};
+
+/**
+ * setup x heap dumps to be created every y seconds after z seconds.
  * @param {Object} config config blob from config/options.js
- *   must have: window_ms (Number), delay_ms (Number), dumpPath (String), count (Number)
+ * @param {boolean} config.enable
+ * @param {string} config.path
+ * @param {number} config.count x
+ * @param {number} config.window_ms y
+ * @param {number} config.delay_ms z
  */
-heapUtil.init = function(config) {
+const init = function init(config) {
   if (!config.enable) return;
-  // NODE-1200: make this optional based on if config
-  // bit is flipped
-  heapdump = require('@contrast/heapdump');
 
   setTimeout(() => {
     let count = 0;
-    const timeout = setInterval(() => {
+
+    const interval = setInterval(() => {
       if (count >= config.count) {
-        clearInterval(timeout);
+        clearInterval(interval);
         return;
       }
-      heapUtil.buildDump(config.path);
+
+      writeHeapSnapshot(config.path);
 
       count++;
     }, config.window_ms);
   }, config.delay_ms).unref();
 };
 
-heapUtil.buildDump = function(dumpPath) {
-  // create directory in cwd
-  dumpPath = `${path.join(process.cwd(), dumpPath)}`;
-  fs.mkdir(dumpPath, (err) => {
-    if (!err || (err && err.code == 'EEXIST')) {
-      // create dump at ${path}/${time}.heapdump
-      const fileName = `${path.join(
-        dumpPath,
-        String(Date.now())
-      )}-contrast.heapsnapshot`;
-      logger.info(`Building heap snapshot at ${fileName}`);
-      heapdump.writeSnapshot(fileName);
-    } else {
-      logger.error(`Unable to create directory for heap snapshots: ${err}`);
-    }
-  });
-};
+module.exports = { writeHeapSnapshot, init };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agent",
-  "version": "4.21.1",
+  "version": "4.22.0",
   "description": "Node.js security instrumentation by Contrast Security",
   "keywords": [
     "security",
@@ -76,11 +76,10 @@
     "@babel/template": "^7.10.4",
     "@babel/traverse": "^7.12.1",
     "@babel/types": "^7.12.1",
-    "@contrast/agent-lib": "^4.2.0",
+    "@contrast/agent-lib": "^4.3.0",
     "@contrast/distringuish-prebuilt": "^3.2.0",
     "@contrast/flat": "^4.1.1",
-    "@contrast/fn-inspect": "^3.0.0",
-    "@contrast/heapdump": "^1.1.0",
+    "@contrast/fn-inspect": "^3.1.0",
     "@contrast/protobuf-api": "^3.2.5",
     "@contrast/require-hook": "^3.2.1",
     "@contrast/synchronous-source-maps": "^1.1.0",