micronodelib 1.0.1 → 1.0.2

package/README.md

@@ -0,0 +1,41 @@
+# Micronodelib
+
+Common core for NodeJs project.
+
+## Features
+
+- Request context injected
+- Http request log
+- Standard logging format
+
+## Install
+
+```shell
+npm install micronodelib
+
+# Or
+
+yarn add micronodelib
+```
+
+## Usage
+
+```shell
+import express, {Application} from "express";
+import {Logger, httpContextMiddleware, requestLogMiddleware} from "micronodelib";
+const app: Application = express();
+
+# Enable request context
+app.use(httpContextMiddleware);
+
+# Enable http request log
+app.use(requestLogMiddleware({
+  # Ignore request log for specific routes
+  ignoreRoutes: ["/actuator/health"]
+}));
+
+app.listen(3000, () => {
+  # Using standard log level: debug, info, warn, error
+  Logger.info('App started');
+})
+```

package/dist/logging/logger.js

@@ -35,17 +35,16 @@ const util = __importStar(require("util"));
 // and used to log messages.
 const winstonLogger = winston_1.default.createLogger({
     format: (0, configuration_1.formatter)(info => {
-        info.level = info.level.toUpperCase();
-        info.msg = info.message;
-        info.ts = Date.parse(info.timestamp) / 1000;
-        info.request_meta = {
-            request_id: (0, express_http_context_1.get)('reqId')
+        return {
+            level: info.level.toUpperCase(),
+            msg: info.message,
+            message: null,
+            ts: Date.parse(info.timestamp) / 1000,
+            request_meta: {
+                request_id: (0, express_http_context_1.get)('reqId'),
+            },
+            stacktrace: info.stack
         };
-        info.stacktrace = info.stack;
-        info.message = "";
-        delete info.timestamp;
-        delete info.stack;
-        return info;
     }),
     transports: configuration_1.transports,
 });

package/dist/logging/middleware.d.ts

@@ -2,4 +2,4 @@ import { Handler } from "express";
 export interface RequestLogOptions {
     ignoreRoutes: string[];
 }
-export declare const requestLogMiddleware: (opt: RequestLogOptions) => Handler;
+export declare const requestLogMiddleware: (opt?: RequestLogOptions | undefined) => Handler;

package/dist/logging/middleware.js

@@ -13,29 +13,29 @@ const requestLogMiddleware = function (opt) {
         msg: 'finish router',
         format: (0, configuration_1.formatter)(info => {
             const req = info.meta.req;
-            info.level = info.level.toUpperCase();
-            info.msg = info.message;
-            info.ts = Date.parse(info.timestamp) / 1000;
-            info.request_meta = {
-                status: info.meta.res.statusCode,
-                execution_time: info.meta.responseTime,
-                request_pattern: url_1.default.parse(req.url).pathname,
-                request_path: url_1.default.parse(req.url).pathname,
-                request_method: req.method,
-                query: new URLSearchParams(req.query).toString(),
-                url: req.url,
-                request_id: req.headers['x-request-id'],
-                client_ip: req.headers['x-forwarded-for'] || (req.connection ? req.connection.remoteAddress : null),
-                user_agent: req.headers['user-agent']
+            return {
+                level: info.level.toUpperCase(),
+                msg: info.message,
+                message: null,
+                ts: Date.parse(info.timestamp) / 1000,
+                request_meta: {
+                    status: info.meta.res.statusCode,
+                    execution_time: info.meta.responseTime,
+                    request_pattern: url_1.default.parse(req.url).pathname,
+                    request_path: url_1.default.parse(req.url).pathname,
+                    request_method: req.method,
+                    query: new URLSearchParams(req.query).toString(),
+                    url: req.url,
+                    device_id: req.headers['device-id'],
+                    request_id: req.headers['x-request-id'],
+                    client_ip: req.headers['x-forwarded-for'] || (req.connection ? req.connection.remoteAddress : null),
+                    user_agent: req.headers['user-agent']
+                }
             };
-            info.message = "";
-            delete info.timestamp;
-            delete info.meta;
-            return info;
         }),
         transports: configuration_1.transports,
         ignoreRoute: function (req, res) {
-            return opt.ignoreRoutes.length > 0 && opt.ignoreRoutes.indexOf(req.url) >= 0;
+            return opt !== undefined && opt.ignoreRoutes.length > 0 && opt.ignoreRoutes.indexOf(req.url) >= 0;
         }
     });
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "micronodelib",
-  "version": "1.0.1",
-  "description": "Common package for NodeJs application",
+  "version": "1.0.2",
+  "description": "Common core for NodeJs project",
   "author": "Thang Bui",
   "license": "MIT",
   "main": "dist/index.js",