infront-logger 1.1.0 → 1.1.2

package/README.MD

@@ -13,7 +13,7 @@ The logger supports both writhing to file and to console.
 	let logger = new BaseLogger("component1", options);  
 	logger.log("this is a test message");
 
-### HttpLogger
+### HttpLogger (Express Logger)
     const {HttpLogger} = require('infront-logger');
 
     const responseInterceptor = (req, res, next) => {
@@ -103,6 +103,7 @@ The logger supports both writhing to file and to console.
     app.use(responseInterceptor);
 
 
+### FastifyLogger
 
 
 ### MongooseLoggerPlugin
@@ -132,6 +133,14 @@ Make sure to use before defining schemas;
 - success(req, res, body)
 - error(err)
 
+### FastifyLogger (extends BaseLogger)
+#### Methods
+- request(req)
+- response(res)
+- body(data)
+- success(req, res, body)
+- error(err)
+
 ## options
 
 - dirname - The directory in which the logs will be created (default: "logs")

package/dist/index.es.js

@@ -9,7 +9,7 @@ const colors = {
   debug: "white"
 };
 addColors(colors);
-const OPTIONS = {
+const OPTIONS$1 = {
   dirname: "logs",
   levels: {
     error: 0,
@@ -101,7 +101,7 @@ function createTransport(options) {
 }
 class Logger {
   constructor(options = {}) {
-    this.options = { ...OPTIONS, ...options };
+    this.options = { ...OPTIONS$1, ...options };
     if (!this.options.filename.includes("."))
       this.options.filename += ".log";
     if (!this.options.errorFilename.includes("."))
@@ -151,7 +151,7 @@ const redact$2 = (data, ...sensitiveKeysList) => {
     }
     const redactedData = {};
     for (const key in data) {
-      if (data == null ? void 0 : data.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(data, key)) {
         if (sensitiveKeysList.includes(key)) {
           redactedData[key] = "*****";
         } else {
@@ -241,6 +241,7 @@ function stats() {
 }
 class BaseLogger {
   constructor(component, options) {
+    this.options = options;
     this.logger = new Logger(options).logger.child({ component });
     this.ctx = {};
     this.startTime = Date.now();
@@ -391,10 +392,13 @@ const ops = [
   "aggregate",
   "save"
 ];
-const MAX_RESULT_BYTES = 100 * 1024;
+const OPTIONS = {
+  maxResBytes: 100 * 1024,
+  logRes: true
+};
 class MongooseLogger extends BaseLogger {
   constructor(options = {}) {
-    super("database", options);
+    super("database", { ...OPTIONS, ...options });
   }
   operation(o) {
     this.ctx.operation = o;
@@ -421,12 +425,14 @@ class MongooseLogger extends BaseLogger {
       this.ctx.resultSizeBytes = JSON.stringify(res).length;
     } catch (err) {
     }
+    if (!this.options.logRes)
+      return this;
     if (Array.isArray(res)) {
       this.ctx.documentCount = res.length;
-    } else if (this.ctx.resultSizeBytes < MAX_RESULT_BYTES) {
+    } else if (this.ctx.resultSizeBytes < this.options.maxResBytes) {
       this.ctx.result = res;
     } else {
-      this.ctx.result = `Result too long (more then ${MAX_RESULT_BYTES} bytes)`;
+      this.ctx.result = `Result too long (more then ${this.options.maxResBytes} bytes)`;
     }
     return this;
   }
@@ -465,10 +471,6 @@ class FastifyLogger extends BaseLogger {
   getResponseHeaders(res) {
     return res.headers;
   }
-  getRequestSocketRemoteAddress(req) {
-    var _a;
-    return (_a = req.socket) == null ? void 0 : _a.remoteAddress;
-  }
   getRequestUserId(req) {
     var _a;
     return (_a = req["user"]) == null ? void 0 : _a.id;
@@ -477,7 +479,7 @@ class FastifyLogger extends BaseLogger {
     return res.statusCode;
   }
   getRequestQuery(req) {
-    return { ...req.query };
+    return req.query;
   }
   getRequestParams(req) {
     return req.params;
@@ -499,7 +501,7 @@ class FastifyLogger extends BaseLogger {
     return url.origin;
   }
   getRequestHeaders(req) {
-    return req.headers;
+    return req.headers || {};
   }
   request(req) {
     this.session(this.getRequestSessionId(req));
@@ -515,7 +517,6 @@ class FastifyLogger extends BaseLogger {
     return this;
   }
   _prepare() {
-    var _a;
     const req = this.req;
     const res = this.res;
     const body = this.data;
@@ -528,7 +529,7 @@ class FastifyLogger extends BaseLogger {
       body: redact(this.getRequestBody(req), "password"),
       params: this.getRequestParams(req),
       query: redact(this.getRequestQuery(req), "password"),
-      clientIP: ((_a = this.getRequestHeaders(req)["x-forwarded-for"]) == null ? void 0 : _a.split(",")[0]) ?? this.getRequestSocketRemoteAddress(req)
+      clientIP: this.getClientIp(req)
     };
     this.ctx.response = {
       headers: omit(this.getResponseHeaders(res), "set-cookie", "x-powered-by"),
@@ -541,7 +542,7 @@ class FastifyLogger extends BaseLogger {
   }
   _message(msg) {
     var _a;
-    const remoteAddress = this.getRemoteAddress(this.req);
+    const remoteAddress = this.getRemoteAddress();
     const ip = this.ctx.request.clientIP;
     const method = this.ctx.request.method;
     const url = this.ctx.request.url;
@@ -550,9 +551,12 @@ class FastifyLogger extends BaseLogger {
     const responseSize = formatBytes((_a = JSON.stringify(this.data)) == null ? void 0 : _a.length);
     return `${method} ${url} ${statusCode} ${responseTimeMs} ${responseSize} ${ip} ${remoteAddress} ${msg || ""}`;
   }
-  getRemoteAddress(req) {
-    var _a;
-    return ((_a = req == null ? void 0 : req.headers["x-forwarded-for"]) == null ? void 0 : _a.split(",")[0]) ?? (req == null ? void 0 : req.socket.remoteAddress);
+  getClientIp(req) {
+    var _a, _b;
+    return ((_a = this.getRequestHeaders(req)["x-forwarded-for"]) == null ? void 0 : _a.split(",")[0]) ?? ((_b = req == null ? void 0 : req.socket) == null ? void 0 : _b.remoteAddress);
+  }
+  getRemoteAddress() {
+    return this.req.ip || this.req._remoteAddress || void 0;
   }
   success(req, res, body) {
     if (req)

package/dist/index.umd.js

@@ -13,7 +13,7 @@
     debug: "white"
   };
   addColors(colors);
-  const OPTIONS = {
+  const OPTIONS$1 = {
     dirname: "logs",
     levels: {
       error: 0,
@@ -105,7 +105,7 @@
   }
   class Logger {
     constructor(options = {}) {
-      this.options = { ...OPTIONS, ...options };
+      this.options = { ...OPTIONS$1, ...options };
       if (!this.options.filename.includes("."))
         this.options.filename += ".log";
       if (!this.options.errorFilename.includes("."))
@@ -155,7 +155,7 @@
       }
       const redactedData = {};
       for (const key in data) {
-        if (data == null ? void 0 : data.hasOwnProperty(key)) {
+        if (Object.prototype.hasOwnProperty.call(data, key)) {
           if (sensitiveKeysList.includes(key)) {
             redactedData[key] = "*****";
           } else {
@@ -245,6 +245,7 @@
   }
   class BaseLogger {
     constructor(component, options) {
+      this.options = options;
       this.logger = new Logger(options).logger.child({ component });
       this.ctx = {};
       this.startTime = Date.now();
@@ -395,10 +396,13 @@
     "aggregate",
     "save"
   ];
-  const MAX_RESULT_BYTES = 100 * 1024;
+  const OPTIONS = {
+    maxResBytes: 100 * 1024,
+    logRes: true
+  };
   class MongooseLogger extends BaseLogger {
     constructor(options = {}) {
-      super("database", options);
+      super("database", { ...OPTIONS, ...options });
     }
     operation(o) {
       this.ctx.operation = o;
@@ -425,12 +429,14 @@
         this.ctx.resultSizeBytes = JSON.stringify(res).length;
       } catch (err) {
       }
+      if (!this.options.logRes)
+        return this;
       if (Array.isArray(res)) {
         this.ctx.documentCount = res.length;
-      } else if (this.ctx.resultSizeBytes < MAX_RESULT_BYTES) {
+      } else if (this.ctx.resultSizeBytes < this.options.maxResBytes) {
         this.ctx.result = res;
       } else {
-        this.ctx.result = `Result too long (more then ${MAX_RESULT_BYTES} bytes)`;
+        this.ctx.result = `Result too long (more then ${this.options.maxResBytes} bytes)`;
       }
       return this;
     }
@@ -469,10 +475,6 @@
     getResponseHeaders(res) {
       return res.headers;
     }
-    getRequestSocketRemoteAddress(req) {
-      var _a;
-      return (_a = req.socket) == null ? void 0 : _a.remoteAddress;
-    }
     getRequestUserId(req) {
       var _a;
       return (_a = req["user"]) == null ? void 0 : _a.id;
@@ -481,7 +483,7 @@
       return res.statusCode;
     }
     getRequestQuery(req) {
-      return { ...req.query };
+      return req.query;
     }
     getRequestParams(req) {
       return req.params;
@@ -503,7 +505,7 @@
       return url.origin;
     }
     getRequestHeaders(req) {
-      return req.headers;
+      return req.headers || {};
     }
     request(req) {
       this.session(this.getRequestSessionId(req));
@@ -519,7 +521,6 @@
       return this;
     }
     _prepare() {
-      var _a;
       const req = this.req;
       const res = this.res;
       const body = this.data;
@@ -532,7 +533,7 @@
         body: redact(this.getRequestBody(req), "password"),
         params: this.getRequestParams(req),
         query: redact(this.getRequestQuery(req), "password"),
-        clientIP: ((_a = this.getRequestHeaders(req)["x-forwarded-for"]) == null ? void 0 : _a.split(",")[0]) ?? this.getRequestSocketRemoteAddress(req)
+        clientIP: this.getClientIp(req)
       };
       this.ctx.response = {
         headers: omit(this.getResponseHeaders(res), "set-cookie", "x-powered-by"),
@@ -545,7 +546,7 @@
     }
     _message(msg) {
       var _a;
-      const remoteAddress = this.getRemoteAddress(this.req);
+      const remoteAddress = this.getRemoteAddress();
       const ip = this.ctx.request.clientIP;
       const method = this.ctx.request.method;
       const url = this.ctx.request.url;
@@ -554,9 +555,12 @@
       const responseSize = formatBytes((_a = JSON.stringify(this.data)) == null ? void 0 : _a.length);
       return `${method} ${url} ${statusCode} ${responseTimeMs} ${responseSize} ${ip} ${remoteAddress} ${msg || ""}`;
     }
-    getRemoteAddress(req) {
-      var _a;
-      return ((_a = req == null ? void 0 : req.headers["x-forwarded-for"]) == null ? void 0 : _a.split(",")[0]) ?? (req == null ? void 0 : req.socket.remoteAddress);
+    getClientIp(req) {
+      var _a, _b;
+      return ((_a = this.getRequestHeaders(req)["x-forwarded-for"]) == null ? void 0 : _a.split(",")[0]) ?? ((_b = req == null ? void 0 : req.socket) == null ? void 0 : _b.remoteAddress);
+    }
+    getRemoteAddress() {
+      return this.req.ip || this.req._remoteAddress || void 0;
     }
     success(req, res, body) {
       if (req)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "infront-logger",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "",
   "files": [
     "dist"
@@ -26,7 +26,7 @@
   "dependencies": {
     "winston": "^3.11.0",
     "winston-daily-rotate-file": "^4.7.1",
-    "infront-utils": "^1.0.0"
+    "infront-utils": "^1.0.1"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",