nope-js-node/dist-nodejs/logger/fileLogging.js

NoPE Runtime for Nodejs. For Browser-Support please use nope-browser

"use strict";
/**
 * @author Martin Karkowski
 * @email m.karkowski@zema.de
 * @create date 2021-05-21 16:44:59
 * @modify date 2021-10-19 17:47:56
 * @desc [description]
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.useLogFile = exports.generateLogfilePath = exports.DEFAULT_LOG_LOCATION = exports.CURRENT_DATE = void 0;
const fs_1 = require("fs");
const path_1 = require("path");
const fileMethods_1 = require("../helpers/fileMethods");
const stringMethods_1 = require("../helpers/stringMethods");
const index_browser_1 = require("../index.browser");
const getLogger_1 = require("./getLogger");
const nopeLogger_1 = require("./nopeLogger");
exports.CURRENT_DATE = _parsableISOString();
exports.DEFAULT_LOG_LOCATION = (0, path_1.join)(process.cwd(), "logs");
const DEFAULT_FILE = (0, path_1.join)(exports.DEFAULT_LOG_LOCATION, exports.CURRENT_DATE + ".log");
function _parsableISOString(date = new Date()) {
    let isoString = date.toISOString();
    isoString = (0, stringMethods_1.replaceAll)(isoString, ":", "-");
    isoString = (0, stringMethods_1.replaceAll)(isoString, ".", "-");
    return isoString;
}
/**
 * Generates a Log-File Path based on the given name with the following format:
 * /logs/{name}_{date}.log
 *
 * @export
 * @param {string} name Name of the File.
 * @return {string}
 * @backend **Only in Nodejs available**
 */
function generateLogfilePath(name) {
    return (0, path_1.join)(exports.DEFAULT_LOG_LOCATION, name + "_" + _parsableISOString() + ".log");
}
exports.generateLogfilePath = generateLogfilePath;
/**
 * Function to use a log file instead of the console log.
 *
 * @author M.Karkowski
 * @export
 * @param {string} [pathToFile=DEFAULT_FILE] Path to the logfile
 * @param {number} [bufferSize=0] Default Buffer-Size. If > 0 we will write the log with buffering.
 * @backend **Only in Nodejs available**
 */
function useLogFile(pathToFile = DEFAULT_FILE, bufferSize = 100) {
    const logger = (0, getLogger_1.getCentralNopeLogger)();
    let bufferSizeToUse = bufferSize;
    // Define a function, that will write the content of the Buffer to our
    // file.
    const writeBufferToFile = function (cb = null) {
        const textToStore = "\n" + buffer.join("\n");
        readyToWrite = false;
        // Now lets start to write the Fil.e
        (0, fs_1.writeFile)(pathToFile, textToStore, {
            encoding: "utf-8",
            flag: "a",
        }, (err) => {
            if (err) {
                console.error(err);
            }
            else {
                readyToWrite = true;
                if (typeof cb == "function") {
                    cb();
                }
            }
        });
        buffer = [];
    };
    let buffer = [];
    let readyToWrite = false;
    // Now every thing, is defined, so we are able to
    // define our file.
    const consoleLogger = (0, getLogger_1.getNopeLogger)("file-logger");
    (0, fileMethods_1.createFile)(pathToFile, "", { encoding: "utf-8" }).then(
    // If our file has been created,
    (_) => {
        readyToWrite = true;
        // Now make shure, that our inital buffer has been written
        if (buffer.length > 0) {
            writeBufferToFile();
        }
    });
    logger.setHandler((msg, context) => {
        // Else we extend our buffer:
        const logAsString = [
            new Date().toISOString(),
            "-",
            context.level.name,
            "-",
            context.name,
            ":",
            // Try to store the Elements a String.
            Object.values(msg)
                .map((item) => {
                try {
                    if (typeof item === "object")
                        return JSON.stringify(item, undefined, 2);
                    return item;
                }
                catch (e) {
                    try {
                        return item.toString();
                    }
                    catch (e) {
                        return item;
                    }
                }
            })
                .join(" "),
        ].join(" ");
        buffer.push(logAsString);
        if (context.level.name === "ERROR") {
            // We want errors to be rendered in here as well.
            console.log(...(0, nopeLogger_1.formatMsgForConsole)(msg, context));
        }
        if (bufferSizeToUse < buffer.length) {
            if (readyToWrite) {
                // Now if the Data is ready, lets write the
                // buffer to the File.
                writeBufferToFile();
            }
            else if (_clearing) {
                clearBufferAtEnd();
            }
        }
    });
    let _clearing = false;
    const clearBufferAtEnd = async () => {
        consoleLogger.info("Shutdown detected! Trying to Write the Buffer");
        _clearing = true;
        while (!readyToWrite || buffer.length > 0) {
            if (readyToWrite) {
                const promise = new Promise((resolve, reject) => {
                    writeBufferToFile(resolve);
                });
                await promise;
            }
            else
                await (0, index_browser_1.sleep)(50);
        }
        bufferSizeToUse = 0;
    };
    return clearBufferAtEnd;
}
exports.useLogFile = useLogFile;