Optional Timestamp in logs

Author: Shaquu

.gitignore

@@ -315,6 +315,7 @@ $RECYCLE.BIN/
 .vscode
 
 *.js
+!src/helpers.js
 
 *.d.ts
 

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.0]
+
+### Added
+ - Optional Timestamp in logs
+
 ## [1.0.0]
 
 ### Official release

README.md

@@ -58,9 +58,19 @@ Parameters
 let LOGGER_DEBUG_COLOR = process.env.LOGGER_DEBUG_COLOR || '4'
 let LOGGER_ERROR_COLOR = process.env.LOGGER_ERROR_COLOR || '9'
 let LOGGER_TRACE_COLOR = process.env.LOGGER_TRACE_COLOR || '15'
-let LOGGER_DEBUG_ENABLED = (process.env.LOGGER_DEBUG_ENABLED === 'true') || false
-let LOGGER_ERROR_ENABLED = (process.env.LOGGER_ERROR_ENABLED === 'true') || true
-let LOGGER_TRACE_ENABLED = (process.env.LOGGER_TRACE_ENABLED === 'true') || false
+
+let LOGGER_DEBUG_ENABLED =
+        process.env.LOGGER_DEBUG_ENABLED &&
+        process.env.LOGGER_DEBUG_ENABLED === 'true'
+let LOGGER_ERROR_ENABLED =
+        (process.env.LOGGER_ERROR_ENABLED &&
+                process.env.LOGGER_ERROR_ENABLED === 'true') ||
+        true
+let LOGGER_TRACE_ENABLED =
+        process.env.LOGGER_TRACE_ENABLED &&
+        process.env.LOGGER_TRACE_ENABLED === 'true'
+
+let LOGGER_TIMESTAMP_ENABLED = process.env.LOGGER_TIMESTAMP_ENABLED || false
 ```
 
 Colors are defined via numbers. Depending on which device you are running your app different range of colors will be

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@nrchkb/logger",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Unified Logger for Node-RED nodes (using debug)",
   "main": "src/index.js",
   "scripts": {
     "build": "tsc",
     "test": "yarn build && cross-env DEBUG=LOGGER* mocha -r ts-node/register './src/**/*.test.[tj]s' --exit",
     "prettier": "prettier --write \"src/**/*.{js,ts}\"",
-    "lint": "eslint src/**/*.{js,ts} --fix"
+    "lint": "eslint src/**/*.{js,ts} --fix",
+    "husky-run": "lint-staged"
   },
   "repository": {
     "type": "git",
@@ -37,14 +38,14 @@
     "@typescript-eslint/parser": "^4.15.0",
     "babel-eslint": "^10.1.0",
     "cross-env": "^7.0.3",
-    "eslint": "^7.19.0",
+    "eslint": "^7.20.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-prettier": "^3.3.1",
     "husky": "^5.0.9",
     "lint-staged": "^10.5.4",
-    "mocha": "^8.2.1",
+    "mocha": "^8.3.0",
     "node-red": "^1.2.9",
-    "node-red-node-test-helper": "^0.2.6",
+    "node-red-node-test-helper": "^0.2.7",
     "prettier": "^2.2.1",
     "ts-node": "^9.1.1",
     "typescript": "^4.1.5"

src/helpers.js

@@ -0,0 +1,52 @@
+const namespaces = []
+
+const setTimestamp = (
+    debug,
+    LOGGER_TIMESTAMP_ENABLED,
+    namespacePrefix,
+    namespace = ''
+) => {
+    if (LOGGER_TIMESTAMP_ENABLED) {
+        namespaces.push(
+            namespacePrefix,
+            namespacePrefix + '-Trace',
+            namespacePrefix + '-Error',
+            namespacePrefix + ':',
+            namespacePrefix + '-Trace:',
+            namespacePrefix + '-Error:',
+            namespacePrefix + ':' + namespace,
+            namespacePrefix + '-Trace:' + namespace,
+            namespacePrefix + '-Error:' + namespace
+        )
+    }
+
+    debug.formatArgs = function (args) {
+        const { namespace: name, useColors } = this
+
+        if (useColors) {
+            const timestamp = namespaces.includes(this?.namespace)
+                ? new Date().toLocaleString('en-GB', {
+                      day: '2-digit',
+                      month: 'short',
+                      hour: 'numeric',
+                      minute: 'numeric',
+                      second: 'numeric',
+                  }) + ' '
+                : '  '
+
+            const c = this.color
+            const colorCode = '\u001B[3' + (c < 8 ? c : '8;5;' + c)
+            const prefix = `${colorCode};1m${name} \u001B[0m`
+
+            args[0] =
+                timestamp + prefix + args[0].split('\n').join('\n' + prefix)
+            args.push(
+                colorCode + 'm+' + debug.humanize(this.diff) + '\u001B[0m'
+            )
+        } else {
+            args[0] = getDate() + name + ' ' + args[0]
+        }
+    }
+}
+
+module.exports = { setTimestamp }

src/index.ts

@@ -2,6 +2,8 @@ import Debug from 'debug'
 import { Node } from 'node-red'
 import { CallbackType, Logger, LoggerSetupData } from './types'
 
+const helpers = require('./helpers')
+
 let LOGGER_DEBUG_COLOR = process.env.LOGGER_DEBUG_COLOR || '4'
 let LOGGER_ERROR_COLOR = process.env.LOGGER_ERROR_COLOR || '9'
 let LOGGER_TRACE_COLOR = process.env.LOGGER_TRACE_COLOR || '15'
@@ -16,37 +18,50 @@ let LOGGER_TRACE_ENABLED =
     process.env.LOGGER_TRACE_ENABLED &&
     process.env.LOGGER_TRACE_ENABLED === 'true'
 
+let LOGGER_TIMESTAMP_ENABLED = process.env.LOGGER_TIMESTAMP_ENABLED || false
+
 export const loggerSetup = ({
     debugColor,
     debugEnabled,
     errorColor,
     errorEnabled,
     traceColor,
     traceEnabled,
+    timestampEnabled,
 }: LoggerSetupData): void => {
-    if (debugColor) {
+    if (debugColor !== undefined) {
         LOGGER_DEBUG_COLOR = debugColor
     }
 
-    if (debugEnabled) {
+    if (debugEnabled !== undefined) {
         LOGGER_DEBUG_ENABLED = debugEnabled
     }
 
-    if (errorColor) {
+    if (errorColor !== undefined) {
         LOGGER_ERROR_COLOR = errorColor
     }
 
-    if (errorEnabled) {
+    if (errorEnabled !== undefined) {
         LOGGER_ERROR_ENABLED = errorEnabled
     }
 
-    if (traceColor) {
+    if (traceColor !== undefined) {
         LOGGER_TRACE_COLOR = traceColor
     }
 
-    if (traceEnabled) {
+    if (traceEnabled !== undefined) {
         LOGGER_TRACE_ENABLED = traceEnabled
     }
+
+    if (timestampEnabled !== undefined) {
+        if (typeof timestampEnabled === 'boolean') {
+            LOGGER_TIMESTAMP_ENABLED = timestampEnabled
+        } else {
+            timestampEnabled.split(',').forEach((n) => {
+                helpers.setTimestamp(Debug, true, n)
+            })
+        }
+    }
 }
 
 const logMessage = (
@@ -71,6 +86,13 @@ export const logger: Logger = (
     messagePrefix,
     node?
 ) => {
+    helpers.setTimestamp(
+        Debug,
+        LOGGER_TIMESTAMP_ENABLED,
+        namespacePrefix,
+        namespace
+    )
+
     //DEBUG
     const debug = Debug(
         namespace ? `${namespacePrefix}:${namespace}` : namespacePrefix

src/test/logger.test.ts

@@ -66,4 +66,41 @@ describe('Logger', function () {
 
         done()
     })
+
+    it('set timestamp', function (done) {
+        const { logger, loggerSetup } = require('../index')
+
+        loggerSetup({
+            timestampEnabled: true,
+        })
+
+        const log1 = logger('LOGGER_TIMESTAMP')
+
+        log1.debug('Red')
+        log1.error('Green')
+        log1.trace('Yellow')
+
+        loggerSetup({
+            timestampEnabled: false,
+        })
+
+        loggerSetup({
+            timestampEnabled:
+                'LOGGER_TIMESTAMP_CHECK_1,LOGGER_TIMESTAMP_CHECK_2',
+        })
+
+        const log2 = logger('LOGGER_TIMESTAMP_CHECK_1')
+
+        log2.debug('Red')
+        log2.error('Green')
+        log2.trace('Yellow')
+
+        const log3 = logger('LOGGER_TIMESTAMP_CHECK_2')
+
+        log3.debug('Red')
+        log3.error('Green')
+        log3.trace('Yellow')
+
+        done()
+    })
 })

src/types.ts

@@ -17,6 +17,7 @@ export type LoggerSetupData = {
     errorEnabled?: boolean
     traceColor?: string
     traceEnabled?: boolean
+    timestampEnabled?: boolean | string
 }
 
 export type Logger = (

tsconfig.json

@@ -32,6 +32,7 @@
   ],
   "exclude": [
     "node_modules",
-    "**/test/*"
+    "**/test/*",
+    "src/helpers.js"
   ]
 }