@cley_faye/boilerplate 3.9.0 → 3.10.0

package/lib/express/logger.d.ts

@@ -1,9 +1,11 @@
 import expressWinston, { BaseLoggerOptions } from "express-winston";
 import { Request, Router } from "express";
 import { LogOptions, UserFromReqFunc } from "./pipelinebuilder.js";
-export declare type LoggerOptions = expressWinston.LoggerOptions | boolean;
+export declare type LoggerOptions = expressWinston.BaseLoggerOptions | boolean;
 interface ErrorLoggerConfiguration {
+    /** @deprecated Use collapseStacktrace */
     collapseNodeModules?: boolean;
+    collapseStacktrace?: boolean;
 }
 export declare type ErrorLoggerOptions = ErrorLoggerConfiguration | boolean;
 export interface LoggingData {
@@ -16,7 +18,7 @@ export interface RequestWithLoggingData extends Request {
     };
 }
 /** Return the default value for route logger is it is set as `true` */
-export declare const defaultRouteLoggerConfig: (userFromReq?: UserFromReqFunc | undefined) => BaseLoggerOptions;
-export declare const registerRouteLogger: (app: Router, logOptions?: LogOptions | undefined) => void;
-export declare const registerErrorLogger: (app: Router, logOptions?: LogOptions | undefined) => void;
+export declare const defaultRouteLoggerConfig: (userFromReq?: UserFromReqFunc) => BaseLoggerOptions;
+export declare const registerRouteLogger: (app: Router, logOptions?: LogOptions) => void;
+export declare const registerErrorLogger: (app: Router, logOptions?: LogOptions) => void;
 export {};

package/lib/express/logger.js

@@ -99,16 +99,6 @@ const registerRouteLogger = (app, logOptions) => {
     }));
 };
 exports.registerRouteLogger = registerRouteLogger;
-const customErrorFormat = (outputTimestamp, config) => {
-    const { collapseNodeModules } = config;
-    return winston_1.default.format.printf((info) => {
-        const meta = info.meta;
-        const finalMessage = collapseNodeModules
-            ? [...(0, winston_js_1.filterNodeModules)(meta.message)].join("\n")
-            : meta.message;
-        return (0, winston_js_1.prefixOutput)(info.level, finalMessage, outputTimestamp);
-    });
-};
 const registerErrorLogger = (app, logOptions) => {
     const { error, logger, timestamp } = logOptions ?? {};
     const config = typeof error === "boolean"
@@ -124,7 +114,7 @@ const registerErrorLogger = (app, logOptions) => {
     else {
         app.use(express_winston_1.default.errorLogger({
             transports: winston_js_1.transports,
-            format: winston_1.default.format.combine(winston_1.default.format.errors(), winston_1.default.format.colorize(), customErrorFormat(timestamp, config)),
+            format: (0, winston_js_1.customFormat)(timestamp, config.collapseStacktrace ?? config.collapseNodeModules),
             meta: false,
         }));
     }

package/lib/express/middlewares/bodylogger.d.ts

@@ -6,4 +6,4 @@ export interface ExtraLoggingOptions {
     /** Do not expose the "hidden" body props */
     noHiddenBodyProps?: boolean;
 }
-export declare const bodyLogger: (bodyProps?: string[] | undefined, extraLoggingData?: ExtraLoggingData | undefined, options?: ExtraLoggingOptions) => (req: Request, res: Response, next: NextFunction) => void;
+export declare const bodyLogger: (bodyProps?: Array<string>, extraLoggingData?: ExtraLoggingData, options?: ExtraLoggingOptions) => (req: Request, res: Response, next: NextFunction) => void;

package/lib/express/pipelinebuilder.js

@@ -106,6 +106,7 @@ class PipelineBuilder {
             (0, winston_js_1.setConfig)({
                 timestamp: log.timestamp ?? false,
                 collapseNodeModules: errorConfig.collapseNodeModules ?? true,
+                collapseStacktrace: errorConfig.collapseStacktrace ?? true,
             });
         }
         const router = express_1.default.Router();

package/lib/express.d.ts

@@ -99,11 +99,11 @@ import { PipelineSettings, LogFunction } from "./express/pipelinebuilder.js";
  * @return
  * The returned object can be used
  */
-export declare const createPipeline: (settings: PipelineSettings, debugLog?: LogFunction | undefined) => express.Router;
+export declare const createPipeline: (settings: PipelineSettings, debugLog?: LogFunction) => express.Router;
 /**
  * Configure the views rendering engine for an ExpressJS App
  */
-export declare const setViewEngine: (app: express.Express, viewEngine: string, viewsDirectory: string, extraLocals?: Record<string, string | number> | undefined) => void;
+export declare const setViewEngine: (app: express.Express, viewEngine: string, viewsDirectory: string, extraLocals?: Record<string, string | number>) => void;
 export interface StartDefinition {
     app: express.Application;
     /** @deprecated use listenInterface instead */

package/lib/grunt/reactapp.d.ts

@@ -85,7 +85,7 @@ export declare type HandlerFunction = (gruntConfig: GruntConfig, targetName: str
  * @return
  * List of tasks to build the application
  */
-export declare const reactApp: (gruntConfig: GruntConfig, targetName?: string, options?: ReactAppOptions | undefined) => Array<string>;
+export declare const reactApp: (gruntConfig: GruntConfig, targetName?: string, options?: ReactAppOptions) => Array<string>;
 export interface HelperOptions {
     production?: boolean;
     watch?: boolean | number;

package/lib/winston.d.ts

@@ -1,16 +1,20 @@
 import winston from "winston";
+import { Format } from "logform";
 /**
- * Collapse all lines containing /node_modules/ into an ellipsis
+ * Collapse useless lines in stacktrace
  */
-export declare const filterNodeModules: (message: string) => Generator<string>;
+export declare const filterStacktrace: (message: string) => Generator<string>;
 /**
  * Prefix all lines with the level and the timestamp if needed
  */
 export declare const prefixOutput: (level: string, message: string, timestamp: boolean | undefined) => string;
 export interface LogConfig {
     timestamp: boolean;
+    /** @deprecated Use collapseStacktrace instead */
     collapseNodeModules: boolean;
+    collapseStacktrace: boolean;
 }
+export declare const customFormat: (timestamp?: boolean, collapseStacktrace?: boolean) => Format;
 /** Edit the configuration applied to consoleLogger */
 export declare const setConfig: (config: LogConfig) => void;
 export declare const transports: winston.transports.ConsoleTransportInstance[];

package/lib/winston.js

@@ -29,30 +29,31 @@ 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.prefixOutput = exports.filterNodeModules = void 0;
+exports.consoleLogger = exports.transports = exports.setConfig = exports.customFormat = exports.prefixOutput = exports.filterStacktrace = void 0;
 const winston_1 = __importDefault(require("winston"));
 // High value because of colorize()
-const LOG_LEVEL_PADDING_SIZE = 19;
+const LOG_LEVEL_PADDING_SIZE = 10;
+const stackFilterRegex = /(?:at process|at runMicrotasks)/u;
 /**
- * Collapse all lines containing /node_modules/ into an ellipsis
+ * Collapse useless lines in stacktrace
  */
-const filterNodeModules = function* (message) {
-    let inNodeModules = false;
+const filterStacktrace = function* (message) {
+    let inCollapse = false;
     const lines = message.split("\n");
     for (const line of lines) {
-        if (/\/node_modules\//u.exec(line)) {
-            if (!inNodeModules) {
-                inNodeModules = true;
+        if (stackFilterRegex.exec(line)) {
+            if (!inCollapse) {
+                inCollapse = true;
                 yield "[...]";
             }
         }
         else {
-            inNodeModules = false;
+            inCollapse = false;
             yield line;
         }
     }
 };
-exports.filterNodeModules = filterNodeModules;
+exports.filterStacktrace = filterStacktrace;
 /**
  * Prefix all lines with the level and the timestamp if needed
  */
@@ -61,21 +62,123 @@ const prefixOutput = (level, message, timestamp) => {
         ? `${new Date().toISOString()} `
         : "";
     const levelPrefix = `${level.toString().padStart(LOG_LEVEL_PADDING_SIZE)}: `;
-    return message.split("\n").map(line => `${timestampPrefix}${levelPrefix}${line}`)
+    const levelEmpty = `${" ".repeat(LOG_LEVEL_PADDING_SIZE)}  `;
+    return message.split("\n").map((line, id) => `${timestampPrefix}${id === 0 ? levelPrefix : levelEmpty}${line}`)
         .join("\n");
 };
 exports.prefixOutput = prefixOutput;
 const logConfig = {
     timestamp: true,
     collapseNodeModules: true,
+    collapseStacktrace: true,
 };
-const customFormat = winston_1.default.format.printf((info) => {
-    const message = ("stack" in info) ? info.stack : info.message;
-    const filteredMessage = logConfig.collapseNodeModules
-        ? [...(0, exports.filterNodeModules)(message)].join("\n")
-        : message;
-    return (0, exports.prefixOutput)(info.level, filteredMessage, logConfig.timestamp);
+const indent = (msg, indentLevel) => {
+    if (indentLevel === 0)
+        return msg;
+    const indentList = [];
+    for (let i = 0; i < indentLevel;) {
+        ++i;
+        const str = `${i}|`;
+        if (i < indentLevel) {
+            indentList.push(" ".repeat(str.length));
+        }
+        else {
+            indentList.push(str);
+        }
+    }
+    const indentStr = indentList.join("");
+    return msg.split("\n")
+        .map(c => `${indentStr} ${c.trimEnd()}`)
+        .join("\n");
+};
+/** Add context from axios */
+const addAxiosContent = (error) => {
+    const res = [];
+    if (error.request?._currentUrl) {
+        res.push(`HTTP Request URL: ${error.request._currentUrl}`);
+    }
+    if (error.response?.data) {
+        res.push("HTTP Response body:");
+        if (typeof error.response.data === "string") {
+            res.push(error.response.data);
+        }
+        else {
+            try {
+                res.push(JSON.stringify(error.response.data));
+            }
+            catch {
+                try {
+                    res.push(error.response.data.toString());
+                }
+                catch {
+                    res.push("<cannot output body>");
+                }
+            }
+        }
+    }
+    if (res.length === 0)
+        return;
+    return res.join("\n");
+};
+/** Add context from http-errors */
+const addHttpErrorContent = (error) => {
+    if (error.statusCode === undefined)
+        return;
+    return `HttpError status: ${error.statusCode}`;
+};
+/** Return a string with the full error and stacktrace, including causes */
+const filterError = (error, collapseStacktrace) => {
+    const resultRows = [];
+    let cursor = error;
+    let indentLevel = 0;
+    while (cursor) {
+        if (indentLevel === 0) {
+            resultRows.push(cursor.name);
+        }
+        else {
+            resultRows.push(indent(`Caused by: ${cursor.name}`, indentLevel));
+        }
+        resultRows.push(indent(cursor.message, indentLevel));
+        if (cursor.stack) {
+            if (collapseStacktrace) {
+                resultRows.push(indent([...(0, exports.filterStacktrace)(cursor.stack)].join("\n"), indentLevel));
+            }
+            else {
+                resultRows.push(indent(cursor.stack, indentLevel));
+            }
+        }
+        const axiosContent = addAxiosContent(cursor);
+        if (axiosContent)
+            resultRows.push(indent(axiosContent, indentLevel));
+        const httpErrorsContent = addHttpErrorContent(cursor);
+        if (httpErrorsContent)
+            resultRows.push(indent(httpErrorsContent, indentLevel));
+        cursor = cursor.cause;
+        ++indentLevel;
+    }
+    return resultRows.join("\n");
+};
+const getErrorFromTransformable = (info) => {
+    if (info instanceof Error)
+        return info;
+    if (info.meta) {
+        const meta = info.meta;
+        if (meta.error && meta.error instanceof Error)
+            return meta.error;
+    }
+};
+const customFormat = (timestamp, collapseStacktrace) => winston_1.default.format.printf((info) => {
+    const effectiveTimestamp = timestamp === undefined
+        ? logConfig.timestamp
+        : timestamp;
+    const effectiveCollapse = collapseStacktrace === undefined
+        ? logConfig.collapseNodeModules || logConfig.collapseStacktrace
+        : collapseStacktrace;
+    const error = getErrorFromTransformable(info);
+    const message = error ? filterError(error, effectiveCollapse) : info.message;
+    return (0, exports.prefixOutput)(info.level, message, effectiveTimestamp);
 });
+exports.customFormat = customFormat;
 /** Edit the configuration applied to consoleLogger */
 const setConfig = (config) => {
     Object.assign(logConfig, config);
@@ -84,6 +187,6 @@ exports.setConfig = setConfig;
 exports.transports = [new winston_1.default.transports.Console()];
 exports.consoleLogger = winston_1.default.createLogger({
     level: "info",
-    format: winston_1.default.format.combine(winston_1.default.format.colorize(), customFormat),
+    format: (0, exports.customFormat)(),
     transports: exports.transports,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -17,26 +17,26 @@
   },
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
-    "@keeex/eslint-config": "^1.7.1",
-    "@types/express": "^4.17.11",
-    "@types/grunt": "^0.4.25",
-    "@types/http-errors": "^1.8.0",
-    "@types/node": "^16.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.12.0",
-    "@typescript-eslint/parser": "^5.12.0",
-    "eslint": "^8.7.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-promise": "^6.0.0",
-    "eslint-webpack-plugin": "^3.0.1",
-    "express-winston": "^4.0.5",
-    "grunt": "^1.4.1",
+    "@keeex/eslint-config": "^1.8.2",
+    "@types/express": "^4.17.14",
+    "@types/grunt": "^0.4.27",
+    "@types/http-errors": "^1.8.2",
+    "@types/node": "^16.11.59",
+    "@typescript-eslint/eslint-plugin": "^5.38.0",
+    "@typescript-eslint/parser": "^5.38.0",
+    "eslint": "^8.23.1",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-promise": "^6.0.1",
+    "eslint-webpack-plugin": "^3.2.0",
+    "express-winston": "^4.2.0",
+    "grunt": "^1.5.3",
     "grunt-banner": "^0.6.0",
-    "grunt-contrib-clean": "^2.0.0",
+    "grunt-contrib-clean": "^2.0.1",
     "grunt-run": "^0.8.1",
     "load-grunt-tasks": "^5.1.0",
-    "logform": "^2.3.2",
-    "typescript": "^4.1.5",
-    "winston": "^3.3.3"
+    "logform": "^2.4.2",
+    "typescript": "^4.8.3",
+    "winston": "^3.8.2"
   },
   "peerDependencies": {
     "@babel/core": "7.x",
@@ -55,9 +55,9 @@
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
     "grunt-webpack": "5.x",
-    "resolve-typescript-plugin": "^1.1.1",
+    "resolve-typescript-plugin": "^1.2.0",
     "sass": "1.x",
-    "ts-loader": "^9.2.6",
+    "ts-loader": "^9.4.0",
     "winston": "3.x"
   },
   "peerDependenciesMeta": {