@contrast/agentify 1.2.0 → 1.3.0

package/lib/index.js

@@ -15,7 +15,10 @@
 
 'use strict';
 
+const fs = require('fs');
+const path = require('path');
 const Module = require('module');
+const { env } = require('process');
 
 const defaultOpts = {
   install: true,
@@ -25,6 +28,7 @@ const defaultOpts = {
     'deadzones',
     'scopes',
     'sources',
+    'architectureComponents',
     'assess',
     'protect',
     'depHooks',
@@ -33,12 +37,12 @@ const defaultOpts = {
   ]
 };
 
-module.exports = function(deps) {
+module.exports = function(core) {
   // compose add'l local services
-  require('./sources')(deps);
-  require('./contrast-methods')(deps);
-  require('./function-hooks')(deps);
-  require('./rewrite-hooks')(deps);
+  require('./sources')(core);
+  require('./contrast-methods')(core);
+  require('./function-hooks')(core);
+  require('./rewrite-hooks')(core);
 
   /**
    * The interface is a function, which when called, will hook runMain
@@ -56,10 +60,10 @@ module.exports = function(deps) {
       opts = { ...defaultOpts, ...opts };
     }
 
-    return new Agent(deps, opts);
+    return new Agent(core, opts);
   }
 
-  deps.agentify = agentify;
+  core.agentify = agentify;
 
   return agentify;
 };
@@ -67,16 +71,16 @@ module.exports = function(deps) {
 class Agent {
   /**
    *
-   * @param {object} deps dependencies
+   * @param {object} core dependencies
    * @param {object} opts
    * @param {function} opts.preRunMain custom function for registering services
    * @param {boolean} opts.install whether to automatically install
    */
-  constructor(deps, opts) {
+  constructor(core, opts) {
     const self = this;
-    const { config, logger } = deps;
+    const { config, logger } = core;
 
-    this.deps = deps;
+    this.core = core;
     this.opts = opts;
     this.runMain = Module.runMain;
 
@@ -89,7 +93,7 @@ class Agent {
         logger.info('Starting the Contrast agent');
         logger.debug({ config }, 'Agent configuration');
 
-        const plugin = await opts.preRunMain(deps);
+        const plugin = await opts.preRunMain(core);
 
         if (opts.install) {
           await self.install();
@@ -101,6 +105,8 @@ class Agent {
       } catch (err) {
         await self.handleInstallFailure(err);
       }
+
+      self.logEffectiveConfig();
       return self.runMain.apply(this, args);
     };
   }
@@ -113,7 +119,7 @@ class Agent {
    * @param {error} err Error thrown during install
    */
   async handleInstallFailure(err) {
-    this.deps.logger.error(
+    this.core.logger.error(
       { err },
       'A fatal agent installation error has occurred. The application will be run without instrumentation.'
     );
@@ -121,13 +127,34 @@ class Agent {
 
   async install() {
     for (const svcName of this.opts.svcList) {
-      this.deps.logger.trace('installing service: %s', svcName);
-      const svc = this.deps[svcName];
+      const svc = this.core[svcName];
       if (svc && svc.install) {
+        this.core.logger.trace('installing service: %s', svcName);
         await svc.install();
       }
     }
   }
+
+  logEffectiveConfig() {
+    const { config, getEffectiveConfig } = this.core;
+
+    if (env.CONTRAST__AGENT__DIAGNOSTICS__ENABLE !== 'false') {
+      const content = JSON.stringify(getEffectiveConfig(), null, 2).concat('\n\n');
+
+      if (env.CONTRAST__AGENT__DIAGNOSTICS__QUIET !== 'true') {
+        fs.writeFileSync(1, content, 'utf8');
+      }
+
+      let outputDir = env.CONTRAST__AGENT__DIAGNOSTICS__REPORT_PATH;
+      if (!outputDir && config.agent.logger.path) {
+        outputDir = path.join(config.agent.logger.path, '../contrast_effective_config.json');
+      } else {
+        outputDir = path.join(__dirname, 'contrast_effective_config.json');
+      }
+
+      fs.writeFileSync(outputDir, content, 'utf-8');
+    }
+  }
 }
 
 module.exports.Agent = Agent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agentify",
-  "version": "1.2.0",
+  "version": "1.3.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)",