config 3.2.6 → 3.3.3

package/History.md

@@ -1,3 +1,27 @@
+3.3.3 / 2020-11-26
+==================
+
+* FIX #460 - Strict mode warning refer to appropriate env variable @iCodeOkay
+* Use Buffer.alloc and Buffer.from instead of contrsuctor @Fcmam5
+* Add support for experimental .cjs modules @lenkan
+
+
+3.3.2 / 2020-09-24
+==================
+
+* Fixed issue with Buffers in config throwing error in util.makeImmutable (#608) - Michal Wadas
+* Added boolean and numeric types to custom environment variables - Ankur Narkhede @ankurnarkhede
+
+3.3.1 / 2020-03-25
+==================
+
+  * Fix security vulnerability in json5 dependency - @twkel
+
+3.3.0 / 2020-02-26
+==================
+
+  * Allow all defined values in `substituteDeep` - @fostyfost
+
 3.2.6 / 2020-02-21
 ==================
 

package/README.md

@@ -147,23 +147,23 @@ Contributors
 <td><img src=https://avatars2.githubusercontent.com/u/1656140?v=4><a href="https://github.com/eheikes">eheikes</a></td>
 <td><img src=https://avatars3.githubusercontent.com/u/138707?v=4><a href="https://github.com/th507">th507</a></td>
 </tr><tr><td><img src=https://avatars2.githubusercontent.com/u/506460?v=4><a href="https://github.com/Osterjour">Osterjour</a></td>
+<td><img src=https://avatars3.githubusercontent.com/u/1751645?v=4><a href="https://github.com/cunneen">cunneen</a></td>
 <td><img src=https://avatars0.githubusercontent.com/u/842998?v=4><a href="https://github.com/nsabovic">nsabovic</a></td>
 <td><img src=https://avatars0.githubusercontent.com/u/5138570?v=4><a href="https://github.com/BadgerBadgerBadgerBadger">BadgerBadgerBadgerBadger</a></td>
 <td><img src=https://avatars2.githubusercontent.com/u/2529835?v=4><a href="https://github.com/simon-scherzinger">simon-scherzinger</a></td>
 <td><img src=https://avatars3.githubusercontent.com/u/8650543?v=4><a href="https://github.com/leonardovillela">leonardovillela</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/175627?v=4><a href="https://github.com/axelhzf">axelhzf</a></td>
-</tr><tr><td><img src=https://avatars3.githubusercontent.com/u/7782055?v=4><a href="https://github.com/benkroeger">benkroeger</a></td>
+</tr><tr><td><img src=https://avatars1.githubusercontent.com/u/175627?v=4><a href="https://github.com/axelhzf">axelhzf</a></td>
+<td><img src=https://avatars3.githubusercontent.com/u/7782055?v=4><a href="https://github.com/benkroeger">benkroeger</a></td>
 <td><img src=https://avatars3.githubusercontent.com/u/1872824?v=4><a href="https://github.com/fgheorghe">fgheorghe</a></td>
 <td><img src=https://avatars3.githubusercontent.com/u/1443067?v=4><a href="https://github.com/IvanVergiliev">IvanVergiliev</a></td>
 <td><img src=https://avatars0.githubusercontent.com/u/1736957?v=4><a href="https://github.com/jpwilliams">jpwilliams</a></td>
 <td><img src=https://avatars2.githubusercontent.com/u/1246875?v=4><a href="https://github.com/jaylynch">jaylynch</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/145742?v=4><a href="https://github.com/jberrisch">jberrisch</a></td>
-</tr><tr><td><img src=https://avatars1.githubusercontent.com/u/9355665?v=4><a href="https://github.com/kgoerlitz">kgoerlitz</a></td>
+</tr><tr><td><img src=https://avatars1.githubusercontent.com/u/145742?v=4><a href="https://github.com/jberrisch">jberrisch</a></td>
+<td><img src=https://avatars1.githubusercontent.com/u/9355665?v=4><a href="https://github.com/kgoerlitz">kgoerlitz</a></td>
 <td><img src=https://avatars0.githubusercontent.com/u/8525267?v=4><a href="https://github.com/bertho-zero">bertho-zero</a></td>
 <td><img src=https://avatars3.githubusercontent.com/u/1918551?v=4><a href="https://github.com/nitzan-shaked">nitzan-shaked</a></td>
 <td><img src=https://avatars3.githubusercontent.com/u/3058150?v=4><a href="https://github.com/robertrossmann">robertrossmann</a></td>
 <td><img src=https://avatars2.githubusercontent.com/u/498929?v=4><a href="https://github.com/roncli">roncli</a></td>
-<td><img src=https://avatars2.githubusercontent.com/u/1355559?v=4><a href="https://github.com/superoven">superoven</a></td>
 </tr></table>
 
 License

package/lib/config.js

@@ -15,7 +15,7 @@ var deferConfig = require('../defer').deferConfig,
 // Static members
 var DEFAULT_CLONE_DEPTH = 20,
     NODE_CONFIG, CONFIG_DIR, RUNTIME_JSON_FILENAME, NODE_ENV, APP_INSTANCE,
-    HOST, HOSTNAME, ALLOW_CONFIG_MUTATIONS, CONFIG_SKIP_GITCRYPT,
+    HOST, HOSTNAME, ALLOW_CONFIG_MUTATIONS, CONFIG_SKIP_GITCRYPT, NODE_ENV_VAR_NAME,
     NODE_CONFIG_PARSER,
     env = {},
     privateUtil = {},
@@ -369,6 +369,9 @@ util.makeHidden = function(object, property, value) {
  * @return object {object} - The original object is returned - for chaining.
  */
 util.makeImmutable = function(object, property, value) {
+  if (Buffer.isBuffer(object)) {
+    return object;
+  }
   var properties = null;
 
   // Backwards compatibility mode where property/value can be specified
@@ -510,11 +513,26 @@ util.loadFileConfigs = function(configDir) {
   var t = this,
       config = {};
 
-  // Initialize parameters from command line, environment, or default
-  NODE_ENV = util.initParam('NODE_ENV', 'development');
+  // Specify variables that can be used to define the environment
+  var node_env_var_names = ['NODE_CONFIG_ENV', 'NODE_ENV'];
+
+  // Loop through the variables to try and set environment
+  for (node_env_var_name of node_env_var_names) {
+    NODE_ENV = util.initParam(node_env_var_name);
+    if (!!NODE_ENV) {
+      NODE_ENV_VAR_NAME = node_env_var_name;
+      break;
+    }
+  }
 
-  // Override, NODE_ENV if NODE_CONFIG_ENV is specified.
-  NODE_ENV = util.initParam('NODE_CONFIG_ENV', NODE_ENV);
+  // If we haven't successfully set the environment using the variables, we'll default it
+  if (!NODE_ENV) {
+    NODE_ENV = 'development';
+  }
+
+  node_env_var_names.forEach(node_env_var_name => {
+    env[node_env_var_name] = NODE_ENV;
+  });
 
   // Split files name, for loading multiple files.
   NODE_ENV = NODE_ENV.split(',');
@@ -949,7 +967,7 @@ util.cloneDeep = function cloneDeep(parent, depth, circular, prototype) {
     } else if (Utils.isDate(parent)) {
       child = new Date(parent.getTime());
     } else if (useBuffer && Buffer.isBuffer(parent)) {
-      child = new Buffer(parent.length);
+      child = Buffer.alloc(parent.length);
       parent.copy(child);
       return child;
     } else {
@@ -1033,12 +1051,12 @@ util.substituteDeep = function (substitutionMap, variables) {
     for (var prop in map) {
       var value = map[prop];
       if (typeof(value) === 'string') { // We found a leaf variable name
-        if (vars[value]) { // if the vars provide a value set the value in the result map
+        if (vars[value] !== undefined) { // if the vars provide a value set the value in the result map
           util.setPath(result, pathTo.concat(prop), vars[value]);
         }
       }
       else if (util.isObject(value)) { // work on the subtree, giving it a clone of the pathTo
-        if('__name' in value && '__format' in value && vars[value.__name]) {
+        if ('__name' in value && '__format' in value && vars[value.__name] !== undefined) {
           try {
             var parsedValue = util.parseString(vars[value.__name], value.__format);
           } catch(err) {
@@ -1406,11 +1424,11 @@ util.runStrictnessChecks = function (config) {
     });
     // development is special-cased because it's the default value
     if (env && (env !== 'development') && !anyFilesMatchEnv) {
-      _warnOrThrow("NODE_ENV value of '"+env+"' did not match any deployment config file names.");
+      _warnOrThrow(NODE_ENV_VAR_NAME+" value of '"+env+"' did not match any deployment config file names.");
     }
     // Throw if NODE_ENV matches' default' or 'local'
     if ((env === 'default') || (env === 'local')) {
-      _warnOrThrow("NODE_ENV value of '"+env+"' is ambiguous.");
+      _warnOrThrow(NODE_ENV_VAR_NAME+" value of '"+env+"' is ambiguous.");
     }
   });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "config",
-  "version": "3.2.6",
+  "version": "3.3.3",
   "main": "./lib/config.js",
   "description": "Configuration control for production node deployments",
   "author": "Loren West <open_source@lorenwest.com>",
@@ -19,7 +19,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "json5": "^1.0.1"
+    "json5": "^2.1.1"
   },
   "devDependencies": {
     "@types/node": "^7.0.8",

package/parser.js

@@ -281,8 +281,33 @@ Parser.stripYamlComments = function(fileStr) {
   return fileStr.replace(/^\s*#.*/mg,'').replace(/^\s*[\n|\r]+/mg,'');
 };
 
-var order = ['js', 'ts', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml'];
+/**
+ * Parses the environment variable to the boolean equivalent.
+ * Defaults to false
+ *
+ * @param {String} content - Environment variable value
+ * @return {boolean} - Boolean value fo the passed variable value
+ */
+Parser.booleanParser = function(filename, content) {
+  return content === 'true';
+};
+
+/**
+ * Parses the environment variable to the number equivalent.
+ * Defaults to undefined
+ *
+ * @param {String} content - Environment variable value
+ * @return {Number} - Number value fo the passed variable value
+ */
+Parser.numberParser = function(filename, content) {
+  const numberValue = Number(content);
+  return Number.isNaN(numberValue) ? undefined : numberValue;
+};
+
+var order = ['js', 'cjs', 'ts', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml',
+  'boolean', 'number'];
 var definitions = {
+  cjs: Parser.jsParser,
   coffee: Parser.coffeeParser,
   cson: Parser.csonParser,
   hjson: Parser.hjsonParser,
@@ -296,6 +321,8 @@ var definitions = {
   xml: Parser.xmlParser,
   yaml: Parser.yamlParser,
   yml: Parser.yamlParser,
+  boolean: Parser.booleanParser,
+  number: Parser.numberParser
 };
 
 Parser.getParser = function(name) {