zeddemore-logger 1.2.2 → 1.2.4

package/lib/date.js

@@ -1,9 +1,11 @@
 // Copyright (c) 2025 by Beardon Services, Inc.
 
+const _ = require('lodash');
+
 function convertMilliseconds(milliseconds, options) {
     options = options || { };
-    const digits = options.digits || 3;
-    const spaced = options.hasOwnProperty('spaced') ? options.spaced : false;
+    const digits = _.isInteger(options.digits) ? options.digits : 3;
+    const spaced = _.isBoolean(options.spaced) ? options.spaced : false;
     let value = milliseconds || 0;
     let unit = 'ms';
     if (milliseconds) {

package/lib/enums.js

@@ -119,9 +119,29 @@ const morganFormats = {
     COMBINED: 'combined',
     COMMON: 'common',
     DEV: 'dev',
-    DEV_ENHANCED: ':method :url :status-colored :response-time-format :content-length-format',
     SHORT: 'short',
     TINY: 'tiny',
+    ZEDDEMORE: 'zeddemore', // added for `zeddemore-logger`
+};
+
+const morganFormatTokens = {
+    CONTENT_LENGTH_FORMAT: 'content-length-format', // added for `zeddemore-logger`
+    DATE: 'date', // :date[format]
+    DECODED_URL: 'decoded-url', // added for `zeddemore-logger`
+    HTTP_VERSION: 'http-version',
+    METHOD: 'method',
+    REFERRER: 'referrer',
+    REMOTE_ADDR: 'remote-addr',
+    REMOTE_USER: 'remote-user',
+    REQ: 'req', // :req[header]
+    RES: 'res', // :res[header]
+    RESPONSE_TIME: 'response-time', // :response-time[digits]
+    RESPONSE_TIME_FORMAT: 'response-time-format', // added for `zeddemore-logger`
+    STATUS: 'status',
+    STATUS_COLORED: 'status-colored', // added for `zeddemore-logger`
+    TOTAL_TIME: 'total-time', // :total-time[digits]
+    URL: 'url',
+    USER_AGENT: 'user-agent',
 };
 
 const winstonLogLevelNames = {
@@ -158,6 +178,7 @@ module.exports = {
     httpRequestHeaders,
     httpResponseHeaders,
     morganFormats,
+    morganFormatTokens,
     winstonLogLevelNames,
     winstonLogLevels,
 };

package/lib/math.js

@@ -5,9 +5,9 @@ const _ = require('lodash');
 function convertBytes(bytes, options = { }) {
     options = options || { };
     if (!bytes) return null;
-    const useBinaryUnits = options.useBinaryUnits || false;
-    const decimals = options.decimals || 2;
-    const spaced = options.hasOwnProperty('spaced') ? options.spaced : false;
+    const useBinaryUnits = _.isBoolean(options.useBinaryUnits) ? options.useBinaryUnits : false;
+    const decimals = _.isInteger(options.decimals) ? options.decimals : 2;
+    const spaced = _.isBoolean(options.spaced) ? options.spaced : false;
     const base = useBinaryUnits ? 1024 : 1000;
     const units = useBinaryUnits
         ? [ 'B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB' ]

package/lib/zeddemore-logger.js

@@ -16,11 +16,14 @@ const { extractToken, getRequestResponseTime, isRequestOfMethod, parseRequest }
 const { logLevelMap } = require('./mappings/log_mappings');
 
 const { colorize, combine, label, metadata, printf, timestamp } = format;
-const { morganFormats: mf, httpMethods: http, httpRequestHeaders: rqh, httpResponseHeaders: rsh, winstonLogLevelNames: wlln,
-    winstonLogLevels: wll } = enums;
+const { morganFormats: mf, morganFormatTokens: mft, httpMethods: http, httpRequestHeaders: rqh, httpResponseHeaders: rsh,
+    winstonLogLevelNames: wlln, winstonLogLevels: wll } = enums;
 
 const COLOR_CONSOLE_WHITE_HEX = '#ECECEC';
+const DEFAULT_CONTENT_LENGTH_DIGITS = 2;
+const DEFAULT_MORGAN_FORMAT_TOKENS = [ mft.METHOD, mft.DECODED_URL, mft.STATUS_COLORED, mft.RESPONSE_TIME_FORMAT, mft.CONTENT_LENGTH_FORMAT ];
 const DEFAULT_REQUEST_ID_ATTRIBUTE = 'requestId';
+const DEFAULT_RESPONSE_TIME_DIGITS = 0;
 const DEFAULT_USER_LOG_LEVEL = -1;
 const WINSTON_CONSOLE_TRANSPORT_NAME = 'console';
 
@@ -58,6 +61,7 @@ class ZeddemoreLogger {
     /** @type {Logger} */
     #logger = null;
     #logLevel = wll.INFO;
+    #morganFormat = null;
 
     constructor(options) {
         options = options || { };
@@ -65,21 +69,24 @@ class ZeddemoreLogger {
         this.apiRouteCategories = options.apiRouteCategories || [ ];
         this.apiRoutes = options.apiRoutes || [ ];
         this.apiVersion = options.apiVersion || null;
+        this.contentLengthDigits = _.isInteger(options.contentLengthDigits) ? options.contentLengthDigits : DEFAULT_CONTENT_LENGTH_DIGITS;
+        this.decodeUrls = _.isBoolean(options.decodeUrls) ? options.decodeUrls : true;
         this.defaultLabel = options.defaultLabel || 'zeddemore-logger';
-        this.disableApiCallLogging = options.hasOwnProperty('disableApiCallLogging') ? options.disableApiCallLogging : false;
-        this.disableRouteLogging = options.hasOwnProperty('disableRouteLogging') ? options.disableRouteLogging : false;
-        this.disableMorganLogging = options.hasOwnProperty('disableMorganLogging') ? options.disableMorganLogging : false;
-        this.displayCaller = options.hasOwnProperty('displayCaller') ? options.displayCaller : true;
-        this.displayIpAddress = options.hasOwnProperty('displayIpAddress') ? options.displayIpAddress : true;
-        this.displayRequestId = options.hasOwnProperty('displayRequestId') ? options.displayRequestId : true;
+        this.disableApiCallLogging = _.isBoolean(options.disableApiCallLogging) ? options.disableApiCallLogging : false;
+        this.disableRouteLogging = _.isBoolean(options.disableRouteLogging) ? options.disableRouteLogging : false;
+        this.disableMorganLogging = _.isBoolean(options.disableMorganLogging) ? options.disableMorganLogging : false;
+        this.displayCaller = _.isBoolean(options.displayCaller) ? options.displayCaller : true;
+        this.displayIpAddress = _.isBoolean(options.displayIpAddress) ? options.displayIpAddress : true;
+        this.displayRequestId = _.isBoolean(options.displayRequestId) ? options.displayRequestId : true;
         this.customCallerSettings = options.customCallerSettings || [ ];
         this.defaultUserLogLevel = options.defaultUserLogLevel || DEFAULT_USER_LOG_LEVEL;
-        this.#forceLogLevel = options.hasOwnProperty('forceLogLevel') ? options.forceLogLevel : false;
-        this.#logLevel = options.hasOwnProperty('logLevel') ? options.logLevel : wll.INFO;
-        this.morganFormat = options.morganFormat || mf.DEV_ENHANCED;
+        this.#forceLogLevel = _.isBoolean(options.forceLogLevel) ? options.forceLogLevel : false;
+        this.#logLevel = _.isInteger(options.logLevel) ? options.logLevel : wll.INFO;
+        this.morganFormat = _.isString(options.morganFormat) ? options.morganFormat : null;
+        this.responseTimeDigits = _.isInteger(options.responseTimeDigits) ? options.responseTimeDigits : DEFAULT_RESPONSE_TIME_DIGITS;
         this.routeModel = options.routeModel || null;
-        this.suppressNonMutatingRequestApiCallLogging = options.hasOwnProperty('suppressNonMutatingRequestApiCallLogging') ? options.suppressNonMutatingRequestApiCallLogging : false;
-        this.suppressSuccessfulRequestApiCallLogging = options.hasOwnProperty('suppressSuccessfulRequestApiCallLogging') ? options.suppressSuccessfulRequestApiCallLogging : false;
+        this.suppressNonMutatingRequestApiCallLogging = _.isBoolean(options.suppressNonMutatingRequestApiCallLogging) ? options.suppressNonMutatingRequestApiCallLogging : false;
+        this.suppressSuccessfulRequestApiCallLogging = _.isBoolean(options.suppressSuccessfulRequestApiCallLogging) ? options.suppressSuccessfulRequestApiCallLogging : false;
         this.timestampFormat = options.timestampFormat || 'YYYY-MM-DD HH:mm:ss';
         this.requestIdAttribute = options.requestIdAttribute || DEFAULT_REQUEST_ID_ATTRIBUTE;
         this.userGetFn = options.userGetFn || this.#userGetFn;
@@ -89,6 +96,15 @@ class ZeddemoreLogger {
         return !this.disableApiCallLogging && !!this.apiCallModel;
     }
 
+    get morganFormat() {
+        if (!!this.#morganFormat) return this.#morganFormat;
+        return mf.ZEDDEMORE;
+    }
+
+    set morganFormat(format) {
+        if (_.isString(format) && !!format.length) this.#morganFormat = format;
+    }
+
     get forceLogLevel() {
         return this.#forceLogLevel;
     }
@@ -118,6 +134,33 @@ class ZeddemoreLogger {
         this.#logLevel = massageLogLevel(level);
     }
 
+    #buildMorganFormat = (morganTokens = [ ]) => {
+        function addArgument(token, argument) {
+            if (hasArgument(token)) return token;
+            const openBracketIndex = token.indexOf('[');
+            const _token = (openBracketIndex > -1) ? token.substring(0, openBracketIndex) : token;
+            return `${ _token }[${ argument }]`;
+        }
+        function hasArgument(token) {
+            const openBracketIndex = token.indexOf('[');
+            const closeBracketIndex = token.indexOf(']');
+            return ((openBracketIndex > -1) && (closeBracketIndex > -1) && (closeBracketIndex > (openBracketIndex + 1)));
+        }
+        if (!morganTokens || !_.isArray(morganTokens) || !morganTokens.length) return mf.DEV;
+        const _morganTokens = _.map(morganTokens, (token) => {
+            if (!_.isString(token) || !token.length) return null;
+            let _token = token.trim();
+            if (_token[ 0 ] !== ':') _token = `:${ _token }`;
+            switch (_token) {
+                case mft.CONTENT_LENGTH_FORMAT: return hasArgument(_token) ? _token : addArgument(_token, this.contentLengthDigits);
+                case mft.RESPONSE_TIME:
+                case mft.RESPONSE_TIME_FORMAT: return hasArgument(_token) ? _token : addArgument(_token, this.responseTimeDigits);
+                default: return _token;
+            }
+        });
+        return (_.compact(_morganTokens)).join(' ');
+    }
+
     #buildWinstonFormat = (options, additionalFormats = [ ]) => {
         options = options || { };
         const formats = [
@@ -242,22 +285,28 @@ class ZeddemoreLogger {
     }
 
     #initializeMorgan() {
-        function buildContentLengthFormatToken(res) {
-            const contentLength = convertBytes(res.get('content-length'), { digits: 2 });
+        function buildContentLengthFormatToken(res, decimals = DEFAULT_CONTENT_LENGTH_DIGITS) {
+            const contentLength = convertBytes(res.get('content-length'), { decimals });
             return contentLength ? ` - ${ contentLength }` : '';
         }
-        function buildResponseTimeFormatToken(req, res) {
+        function buildDecodedUrl(req) {
+            const url = req.originalUrl || req.url;
+            return decodeURI(url);
+        }
+        function buildResponseTimeFormatToken(req, res, digits = DEFAULT_RESPONSE_TIME_DIGITS) {
             const responseTime = getRequestResponseTime(req, res);
-            return responseTime ? convertMilliseconds(responseTime, { digits: 0 }) : '-';
+            return responseTime ? convertMilliseconds(responseTime, { digits }) : '-';
         }
         function buildStatusColoredToken(res) {
             const statusCode = areHeadersSent(res) ? res.statusCode : null;
             if (!statusCode) return '-';
             return chalkHttpStatuses(statusCode);
         }
-        morgan.token('content-length-format', (req, res) => { return buildContentLengthFormatToken(res); });
-        morgan.token('response-time-format', (req, res) => { return buildResponseTimeFormatToken(req, res); });
-        morgan.token('status-colored', (req, res) => { return buildStatusColoredToken(res); });
+        morgan.token(mft.CONTENT_LENGTH_FORMAT, (req, res, decimals) => { return buildContentLengthFormatToken(res, decimals); });
+        morgan.token(mft.DECODED_URL, (req, res) => { return buildDecodedUrl(req); });
+        morgan.token(mft.RESPONSE_TIME_FORMAT, (req, res, digits) => { return buildResponseTimeFormatToken(req, res, digits); });
+        morgan.token(mft.STATUS_COLORED, (req, res) => { return buildStatusColoredToken(res); });
+        morgan.format(mf.ZEDDEMORE, this.#buildMorganFormat(DEFAULT_MORGAN_FORMAT_TOKENS));
     }
 
     log = (logLevel) => {
@@ -268,7 +317,7 @@ class ZeddemoreLogger {
 
     #logServerInfo = (options, logLevel = wll.INFO) => {
         options = options || { };
-        const showLogLevel = options.hasOwnProperty('showLogLevel') ? options.showLogLevel : true;
+        const showLogLevel = _.isBoolean(options.showLogLevel) ? options.showLogLevel : true;
         const logLevelLabel = chalkLogLevel(this.#logLevel, this.logLevelName.toUpperCase());
         const msgParts = [ `Server is ${ chalk.bold(chalk.yellowBright('⚡live⚡')) }` ];
         if (showLogLevel) msgParts.push(`with log level ${ logLevelLabel }${ this.#forceLogLevel ? ` (${ chalk.italic('forced') })` : '' }`);
@@ -302,7 +351,7 @@ class ZeddemoreLogger {
 
     #logServerRoutesAdded = (options, logLevel = wll.INFO) => {
         options = options || { };
-        const showCategories = options.hasOwnProperty('showCategories') ? options.showCategories : true;
+        const showCategories = _.isBoolean(options.showCategories) ? options.showCategories : true;
         const routes = options.routes || this.apiRoutes || [ ];
         const routesLabel = (routes.length === 1) ? 'route' : 'routes';
         const addedLabel = chalk.green('added');
@@ -316,10 +365,10 @@ class ZeddemoreLogger {
 
     logServerStartup = (options, logLevel = wll.INFO) => {
         options = options || { };
-        const showListening = options.hasOwnProperty('showListening') ? options.showListening : true;
-        const showPackages = options.hasOwnProperty('showPackages') ? options.showPackages : true;
-        const showRoutes = options.hasOwnProperty('showRoutes') ? options.showRoutes : true;
-        const showInfo = options.hasOwnProperty('showInfo') ? options.showInfo : true;
+        const showListening = _.isBoolean(options.showListening) ? options.showListening : true;
+        const showPackages = _.isBoolean(options.showPackages) ? options.showPackages : true;
+        const showRoutes = _.isBoolean(options.showRoutes) ? options.showRoutes : true;
+        const showInfo = _.isBoolean(options.showInfo) ? options.showInfo : true;
         if (showListening) this.#logServerListening(options, logLevel);
         if (showPackages && options.packages) this.#logServerPackagesInfo(options, options.packages, logLevel);
         if (showRoutes) this.#logServerRoutesAdded(options, logLevel);
@@ -340,8 +389,8 @@ class ZeddemoreLogger {
 
     morganMiddleware = (options) => {
         options = options || { };
-        const disableMorganLogging = options.hasOwnProperty('disableMorganLogging') ? options.disableMorganLogging : this.disableMorganLogging;
-        const morganFormat = options.morganFormat || this.morganFormat;
+        const disableMorganLogging = _.isBoolean(options.disableMorganLogging) ? options.disableMorganLogging : this.disableMorganLogging;
+        const morganFormat = options.morganFormat || this.#buildMorganFormat(DEFAULT_MORGAN_FORMAT_TOKENS);
         const userGetFn = (_.isFunction(options.userGetFn) ? options.userGetFn : null) || this.userGetFn;
         return (req, res, next) => {
             this.#initializeMorgan();
@@ -490,10 +539,10 @@ class ZeddemoreLogger {
         const prefix = logOptions.prefix ? `[${ logOptions.prefix }]` : null;
         const status = chalkHttpStatuses(_response.status);
         const _duration = axiosError.duration || _response.duration;
-        const duration = _duration ? convertMilliseconds(_duration) : '-';
+        const duration = _duration ? convertMilliseconds(_duration, logger.responseTimeDigits) : '-';
         let _contentLength = _headers ? _headers[ rsh.CONTENT_LENGTH ] : null;
         if (!_contentLength) _contentLength = _data ? sizeof(_data) : null;
-        const contentLength = _contentLength ? `- ${ convertBytes(_contentLength) }` : null;
+        const contentLength = _contentLength ? `- ${ convertBytes(_contentLength, logger.contentLengthDigits) }` : null;
         const data = _data ? JSON.stringify(_data) : null;
         const parts = [ prefix, method, path, status, duration, contentLength, data ];
         const message = _.compact(parts).join(' ');
@@ -519,10 +568,10 @@ class ZeddemoreLogger {
         const responseData = (logOptions.response && _.isObject(_data)) ? JSON.stringify(_data) : null;
         const status = chalkHttpStatuses(axiosResponse.status);
         const _duration = axiosResponse.duration;
-        const duration = _duration ? convertMilliseconds(_duration) : '-';
+        const duration = _duration ? convertMilliseconds(_duration, logger.responseTimeDigits) : '-';
         let _contentLength = _headers ? _headers[ rsh.CONTENT_LENGTH ] : null;
         if (!_contentLength) _contentLength = _data ? sizeof(_data) : null;
-        const contentLength = _contentLength ? `- ${ convertBytes(_contentLength) }` : null;
+        const contentLength = _contentLength ? `- ${ convertBytes(_contentLength, logger.contentLengthDigits) }` : null;
         const parts = [ prefix, method, path, configData, status, responseData, duration, contentLength ];
         const message = _.compact(parts).join(' ');
         logger[ logLevel ](message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zeddemore-logger",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Node.js Express logger using Morgan and Winston for thread and caller info tracking",
   "repository": {
     "type": "git",