1.1.4 / 2021-07-22

craig · craig · commit 7fca9b975dc8 · 2021-07-22T07:10:50.000+10:00
================== * Refactor reistry to categoryCache - @craigparra
diff --git a/CachingLoggerFactory.js b/CachingLoggerFactory.js
@@ -16,7 +16,7 @@ module.exports = class CachingLoggerFactory extends LoggerFactory {
                 new CachingConsole()),
             category,
             configPath,
-            registry || LoggerFactory.loggerRegistry);
+            registry || LoggerFactory.loggerCategoryCache);
     }
 
     constructor(config, registry, configPath) {
diff --git a/History.md b/History.md
@@ -1,13 +1,17 @@
-1.1.2 / 2021-07-19
+1.1.4 / 2021-07-22
 ==================
 
-* Updated README.md for boot - @craigparra
+* Refactor reistry to categoryCache - @craigparra
   
 1.1.3 / 2021-07-20
 ==================
 
 * Fix Registry cache get  - @craigparra
 
+1.1.2 / 2021-07-19
+==================
+
+* Updated README.md for boot - @craigparra
 
 1.1.1 / 2021-07-19
 ==================
diff --git a/LoggerCategoryCache.js b/LoggerCategoryCache.js
@@ -1,4 +1,4 @@
-module.exports = class LoggerRegistry {
+module.exports = class LoggerCategoryCache {
   constructor() {
     this.cache = {};
   }
diff --git a/LoggerFactory.js b/LoggerFactory.js
@@ -1,11 +1,11 @@
 const ConfigurableLogger = require('./ConfigurableLogger');
 const ConsoleLogger = require('./ConsoleLogger');
-const LoggerRegistry = require('./LoggerRegistry');
+const LoggerCategoryCache = require('./LoggerCategoryCache');
 const JSONFormatter = require('./JSONFormatter');
 const PlainTextFormatter = require('./PlainTextFormatter');
 
 module.exports = class LoggerFactory {
-    static loggerRegistry = new LoggerRegistry();
+    static loggerCategoryCache = new LoggerCategoryCache();
 
      static detectBrowser(){
         let browser = !(typeof window == 'undefined');
@@ -79,7 +79,7 @@ module.exports = class LoggerFactory {
               null),
             _category,
           configPath,
-          registry || LoggerFactory.loggerRegistry);
+          registry || LoggerFactory.loggerCategoryCache);
     }
 
     constructor(config, registry, configPath) {
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ To use the module, import the LoggerFactory and call the `getLogger` function wi
 requires path is a sensible choice).
 
 ```javascript
-const {config} = require('config');
+const config = require('config');
 const {LoggerFactory} = require('@alt-javascript/logger');
 const logger = LoggerFactory.getLogger('@myorg/mypackage/MyModule',config);
 
@@ -53,10 +53,10 @@ to the global root context, freeing your sub-modules from requiring and injectin
 
 `MyModule.js`
 ```javascript
-const config = require('@alt-javascript/config');
+const {config} = require('@alt-javascript/config');
 const {LoggerFactory} = require('@alt-javascript/logger');
 const {boot} = require('@alt-javascript/boot');
-boot(config);
+boot({config:config});
 
 ```
 
@@ -103,7 +103,7 @@ While the module uses sensible defaults, it is flexible and pluggable.  To use t
 winston and winston options (nullish options will fall back to defaults).
 
 ```javascript
-const {config} = require('config');
+const config = require('config');
 const {winston} = require('winston');
 const {WinstonLoggerFactory} = require('@alt-javascript/logger');
 const logger = WinstonLoggerFactory.getLogger('@myorg/mypackage/MyModule', config, winston,  {/*mywinstonoptions*/}));
@@ -133,7 +133,7 @@ Testing loggers is hard, and testability is a first class concern at @alt-javasc
 'CachingLoggerFactory' that will provide a logger implementation that will capture log lines that can be asserted.
 
 ```javascript
-const {config} = require('config');
+const config = require('config');
 const {CachingLoggerFactory} = require('@alt-javascript/logger');
 const logger = CachingLoggerFactory.getLogger('@myorg/mypackage/MyModule', config);
 
diff --git a/WinstonLoggerFactory.js b/WinstonLoggerFactory.js
@@ -10,7 +10,7 @@ module.exports = class WinstonLoggerFactory {
            new WinstonLogger(category,null,null,null,winston,options),
           category,
           configPath,
-          registry || LoggerFactory.loggerRegistry);
+          registry || LoggerFactory.loggerCategoryCache);
     }
 
     constructor(config,winston,options,registry, configPath) {
diff --git a/index.js b/index.js
@@ -7,7 +7,7 @@ module.exports.JSONFormatter = require('./JSONFormatter');
 module.exports.Logger = require('./Logger');
 module.exports.LoggerFactory = require('./LoggerFactory');
 module.exports.LoggerLevel = require('./LoggerLevel');
-module.exports.LoggerRegistry = require('./LoggerRegistry');
+module.exports.LoggerCategoryCache = require('./LoggerCategoryCache');
 module.exports.MultiLogger = require('./MultiLogger');
 module.exports.PlainTextFormatter = require('./PlainTextFormatter');
 module.exports.WinstonLogger = require('./WinstonLogger');
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@alt-javascript/logger",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "A simple configurable logging facade for javascript.",
   "author": "",
   "keywords": [
diff --git a/test/CachingLoggerFactory.spec.js b/test/CachingLoggerFactory.spec.js
@@ -4,7 +4,7 @@ const CachingLoggerFactory = require('../CachingLoggerFactory');
 const ConfigurableLogger = require('../ConfigurableLogger');
 const Logger = require('../Logger');
 const LoggerFactory = require('../LoggerFactory');
-const LoggerRegistry = require('../LoggerRegistry');
+const LoggerCategoryCache = require('../LoggerCategoryCache');
 
 const nodeconfig = require('config');
 const loggr = LoggerFactory.getLogger('@alt-javascript/logger/test/CachingLoggerFactory_spec',nodeconfig);
@@ -37,7 +37,7 @@ describe('CachingLoggerFactory Specification', () => {
 
   it('Instantiate - constructor args are set', () => {
     const config = new EphemeralConfig({});
-    const registry = new LoggerRegistry();
+    const registry = new LoggerCategoryCache();
     const cachingLoggerFactory = new CachingLoggerFactory(config,registry,ConfigurableLogger.DEFAULT_CONFIG_PATH);
 
     assert.equal(cachingLoggerFactory.config, config, 'cachingLoggerFactory.config === config');
@@ -48,7 +48,7 @@ describe('CachingLoggerFactory Specification', () => {
   it('static getLogger', () => {
 
     const config = new EphemeralConfig({});
-    const registry = new LoggerRegistry();
+    const registry = new LoggerCategoryCache();
     const logger = CachingLoggerFactory.getLogger(Logger.DEFAULT_CATEGORY,config,ConfigurableLogger.DEFAULT_CONFIG_PATH,registry);
 
     assert.equal(logger.config, config, 'logger.config === config');
diff --git a/test/ConfigurableLogger.spec.js b/test/ConfigurableLogger.spec.js
@@ -7,7 +7,7 @@ const JSONFormatter = require('../JSONFormatter');
 const Logger = require('../Logger');
 const LoggerLevel = require('../LoggerLevel');
 const LoggerFactory = require('../LoggerFactory');
-const LoggerRegistry = require('../LoggerRegistry');
+const LoggerCategoryCache = require('../LoggerCategoryCache');
 
 const config = require('config');
 const loggr = LoggerFactory.getLogger('@alt-javascript/logger/test/ConfigurableLogger_spec',config);
@@ -40,7 +40,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Instantiate - constructor args are set', () => {
     const config = new EphemeralConfig({});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.DEBUG,LoggerLevel.ENUMS,{},new JSONFormatter(), new CachingConsole(10,true));
-    const registry = new LoggerRegistry();
+    const registry = new LoggerCategoryCache();
     const logger = new ConfigurableLogger(config,consoleLogger,Logger.DEFAULT_CATEGORY,ConfigurableLogger.DEFAULT_CONFIG_PATH,registry);
 
 //  constructor(config, provider, category, configPath, registry) {
@@ -53,7 +53,7 @@ describe('ConfigurableLogger Specification', () => {
 
   it('Instantiate - default constructor args are set', () => {
     const config = new EphemeralConfig({});
-    const registry = new LoggerRegistry();
+    const registry = new LoggerCategoryCache();
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.DEBUG,LoggerLevel.ENUMS,{},new JSONFormatter(), new CachingConsole(10,true));
     const logger = new ConfigurableLogger(config,consoleLogger,null,null,registry);
 
@@ -67,13 +67,13 @@ describe('ConfigurableLogger Specification', () => {
   it('Instantiate - config is required', () => {
     const config = new EphemeralConfig({});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.DEBUG,LoggerLevel.ENUMS,{},new JSONFormatter(), new CachingConsole(10,true));
-    assert.throws(()=>{new ConfigurableLogger(null,consoleLogger,null,null,new LoggerRegistry())},'config is required');
+    assert.throws(()=>{new ConfigurableLogger(null,consoleLogger,null,null,new LoggerCategoryCache())},'config is required');
   });
 
   it('Instantiate - provider is required', () => {
     const config = new EphemeralConfig({});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.DEBUG,LoggerLevel.ENUMS,{},new JSONFormatter(), new CachingConsole(10,true));
-    assert.throws(()=>{new ConfigurableLogger(config,null,null,null,new LoggerRegistry())},'provider is required');
+    assert.throws(()=>{new ConfigurableLogger(config,null,null,null,new LoggerCategoryCache())},'provider is required');
   });
 
   it('Instantiate - provider is required', () => {
@@ -85,7 +85,7 @@ describe('ConfigurableLogger Specification', () => {
 
   it('setLevel', () => {
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.DEBUG,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     logger.setLevel(LoggerLevel.DEBUG);
     assert.equal(logger.provider.level, LoggerLevel.ENUMS[LoggerLevel.DEBUG], 'logger.level === LoggerLevels.ENUMS[LoggerLevel.DEBUG]');
   });
@@ -94,7 +94,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Check levels - debug', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.DEBUG}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.DEBUG,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     assert.isTrue(logger.isLevelEnabled(LoggerLevel.DEBUG), 'Debug is true');
     assert.isTrue(logger.isLevelEnabled(LoggerLevel.VERBOSE), 'Verbose is true');
     assert.isTrue(logger.isLevelEnabled(LoggerLevel.INFO), 'Info is true');
@@ -113,7 +113,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Check levels - verbose', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.VERBOSE}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.VERBOSE,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.DEBUG), 'Debug is false');
     assert.isTrue(logger.isLevelEnabled(LoggerLevel.VERBOSE), 'Verbose is true');
     assert.isTrue(logger.isLevelEnabled(LoggerLevel.INFO), 'Info is true');
@@ -132,7 +132,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Check levels - info', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.INFO}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.INFO,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.DEBUG), 'Debug is false');
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.VERBOSE), 'Verbose is false');
     assert.isTrue(logger.isLevelEnabled(LoggerLevel.INFO), 'Info is true');
@@ -151,7 +151,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Check levels - warn', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.WARN}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.WARN,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.DEBUG), 'Debug is false');
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.VERBOSE), 'Verbose is false');
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.INFO), 'Info is false');
@@ -170,7 +170,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Check levels - error', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.ERROR}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.ERROR,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.DEBUG), 'Debug is false');
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.VERBOSE), 'Verbose is false');
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.INFO), 'Info is false');
@@ -189,7 +189,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Check levels - fatal', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.FATAL}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.FATAL,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.DEBUG), 'Debug is false');
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.VERBOSE), 'Verbose is false');
     assert.isFalse(logger.isLevelEnabled(LoggerLevel.INFO), 'Info is false');
@@ -208,7 +208,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Log levels - debug', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.DEBUG}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.DEBUG,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -228,7 +228,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Log levels - verbose', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.VERBOSE}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.VERBOSE,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -247,7 +247,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Log levels - info', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.INFO}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.INFO,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -265,7 +265,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Log levels - warn', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.WARN}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.WARN,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -282,7 +282,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Log levels - error', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.ERROR}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.ERROR,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -298,7 +298,7 @@ describe('ConfigurableLogger Specification', () => {
   it('Log levels - fatal', () => {
     const config = new EphemeralConfig({logging:{level:{'/':LoggerLevel.FATAL}}});
     const consoleLogger = new ConsoleLogger(Logger.DEFAULT_CATEGORY,LoggerLevel.FATAL,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerRegistry());
+    const logger = new ConfigurableLogger(config,consoleLogger,null,null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -318,7 +318,7 @@ describe('ConfigurableLogger Specification', () => {
         'two': LoggerLevel.WARN
       }}});
     let consoleLogger = new ConsoleLogger('one',LoggerLevel.FATAL,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    let logger = new ConfigurableLogger(config,consoleLogger,'one',null,new LoggerRegistry());
+    let logger = new ConfigurableLogger(config,consoleLogger,'one',null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -331,7 +331,7 @@ describe('ConfigurableLogger Specification', () => {
     assert.isTrue(logger.provider.console.cache[1].includes('"level":"fatal","message":"message"'),'logger.provider.console.cache[0].includes(\'"level":"fatal","message":"message"\')');
 
     consoleLogger = new ConsoleLogger('two',LoggerLevel.FATAL,LoggerLevel.ENUMS,{},new JSONFormatter(),new CachingConsole(10,true));
-    logger = new ConfigurableLogger(config,consoleLogger,'two',null,new LoggerRegistry());
+    logger = new ConfigurableLogger(config,consoleLogger,'two',null,new LoggerCategoryCache());
     logger.debug('message');
     logger.verbose('message');
     logger.info('message');
@@ -345,4 +345,4 @@ describe('ConfigurableLogger Specification', () => {
     assert.isTrue(logger.provider.console.cache[2].includes('"level":"fatal","message":"message"'),'logger.provider.console.cache[0].includes(\'"level":"fatal","message":"message"\')');
 
   });
-});
+});
diff --git a/test/LoggerCategoryCache.spec.js b/test/LoggerCategoryCache.spec.js
diff --git a/test/LoggerFactory.spec.js b/test/LoggerFactory.spec.js

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ module.exports = class CachingLoggerFactory extends LoggerFactory {`
`16`	`16`	`new CachingConsole()),`
`17`	`17`	`category,`
`18`	`18`	`configPath,`
`19`		`- registry \|\| LoggerFactory.loggerRegistry);`
	`19`	`+ registry \|\| LoggerFactory.loggerCategoryCache);`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`constructor(config, registry, configPath) {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-module.exports = class LoggerRegistry {`
	`1`	`+module.exports = class LoggerCategoryCache {`
`2`	`2`	`constructor() {`
`3`	`3`	`this.cache = {};`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ module.exports = class WinstonLoggerFactory {`
`10`	`10`	`new WinstonLogger(category,null,null,null,winston,options),`
`11`	`11`	`category,`
`12`	`12`	`configPath,`
`13`		`- registry \|\| LoggerFactory.loggerRegistry);`
	`13`	`+ registry \|\| LoggerFactory.loggerCategoryCache);`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`constructor(config,winston,options,registry, configPath) {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@alt-javascript/logger",`
`3`		`- "version": "1.1.3",`
	`3`	`+ "version": "1.1.4",`
`4`	`4`	`"description": "A simple configurable logging facade for javascript.",`
`5`	`5`	`"author": "",`
`6`	`6`	`"keywords": [`