zeddemore-logger 1.2.3 → 1.2.5

package/lib/zeddemore-logger.js

@@ -20,8 +20,10 @@ const { morganFormats: mf, morganFormatTokens: mft, httpMethods: http, httpReque
     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';
 
@@ -67,6 +69,7 @@ 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 = _.isBoolean(options.disableApiCallLogging) ? options.disableApiCallLogging : false;
@@ -80,6 +83,7 @@ class ZeddemoreLogger {
         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 = _.isBoolean(options.suppressNonMutatingRequestApiCallLogging) ? options.suppressNonMutatingRequestApiCallLogging : false;
         this.suppressSuccessfulRequestApiCallLogging = _.isBoolean(options.suppressSuccessfulRequestApiCallLogging) ? options.suppressSuccessfulRequestApiCallLogging : false;
@@ -142,17 +146,15 @@ class ZeddemoreLogger {
             const closeBracketIndex = token.indexOf(']');
             return ((openBracketIndex > -1) && (closeBracketIndex > -1) && (closeBracketIndex > (openBracketIndex + 1)));
         }
-        const DEFAULT_CONTENT_LENGTH_FORMAT_DIGITS = 0;
-        const DEFAULT_RESPONSE_TIME_DIGITS = 2;
         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, DEFAULT_CONTENT_LENGTH_FORMAT_DIGITS);
+                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, DEFAULT_RESPONSE_TIME_DIGITS);
+                case mft.RESPONSE_TIME_FORMAT: return hasArgument(_token) ? _token : addArgument(_token, this.responseTimeDigits);
                 default: return _token;
             }
         });
@@ -283,15 +285,15 @@ class ZeddemoreLogger {
     }
 
     #initializeMorgan() {
-        function buildContentLengthFormatToken(res, digits = 2) {
-            const contentLength = convertBytes(res.get('content-length'), { digits });
+        function buildContentLengthFormatToken(res, decimals = DEFAULT_CONTENT_LENGTH_DIGITS) {
+            const contentLength = convertBytes(res.get('content-length'), { decimals });
             return contentLength ? ` - ${ contentLength }` : '';
         }
         function buildDecodedUrl(req) {
             const url = req.originalUrl || req.url;
             return decodeURI(url);
         }
-        function buildResponseTimeFormatToken(req, res, digits = 0) {
+        function buildResponseTimeFormatToken(req, res, digits = DEFAULT_RESPONSE_TIME_DIGITS) {
             const responseTime = getRequestResponseTime(req, res);
             return responseTime ? convertMilliseconds(responseTime, { digits }) : '-';
         }
@@ -300,7 +302,7 @@ class ZeddemoreLogger {
             if (!statusCode) return '-';
             return chalkHttpStatuses(statusCode);
         }
-        morgan.token(mft.CONTENT_LENGTH_FORMAT, (req, res, digits) => { return buildContentLengthFormatToken(res, digits); });
+        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); });
@@ -537,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(' ');
@@ -566,10 +568,11 @@ 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 contentLengthDigits = logOptions.contentLengthDigits || logger.contentLengthDigits || DEFAULT_CONTENT_LENGTH_DIGITS;
+        const contentLength = _contentLength ? `- ${ convertBytes(_contentLength, contentLengthDigits) }` : null;
         const parts = [ prefix, method, path, configData, status, responseData, duration, contentLength ];
         const message = _.compact(parts).join(' ');
         logger[ logLevel ](message);
@@ -578,6 +581,7 @@ class ZeddemoreLogger {
 }
 
 module.exports = {
+    enums,
     log: ZeddemoreLogger.getLogger,
     winstonLogLevelIdToName,
     writeAxiosErrorLog: ZeddemoreLogger.writeAxiosErrorLog,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zeddemore-logger",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Node.js Express logger using Morgan and Winston for thread and caller info tracking",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "lodash": "^4.17.21",
-    "morgan": "^1.10.0",
+    "morgan": "^1.10.1",
     "object-sizeof": "^2.6.5",
     "uuid": "^10.0.0",
     "winston": "^3.17.0"