@contrast/config 1.3.3 → 1.5.0

package/lib/options.js

@@ -382,12 +382,23 @@ const protect = [
     fn: castBoolean,
     desc: 'turns on probe analysis and report them to Contrast UI'
   },
-  ...Object.values(Rule).map((ruleId) => ({
-    name: `protect.rules.${ruleId}.mode`,
-    arg: '<mode>',
-    enum: ['monitor', 'block', 'block_at_perimeter', 'off'],
-    desc: `the mode in which to run the ${ruleId} rule`,
-  })),
+  ...Object.values(Rule)
+    .filter((ruleId) => ![Rule.BOT_BLOCKER, Rule.IP_DENYLIST, Rule.VIRTUAL_PATCH].includes(ruleId))
+    .map((ruleId) => ({
+      name: `protect.rules.${ruleId}.mode`,
+      arg: '<mode>',
+      enum: ['monitor', 'block', 'block_at_perimeter', 'off'],
+      desc: `the mode in which to run the ${ruleId} rule`,
+    })),
+];
+
+const assess = [
+  {
+    name: 'assess.enable',
+    arg: '[false]',
+    fn: castBoolean,
+    desc: 'if false, disable assess for this agent'
+  },
 ];
 
 const server = [
@@ -417,7 +428,15 @@ const server = [
   },
 ];
 
-const options = [].concat(config, api, agent, application, protect, server);
+const options = [].concat(
+  config,
+  api,
+  agent,
+  application,
+  protect,
+  assess,
+  server
+);
 
 module.exports.configOptions = options;
 module.exports.clearBaseCase = clearBaseCase;

package/lib/util.js

@@ -42,9 +42,11 @@ function set(obj, name, value) {
  * @param {*} value
  * @param {boolean} def set from default or not
  */
-function setConfig(conf, name, value, def) {
+function setConfig(conf, name, value, def, origin) {
   set(conf, name, value);
   conf._default[name] = def;
+  conf._flat[name] = value;
+  conf._sources[name] = origin;
 }
 
 class ConfigurationError extends Error {
@@ -57,7 +59,8 @@ class Config {
   constructor() {
     Object.assign(this, {
       _default: {},
-      api: {},
+      _flat: {},
+      _sources: {},
       agent: {
         reporters: {},
         logger: {},
@@ -67,7 +70,9 @@ class Config {
       protect: {
         rules: {},
       },
+      assess: {},
       server: {},
+      api: {},
     });
   }
 
@@ -243,12 +248,17 @@ function mergeOptions() {
       .reduce((obj, prop) => obj?.[prop], fileOptions);
 
     // For some values, we want to know if we assigned by falling back to default
-    let isFromDefault;
+    let isFromDefault, origin;
+
+    if (env != null || autoEnv != null) {
+      origin = 'ENV';
+    } else if (fileFlag != null) {
+      origin = 'YAML';
+    }
 
     // env > file > default
     let value = [env, autoEnv, fileFlag]
-      .map((v) => fn(v))
-      .find((flag) => flag !== undefined);
+      .map((v) => fn(v)).find((flag) => flag !== undefined);
 
     // if it's an enum, find it in the enum or set the value to default
     // ineffective if optDefault wasn't in the enum;
@@ -256,6 +266,7 @@ function mergeOptions() {
     if (optEnum && optEnum.indexOf(value) === -1) {
       value = fn(optDefault);
       isFromDefault = true;
+      origin = 'DEFAULT';
     }
 
     // set default last and separately, so that we can mark that the option was
@@ -263,9 +274,10 @@ function mergeOptions() {
     if (value === undefined) {
       value = fn(optDefault);
       isFromDefault = true;
+      origin = 'DEFAULT';
     }
 
-    setConfig(options, name, value, isFromDefault);
+    setConfig(options, name, value, isFromDefault, origin);
     return options;
   }, new Config());
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.3.3",
+  "version": "1.5.0",
   "description": "An API for discovering Contrast agent configuration data",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,7 +17,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.1.5",
+    "@contrast/common": "1.3.0",
     "yaml": "^2.0.1"
   }
-}
+}