1.0.6 / 2021-07-27

==================

* Remove node-fetch dependency, must inject/boot - @craigparra
* Tidy tests and lint - @craigparra

Author: craigparra

ConfigFactory.js

@@ -8,11 +8,37 @@ const PrefixSelector = require('./PrefixSelector');
 const URLResolver = require('./URLResolver');
 
 module.exports = class ConfigFactory {
-  static getConfig(config, resolver) {
+  static detectBrowser() {
+    const browser = !(typeof window === 'undefined');
+    return browser;
+  }
+
+  static detectFetch(fetchArg) {
+    let $fetch = null;
+    if (!(typeof fetch === 'undefined')) {
+      // eslint-disable-next-line no-undef
+      $fetch = fetch;
+    }
+    if (global?.boot?.contexts?.root?.fetch) {
+      $fetch = global.boot.contexts.root.fetch;
+    }
+    if (ConfigFactory.detectBrowser() && window?.fetch) {
+      $fetch = window.fetch;
+    }
+    if (ConfigFactory.detectBrowser() && window?.boot?.contexts?.root?.fetch) {
+      $fetch = window.boot.contexts.root.fetch;
+    }
+    $fetch = fetchArg || $fetch;
+    return $fetch;
+  }
+
+  static getConfig(config, resolver, fetchArg) {
     const placeHolderResolver = new PlaceHolderResolver(new PlaceHolderSelector());
     const jasyptDecryptor = new JasyptDecryptor(new PrefixSelector('enc.'));
-    const urlResolver = new URLResolver(new PrefixSelector('url.'))
-    const delegatingResolver = new DelegatingResolver([placeHolderResolver, jasyptDecryptor,urlResolver]);
+    const urlResolver = new URLResolver(new PrefixSelector('url.'), ConfigFactory.detectFetch(fetchArg));
+    const delegatingResolver = new DelegatingResolver(
+      [placeHolderResolver, jasyptDecryptor, urlResolver],
+    );
     const valueResolvingConfig = new ValueResolvingConfig(config || npmconfig,
       resolver || delegatingResolver);
 

History.md

@@ -1,3 +1,9 @@
+1.0.6 / 2021-07-27
+==================
+
+* Remove node-fetch dependency, must inject/boot - @craigparra
+* Tidy tests and lint - @craigparra
+  
 1.0.5 / 2021-07-21
 ==================
 

PrefixSelector.js

@@ -16,6 +16,6 @@ module.exports = class PrefixSelector extends Selector {
   }
 
   async asyncResolveValue(value) {
-    return resolveValue(value);
+    return this.resolveValue(value);
   }
 };

README.md

@@ -13,7 +13,7 @@ An extensible wrapper of the popular config package, supporting:
 - placeholder resolution (or variable expansion),
 - encrypted values (via jasypt) 
 - default (or fallback) values, 
-- and asynchronous url fetching.
+- and optional asynchronous url fetching.
 
 <a name="usage">Usage</a>
 -------------------------
@@ -37,11 +37,16 @@ Config values that start with the prefix `enc.` will be decrypted with the
 [jasypt](https://www.npmjs.com/package/jasypt) package port, with the passphrase being
 sourced from the `process.env.NODE_CONFIG_PASSPHRASE` environment variable.
 
-Config values that start with the prefix `url.` can be fetched and resolved asynchronously with the `fetch` function,
-and HTTP options can be specified as in the example config file.
+Optionally, config values that start with the prefix `url.` can be fetched and resolved asynchronously with the `fetch` 
+function, and HTTP options can be specified as in the example config file.  To avoid bundling `node-fetch`, you need to
+provide it by using `@alt-javascript/boot` to boot it into the global root context, where the package will detect it.
 
 ```javascript
+const {boot} = require('@alt-javascript/boot');
 const {config} = require('@alt-javascript/config');
+const fetch = require('node-fetch');
+
+boot({config,fetch})
 const webdata = await config.fetch('pathToUrlPrefixedValue'); 
 ```
 > :warning: While we have implemented asynchronous fetch from "the network", we discourage it.  

Resolver.js

@@ -14,5 +14,4 @@ module.exports = class Resolver {
     }
     return callback(values);
   }
-
 };

URLResolver.js

@@ -1,12 +1,12 @@
 const _ = require('lodash');
-const fetch = require('node-fetch');
 const Resolver = require('./Resolver');
 const SelectiveResolver = require('./SelectiveResolver');
 const PrefixSelector = require('./PrefixSelector');
 
 module.exports = class URLResolver extends SelectiveResolver {
-  constructor(selector) {
+  constructor(selector, fetchArg) {
     super(selector || (new PrefixSelector('url.')));
+    this.$fetch = fetchArg;
   }
 
   resolve(config) {
@@ -30,12 +30,14 @@ module.exports = class URLResolver extends SelectiveResolver {
       if (self.selector.matches(v)) {
         try {
           const selectedValue = self.selector.resolveValue(v);
-          let urlPath = path.substring(0,path.lastIndexOf('.'));
-          let method = parentConfig.has(`${urlPath}.method`) ? parentConfig.get(`${urlPath}.method`) : null;
-          let authorization = parentConfig.has(`${urlPath}.authorization`) ? parentConfig.get(`${urlPath}.authorization`) : null;
-          let body = parentConfig.has(`${urlPath}.body`) ? parentConfig.get(`${urlPath}.body`) : null;
-          let headers = parentConfig.has(`${urlPath}.headers`) ? parentConfig.get(`${urlPath}.headers`) : null;
-          const fetchedValue = await this.fetch(selectedValue,authorization,method,body,headers);
+          const urlPath = path.substring(0, path.lastIndexOf('.'));
+          const method = parentConfig.has(`${urlPath}.method`) ? parentConfig.get(`${urlPath}.method`) : null;
+          const authorization = parentConfig.has(`${urlPath}.authorization`) ? parentConfig.get(`${urlPath}.authorization`) : null;
+          const body = parentConfig.has(`${urlPath}.body`) ? parentConfig.get(`${urlPath}.body`) : null;
+          const headers = parentConfig.has(`${urlPath}.headers`) ? parentConfig.get(`${urlPath}.headers`) : null;
+          const fetchedValue = await this.fetch(
+            selectedValue, authorization, method, body, headers,
+          );
           return fetchedValue;
         } catch (e) {
           return v;
@@ -46,14 +48,16 @@ module.exports = class URLResolver extends SelectiveResolver {
     return resolvedConfig;
   }
 
-  async fetch (url,authorization,method,body,headers){
-    let _headers = authorization ? {'authorization':authorization} : {};
-    _.assignIn(_headers,headers)
-    let opts = {method: method || 'get',headers: _headers}
-    if (method && method?.toLowerCase()!='get'  && method?.toLowerCase() != 'head'){
-      _.assignIn(opts,JSON.stringify(body||{}))
+  async fetch(url, authorization, method, body, headers) {
+    if (!this.$fetch) {
+      throw new Error('fetch is required');
     }
-    return await fetch(url, opts).then(res => res.json());
+    const $headers = authorization ? { authorization } : {};
+    _.assignIn($headers, headers);
+    const opts = { method: method || 'get', headers: $headers };
+    if (method && method?.toLowerCase() !== 'get' && method?.toLowerCase() !== 'head') {
+      _.assignIn(opts, JSON.stringify(body || {}));
+    }
+    return this.$fetch(url, opts).then((res) => res.json());
   }
-
 };

ValueResolvingConfig.js

@@ -21,12 +21,15 @@ module.exports = class ValueResolvingConfig extends DelegatingConfig {
     return new ValueResolvingConfig(this.config, this.resolver, path).resolved_config;
   }
 
-  async fetch (path, defaultValue){
-    let self = this;
+  async fetch(path, defaultValue) {
+    const self = this;
     if (defaultValue && this.has(path) === false) {
       return defaultValue;
     }
-    let asyncConfig = new ValueResolvingConfig(this.config, this.resolver, path, true);
-    return await asyncConfig.resolver.asyncResolve(asyncConfig.path == null ? asyncConfig : asyncConfig.config.get(asyncConfig.path),self,path);
+    const asyncConfig = new ValueResolvingConfig(this.config, this.resolver, path, true);
+    return asyncConfig.resolver.asyncResolve(
+      asyncConfig.path == null ? asyncConfig : asyncConfig.config.get(asyncConfig.path),
+      self, path,
+    );
   }
 };

index.js

@@ -26,5 +26,5 @@ module.exports = {
   Selector,
   URLResolver,
   ValueResolvingConfig,
-  config : ConfigFactory.getConfig()
+  config: ConfigFactory.getConfig(),
 };

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@alt-javascript/config",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "An extensible wrapper of the popular config package, supporting placeholder resolution, encrypted values and url fetch.",
   "author": "Craig Parravicini",
   "keywords": [
@@ -42,10 +42,11 @@
   "dependencies": {
     "config": "^3.3.6",
     "jasypt": "^1.0.5",
-    "lodash": "^4.17.21",
-    "node-fetch": "^2.6.1"
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
+    "@alt-javascript/boot": "^1.0.3",
+    "@alt-javascript/logger": "^1.1.5",
     "@cucumber/cucumber": "^7.3.0",
     "babel-eslint": "^10.1.0",
     "chai": "^4.3.4",
@@ -56,6 +57,7 @@
     "eslint-plugin-cucumber": "^1.4.0",
     "eslint-plugin-import": "^2.23.4",
     "mocha": "^9.0.2",
+    "node-fetch": "^2.6.1",
     "nyc": "^15.1.0",
     "run-script-os": "^1.1.6"
   }