sasai-common-utils 1.0.3 → 1.0.5

package/.env

@@ -0,0 +1,4 @@
+LOG_LEVEL=debug
+DEBUG_MODE=console
+SERVICE_NAME=my-service
+API_LOG_MODE=true

package/package.json

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

package/src/config/index.js

@@ -0,0 +1,109 @@
+require("dotenv").config();
+
+const authConfig = {
+	/**
+	 * Postgresql Url
+	 */
+	serviceName: process.env.SERVICE_NAME,
+	nodeEnv: process.env.NODE_ENV,
+	basePath: process.env.ENV_BASE_PATH,
+	dbHost: process.env.DB_HOST,
+	dbUser: process.env.DB_USER,
+	dbPassword: Buffer.from(process.env.DB_PASSWORD ?? "", "base64").toString("utf-8"),
+	dbName: process.env.DB_NAME,
+	dbDialect: process.env.DB_DIALECT,
+	dbPort: process.env.DB_PORT,
+	dbPool: {
+		max: 5,
+		min: 0,
+		acquire: 30000,
+		idle: 10000,
+	},
+	otpByPass: process.env.OTP_BYPASS,
+	cdnBaseUrl: process.env.CDN_BASE_URL,
+	/***Microservices URLs**/
+	userServiceUrl: process.env.USER_SERVICE_URL,
+	otpServiceUrl: process.env.OTP_SERVICE_URL,
+	configServiceUrl: process.env.CONFIG_SERVICE_URL,
+	catalogServiceUrl: process.env.CATALOG_SERVICE_URL,
+	paymentServiceUrl: process.env.PAYMENT_SERVICE_URL,
+	integratorServiceUrl: process.env.INTEGRATOR_SERVICE_URL,
+	vaultServiceUrl: process.env.VAULT_SERVICE_URL,
+	activityServiceUrl: process.env.ACTIVITY_SERVICE_URL,
+	linksServiceUrl: process.env.LINKS_SERVICE_URL,
+	moneyTransferServiceUrl: process.env.MONEY_TRANSFER_SERVICE_URL,
+	notificationServiceUrl: process.env.NOTIFY_SERVICE_URL,
+
+	/***Social URLs**/
+	social: {
+		googleUserInfoUrl: process.env.GOOGLE_USER_INFO_URL,
+		facebookUserInfoUrl: process.env.FACEBOOK_USER_INFO_URL,
+	},
+
+	/***Azure Config**/
+	azure: {
+		accountName: process.env.AZURE_ACCOUNT_NAME,
+		accountAccessKey: Buffer.from(process.env.AZURE_ACCOUNT_ACCESS_KEY ?? "", "base64").toString("utf-8"),
+		profileDocStorage: process.env.AZURE_PROFILE_DOC_STORAGE,
+		storageContainerName: process.env.AZURE_STORAGE_CONTAINER_NAME,
+		storageUrl: process.env.AZURE_STORAGE_URL,
+		sasTokenExpiryTime: process.env.AZURE_SAS_TOKEN_EXPIRY_TIME,
+	},
+
+	redis: {
+		url: process.env.REDIS_DB_URL,
+		user: process.env.REDIS_DB_USER,
+		password: Buffer.from(process.env.REDIS_DB_PASS ?? "", "base64").toString("utf-8"),
+		name: process.env.REDIS_DB_NAME,
+		tls: process.env.REDIS_DB_TLS_URI_PREFIX,
+	},
+	/***MongoDB Config */
+	mongodb: {
+		url: process.env.MONGODB_URL,
+	},
+	kafka: {
+		clientId: process.env.KAFKA_CLIENT_ID,
+		brokers: process.env.KAFKA_BROKERS,
+		groupId: process.env.KAFKA_GROUP_ID,
+		userEventTopic: process.env.KAFKA_TOPIC_USER_EVENT,
+		bffEvetTopic: process.env.KAFKA_TOPIC_BFF_EVENT,
+		bffKafkaConcurrency: process.env.KAFKA_CONCURRENCY,
+	},
+	strapiCms: {
+		url: process.env.STRAPI_CMS_URL,
+		authKey: Buffer.from(process.env.STRAPI_CMS_AUTH_KEY ?? "", "base64").toString("utf-8"),
+	},
+	spgPrivateUser: {
+		username: process.env.SPG_PRIVATE_USER_USERNAME,
+		password: Buffer.from(process.env.SPG_PRIVATE_USER_PASSWORD ?? "", "base64").toString("utf-8"),
+		tenantId: process.env.SPG_PRIVATE_USER_TENANT_ID,
+		clientId: process.env.SPG_PRIVATE_USER_CLIENT_ID,
+	},
+	guestUser: {
+		username: process.env.GUEST_USERNAME,
+		password: Buffer.from(process.env.GUEST_PASSWORD ?? "", "base64").toString("utf-8"),
+		tenantId: process.env.GUEST_TENANT_ID,
+		clientId: process.env.GUEST_CLIENT_ID,
+	},
+	jwt: {
+		secretKey: Buffer.from(process.env.JWT_SECRET_KEY ?? "", "base64").toString("utf-8"),
+	},
+	invite: {
+		appLink: process.env.APP_LINK,
+	},
+	userDetails: {
+		expenseCategory: process.env.EXPENSE_CATEGORY,
+		serviceType: process.env.SERVICE_TYPE,
+	},
+	apm: {
+		serverUrl: process.env.APM_SERVER_URL,
+		apmEnabled: process.env.APM_ENABLED,
+	},
+	debugging: {
+		debugMode: process.env.DEBUG_MODE,
+	},
+	apiLog: process.env.API_REQ_RESP_LOG,
+	logLevel: process.env.LOG_LEVEL,
+};
+
+module.exports = authConfig;

package/src/features/logger/constants.js

@@ -1,7 +1,36 @@
 const LOG_LEVELS = {
-    ERROR: "error",
-    INFO: "info",
-    DEBUG: "debug",
+	ERROR: "error",
+	WARN: "warn",
+	INFO: "info",
+	DEBUG: "debug",
 };
 
-module.exports = { LOG_LEVELS };
+const DEBUG_MODES = {
+	FILE: "file",
+	CONSOLE: "console",
+	BOTH: "both",
+	DISABLE: "disable",
+};
+
+const API_LOG_MODE = {
+	TRUE_VALUE: "true",
+};
+
+const API_CALL_TYPE = {
+	REQUEST:"REQUEST",
+	RESPONSE:"RESPONSE"
+}
+
+const HTTP_STATUS_CODES = {
+	SUCCESS: 200,
+	BAD_REQUEST: 400,
+	NOT_FOUND: 404,
+	INTERNAL_SERVER_ERROR: 500,
+	UNAUTHORIZED: 401,
+	FORBIDDEN: 403,
+	BAD_GATEWAY: 502,
+	SERVICE_UNAVAILABLE: 503,
+	GATEWAY_TIMEOUT_ERROR: 504,
+};
+
+module.exports = { LOG_LEVELS, DEBUG_MODES, API_CALL_TYPE, API_LOG_MODE, HTTP_STATUS_CODES };

package/src/features/logger/index.js

@@ -1,9 +1,100 @@
-const createLogger = require("./logger");
+const winston = require("winston");
+const { LOG_LEVELS, DEBUG_MODES, HTTP_STATUS_CODES } = require("./constants");
+// const utils = require("./utils");
+const envConfig = require("../../config");
+const {  ecsStringify } = require("@elastic/ecs-winston-format");
 const { redactInformation } = require("./redact");
-const { LOG_LEVELS } = require("./constants");
+const jwt = require("jsonwebtoken");
+
+const logFormat = winston.format.combine(
+    winston.format((info) => redactInformation(info))(), // Redact 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 = utils.apm?.currentTraceIds?.["trace.id"] || "";
+        // info.span = utils.apm?.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());
+}
+
+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,
-    redactInformation,
-    LOG_LEVELS,
+    logInfo,
+    logError,
+    logDebug,
+    logger: defaultLogger,
+    attachAxiosLogger: require("../axios-logger/attachAxiosLogger"), // Export axios logger here
 };

package/src/features/logger/utils.js

@@ -2,6 +2,17 @@
  * Formats a timestamp for logging.
  * @returns {string} The formatted timestamp.
  */
+const envConfig = require("../../config");
+
 const formatTimestamp = () => new Date().toISOString();
 
-module.exports = { formatTimestamp };
+const apm = require('elastic-apm-node').start({
+    serviceName: envConfig.serviceName,
+    serverUrl: envConfig?.apm?.serverUrl,
+    // Use if APM Server requires a token
+    captureBody: 'all',
+	secretToken: "",
+    active: envConfig?.apm?.apmEnabled === "true" ? true : false,
+})
+
+module.exports = { formatTimestamp, apm };

package/src/index.js

@@ -1,107 +1,35 @@
-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");
-const axios = require("axios");  // Import axios for interceptors
-const { attachAxiosLogger } = require("./axiosLogger");  // Import attachAxiosLogger function
-
-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;
-}
+// Logger features
+const {
+    logInfo,
+    logError,
+    logDebug,
+    logger,
+    attachAxiosLogger,
+} = require("./features/logger");
 
-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());
-}
+// Express logger feature
+const expressLogger = require("./features/express-logger");
 
-// Default logger instance
-const defaultLogger = winston.createLogger({
-    format: logFormat,
-    defaultMeta: { app: envConfig?.serviceName },
-    transports,
-    silent: silentLogs,
-    level: envConfig.logLevel,
-});
+// Axios logger feature
+const axiosLogger = require("./features/axios-logger");
 
-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);
-};
+// Utility functions (if needed in the future)
+const utils = require("./utils");
 
-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);
-};
-
-// Export the logging methods and default logger instance
 module.exports = {
+    // Logger-related exports
     logInfo,
     logError,
     logDebug,
-    logger: defaultLogger,
-    attachAxiosLogger // Export the attachAxiosLogger function
-};
+    logger,
+    attachAxiosLogger,
 
+    // Express-related logging
+    expressLogger,
+
+    // Axios-related logging
+    axiosLogger,
+
+    // Future utilities
+    utils,
+};

package/src/utils/index.js

@@ -0,0 +1,11 @@
+const envConfig = require('./src/config');       // dependency `elastic-apm-node`
+
+const apm = require('elastic-apm-node').start({
+    serviceName: envConfig.serviceName,
+    serverUrl: envConfig?.apm?.serverUrl,
+    // Use if APM Server requires a token
+    captureBody: 'all',
+	secretToken: "",
+    active: envConfig?.apm?.apmEnabled === "true" ? true : false,
+})
+module.exports = apm