hermodlog 1.3.0 → 1.4.1

package/README.md

@@ -37,18 +37,6 @@ listenerLogger.debug("Message received!");
 #### `new Logger(options)`
 Create a new logger instance.
 
-##### `context(name)`
-Create a new context logger with the given context name.
-
-##### `module(name)`
-Create a new module logger with the given module name.
-
-##### `listener(name)`
-Create a new listener sublogger with the given listener name.
-
-##### `method(name)`
-Create a new method sublogger with the given method name.
-
 #### Level methods
 
 ##### `log(message, level)`
@@ -72,20 +60,78 @@ Log a message with the error level.
 ##### `fatal(message)`
 Log a message with the fatal level.
 
+#### Context methods
+
+##### `context(name)`
+Create a new context logger with the given context name.
+
+##### `module(name)`
+Create a new module logger with the given module name.
+
+##### `listener(name)`
+Create a new listener sublogger with the given listener name.
+
+##### `method(name)`
+Create a new method sublogger with the given method name.
+
+##### `child(name)`
+Create a new child logger with the given child name.
+
+##### `object(object)`
+Create a new object logger with the given object.
+
+#### Other methods
+
+#### `clone(opts)`
+Clone the logger. The `opts` object can have the following properties:
+- keepHistory: Whether to keep the history of the logger. Default: `false` (unique falsy one).
+- keepContext: Whether to keep the context of the logger. Default: `true`.
+- keepModule: Whether to keep the module of the logger. Default: `true`.
+- keepListener: Whether to keep the listener of the logger. Default: `true`.
+- keepMethod: Whether to keep the method of the logger. Default: `true`.
+- keepObject: Whether to keep the object of the logger. Default: `true`.
+- keepChild: Whether to keep the child of the logger. Default: `true`.
+- keepLevel: Whether to keep the level of the logger. Default: `true`.
+- keepColors: Whether to keep the colors of the logger. Default: `true`.
+- keepDate: Whether to keep the date of the logger. Default: `true`.
 
 #### constructor options
 The `options` object can have the following properties:  
 
-level: The default log level. Can be one of 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
-colors: An object where each key is a log level and the value is an array of colors for different parts of the log message. The array should have the following order: [date color, type color, context color, module color, listener color, method color, object color, string color, function color, number/default color].
-date: A date-compatible format
+##### `date`
+A date-compatible format. Default: `YYYY-MM-DD HH:mm:ss.SSS`.
+
+##### `level`
+A default log level. Can be one of 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. Default: `info`.
+
+##### `history`
+The history of the logger. Default: `[]`.
+
+##### `contextName`
+The context name of the logger. Default: `null`.
+
+##### `moduleName`
+The module name of the logger. Default: `null`.
+
+##### `listenerName`
+The listener name of the logger. Default: `null`.
+
+##### `methodName`
+The method name of the logger. Default: `null`.
+
+##### `objectName`
+The object name of the logger. Default: `null`.
+
+##### `colors`
+An object where each key is a log level and the value is an array of colors for different parts of the log message. The array should have the following order: [date color, type color, context color, module color, listener color, method color, object color, string color, function color, number/default color].
 
 ```js
 {
     const options = {
-        date: new Date('2024-01-01T00:01:01.001Z')},
+        date: new Date('2024-01-01T00:01:01.001Z'),
         level: 'info', // Set the default log level
-        colors: { // Set the colors for different parts of the log message
+        colors: {
+            // Set the colors for different parts of the log message
             fatal: [chalk.gray, chalk.red, chalk.blueBright, chalk.gray, chalk.cyan, chalk.yellow, chalk.magenta, chalk.white, chalk.blue, chalk.cyan],
             error: [chalk.gray, chalk.red, chalk.blueBright, chalk.gray, chalk.cyan, chalk.yellow, chalk.red, chalk.yellow, chalk.green, chalk.blue],
             warn: [chalk.gray, chalk.red, chalk.blueBright, chalk.gray, chalk.cyan, chalk.yellow, chalk.yellow, chalk.blue, chalk.magenta, chalk.red],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hermodlog",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Simple contextual logger to simplify log display in heavy load context and provide easy parsing",
   "main": "src/Logger.js",
   "type": "module",

package/src/Logger.js

@@ -14,6 +14,7 @@ import fatal from "./methods/fatal.js";
 import child from "./methods/child.js";
 
 import LOG_COLORS from "./LOG_COLORS.js";
+import object from "./methods/object.js";
 class Logger {
     constructor(props = {}) {
         this.level = props.level ?? 'info';
@@ -21,12 +22,14 @@ class Logger {
             throw new Error(`Unknown log level ${this.level}`)
         }
 
-        this.history = [];
+        this.history = props.history ?? [];
+
+        this.contextName = props.contextName ?? null;
+        this.methodName = props.methodName ?? null;
+        this.moduleName = props.moduleName ?? null;
+        this.listenerName = props.listenerName ?? null;
+        this.objectName = props.objectName ?? null;
 
-        this.contextName = null
-        this.methodName = null
-        this.moduleName = null
-        this.listenerName = null
         if (props.date) {
             this.date = props.date;
         }
@@ -38,10 +41,27 @@ class Logger {
         console.log(message)
     }
 
-    clone() {
+    clone(opts = {}) {
+        const keepHistory = opts?.keepHistory ?? false;
+        const keepLevel = opts?.keepLevel ?? true;
+        const keepDate = opts?.keepDate ?? true;
+        const keepColors = opts?.keepColors ?? true;
+        const keepContext = opts?.keepContext ?? true;
+        const keepMethod = opts?.keepMethod ?? true;
+        const keepModule = opts?.keepModule ?? true;
+        const keepListener = opts?.keepListener ?? true;
+        const keepObject = opts?.keepObject ?? true;
+
         return new Logger({
-            level: this.level,
-            date: this.date,
+            level: (keepLevel) ? this.level : opts.level ?? this.level,
+            date: (keepDate) ? this.date : opts.date ?? null,
+            history: keepHistory ? this.history : [],
+            colors: (keepColors) ? this.LOG_COLORS : opts.colors ?? this.LOG_COLORS,
+            contextName: (keepContext) ? this.contextName : opts.contextName ?? null,
+            methodName: (keepMethod) ? this.methodName : opts.methodName ?? null,
+            moduleName: (keepModule) ? this.moduleName : opts.moduleName ?? null,
+            listenerName: (keepListener) ? this.listenerName : opts.listenerName ?? null,
+            objectName: (keepObject) ? this.objectName : opts.objectName ?? null,
         })
     }
 
@@ -55,6 +75,7 @@ Logger.prototype.info = info;
 Logger.prototype.listener = listener;
 Logger.prototype.log = log;
 Logger.prototype.method = method;
+Logger.prototype.object = object;
 Logger.prototype.module = module;
 Logger.prototype.trace = trace;
 Logger.prototype.warn = warn;

package/src/Logger.spec.js

@@ -39,6 +39,7 @@ describe('Logger', () => {
     })
     it('should handle level', function () {
         const levelLogger = new Logger({level: 'error'})
+        levelLogger._log = () => {}
         levelLogger.error('Hello');
         assert.equal(levelLogger.history.length, 1)
         levelLogger.warn('Hello');

package/src/methods/context.js

@@ -3,10 +3,6 @@ import Logger from "../Logger.js";
 export default function context(_context) {
     const logger = this.clone();
     logger.contextName = _context;
-    logger.methodName = this.methodName;
-    logger.moduleName = this.moduleName;
-    logger.listenerName = this.listenerName;
-
     logger._log = this._log.bind(logger);
     return logger;
 }

package/src/methods/listener.js

@@ -2,8 +2,6 @@ import Logger from "../Logger.js";
 
 export default function  listener(_listener) {
     const logger = this.clone();
-    logger.moduleName = this.moduleName;
-    logger.contextName = this.contextName;
     logger.listenerName = _listener;
     logger._log = this._log.bind(logger);
     return logger;

package/src/methods/method.js

@@ -2,9 +2,6 @@ import Logger from "../Logger.js";
 
 export default function  method(_method) {
     const logger = this.clone();
-    logger.moduleName = this.moduleName;
-    logger.contextName = this.contextName;
-    logger.listenerName = this.listenerName;
     logger.methodName = _method;
     logger._log = this._log.bind(logger);
     return logger;

package/src/methods/module.js

@@ -1,12 +1,8 @@
 import Logger from "../Logger.js";
 
-export default function   module(_module) {
+export default function module(_module) {
     const logger = this.clone();
-    logger.methodName = this.methodName;
     logger.moduleName = _module;
-    logger.contextName = this.contextName;
-    logger.listenerName = this.listenerName;
-
     logger._log = this._log.bind(logger);
     return logger;
 }

package/src/methods/object.js

@@ -0,0 +1,8 @@
+import Logger from "../Logger.js";
+
+export default function object(_context) {
+    const logger = this.clone();
+    logger.objectName = _context;
+    logger._log = this._log.bind(logger);
+    return logger;
+}

package/src/utils/log.js

@@ -1,4 +1,22 @@
-// src/utils/log.js
+function safeStringify(obj, indent = 2, depth = 5, level = 0) {
+    let cache = [];
+    const retVal = JSON.stringify(
+        obj,
+        (key, value) => {
+            if (level > depth) return '...';
+            if (typeof value === "object" && value !== null) {
+                if (cache.includes(value)) return undefined; // Duplicate reference found, discard key
+                cache.push(value); // Store value in our collection
+                level++;
+            }
+            return value;
+        },
+        indent
+    );
+    cache = null;
+    return retVal;
+}
+
 export default function log(level, args, context) {
     const LOG_COLORS = context.LOG_COLORS;
     const colors = LOG_COLORS[level] || LOG_COLORS['info'];
@@ -10,6 +28,9 @@ export default function log(level, args, context) {
         message = `[${colors[0](date.toISOString())}]`;
     }
 
+
+    // TODO: It would be neat to just have a single parents array that would be used
+    //  to generate the context string.
     if(context.contextName){
         message += ` context: ${colors[2](context.contextName)} |`;
     }
@@ -22,6 +43,10 @@ export default function log(level, args, context) {
     if(context.methodName){
         message += ` method: ${colors[5](context.methodName)} |`;
     }
+    if(context.objectName){
+        message += ` Object[${colors[6](context.objectName)}] |`;
+    }
+
     if(message.endsWith(' |')){
         message = message.slice(0, -1);
     }
@@ -34,10 +59,16 @@ export default function log(level, args, context) {
                 color = colors[6]; // object color
                 const constructorName = args[i].constructor.name;
                 message += ` ${color(`${constructorName}(`)}`
-                if(constructorName === 'Error'){
-                    message += color(JSON.stringify(args[i].message, null, 2))
+                try {
+                    if(constructorName === 'Error'){
+                        message += color(safeStringify(args[i].message, 3, 4))
+                    }
+                    message += color(safeStringify(args[i], 3, 4))
+                } catch (err) {
+                    // Probably a circular reference
+                    message += color(args[i].toString())
                 }
-                message += color(JSON.stringify(args[i], null, 2))
+
                 message += ` ${color(")")}`
                 break;
             case 'string':

package/usage.example.js

@@ -1,31 +1,11 @@
 import Logger from './src/Logger.js';
 
-
 const logger = new Logger({
     level: 'trace',
 });
 
-// {
-//     room: 'CANDLE',
-//         message: {
-//     payload: Candle {
-//         market: [Market],
-//             interval: '1m',
-//             open: '41303.70',
-//             close: '41305.60',
-//             low: '41301.00',
-//             high: '41308.50',
-//             volume: [Object],
-//             openTime: [Epoch],
-//             closeTime: [Epoch],
-//             trades: '223',
-//             id: '8e884b29'
-//     },
-//     topic: 'CANDLE'
-// }
-// }
-
 
+logger.context('APIContext').module('Websocket Server').listener('onMessage').method('processIncomingMessage').log('Hello World');
 
 const contextLogger = logger.context('APIContext')
 contextLogger.log('Started API');