config 3.3.11 → 4.0.0

package/async.js

@@ -41,12 +41,11 @@ function resolveAsyncConfigs(config) {
   var promises = [];
   var resolvers = [];
   (function iterate(prop) {
-    var propsToSort = [];
-    for (var property in prop) {
-      if (Object.hasOwnProperty.call(prop, property) && prop[property] != null) {
-        propsToSort.push(property);
-      }
+    if (prop.constructor === String) {
+      return;
     }
+
+    var propsToSort = Object.keys(prop).filter((property) => prop[property] != null);
     propsToSort.sort().forEach(function(property) {
       if (prop[property].constructor === Object) {
         iterate(prop[property]);
@@ -54,7 +53,7 @@ function resolveAsyncConfigs(config) {
       else if (prop[property].constructor === Array) {
         prop[property].forEach(iterate);
       }
-      else if (prop[property] && prop[property].async === asyncSymbol) {
+      else if (prop[property].async === asyncSymbol) {
         resolvers.push(prop[property].prepare(config, prop, property));
         promises.push(prop[property]);
       }

package/lib/config.js

@@ -7,7 +7,6 @@
 const DeferredConfig = require('../defer').DeferredConfig;
 const RawConfig = require('../raw').RawConfig;
 let Parser = require('../parser');
-const Utils = require('util');
 const Path = require('path');
 const FileSystem = require('fs');
 
@@ -415,6 +414,29 @@ util.makeImmutable = function(object, property, value) {
         // Create a proxy, to capture user updates of configuration options, and throw an exception for awareness, as per:
         // https://github.com/lorenwest/node-config/issues/514
         value = new Proxy(util.makeImmutable(value), {
+          get(target, property, receiver) {
+            // Config's own defined prototype properties and methods (e.g., `get`, `has`, etc.)
+            const ownProps = [
+              ...Object.getOwnPropertyNames(Config.prototype),
+              ...Object.getOwnPropertyNames(target),
+            ]
+
+            // Bypass proxy receiver for properties directly on the target (e.g., RegExp.prototype.source)
+            // or properties that are not functions to prevent errors related to internal object methods.
+            if (ownProps.includes(property) || (property in target && typeof target[property] !== 'function')) {
+              return Reflect.get(target, property);
+            }
+
+            // Otherwise, use the proxy receiver to handle the property access
+            const ref = Reflect.get(target, property, receiver);
+
+            // Binds the method's `this` context to the target object (e.g., Date.prototype.toISOString)
+            // to ensure it behaves correctly when called on the proxy.
+            if (typeof ref === 'function') {
+              return ref.bind(target);
+            }
+            return ref;
+          },
           set (target, name) {
             const message = (Reflect.has(target, name) ? 'update' : 'add');
             // Notify the user.
@@ -494,15 +516,14 @@ util.getOption = function(options, optionName, defaultValue) {
  *   (hostname)-(deployment).EXT
  *   local.EXT
  *   local-(deployment).EXT
- *   runtime.json
  * </pre>
  *
  * <p>
- * EXT can be yml, yaml, coffee, iced, json, cson or js signifying the file type.
+ * EXT can be yml, yaml, coffee, iced, json, jsonc, cson or js signifying the file type.
  * yaml (and yml) is in YAML format, coffee is a coffee-script, iced is iced-coffee-script,
- * json is in JSON format, cson is in CSON format, properties is in .properties format
- * (http://en.wikipedia.org/wiki/.properties), and js is a javascript executable file that is
- * require()'d with module.exports being the config object.
+ * json is in JSON format, jsonc is in JSONC format, cson is in CSON format, properties is 
+ * in .properties format (http://en.wikipedia.org/wiki/.properties), and js is a javascript
+ * executable file that is require()'d with module.exports being the config object.
  * </p>
  *
  * <p>
@@ -524,11 +545,6 @@ util.getOption = function(options, optionName, defaultValue) {
  * </p>
  *
  * <p>
- * The runtime.json file contains configuration changes made at runtime either
- * manually, or by the application setting a configuration value.
- * </p>
- *
- * <p>
  * If the $NODE_APP_INSTANCE environment variable (or --NODE_APP_INSTANCE
  * command line parameter) is set, then files with this appendage will be loaded.
  * See the Multiple Application Instances section of the main documentation page
@@ -577,9 +593,6 @@ util.loadFileConfigs = function(configDir, options) {
   APP_INSTANCE = util.initParam('NODE_APP_INSTANCE');
   CONFIG_SKIP_GITCRYPT = util.initParam('CONFIG_SKIP_GITCRYPT');
 
-  // This is for backward compatibility
-  const runtimeFilename = util.initParam('NODE_CONFIG_RUNTIME_JSON', Path.join(dir , 'runtime.json') );
-
   NODE_CONFIG_PARSER = util.initParam('NODE_CONFIG_PARSER');
   if (NODE_CONFIG_PARSER) {
     try {
@@ -638,12 +651,15 @@ util.loadFileConfigs = function(configDir, options) {
   let resolutionIndex = 1;
   const extNames = Parser.getFilesOrder();
   baseNames.forEach(function(baseName) {
-    extNames.forEach(function(extName) {
-      allowedFiles[baseName + '.' + extName] = resolutionIndex++;
-      if (APP_INSTANCE) {
-        allowedFiles[baseName + '-' + APP_INSTANCE + '.' + extName] = resolutionIndex++;
-      }
-    });
+    const fileNames = [baseName];
+    if (APP_INSTANCE) {
+      fileNames.push(baseName + '-' + APP_INSTANCE);
+    }
+    fileNames.forEach(function(fileName) {
+      extNames.forEach(function(extName) {
+        allowedFiles[fileName + '.' + extName] = resolutionIndex++;
+      });
+    })
   });
 
   const locatedFiles = util.locateMatchingFiles(dir, allowedFiles);
@@ -703,10 +719,6 @@ util.loadFileConfigs = function(configDir, options) {
   const customEnvVars = util.getCustomEnvVars(dir, extNames);
   util.extendDeep(config, customEnvVars);
 
-  // Extend the original config with the contents of runtime.json (backwards compatibility)
-  const runtimeJson = util.parseFile(runtimeFilename) || {};
-  util.extendDeep(config, runtimeJson);
-
   util.resolveDeferredConfigs(config);
 
   // Return the configuration object
@@ -726,19 +738,18 @@ util.loadFileConfigs = function(configDir, options) {
  */
 util.locateMatchingFiles = function(configDirs, allowedFiles) {
   return configDirs.split(Path.delimiter)
+    .filter(Boolean)
     .reduce(function(files, configDir) {
-      if (configDir) {
-        configDir = _toAbsolutePath(configDir);
-        try {
-          FileSystem.readdirSync(configDir).forEach(function(file) {
-            if (allowedFiles[file]) {
-              files.push([allowedFiles[file], Path.join(configDir, file)]);
-            }
-          });
-        }
-        catch(e) {}
-        return files;
+      configDir = _toAbsolutePath(configDir);
+      try {
+        FileSystem.readdirSync(configDir)
+          .filter(file => allowedFiles[file])
+          .forEach(function(file) {
+            files.push([allowedFiles[file], Path.join(configDir, file)]);
+        });
       }
+      catch(e) {}
+      return files;
     }, [])
     .sort(function(a, b) { return a[0] - b[0]; })
     .map(function(file) { return file[1]; });
@@ -749,16 +760,12 @@ util.resolveDeferredConfigs = function (config) {
   const deferred = [];
 
   function _iterate (prop) {
+    if (prop.constructor === String) {
+      return;
+    }
 
     // We put the properties we are going to look it in an array to keep the order predictable
-    const propsToSort = [];
-
-    // First step is to put the properties of interest in an array
-    for (const property in prop) {
-      if (Object.hasOwnProperty.call(prop, property) && prop[property] != null) {
-        propsToSort.push(property);
-      }
-    }
+    const propsToSort = Object.keys(prop).filter((property) => prop[property] != null);
 
     // Second step is to iterate of the elements in a predictable (sorted) order
     propsToSort.sort().forEach(function (property) {
@@ -798,7 +805,7 @@ util.resolveDeferredConfigs = function (config) {
  * .js = File to run that has a module.exports containing the config object
  * .coffee = File to run that has a module.exports with coffee-script containing the config object
  * .iced = File to run that has a module.exports with iced-coffee-script containing the config object
- * All other supported file types (yaml, toml, json, cson, hjson, json5, properties, xml)
+ * All other supported file types (yaml, toml, json, jsonc, cson, hjson, json5, properties, xml)
  * are parsed with util.parseString.
  *
  * If the file doesn't exist, a null will be returned.  If the file can't be
@@ -873,7 +880,8 @@ util.parseFile = function(fullFilename, options) {
  *
  * The format determines the parser to use.
  *
- * json = File is parsed using JSON.parse()
+ * json = Parsed with a JSON5 parser
+ * jsonc = Parsed with a JSON5 parser
  * yaml (or yml) = Parsed with a YAML parser
  * toml = Parsed with a TOML parser
  * cson = Parsed with a CSON parser
@@ -1003,12 +1011,12 @@ util.cloneDeep = function cloneDeep(parent, depth, circular, prototype) {
       return parent;
     }
 
-    if (Utils.isArray(parent)) {
+    if (Array.isArray(parent)) {
       child = [];
-    } else if (Utils.isRegExp(parent)) {
+    } else if (parent instanceof RegExp) {
       child = new RegExp(parent.source, util.getRegExpFlags(parent));
       if (parent.lastIndex) child.lastIndex = parent.lastIndex;
-    } else if (Utils.isDate(parent)) {
+    } else if (parent instanceof Date) {
       child = new Date(parent.getTime());
     } else if (useBuffer && Buffer.isBuffer(parent)) {
       child = Buffer.alloc(parent.length);
@@ -1278,11 +1286,9 @@ util.diffDeep = function(object1, object2, depth) {
  * @param depth {integer} An optional depth to prevent recursion.  Default: 20.
  * @return {object} The altered mergeInto object is returned
  */
-util.extendDeep = function(mergeInto) {
+util.extendDeep = function(mergeInto, ...vargs) {
 
   // Initialize
-  const t = this;
-  const vargs = Array.prototype.slice.call(arguments, 1);
   let depth = vargs.pop();
   if (typeof(depth) != 'number') {
     vargs.push(depth);
@@ -1458,8 +1464,11 @@ util.toObject = function(config) {
 
 // Run strictness checks on NODE_ENV and NODE_APP_INSTANCE and throw an error if there's a problem.
 util.runStrictnessChecks = function (config) {
-  const sources = config.util.getConfigSources();
+  if (util.initParam('SUPPRESS_STRICTNESS_CHECK')) {
+    return;
+  }
 
+  const sources = config.util.getConfigSources();
   const sourceFilenames = sources.map(function (src) {
     return Path.basename(src.name);
   });
@@ -1514,8 +1523,7 @@ function _toAbsolutePath (configDir) {
 // Instantiate and export the configuration
 const config = module.exports = new Config();
 
-// copy methods to util for backwards compatibility
-util.stripComments = Parser.stripComments;
+// copy method to util for backwards compatibility
 util.stripYamlComments = Parser.stripYamlComments;
 
 // Produce warnings if the configuration is empty

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "config",
-  "version": "3.3.11",
+  "version": "4.0.0",
   "main": "./lib/config.js",
   "description": "Configuration control for production node deployments",
   "author": "Loren West <open_source@lorenwest.com>",
@@ -30,6 +30,7 @@
     "cson": "^3.0.1",
     "hjson": "^1.2.0",
     "js-yaml": "^3.2.2",
+    "nyc": "^15.1.0",
     "properties": "~1.2.1",
     "semver": "5.3.0",
     "toml": "^2.0.6",
@@ -44,9 +45,21 @@
     "url": "http://github.com/node-config/node-config.git"
   },
   "engines": {
-    "node": ">= 10.0.0"
+    "node": ">= 20.0.0"
+  },
+  "nyc": {
+    "include": [
+      "*.js",
+      "lib/**/*.js"
+    ],
+    "extension": [
+      ".js"
+    ],
+    "report-dir": "./coverage",
+    "reporter": "lcov"
   },
   "scripts": {
-    "test": "./node_modules/vows/bin/vows test/*.js --spec"
+    "test": "nyc vows test/*.js --spec",
+    "vows": "nyc vows"
   }
 }

package/parser.js

@@ -1,5 +1,4 @@
 // External libraries are lazy-loaded only if these file types exist.
-const util = require("util");
 
 // webpack can't solve dynamic module
 // @see https://github.com/node-config/node-config/issues/755
@@ -61,7 +60,7 @@ Parser.xmlParser = function(filename, content) {
 Parser.jsParser = function(filename, content) {
   var configObject = require(filename);
 
-  if (configObject.__esModule && util.isObject(configObject.default)) {
+  if (configObject.__esModule && isObject(configObject.default)) {
     return configObject.default
   }
   return configObject;
@@ -209,72 +208,6 @@ Parser.propertiesParser = function(filename, content) {
   return PPARSER.parse(content, { namespaces: true, variables: true, sections: true });
 };
 
-/**
- * Strip all Javascript type comments from the string.
- *
- * The string is usually a file loaded from the O/S, containing
- * newlines and javascript type comments.
- *
- * Thanks to James Padolsey, and all who contributed to this implementation.
- * http://james.padolsey.com/javascript/javascript-comment-removal-revisted/
- *
- * @protected
- * @method stripComments
- * @param fileStr {string} The string to strip comments from
- * @param stringRegex {RegExp} Optional regular expression to match strings that
- *   make up the config file
- * @return {string} The string with comments stripped.
- */
-Parser.stripComments = function(fileStr, stringRegex) {
-  stringRegex = stringRegex || /"((?:[^"\\]|\\.)*)"/g;
-
-  var uid = '_' + +new Date(),
-    primitives = [],
-    primIndex = 0;
-
-  return (
-    fileStr
-
-    /* Remove strings */
-      .replace(stringRegex, function(match){
-        primitives[primIndex] = match;
-        return (uid + '') + primIndex++;
-      })
-
-      /* Remove Regexes */
-      .replace(/([^\/])(\/(?!\*|\/)(\\\/|.)+?\/[gim]{0,3})/g, function(match, $1, $2){
-        primitives[primIndex] = $2;
-        return $1 + (uid + '') + primIndex++;
-      })
-
-      /*
-      - Remove single-line comments that contain would-be multi-line delimiters
-          E.g. // Comment /* <--
-      - Remove multi-line comments that contain would be single-line delimiters
-          E.g. /* // <--
-     */
-      .replace(/\/\/.*?\/?\*.+?(?=\n|\r|$)|\/\*[\s\S]*?\/\/[\s\S]*?\*\//g, '')
-
-      /*
-      Remove single and multi-line comments,
-      no consideration of inner-contents
-     */
-      .replace(/\/\/.+?(?=\n|\r|$)|\/\*[\s\S]+?\*\//g, '')
-
-      /*
-      Remove multi-line comments that have a replaced ending (string/regex)
-      Greedy, so no inner strings/regexes will stop it.
-     */
-      .replace(RegExp('\\/\\*[\\s\\S]+' + uid + '\\d+', 'g'), '')
-
-      /* Bring back strings & regexes */
-      .replace(RegExp(uid + '(\\d+)', 'g'), function(match, n){
-        return primitives[n];
-      })
-  );
-
-};
-
 /**
  * Strip YAML comments from the string
  *
@@ -314,7 +247,7 @@ Parser.numberParser = function(filename, content) {
   return Number.isNaN(numberValue) ? undefined : numberValue;
 };
 
-var order = ['js', 'cjs', 'ts', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml',
+var order = ['js', 'cjs', 'mjs', 'ts', 'json', 'jsonc', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml',
   'boolean', 'number'];
 var definitions = {
   cjs: Parser.jsParser,
@@ -324,7 +257,9 @@ var definitions = {
   iced: Parser.icedParser,
   js: Parser.jsParser,
   json: Parser.jsonParser,
+  jsonc: Parser.jsonParser,
   json5: Parser.json5Parser,
+  mjs: Parser.jsParser,
   properties: Parser.propertiesParser,
   toml: Parser.tomlParser,
   ts: Parser.tsParser,
@@ -366,3 +301,7 @@ Parser.setFilesOrder = function(name, newIndex) {
   }
   return order;
 };
+
+function isObject(arg) {
+  return (arg !== null) && (typeof arg === 'object');
+}