sasai-common-utils 1.0.0

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "sasai-common-utils",
+  "version": "1.0.0",
+  "description": "Reusable utility library for common logging and other shared features.",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@elastic/ecs-winston-format": "^1.5.3",
+    "jsonwebtoken": "^9.0.2",
+    "winston": "^3.17.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.15.0",
+    "jest": "^29.7.0"
+  }
+}

package/src/features/axios-logger/axiosLogger.js

@@ -0,0 +1,64 @@
+const { LOG_LEVELS } = require("../logger/constants");
+
+/**
+ * Logs Axios requests.
+ * @param {Object} request - Axios request object.
+ * @param {Object} logger - Logger instance.
+ */
+const logRequest = (request, logger) => {
+    const { method, url, headers, data, params } = request;
+    const logObject = { method, url, headers, body: data, params };
+    logger.log(LOG_LEVELS.INFO, "Axios Request", logObject);
+    return request;
+};
+
+/**
+ * Logs Axios responses.
+ * @param {Object} response - Axios response object.
+ * @param {Object} logger - Logger instance.
+ */
+const logResponse = (response, logger) => {
+    const { status, config, data } = response;
+    const { method, url, headers, data: requestBody } = config;
+    const logObject = { status, method, url, headers, requestBody, responseBody: data };
+    logger.log(LOG_LEVELS.INFO, "Axios Response", logObject);
+    return response;
+};
+
+/**
+ * Logs Axios errors.
+ * @param {Object} error - Axios error object.
+ * @param {Object} logger - Logger instance.
+ */
+const logError = (error, logger) => {
+    const { response, config } = error;
+    const { method, url } = config || {};
+    const logObject = {
+        method,
+        url,
+        status: response?.status,
+        message: error.message,
+        stack: error.stack,
+    };
+    logger.log(LOG_LEVELS.ERROR, "Axios Error", logObject);
+    return Promise.reject(error);
+};
+
+/**
+ * Attaches logging interceptors to an Axios instance.
+ * @param {Object} axiosInstance - Axios instance.
+ * @param {Object} logger - Logger instance.
+ */
+const attachAxiosLogger = (axiosInstance, logger) => {
+    axiosInstance.interceptors.request.use(
+        (request) => logRequest(request, logger),
+        (error) => logError(error, logger)
+    );
+
+    axiosInstance.interceptors.response.use(
+        (response) => logResponse(response, logger),
+        (error) => logError(error, logger)
+    );
+};
+
+module.exports = { attachAxiosLogger };

package/src/features/axios-logger/index.js

@@ -0,0 +1,5 @@
+const { attachAxiosLogger } = require("./axiosLogger");
+
+module.exports = {
+    attachAxiosLogger,
+};

package/src/features/express-logger/expressLogger.js

@@ -0,0 +1,45 @@
+const { LOG_LEVELS } = require("../logger/constants");
+
+/**
+ * Logs incoming HTTP requests.
+ * @param {Object} request - Express request object.
+ * @param {Object} logger - Logger instance.
+ */
+const logRequest = (request, logger) => {
+    const { method, url, headers, body, query, params } = request;
+    const logObject = { method, url, headers, body, query, params };
+    logger.log(LOG_LEVELS.INFO, "Incoming Request", logObject);
+};
+
+/**
+ * Logs outgoing HTTP responses.
+ * @param {Object} response - Express response object.
+ * @param {Object} logger - Logger instance.
+ */
+const logResponse = (response, logger) => {
+    const originalJson = response.json;
+
+    // Override res.json to intercept response data
+    response.json = function (data) {
+        const { statusCode } = response;
+        const { method, url, headers, body } = response.req;
+        const logObject = { statusCode, method, url, headers, body, data };
+        logger.log(LOG_LEVELS.INFO, "Outgoing Response", logObject);
+
+        // Call the original res.json
+        return originalJson.call(this, data);
+    };
+};
+
+/**
+ * Express middleware for logging requests and responses.
+ * @param {Object} logger - Logger instance.
+ * @returns {Function} Middleware function.
+ */
+const logExpressApis = (logger) => (request, response, next) => {
+    logRequest(request, logger);
+    logResponse(response, logger);
+    next();
+};
+
+module.exports = { logExpressApis };

package/src/features/express-logger/index.js

@@ -0,0 +1,5 @@
+const { logExpressApis } = require("./expressLogger");
+
+module.exports = {
+    logExpressApis,
+};

package/src/features/logger/config.js

@@ -0,0 +1,6 @@
+const defaultConfig = {
+    logLevel: "info",
+    transports: [],
+};
+
+module.exports = { defaultConfig };

package/src/features/logger/constants.js

@@ -0,0 +1,7 @@
+const LOG_LEVELS = {
+    ERROR: "error",
+    INFO: "info",
+    DEBUG: "debug",
+};
+
+module.exports = { LOG_LEVELS };

package/src/features/logger/index.js

@@ -0,0 +1,9 @@
+const createLogger = require("./logger");
+const { redactInformation } = require("./redact");
+const { LOG_LEVELS } = require("./constants");
+
+module.exports = {
+    createLogger,
+    redactInformation,
+    LOG_LEVELS,
+};

package/src/features/logger/logger.js

@@ -0,0 +1,25 @@
+const winston = require("winston");
+const { redactInformation } = require("./redact");
+const { ecsStringify } = require("@elastic/ecs-winston-format");
+
+/**
+ * Initializes the logger with the given configuration.
+ * @param {Object} options - Logger configuration options.
+ */
+const createLogger = (options = {}) => {
+    const logFormat = winston.format.combine(
+        winston.format(info => redactInformation(info))(),
+        winston.format.errors({ stack: true }),
+        winston.format.json(),
+        ecsStringify()
+    );
+
+    return winston.createLogger({
+        level: options?.logLevel || "info",
+        format: logFormat,
+        defaultMeta: { service: options?.serviceName || "sasai-service" },
+        transports: options.transports || [new winston.transports.Console()],
+    });
+};
+
+module.exports = createLogger;

package/src/features/logger/redact.js

@@ -0,0 +1,13 @@
+/**
+ * Redacts sensitive information from log entries.
+ * @param {Object} info - Log information.
+ * @returns {Object} The redacted log entry.
+ */
+const redactInformation = (info) => {
+    if (info?.password) {
+        info.password = "[REDACTED]";
+    }
+    return info;
+};
+
+module.exports = { redactInformation };

package/src/features/logger/utils.js

@@ -0,0 +1,7 @@
+/**
+ * Formats a timestamp for logging.
+ * @returns {string} The formatted timestamp.
+ */
+const formatTimestamp = () => new Date().toISOString();
+
+module.exports = { formatTimestamp };

package/src/index.js

@@ -0,0 +1,15 @@
+// Logger Feature
+const { createLogger, LOG_LEVELS } = require("./features/logger");
+
+// Express Logger Feature
+const { logExpressApis } = require("./features/express-logger");
+
+// Axios Logger Feature
+const { attachAxiosLogger } = require("./features/axios-logger");
+
+module.exports = {
+    createLogger,
+    LOG_LEVELS,
+    logExpressApis,
+    attachAxiosLogger,
+};