@contrast/agentify 1.21.0 → 1.22.0

package/lib/function-hooks.js

@@ -78,7 +78,7 @@ module.exports = function (deps) {
     // cannot parse lone function expressions that are not part of an assignment.
     try {
       let unwritten = functionHooks.contextualizeFunction(code);
-      unwritten = rewriter.unwrite(unwritten);
+      unwritten = rewriter.unwriteSync(unwritten);
       unwritten = unwritten.replace(METHOD_CONTEXT, '');
       unwritten = unwritten.replace(FUNCTION_CONTEXT, '');
       unwritten = unwritten.replace(/;\s*$/, ''); // removes trailing semicolon/whitespace

package/lib/index.d.ts

@@ -13,21 +13,36 @@
  * way not consistent with the End User License Agreement.
  */
 
-import { Config } from '@contrast/config';
 import { Installable } from '@contrast/common';
+import { Config } from '@contrast/config';
+import { Core as _Core } from '@contrast/core';
 import { Logger } from '@contrast/logger';
 import { Rewriter } from '@contrast/rewriter';
 import RequireHook from '@contrast/require-hook';
+import { Patcher } from '@contrast/patcher';
+import { Scopes } from '@contrast/scopes';
+import { Deadzones } from '@contrast/deadzones';
+import { ReporterBus } from '@contrast/reporter';
 
 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);
+
+    static _extensions: {
+      /**
        * @see https://github.com/nodejs/node/blob/main/lib/internal/modules/cjs/loader.js
-       * @param content The source code of the module
+       * @param module The module to compile
        * @param filename The file path of the module
        */
-    _compile(content: string, filename: string);
+      ['.js'](module: import('module'), filename: string);
+    };
   }
+
   export = Module;
 }
 
@@ -36,13 +51,17 @@ declare module 'node:module' {
   export = Module;
 }
 
-// TODO: this is now much larger with all of the existing core deps
-export interface Core {
-  readonly config: Config;
-  readonly depHooks: RequireHook;
-  readonly logger: Logger;
-  readonly rewriter: Rewriter;
-  readonly threadInfo: any;
+export interface Core extends _Core {
+  config: Config;
+  logger: Logger;
+  depHooks: RequireHook;
+  patcher: Patcher
+  rewriter: Rewriter;
+  scopes: Scopes;
+  deadzones: Deadzones;
+  reporter: ReporterBus;
+  instrumentation: any;
+  metrics: any;
 }
 
 export interface AgentifyOptions {
@@ -50,13 +69,13 @@ export interface AgentifyOptions {
 }
 
 export interface PreRunMain {
-  (core: any): Installable | void | Promise<Installable | void>;
+  (core: Core): Installable | void | Promise<Installable | void>;
 }
 
 export interface Agentify {
-  (preRunMain: PreRunMain, opts?: AgentifyOptions): any;
+  (preRunMain: PreRunMain, opts?: AgentifyOptions): Installable | void;
 }
 
-declare function init(core: any): Agentify;
+declare function init(core: Partial<Core>): Agentify;
 
 export = init;

package/lib/index.js

@@ -55,6 +55,8 @@ const DEFAULT_INSTALL_ORDER = [
  * @returns {import('.').Agentify}
  */
 module.exports = function init(core = {}) {
+  core.startTime = process.hrtime.bigint();
+
   let _callback;
   let _opts;
 

package/lib/rewrite-hooks.js

@@ -16,7 +16,7 @@
 
 'use strict';
 
-const Module = require('module');
+const Module = require('node:module');
 
 /**
  * @param {import('.').Core & {
@@ -25,11 +25,12 @@ const Module = require('module');
  * @returns {import('@contrast/common').Installable}
  */
 module.exports = function init(core) {
+  const js = Module._extensions['.js'];
   const { _compile } = Module.prototype;
 
   core.rewriteHooks = {
     install() {
-      if (!core.config.agent.node.enable_rewrite) return;
+      if (!core.config.agent.node.rewrite.enable) return;
 
       /**
        * @see https://github.com/nodejs/node/blob/main/lib/internal/modules/cjs/loader.js
@@ -37,33 +38,58 @@ module.exports = function init(core) {
        * @param {string} filename The file path of the module
        */
       Module.prototype._compile = function (content, filename) {
-        let result;
+        /** @type {import('@contrast/rewriter').RewriteOpts} */
         const options = {
           filename,
           isModule: false,
           inject: true,
           wrap: true,
+          trim: false,
         };
 
-        const { code } = core.rewriter.rewrite(content, options);
+        const result = core.rewriter.rewriteSync(content, options);
 
         try {
-          result = _compile.call(this, code, filename);
+          const compiled = Reflect.apply(_compile, this, [result.code, filename]);
+
+          if (core.config.agent.node.rewrite.cache.enable) {
+            core.rewriter.cache.write(filename, result);
+          }
+
+          return compiled;
         } catch (err) {
           core.logger.warn(
             { err },
             'Failed to compile rewritten code for %s, compiling original code.',
             filename,
           );
-          result = _compile.call(this, content, filename);
+
+          return Reflect.apply(_compile, this, [content, filename]);
         }
+      };
+
+      /**
+       * @see https://github.com/nodejs/node/blob/main/lib/internal/modules/cjs/loader.js
+       * @param {Module} module The module to compile
+       * @param {string} filename The file path of the module
+       */
+      Module._extensions['.js'] = function (module, filename) {
+        if (!core.config.agent.node.rewrite.cache.enable) {
+          return Reflect.apply(js, this, [module, filename]);
+        }
+
+        const cached = core.rewriter.cache.readSync(filename);
 
-        return result;
+        // If cached, short circuit the _extensions method and go straight to compile.
+        return cached
+          ? Reflect.apply(_compile, module, [cached, filename])
+          : Reflect.apply(js, this, [module, filename]);
       };
     },
 
     uninstall() {
       Module.prototype._compile = _compile;
+      Module._extensions['.js'] = js;
     }
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agentify",
-  "version": "1.21.0",
+  "version": "1.22.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)",
@@ -22,13 +22,13 @@
     "@contrast/core": "1.30.0",
     "@contrast/deadzones": "1.1.2",
     "@contrast/dep-hooks": "1.3.1",
-    "@contrast/esm-hooks": "2.3.0",
+    "@contrast/esm-hooks": "2.4.0",
     "@contrast/instrumentation": "1.6.0",
     "@contrast/logger": "1.8.0",
-    "@contrast/metrics": "1.5.0",
+    "@contrast/metrics": "1.6.0",
     "@contrast/patcher": "1.7.1",
-    "@contrast/reporter": "1.25.0",
-    "@contrast/rewriter": "1.4.2",
+    "@contrast/reporter": "1.25.1",
+    "@contrast/rewriter": "1.5.0",
     "@contrast/scopes": "1.4.0"
   }
 }