@cley_faye/boilerplate 3.21.2 → 4.0.1

package/lib/winston.js

@@ -1,224 +0,0 @@
-/**
- * @license
- * @preserve
- * MIT License
- *
- * Copyright (c) 2021 Gabriel Paul "Cley Faye" Risterucci
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- */
-"use strict";
-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.filterError = exports.prefixOutput = exports.filterStacktrace = void 0;
-const winston_1 = __importDefault(require("winston"));
-const unprocessableentityerror_js_1 = require("./express/unprocessableentityerror.js");
-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, extraFilter) {
-    let inCollapse = false;
-    const lines = message.split("\n");
-    for (const line of lines) {
-        if (isFiltered(line, extraFilter)) {
-            if (!inCollapse) {
-                inCollapse = true;
-                yield "[...]";
-            }
-        }
-        else {
-            inCollapse = false;
-            yield line;
-        }
-    }
-};
-exports.filterStacktrace = filterStacktrace;
-/**
- * Prefix all lines with the level and the timestamp if needed
- */
-const prefixOutput = (level, message, timestamp) => {
-    const timestampPrefix = (timestamp ?? (level.toLowerCase() === "error"))
-        ? `${new Date().toISOString()} `
-        : "";
-    const levelPrefix = `${level.toString().padStart(LOG_LEVEL_PADDING_SIZE)}: `;
-    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,
-    stacktraceFilter: undefined,
-};
-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 {
-                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}`;
-};
-const getCause = (error) => {
-    const cause = error.cause;
-    if (cause === undefined)
-        return;
-    if (cause instanceof Error)
-        return cause;
-    try {
-        return new Error(JSON.stringify(cause));
-    }
-    catch {
-        return new Error("Unknown cause");
-    }
-};
-/** Handle 422
- *
- * If return a string, do not process the error normally.
- */
-const process422Error = (error) => {
-    const errorInfo = (0, unprocessableentityerror_js_1.get422Fields)(error);
-    return errorInfo?.message;
-};
-/** Return a string with the full error and stacktrace, including causes */
-const filterError = (error, collapseStacktrace = true, extraFilter) => {
-    const resultRows = [];
-    const unprocessableCheck = process422Error(error);
-    if (unprocessableCheck)
-        return unprocessableCheck;
-    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, extraFilter)].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 = getCause(cursor);
-        ++indentLevel;
-    }
-    return resultRows.join("\n");
-};
-exports.filterError = filterError;
-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, stacktraceFilter) => winston_1.default.format.printf((info) => {
-    const effectiveTimestamp = timestamp ?? logConfig.timestamp;
-    const effectiveCollapse = collapseStacktrace
-        ?? (logConfig.collapseNodeModules || logConfig.collapseStacktrace);
-    const effectiveStacktraceFilter = stacktraceFilter ?? logConfig.stacktraceFilter;
-    const error = getErrorFromTransformable(info);
-    const message = error
-        ? (0, exports.filterError)(error, effectiveCollapse, effectiveStacktraceFilter)
-        : info.message.toString();
-    return (0, exports.prefixOutput)(info.level, message, effectiveTimestamp);
-});
-exports.customFormat = customFormat;
-/** Edit the configuration applied to consoleLogger */
-const setConfig = (config) => {
-    Object.assign(logConfig, config);
-};
-exports.setConfig = setConfig;
-exports.transports = [new winston_1.default.transports.Console()];
-exports.consoleLogger = winston_1.default.createLogger({
-    level: "info",
-    format: (0, exports.customFormat)(),
-    transports: exports.transports,
-});