1.0.3 / 2021-07-21

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

* Breaking change to boot function parameter to pass a context object, oh well early days - @craigparra
* Refactor loggerRegistry to LoggerCategoryCache - @craigparra

Author: craig

History.md

@@ -1,3 +1,9 @@
+1.0.3 / 2021-07-21
+==================
+
+* Breaking change to boot function parameter to pass a context object, oh well early days - @craigparra
+* Refactor loggerRegistry to LoggerCategoryCache - @craigparra
+  
 1.0.2 / 2021-07-21
 ==================
 

README.md

@@ -29,7 +29,7 @@ const {config} = require('@alt-javascript/config');
 const {LoggerFactory} = require('@alt-javascript/logger');
 const {boot} = require('@alt-javascript/boot');
 
-boot(config);
+boot({config:config});
 
 config.get('key');
 config.get('nested.key');
@@ -49,7 +49,7 @@ const winston = require('winston');
 const {LoggerFactory, WinstonLoggerFactory} = require('@alt-javascript/logger');
 const {boot} = require('@alt-javascript/boot');
 const winstonLoggerFactory = new WinstonLoggerFactory(config,winston,{/*my winston options*/})
-boot(config, winstonLoggerFactory);
+boot({config:config, loggerFactory:winstonLoggerFactory});
 ```
 
 Then in your application modules, you only need.

boot.js

@@ -1,7 +1,11 @@
 const {ValueResolvingConfig,EphemeralConfig,ConfigFactory} = require ('@alt-javascript/config');
-const {LoggerRegistry,LoggerFactory,ConfigurableLogger} = require('@alt-javascript/logger');
+const {LoggerCategoryCache,LoggerFactory,ConfigurableLogger} = require('@alt-javascript/logger');
 
-module.exports = function (configArg,loggerFactoryArg,loggerRegistryArg) {
+module.exports = function (context) {
+
+    let configArg = context?.config;
+    let loggerFactoryArg = context?.loggerFactory;
+    let loggerCategoryCacheArg = context?.loggerFactory;
 
     let browser = !(typeof window == 'undefined');
 
@@ -27,21 +31,21 @@ module.exports = function (configArg,loggerFactoryArg,loggerRegistryArg) {
         throw new Error ('Unable to detect config, is \'config\' declared or provided?');
     }
 
-    let _loggerRegistry = null;
-    if (!(typeof loggerRegistry == 'undefined')){
-        _loggerRegistry = loggerRegistry;
+    let _loggerCategoryCache = null;
+    if (!(typeof loggerCategoryCacheArg == 'undefined')){
+        _loggerCategoryCache = loggerCategoryCacheArg;
     }
-    if (browser && window?.loggerRegistry){
-        _config = window.loggerRegistry;
+    if (browser && window?.loggerCategoryCache){
+        _config = window.loggerCategoryCache;
     }
 
-    _loggerRegistry = _loggerRegistry || loggerRegistryArg || new LoggerRegistry();
+    _loggerCategoryCache = _loggerCategoryCache || loggerCategoryCacheArg || new LoggerCategoryCache();
 
     let _loggerFactory = null;
     if (!(typeof loggerFactory == 'undefined')){
         _loggerFactory = loggerFactory;
     }
-    _loggerFactory = _loggerFactory || loggerFactoryArg || new LoggerFactory(_config,_loggerRegistry,ConfigurableLogger.DEFAULT_CONFIG_PATH);
+    _loggerFactory = _loggerFactory || loggerFactoryArg || new LoggerFactory(_config,_loggerCategoryCache,ConfigurableLogger.DEFAULT_CONFIG_PATH);
 
     let _globalref = null;
     if (browser){
@@ -50,7 +54,7 @@ module.exports = function (configArg,loggerFactoryArg,loggerRegistryArg) {
         _globalref = global;
     }
     _globalref.boot = {contexts: {root:{config:_config}}};
-    _globalref.boot.contexts.root.loggerRegistry = _loggerRegistry;
+    _globalref.boot.contexts.root.loggerCategoryCache = _loggerCategoryCache;
     _globalref.boot.contexts.root.loggerFactory = _loggerFactory;
 
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alt-javascript/boot",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "An Extensible Config & Logging Application Bootstrap Function",
   "author": "Craig Parravicini",
   "keywords": ["logging","configuration","boostrap","boot","global","context"],

test/boot.spec.js

@@ -3,7 +3,7 @@ const config = require('config');
 const altConfig = require('@alt-javascript/config').config;
 const {EphemeralConfig,ConfigFactory,ValueResolvingConfig} = require('@alt-javascript/config');
 const {boot} = require('..');
-const {CachingLoggerFactory,LoggerFactory,LoggerRegistry} = require('@alt-javascript/logger');
+const {CachingLoggerFactory,LoggerFactory,LoggerCategoryCache} = require('@alt-javascript/logger');
 const logger = LoggerFactory.getLogger('@alt-javascript/boot/test/boot_spec',config);
 
 before(async () => {
@@ -36,18 +36,18 @@ describe('boot function', () => {
   });
   it('boot - config ', () => {
     const config = new EphemeralConfig({});
-    boot(config);
+    boot({config:config});
     assert.instanceOf(global.boot.contexts.root.config,ValueResolvingConfig,'global.boot.contexts.root.config instanceof ValueResolvingConfig');
     assert.instanceOf(global.boot.contexts.root.loggerFactory,LoggerFactory,'global.boot.contexts.root.loggerFactory instanceof LoggerFactory');
-    assert.instanceOf(global.boot.contexts.root.loggerRegistry,LoggerRegistry,'global.boot.contexts.root.loggerRegistry instanceof loggerRegistry');
+    assert.instanceOf(global.boot.contexts.root.loggerCategoryCache,LoggerCategoryCache,'global.boot.contexts.root.loggerCategoryCache instanceof loggerCategoryCache');
     global.boot = undefined;
   });
   it('boot - config with ValueResolvingConfig ', () => {
     const config = ConfigFactory.getConfig(new EphemeralConfig({})) ;
-    boot(config);
+    boot({config:config});
     assert.instanceOf(global.boot.contexts.root.config,ValueResolvingConfig,'global.boot.contexts.root.config instanceof ValueResolvingConfig');
     assert.instanceOf(global.boot.contexts.root.loggerFactory,LoggerFactory,'global.boot.contexts.root.loggerFactory instanceof LoggerFactory');
-    assert.instanceOf(global.boot.contexts.root.loggerRegistry,LoggerRegistry,'global.boot.contexts.root.loggerRegistry instanceof loggerRegistry');
+    assert.instanceOf(global.boot.contexts.root.loggerCategoryCache,LoggerCategoryCache,'global.boot.contexts.root.loggerCategoryCache instanceof loggerCategoryCache');
     global.boot = undefined;
   });
 
@@ -57,7 +57,7 @@ describe('boot function', () => {
     boot();
     assert.instanceOf(global.boot.contexts.root.config,ValueResolvingConfig,'global.boot.contexts.root.config instanceof ValueResolvingConfig');
     assert.instanceOf(global.boot.contexts.root.loggerFactory,LoggerFactory,'global.boot.contexts.root.loggerFactory instanceof LoggerFactory');
-    assert.instanceOf(global.boot.contexts.root.loggerRegistry,LoggerRegistry,'global.boot.contexts.root.loggerRegistry instanceof loggerRegistry');
+    assert.instanceOf(global.boot.contexts.root.loggerCategoryCache,LoggerCategoryCache,'global.boot.contexts.root.loggerCategoryCache instanceof loggerCategoryCache');
     global.boot = undefined;
     global.config = undefined;
   });
@@ -68,16 +68,16 @@ describe('boot function', () => {
     boot();
     assert.instanceOf(global.window.boot.contexts.root.config,ValueResolvingConfig,'global.boot.contexts.root.config instanceof ValueResolvingConfig');
     assert.instanceOf(global.window.boot.contexts.root.loggerFactory,LoggerFactory,'global.boot.contexts.root.loggerFactory instanceof LoggerFactory');
-    assert.instanceOf(global.window.boot.contexts.root.loggerRegistry,LoggerRegistry,'global.boot.contexts.root.loggerRegistry instanceof loggerRegistry');
+    assert.instanceOf(global.window.boot.contexts.root.loggerCategoryCache,LoggerCategoryCache,'global.boot.contexts.root.loggerCategoryCache instanceof loggerCategoryCache');
     global.boot = undefined;
     global.window = undefined;
   });
 
   it('boot - LoggerFactory detects boot root context', () => {
     const config = new EphemeralConfig({logging:{level:{'/': 'info'}}});
-    const cachingLoggerFactory = new CachingLoggerFactory(config, new LoggerRegistry());
+    const cachingLoggerFactory = new CachingLoggerFactory(config, new LoggerCategoryCache());
 
-    boot(config,cachingLoggerFactory);
+    boot({config:config,loggerFactory:cachingLoggerFactory});
     const logger = LoggerFactory.getLogger('@alt-javascript/boot/test/boot_spec')
 
     logger.info('message');
@@ -87,8 +87,8 @@ describe('boot function', () => {
   });
 
   it('boot - uses config local-development', () => {
-    const cachingLoggerFactory = new CachingLoggerFactory(config, new LoggerRegistry());
-    boot(config,cachingLoggerFactory);
+    const cachingLoggerFactory = new CachingLoggerFactory(config, new LoggerCategoryCache());
+    boot({config:config,loggerFactory:cachingLoggerFactory});
     const logger = LoggerFactory.getLogger('@alt-javascript/boot/test/boot_spec/local-development')
 
     logger.debug('message');