sasai-common-utils 1.0.1 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sasai-common-utils",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Reusable utility library for common logging and other shared features.",
   "main": "src/index.js",
   "scripts": {

package/src/features/logger/index.js

@@ -1,102 +1,9 @@
-const winston = require("winston");
-let { LOG_LEVELS, DEBUG_MODES } = require("../constants/logConstants");
-const { HTTP_STATUS_CODES } = require("../constants/apiResponseConstants");
-const apmTracing = require("../../apmTracing");
-const { extractDeviceInfoFromHeaders } = require("../utils/utils");
-const envConfig = require("../config");
-const { ecsFormat, ecsFields, ecsStringify } = require("@elastic/ecs-winston-format");
+const createLogger = require("./logger");
 const { redactInformation } = require("./redact");
-const jwt = require("jsonwebtoken");
-
-const logFormat = winston.format.combine(
-    winston.format(info => redactInformation(info))(), // Prevent logging sensitive data
-    winston.format.errors({ stack: true }),
-    winston.format.json(),
-    winston.format.printf(info => {
-        info.time = info.timestamp;
-        delete info.timestamp;
-        info.LEVEL = info.level.toUpperCase();
-        delete info.level;
-        info.trace = apmTracing?.currentTraceIds?.["trace.id"] ?? "";
-        info.span = apmTracing?.currentTraceIds?.["transaction.id"] ?? "";
-        return JSON.stringify(info, null, 4);
-    }),
-    ecsStringify()
-);
-
-let silentLogs = false;
-let transports = [];
-
-if (envConfig?.debugging?.debugMode === DEBUG_MODES.DISABLE) {
-    silentLogs = true;
-}
-
-if (envConfig?.debugging?.debugMode === DEBUG_MODES.FILE) {
-    transports.push(new winston.transports.File({ filename: "app.log" }));
-} else if (envConfig?.debugging?.debugMode === DEBUG_MODES.CONSOLE) {
-    transports.push(new winston.transports.Console());
-} else {
-    transports.push(new winston.transports.File({ filename: "app.log" }));
-    transports.push(new winston.transports.Console());
-}
-
-// Default logger instance
-const defaultLogger = winston.createLogger({
-    format: logFormat,
-    defaultMeta: { app: envConfig?.serviceName },
-    transports,
-    silent: silentLogs,
-    level: envConfig.logLevel,
-});
-
-const logInfo = (message, data = {}) => {
-    data.info = message;
-    data.path = data?.url ?? "";
-    const tokenData = jwt.decode(data?.headers?.Authorization?.split(" ")[1], { complete: true })?.payload;
-    data.tokenDetails = {
-        "customerId": tokenData?.customerId ?? "",
-        "mid": tokenData?.mid ?? "",
-        "tenantId": tokenData?.tenantId ?? ""
-    };
-    data.queryParams = data?.query ?? {};
-    if (data?.query) delete data?.query;
-    data.requestBody = data?.body ?? {};
-    if (data?.body) delete data.body;
-    data.response = data?.data ?? {};
-    if (data?.data) delete data?.data;
-    defaultLogger.info(data);
-};
-
-const logError = (data = {}, req = {}) => {
-    data = { ...data };
-    const errorResponse = data?.error?.response;
-    let requestId = req?.headers?.requestid ?? "";
-    let userInfo = req?.user ?? {};
-    data.message = {
-        step: data?.step,
-        error: data?.error?.message,
-        stack: data?.error?.stack,
-        statusCode: errorResponse?.status ?? HTTP_STATUS_CODES.BAD_REQUEST,
-        path: errorResponse?.config?.url ?? req?.originalUrl,
-        headers: errorResponse?.config?.headers ?? {},
-        requestBody: errorResponse?.config?.body ?? req?.body,
-        method: errorResponse?.config?.method ?? req?.method,
-        response: errorResponse?.data ?? {}
-    };
-    if (data?.step) delete data?.step;
-    if (data?.error) delete data.error;
-    data["level"] = LOG_LEVELS.ERROR;
-    defaultLogger.error(data);
-};
-
-const logDebug = (message, data = {}) => {
-    data.message = message;
-    defaultLogger.debug(data);
-};
+const { LOG_LEVELS } = require("./constants");
 
 module.exports = {
-    logInfo,
-    logError,
-    logDebug,
-    logger: defaultLogger
+    createLogger,
+    redactInformation,
+    LOG_LEVELS,
 };

package/src/index.js

@@ -1,15 +1,102 @@
-// Logger Feature
-const { createLogger, LOG_LEVELS } = require("./features/logger");
+const winston = require("winston");
+let { LOG_LEVELS, DEBUG_MODES } = require("../constants/logConstants");
+const { HTTP_STATUS_CODES } = require("../constants/apiResponseConstants");
+const apmTracing = require("../../apmTracing");
+const { extractDeviceInfoFromHeaders } = require("../utils/utils");
+const envConfig = require("../config");
+const { ecsFormat, ecsFields, ecsStringify } = require("@elastic/ecs-winston-format");
+const { redactInformation } = require("./redact");
+const jwt = require("jsonwebtoken");
 
-// Express Logger Feature
-const { logExpressApis } = require("./features/express-logger");
+const logFormat = winston.format.combine(
+    winston.format(info => redactInformation(info))(), // Prevent logging sensitive data
+    winston.format.errors({ stack: true }),
+    winston.format.json(),
+    winston.format.printf(info => {
+        info.time = info.timestamp;
+        delete info.timestamp;
+        info.LEVEL = info.level.toUpperCase();
+        delete info.level;
+        info.trace = apmTracing?.currentTraceIds?.["trace.id"] ?? "";
+        info.span = apmTracing?.currentTraceIds?.["transaction.id"] ?? "";
+        return JSON.stringify(info, null, 4);
+    }),
+    ecsStringify()
+);
 
-// Axios Logger Feature
-const { attachAxiosLogger } = require("./features/axios-logger");
+let silentLogs = false;
+let transports = [];
+
+if (envConfig?.debugging?.debugMode === DEBUG_MODES.DISABLE) {
+    silentLogs = true;
+}
+
+if (envConfig?.debugging?.debugMode === DEBUG_MODES.FILE) {
+    transports.push(new winston.transports.File({ filename: "app.log" }));
+} else if (envConfig?.debugging?.debugMode === DEBUG_MODES.CONSOLE) {
+    transports.push(new winston.transports.Console());
+} else {
+    transports.push(new winston.transports.File({ filename: "app.log" }));
+    transports.push(new winston.transports.Console());
+}
+
+// Default logger instance
+const defaultLogger = winston.createLogger({
+    format: logFormat,
+    defaultMeta: { app: envConfig?.serviceName },
+    transports,
+    silent: silentLogs,
+    level: envConfig.logLevel,
+});
+
+const logInfo = (message, data = {}) => {
+    data.info = message;
+    data.path = data?.url ?? "";
+    const tokenData = jwt.decode(data?.headers?.Authorization?.split(" ")[1], { complete: true })?.payload;
+    data.tokenDetails = {
+        "customerId": tokenData?.customerId ?? "",
+        "mid": tokenData?.mid ?? "",
+        "tenantId": tokenData?.tenantId ?? ""
+    };
+    data.queryParams = data?.query ?? {};
+    if (data?.query) delete data?.query;
+    data.requestBody = data?.body ?? {};
+    if (data?.body) delete data.body;
+    data.response = data?.data ?? {};
+    if (data?.data) delete data?.data;
+    defaultLogger.info(data);
+};
+
+const logError = (data = {}, req = {}) => {
+    data = { ...data };
+    const errorResponse = data?.error?.response;
+    let requestId = req?.headers?.requestid ?? "";
+    let userInfo = req?.user ?? {};
+    data.message = {
+        step: data?.step,
+        error: data?.error?.message,
+        stack: data?.error?.stack,
+        statusCode: errorResponse?.status ?? HTTP_STATUS_CODES.BAD_REQUEST,
+        path: errorResponse?.config?.url ?? req?.originalUrl,
+        headers: errorResponse?.config?.headers ?? {},
+        requestBody: errorResponse?.config?.body ?? req?.body,
+        method: errorResponse?.config?.method ?? req?.method,
+        response: errorResponse?.data ?? {}
+    };
+    if (data?.step) delete data?.step;
+    if (data?.error) delete data.error;
+    data["level"] = LOG_LEVELS.ERROR;
+    defaultLogger.error(data);
+};
+
+const logDebug = (message, data = {}) => {
+    data.message = message;
+    defaultLogger.debug(data);
+};
 
 module.exports = {
-    createLogger,
-    LOG_LEVELS,
-    logExpressApis,
-    attachAxiosLogger,
+    logInfo,
+    logError,
+    logDebug,
+    logger: defaultLogger
 };