sm-utility 1.2.0 → 1.3.1

package/logger/index.js

@@ -12,6 +12,7 @@ exports.logger = exports.logError = exports.loggerMiddleware = void 0;
 var process_1 = require("process");
 var winston_1 = __importDefault(require("winston"));
 var express_winston_1 = __importDefault(require("express-winston"));
+var ecs_winston_format_1 = __importDefault(require("@elastic/ecs-winston-format"));
 var configs;
 try {
     configs = require(process_1.cwd() + "/logger.config");
@@ -19,15 +20,6 @@ try {
 catch (_a) {
     throw Error('Logger configs could not be found on app root\'s directory.');
 }
-function formatReqResLog(info) {
-    // in case the info itself is not from a request/response pair
-    if (!info.meta || (info === null || info === void 0 ? void 0 : info.meta.req)) {
-        return JSON.stringify(info);
-    }
-    var level = info.level, _a = info.meta, req = _a.req, res = _a.res, responseTime = _a.responseTime;
-    var logData = Object.assign({}, { req: req, res: res, responseTime: responseTime + "ms" });
-    return level + " - [" + req.method + "] " + req.url + ": " + JSON.stringify(logData);
-}
 function filterRequestHeaders(confidentialHeaders) {
     if (confidentialHeaders === void 0) { confidentialHeaders = []; }
     return function (req, propName) {
@@ -63,34 +55,40 @@ function getSplitedRouteParts(route) {
     });
     return filteredParts;
 }
+function getTransports() {
+    var transports = [];
+    if (configs.console) {
+        transports.push(new winston_1.default.transports.Console(configs.console));
+    }
+    if (configs.file) {
+        transports.push(new winston_1.default.transports.File(configs.file));
+    }
+    return transports;
+}
 function createLoggerMiddleware() {
     var _a, _b;
     (_a = express_winston_1.default.requestWhitelist).push.apply(_a, __spreadArray(["body"], configs.requestWhitelist || []));
     (_b = express_winston_1.default.responseWhitelist).push.apply(_b, __spreadArray(["body"], configs.responseWhitelist || []));
     return express_winston_1.default.logger({
         statusLevels: true,
-        transports: [
-            new winston_1.default.transports.Console(configs.console),
-        ],
+        transports: getTransports(),
         requestFilter: filterRequestHeaders(configs.confidentialHeaders || []),
         ignoreRoute: routeFilter,
-        format: winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.printf(formatReqResLog)),
+        format: ecs_winston_format_1.default({ convertReqRes: true })
     });
 }
 function createErrorLoggerMiddleware() {
     return express_winston_1.default.errorLogger({
-        transports: [
-            new winston_1.default.transports.Console(configs.console)
-        ],
+        format: ecs_winston_format_1.default({ convertReqRes: true }),
+        transports: getTransports(),
         requestFilter: filterRequestHeaders(configs.confidentialHeaders || []),
     });
 }
 exports.loggerMiddleware = createLoggerMiddleware();
 exports.logError = createErrorLoggerMiddleware();
 exports.logger = winston_1.default.createLogger({
-    transports: [
-        new winston_1.default.transports.Console(configs.console)
-    ],
+    format: ecs_winston_format_1.default({ convertReqRes: true }),
+    transports: getTransports(),
     exitOnError: false,
 });
 exports.logger.stream = Object.assign(exports.logger.stream, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "index.d.ts",
@@ -28,6 +28,7 @@
     "typescript": "^4.2.4"
   },
   "dependencies": {
+    "@elastic/ecs-winston-format": "^1.3.1",
     "axios": "^0.23.0",
     "express-winston": "^4.1.0",
     "uuid": "^8.3.2",

package/request/index.d.ts

@@ -1,2 +1,2 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
-export declare function createApi(config?: AxiosRequestConfig): AxiosInstance;
+export declare function createApi(axiosConfig?: AxiosRequestConfig): AxiosInstance;

package/request/index.js

@@ -6,50 +6,75 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApi = void 0;
 var axios_1 = __importDefault(require("axios"));
 var uuid_1 = require("uuid");
-function createApi(config) {
-    var axiosApi = axios_1.default.create(config);
+var logger_1 = require("../logger");
+function createApi(axiosConfig) {
+    var axiosApi = axios_1.default.create(axiosConfig);
     axiosApi.interceptors.request.use(function (request) {
-        var data = request.data, params = request.params, method = request.method;
-        var fullUrl = getFullUrlFromConfig(request);
-        request.meta = request.meta || {};
-        request.meta.requestId = uuid_1.v4();
-        request.meta.requestStartedAt = new Date().getTime();
-        logApiInfo(request.meta.requestId, 'Request', method, fullUrl, {
-            data: data,
-            params: params,
-        });
+        if (axiosConfig === null || axiosConfig === void 0 ? void 0 : axiosConfig.logRequests) {
+            var data = request.data, params = request.params, method = request.method;
+            var fullUrl = getFullUrlFromConfig(request);
+            request.meta = request.meta || {};
+            request.meta.requestId = uuid_1.v4();
+            request.meta.requestStartedAt = new Date().getTime();
+            logRequest(request.meta.requestId, method, fullUrl, data, params);
+        }
         return request;
     });
     axiosApi.interceptors.response.use(function (response) {
-        var status = response.status, data = response.data, config = response.config;
-        var method = config.method, meta = config.meta;
-        var fullUrl = getFullUrlFromConfig(config);
-        var responseTime = getResponseTimeFromConfig(config);
-        logApiInfo(meta === null || meta === void 0 ? void 0 : meta.requestId, 'Response', method, fullUrl, {
-            status: status,
-            data: data,
-            responseTime: responseTime,
-        });
+        if (axiosConfig === null || axiosConfig === void 0 ? void 0 : axiosConfig.logRequests) {
+            var status_1 = response.status, data = response.data, config = response.config;
+            var method = config.method, meta = config.meta;
+            var fullUrl = getFullUrlFromConfig(config);
+            var responseTime = getResponseTimeFromConfig(config);
+            logResponse(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, data, status_1, responseTime);
+        }
         return response;
     }, function (error) {
-        var config = error.config, message = error.message, response = error.response;
-        var method = config.method, meta = config.meta;
-        var fullUrl = getFullUrlFromConfig(config);
-        var responseTime = getResponseTimeFromConfig(config);
-        logApiInfo(meta === null || meta === void 0 ? void 0 : meta.requestId, 'Error', method, fullUrl, {
-            status: response === null || response === void 0 ? void 0 : response.status,
-            message: message,
-            data: response === null || response === void 0 ? void 0 : response.data,
-            responseTime: responseTime,
-        });
+        if (axiosConfig === null || axiosConfig === void 0 ? void 0 : axiosConfig.logRequests) {
+            var config = error.config, message = error.message, response = error.response;
+            var method = config.method, meta = config.meta;
+            var fullUrl = getFullUrlFromConfig(config);
+            logError(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message);
+        }
         throw error;
     });
     return axiosApi;
 }
 exports.createApi = createApi;
-function logApiInfo(id, title, method, url, content) {
-    var formattedLog = "(" + title + ") " + id + " - [" + (method === null || method === void 0 ? void 0 : method.toUpperCase()) + "] " + url + ": " + JSON.stringify(content);
-    console.log(formattedLog);
+function logRequest(id, method, url, body, params) {
+    var _a;
+    var request = (_a = {},
+        _a['context-id'] = id,
+        _a.url = url,
+        _a.method = method === null || method === void 0 ? void 0 : method.toUpperCase(),
+        _a.params = params,
+        _a.body = body,
+        _a);
+    logger_1.logger.info('sm-utility/api-request', { request: request });
+}
+function logResponse(id, method, url, body, status, responseTime) {
+    var _a;
+    var response = (_a = {},
+        _a['context-id'] = id,
+        _a.url = url,
+        _a.method = method === null || method === void 0 ? void 0 : method.toUpperCase(),
+        _a.body = body,
+        _a.status = status,
+        _a.responseTime = responseTime,
+        _a);
+    logger_1.logger.info('sm-utility/api-response', { response: response });
+}
+function logError(id, method, url, data, status, message) {
+    var _a;
+    var err = (_a = {},
+        _a['context-id'] = id,
+        _a.url = url,
+        _a.method = method === null || method === void 0 ? void 0 : method.toUpperCase(),
+        _a.data = data,
+        _a.status = status,
+        _a.message = message,
+        _a);
+    logger_1.logger.error('sm-utility/api-error', { err: err });
 }
 function getResponseTimeFromConfig(config) {
     var _a;