@contrast/agentify 1.19.2 → 1.20.0

package/lib/index.js

@@ -16,8 +16,9 @@
 'use strict';
 
 const Module = require('module');
+const { IntentionalError } = require('@contrast/common');
 
-const ERROR_MESSAGE = 'A fatal agent installation error has occurred. The application will be run without instrumentation.';
+const ERROR_MESSAGE = 'An error prevented the Contrast agent from installing. The application will be run without instrumentation.';
 const DEFAULT_INSTALL_ORDER = [
   'reporter',
   'contrastMethods',
@@ -44,12 +45,18 @@ module.exports = function init(core = {}) {
   try {
     require('@contrast/core/lib/messages')(core);
     require('@contrast/config')(core);
+    if (core.config._errors?.length) {
+      throw core.config._errors[0];
+    }
     require('@contrast/logger').default(core);
 
     // @contrast/info ?
     require('@contrast/core/lib/agent-info')(core);
     require('@contrast/core/lib/system-info')(core);
     require('@contrast/core/lib/app-info')(core);
+    if (core.appInfo._errors?.length) {
+      throw core.appInfo._errors[0];
+    }
     require('@contrast/core/lib/sensitive-data-masking')(core);
     require('@contrast/core/lib/is-agent-path')(core);
     require('@contrast/dep-hooks')(core);
@@ -98,6 +105,7 @@ module.exports = function init(core = {}) {
           }
 
           logger.info('Starting %s v%s', core.agentName, core.agentVersion);
+          // pino serializers know how to log redacted values and omit certain props
           logger.info({ config }, 'Agent configuration');
 
           const plugin = await preRunMain(core);
@@ -127,15 +135,18 @@ module.exports = function init(core = {}) {
     };
   } catch (err) {
     // TODO: Consider proper UNINSTALLATION and normal startup w/o agent
-    if (core.logger) {
-      core.logger.error({ err }, ERROR_MESSAGE);
-    } else {
-      console.error(new Error(ERROR_MESSAGE, { cause: err }));
-    }
-
     core.agentify = function agentify() {
       return core;
     };
+
+    // ignore intentional errors
+    if (!(err instanceof IntentionalError)) {
+      if (core.logger) {
+        core.logger.error({ err }, ERROR_MESSAGE);
+      } else {
+        console.error(new Error(ERROR_MESSAGE, { cause: err }));
+      }
+    }
   }
 
   return core.agentify;

package/lib/initialize.mjs

@@ -24,7 +24,7 @@ import Module from 'node:module';
 //
 import { isMainThread, threadId } from 'node:worker_threads';
 
-const ERROR_MESSAGE = 'A fatal agent installation error has occurred. The application will be run without instrumentation.';
+const ERROR_MESSAGE = 'An error prevented the Contrast agent from installing. The application will be run without instrumentation.';
 const DEFAULT_INSTALL_ORDER = [
   'reporter',
   'contrastMethods',
@@ -45,6 +45,7 @@ const DEFAULT_INSTALL_ORDER = [
 ];
 
 const require = Module.createRequire(import.meta.url);
+let startupError;
 
 /**
  * @param {object} { core = {}, options = {} }
@@ -53,7 +54,11 @@ async function loadModules({ core = {}, options = {} }) {
   try {
     require('@contrast/core/lib/messages')(core);
     require('@contrast/config')(core);
+    if (core.config._errors?.length) {
+      throw core.config._errors[0];
+    }
     require('@contrast/logger').default(core);
+
     const thread = isMainThread ? 'main' : 'loader';
     core.logger.trace({ tid: threadId }, 'initializing core modules in %s thread', thread);
 
@@ -62,6 +67,9 @@ async function loadModules({ core = {}, options = {} }) {
       require('@contrast/core/lib/agent-info')(core);
       require('@contrast/core/lib/system-info')(core);
       require('@contrast/core/lib/app-info')(core);
+      if (core.appInfo._errors?.length) {
+        throw core.appInfo._errors[0];
+      }
       require('@contrast/core/lib/sensitive-data-masking')(core);
       require('@contrast/core/lib/is-agent-path')(core);
       require('@contrast/dep-hooks')(core);
@@ -101,13 +109,14 @@ async function loadModules({ core = {}, options = {} }) {
     } else {
       console.error(new Error(ERROR_MESSAGE, { cause: err }));
     }
-
+    startupError = err;
   }
-
   return core;
 }
 
 async function startAgent({ core, options = {} }) {
+  if (startupError) return;
+
   const { executor, installOrder = DEFAULT_INSTALL_ORDER } = options;
   const { config, logger } = core;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agentify",
-  "version": "1.19.2",
+  "version": "1.20.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,17 +17,17 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.17.0",
-    "@contrast/config": "1.24.0",
-    "@contrast/core": "1.28.0",
+    "@contrast/common": "1.18.0",
+    "@contrast/config": "1.25.0",
+    "@contrast/core": "1.29.0",
     "@contrast/deadzones": "1.1.2",
     "@contrast/dep-hooks": "1.3.1",
-    "@contrast/esm-hooks": "2.1.1",
-    "@contrast/instrumentation": "1.4.0",
-    "@contrast/logger": "1.7.1",
-    "@contrast/metrics": "1.3.0",
+    "@contrast/esm-hooks": "2.2.0",
+    "@contrast/instrumentation": "1.5.0",
+    "@contrast/logger": "1.7.2",
+    "@contrast/metrics": "1.4.0",
     "@contrast/patcher": "1.7.1",
-    "@contrast/reporter": "1.23.2",
+    "@contrast/reporter": "1.24.0",
     "@contrast/rewriter": "1.4.2",
     "@contrast/scopes": "1.4.0"
   }