@cley_faye/boilerplate 3.10.0 → 3.11.0

package/lib/express/logger.d.ts

@@ -6,6 +6,7 @@ interface ErrorLoggerConfiguration {
     /** @deprecated Use collapseStacktrace */
     collapseNodeModules?: boolean;
     collapseStacktrace?: boolean;
+    extraFilter?: Array<RegExp> | RegExp;
 }
 export declare type ErrorLoggerOptions = ErrorLoggerConfiguration | boolean;
 export interface LoggingData {

package/lib/express/logger.js

@@ -53,7 +53,7 @@ const customRouteFormat = (outputTimestamp) => winston_1.default.format.printf((
         }
     }
     const metaString = JSON.stringify(info.meta);
-    const finalMessage = `${info.message} ${metaString === "{}" ? "" : metaString}`;
+    const finalMessage = `${info.message.toString()} ${metaString === "{}" ? "" : metaString}`;
     return (0, winston_js_1.prefixOutput)(info.level, finalMessage, outputTimestamp);
 });
 /** Return the default value for route logger is it is set as `true` */
@@ -88,8 +88,7 @@ const registerRouteLogger = (app, logOptions) => {
         requestWhitelist: ["body"],
         bodyWhitelist: [],
         expressFormat: false,
-        format: winston_1.default.format.combine(winston_1.default.format.colorize(), customRouteFormat(timestamp)),
-        colorize: true,
+        format: customRouteFormat(timestamp),
         msg: "{{req.method}} {{req.url}} {{res.statusCode}} {{res.responseTime}}ms",
     };
     app.use(express_winston_1.default.logger({
@@ -99,6 +98,14 @@ const registerRouteLogger = (app, logOptions) => {
     }));
 };
 exports.registerRouteLogger = registerRouteLogger;
+const getExtraFilter = (userExtraFilter) => {
+    const expressRegEx = /node_modules\/express/u;
+    if (!userExtraFilter)
+        return expressRegEx;
+    if (Array.isArray(userExtraFilter))
+        return [expressRegEx, ...userExtraFilter];
+    return [expressRegEx, userExtraFilter];
+};
 const registerErrorLogger = (app, logOptions) => {
     const { error, logger, timestamp } = logOptions ?? {};
     const config = typeof error === "boolean"
@@ -114,7 +121,7 @@ const registerErrorLogger = (app, logOptions) => {
     else {
         app.use(express_winston_1.default.errorLogger({
             transports: winston_js_1.transports,
-            format: (0, winston_js_1.customFormat)(timestamp, config.collapseStacktrace ?? config.collapseNodeModules),
+            format: (0, winston_js_1.customFormat)(timestamp, config.collapseStacktrace ?? config.collapseNodeModules, getExtraFilter(config.extraFilter)),
             meta: false,
         }));
     }

package/lib/express/pipelinebuilder.d.ts

@@ -30,6 +30,7 @@ export interface LogOptions {
     error?: ErrorLoggerOptions;
     logger?: winston.Logger;
     timestamp?: boolean;
+    extraStacktraceFilter?: Array<RegExp> | RegExp;
     userFromReq?: UserFromReqFunc;
 }
 export interface DefaultErrorHandlerConfig {

package/lib/winston.d.ts

@@ -3,7 +3,7 @@ import { Format } from "logform";
 /**
  * Collapse useless lines in stacktrace
  */
-export declare const filterStacktrace: (message: string) => Generator<string>;
+export declare const filterStacktrace: (message: string, extraFilter?: Array<RegExp> | RegExp) => Generator<string>;
 /**
  * Prefix all lines with the level and the timestamp if needed
  */
@@ -13,9 +13,24 @@ export interface LogConfig {
     /** @deprecated Use collapseStacktrace instead */
     collapseNodeModules: boolean;
     collapseStacktrace: boolean;
+    stacktraceFilter?: Array<RegExp> | RegExp;
 }
-export declare const customFormat: (timestamp?: boolean, collapseStacktrace?: boolean) => Format;
+interface ExtendedErrorFields {
+    cause?: Error;
+    response?: {
+        data?: string | Record<string, unknown>;
+    };
+    request?: {
+        _currentUrl?: string;
+    };
+    statusCode?: number;
+}
+declare type ExtendedError = Error & ExtendedErrorFields;
+/** Return a string with the full error and stacktrace, including causes */
+export declare const filterError: (error: ExtendedError, collapseStacktrace?: boolean, extraFilter?: Array<RegExp> | RegExp) => string;
+export declare const customFormat: (timestamp?: boolean, collapseStacktrace?: boolean, stacktraceFilter?: Array<RegExp> | RegExp) => Format;
 /** Edit the configuration applied to consoleLogger */
 export declare const setConfig: (config: LogConfig) => void;
 export declare const transports: winston.transports.ConsoleTransportInstance[];
 export declare const consoleLogger: winston.Logger;
+export {};

package/lib/winston.js

@@ -29,19 +29,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.consoleLogger = exports.transports = exports.setConfig = exports.customFormat = exports.prefixOutput = exports.filterStacktrace = void 0;
+exports.consoleLogger = exports.transports = exports.setConfig = exports.customFormat = exports.filterError = exports.prefixOutput = exports.filterStacktrace = void 0;
 const winston_1 = __importDefault(require("winston"));
-// High value because of colorize()
 const LOG_LEVEL_PADDING_SIZE = 10;
 const stackFilterRegex = /(?:at process|at runMicrotasks)/u;
+const isFiltered = (line, extraFilter) => {
+    if (stackFilterRegex.exec(line))
+        return true;
+    if (extraFilter) {
+        for (const filter of Array.isArray(extraFilter) ? extraFilter : [extraFilter]) {
+            if (filter.exec(line))
+                return true;
+        }
+    }
+    return false;
+};
 /**
  * Collapse useless lines in stacktrace
  */
-const filterStacktrace = function* (message) {
+const filterStacktrace = function* (message, extraFilter) {
     let inCollapse = false;
     const lines = message.split("\n");
     for (const line of lines) {
-        if (stackFilterRegex.exec(line)) {
+        if (isFiltered(line, extraFilter)) {
             if (!inCollapse) {
                 inCollapse = true;
                 yield "[...]";
@@ -71,6 +81,7 @@ const logConfig = {
     timestamp: true,
     collapseNodeModules: true,
     collapseStacktrace: true,
+    stacktraceFilter: undefined,
 };
 const indent = (msg, indentLevel) => {
     if (indentLevel === 0)
@@ -127,7 +138,7 @@ const addHttpErrorContent = (error) => {
     return `HttpError status: ${error.statusCode}`;
 };
 /** Return a string with the full error and stacktrace, including causes */
-const filterError = (error, collapseStacktrace) => {
+const filterError = (error, collapseStacktrace = true, extraFilter) => {
     const resultRows = [];
     let cursor = error;
     let indentLevel = 0;
@@ -141,7 +152,7 @@ const filterError = (error, collapseStacktrace) => {
         resultRows.push(indent(cursor.message, indentLevel));
         if (cursor.stack) {
             if (collapseStacktrace) {
-                resultRows.push(indent([...(0, exports.filterStacktrace)(cursor.stack)].join("\n"), indentLevel));
+                resultRows.push(indent([...(0, exports.filterStacktrace)(cursor.stack, extraFilter)].join("\n"), indentLevel));
             }
             else {
                 resultRows.push(indent(cursor.stack, indentLevel));
@@ -158,6 +169,7 @@ const filterError = (error, collapseStacktrace) => {
     }
     return resultRows.join("\n");
 };
+exports.filterError = filterError;
 const getErrorFromTransformable = (info) => {
     if (info instanceof Error)
         return info;
@@ -167,15 +179,20 @@ const getErrorFromTransformable = (info) => {
             return meta.error;
     }
 };
-const customFormat = (timestamp, collapseStacktrace) => winston_1.default.format.printf((info) => {
+const customFormat = (timestamp, collapseStacktrace, stacktraceFilter) => winston_1.default.format.printf((info) => {
     const effectiveTimestamp = timestamp === undefined
         ? logConfig.timestamp
         : timestamp;
     const effectiveCollapse = collapseStacktrace === undefined
         ? logConfig.collapseNodeModules || logConfig.collapseStacktrace
         : collapseStacktrace;
+    const effectiveStacktraceFilter = stacktraceFilter === undefined
+        ? logConfig.stacktraceFilter
+        : stacktraceFilter;
     const error = getErrorFromTransformable(info);
-    const message = error ? filterError(error, effectiveCollapse) : info.message;
+    const message = error
+        ? (0, exports.filterError)(error, effectiveCollapse, effectiveStacktraceFilter)
+        : info.message.toString();
     return (0, exports.prefixOutput)(info.level, message, effectiveTimestamp);
 });
 exports.customFormat = customFormat;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.10.0",
+  "version": "3.11.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",