@contrast/agentify 1.13.1 → 1.15.0

package/lib/heap-snapshots.js

@@ -0,0 +1,63 @@
+/*
+ * Copyright: 2023 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const v8 = require('v8');
+
+module.exports = function init(core) {
+  const {
+    config: {
+      agent: { heap_dump },
+    },
+    logger
+  } = core;
+
+  const dir = path.join(process.cwd(), heap_dump.path);
+  const ext = '.heapsnapshot';
+
+  const heapSnapshots = {
+    writeHeapSnapshot() {
+      const filename = path.format({ name: `${Date.now()}-contrast`, dir, ext });
+      logger.info('Writing heap snapshot at %s', filename);
+      v8.writeHeapSnapshot(filename);
+    },
+    async install() {
+      if (!heap_dump.enable) return;
+
+      try {
+        await fs.promises.mkdir(dir, { recursive: true });
+      } catch (err) {
+        logger.error({ err }, 'Unable to create snapshot directory. No heap snapshots will be taken.');
+        return;
+      }
+
+      setTimeout(() => {
+        let count = 0;
+        const interval = setInterval(async () => {
+          await heapSnapshots.writeHeapSnapshot();
+          count++;
+          if (count === heap_dump.count) {
+            clearInterval(interval);
+          }
+        }, heap_dump.window_ms).unref();
+      }, heap_dump.delay_ms).unref();
+    },
+  };
+
+  return core.heapSnapshots = heapSnapshots;
+};

package/lib/index.d.ts

@@ -13,8 +13,27 @@
  * way not consistent with the End User License Agreement.
  */
 
-import RequireHook from '@contrast/require-hook';
+import { Config } from '@contrast/config';
 import { Logger } from '@contrast/logger';
+import RequireHook from '@contrast/require-hook';
+import { Rewriter } from '@contrast/rewriter';
+
+declare module 'module' {
+  class Module {
+    /**
+       * @see https://github.com/nodejs/node/blob/main/lib/internal/modules/cjs/loader.js
+       * @param content The source code of the module
+       * @param filename The file path of the module
+       */
+    _compile(content: string, filename: string);
+  }
+  export = Module;
+}
+
+declare module 'node:module' {
+  import Module = require('module');
+  export = Module;
+}
 
 interface AgentifyOptions {
   install: boolean;
@@ -41,9 +60,11 @@ export interface Agentify<T> {
   (preRunMain: PreRunMain<T>, opts?: AgentifyOptions): Agent<T>;
 }
 
-interface Core<T> {
+export interface Core<T> {
+  readonly config: Config;
   readonly depHooks: RequireHook;
   readonly logger: Logger;
+  readonly rewriter: Rewriter;
   agentify: Agentify<T>;
 }
 

package/lib/index.js

@@ -20,8 +20,7 @@ const path = require('path');
 const Module = require('module');
 
 const defaultOpts = {
-  install: true,
-  svcList: [
+  installOrder: [
     'reporter',
     'contrastMethods',
     'deadzones',
@@ -33,6 +32,7 @@ const defaultOpts = {
     'depHooks',
     'routeCoverage',
     'libraryAnalysis',
+    'heapSnapshots',
     'rewriteHooks',
     'functionHooks'
   ]
@@ -40,10 +40,12 @@ const defaultOpts = {
 
 module.exports = function (core) {
   // compose add'l local services
+  require('./heap-snapshots')(core);
   require('./sources')(core);
   require('./function-hooks')(core);
   require('./rewrite-hooks')(core);
 
+
   /**
    * The interface is a function, which when called, will hook runMain
    * @param {function} preRunMain
@@ -95,11 +97,11 @@ class Agent {
         }
 
         logger.info('Starting the Contrast agent');
-        logger.debug({ config }, 'Agent configuration');
+        logger.info({ config }, 'Agent configuration');
 
         const plugin = await opts.preRunMain(core);
 
-        if (opts.install) {
+        if (opts.installOrder?.length) {
           await self.install();
         }
 
@@ -130,7 +132,7 @@ class Agent {
   }
 
   async install() {
-    for (const svcName of this.opts.svcList) {
+    for (const svcName of this.opts.installOrder) {
       const svc = this.core[svcName];
       if (svc?.install) {
         this.core.logger.trace('installing service: %s', svcName);

package/lib/rewrite-hooks.js

@@ -12,22 +12,33 @@
  * engineered, modified, repackaged, sold, redistributed or otherwise used in a
  * way not consistent with the End User License Agreement.
  */
+// @ts-check
 
 'use strict';
 
 const Module = require('module');
 
-module.exports = function(deps) {
-  const origCompile = Module.prototype._compile;
-
-  deps.rewriteHooks = {
+/**
+ * @param {import('.').Core & {
+ *  rewriteHooks?: import('@contrast/common').Installable;
+ * }} core;
+ * @returns {import('@contrast/common').Installable}
+ */
+module.exports = function init(core) {
+  const { _compile } = Module.prototype;
 
+  core.rewriteHooks = {
     install() {
-      if (!deps.config.agent.node.enable_rewrite) return;
+      if (!core.config.agent.node.enable_rewrite) return;
 
-      Module.prototype._compile = function(content, filename) {
-        let compiled;
-        const { code } = deps.rewriter.rewrite(content, {
+      /**
+       * @see https://github.com/nodejs/node/blob/main/lib/internal/modules/cjs/loader.js
+       * @param {string} content The source code of the module
+       * @param {string} filename The file path of the module
+       */
+      Module.prototype._compile = function (content, filename) {
+        let result;
+        const { code } = core.rewriter.rewrite(content, {
           filename,
           isModule: false,
           inject: true,
@@ -35,25 +46,24 @@ module.exports = function(deps) {
         });
 
         try {
-          compiled = origCompile.call(this, code, filename);
+          result = _compile.call(this, code, filename);
         } catch (err) {
-          deps.logger.error(
+          core.logger.warn(
             { err },
-            'Failed to compile rewritten code for %s, rewritten code %s, compiling original code.',
+            'Failed to compile rewritten code for %s, compiling original code.',
             filename,
-            code
           );
-          compiled = origCompile.call(this, content, filename);
+          result = _compile.call(this, content, filename);
         }
 
-        return compiled;
+        return result;
       };
     },
 
-    restore() {
-      Module.prototype._compile = origCompile;
+    uninstall() {
+      Module.prototype._compile = _compile;
     }
   };
 
-  return deps.rewriteHooks;
+  return core.rewriteHooks;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agentify",
-  "version": "1.13.1",
+  "version": "1.15.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)",
@@ -17,6 +17,8 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.15.1"
+    "@contrast/common": "1.15.1",
+    "@contrast/config": "1.20.0",
+    "@contrast/logger": "1.6.0"
   }
 }