Superalgos/Debug Log.js

exports.newDebugLog = function newDebugLog() {

    const MODULE_NAME = "Debug Log";
    const fileSystem = require('fs');

    const currentDate = new Date();
    const dateString = currentDate.getUTCFullYear() + '-' + pad(currentDate.getUTCMonth() + 1, 2) + '-' + pad(currentDate.getUTCDate(), 2) + '-' + pad(currentDate.getUTCHours(), 2) + '-' + pad(currentDate.getUTCMinutes(), 2);
    const randomId = parseInt(Math.random() * 1000000); 

    let fileNumber = 1;
    let messageId = 0;
    let firstCall = true;
    let folderPath;
    let loopCounter;
    let loopIncremented = false;

    let thisObject = {
        bot: undefined,
        fileName: undefined,
        forceLoopSplit: false,          // When set to 'true' this will force that the logs of the current module are split in many different Loop folders.
        write: write
    };

    return thisObject;

    function createFolders() {

        try {

            folderPath = '../Logs';

            createFolderSync(folderPath);

            folderPath = '../Logs/' + thisObject.bot.devTeam;

            createFolderSync(folderPath);

            folderPath = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type;

            createFolderSync(folderPath);

            folderPath = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type + "/" + thisObject.bot.codeName + "." + thisObject.bot.version.major + "." + thisObject.bot.version.minor;

            createFolderSync(folderPath);

            folderPath = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type + "/" + thisObject.bot.codeName + "." + thisObject.bot.version.major + "." + thisObject.bot.version.minor + "/" + thisObject.bot.process;

            createFolderSync(folderPath);

            firstCall = false;

        }
        catch (err) {
            console.log("Error trying to create the folders needed.  Error: " + err.message);
        }
    }

    function createLoopFolder() {

        try {

            let folderToRemove = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type + "/" + thisObject.bot.codeName + "." + thisObject.bot.version.major + "." + thisObject.bot.version.minor + "/" + thisObject.bot.process + "/Loop." + (loopCounter + 1).toString();

            /* We create the new one. */

            folderPath = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type + "/" + thisObject.bot.codeName + "." + thisObject.bot.version.major + "." + thisObject.bot.version.minor + "/" + thisObject.bot.process + "/Loop." + loopCounter;

            createFolderSync(folderPath);

            /* We also remove old folders according to the configuration value of global.PLATFORM_CONFIG.maxLogLoops. */

            folderToRemove = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type + "/" + thisObject.bot.codeName + "." + thisObject.bot.version.major + "." + thisObject.bot.version.minor + "/" + thisObject.bot.process + "/Loop." + (loopCounter - global.PLATFORM_CONFIG.maxLogLoops).toString();

            deleteLoopFolder(folderToRemove);

            if (thisObject.bot.debug.year !== undefined) {

                folderPath = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type + "/" + thisObject.bot.codeName + "." + thisObject.bot.version.major + "." + thisObject.bot.version.minor + "/" + thisObject.bot.process + "/Loop." + loopCounter + "/" + thisObject.bot.debug.year; 

                createFolderSync(folderPath);

                if (thisObject.bot.debug.month !== undefined) {

                    folderPath = '../Logs/' + thisObject.bot.devTeam + "/" + thisObject.bot.type + "/" + thisObject.bot.codeName + "." + thisObject.bot.version.major + "." + thisObject.bot.version.minor + "/" + thisObject.bot.process + "/Loop." + loopCounter + "/" + thisObject.bot.debug.year + "/" + thisObject.bot.debug.month;

                    createFolderSync(folderPath);

                }
            }
        }
        catch (err) {
            console.log("Error trying to create the loop folder needed or deleting old ones.  Error: " + err.message);
        }
    }

    function write(Message) {

        if (firstCall === true) { createFolders(); }

        if (thisObject.bot.loopCounter !== loopCounter) {

            if (thisObject.forceLoopSplit === false) {

                if (loopIncremented === false) {

                    loopIncremented = true;

                    loopCounter = thisObject.bot.loopCounter;
                    createLoopFolder();
                }
            } else {

                loopIncremented = true;

                loopCounter = thisObject.bot.loopCounter;
                createLoopFolder();

            }
        }

        let filePath = getCurrentLogFile(folderPath + "/" + dateString + "---" + randomId + "---", this.fileName);

        let newDate = new Date();
        newDate = newDate.toISOString();

        messageId++;

        try {

            fileSystem.appendFileSync(filePath, '\r\n' + newDate + "   "  + messageId + "   " + Message);

        }
        catch (err) {
            console.log("Error trying to log info into a file.");
            console.log("File: " + filePath );
            console.log("Error: " + err.message);
        }
    }

    function createFolderSync(name) {
        try {
            fileSystem.mkdirSync(  name)
        } catch (err) {
            if (err.code !== 'EEXIST') throw err
        }
    }

    function getCurrentLogFile(relativePath, fileName) {

        let filePath;
        let stats;
        let i;

        try {
            for (i = 1; i < 1000000; i++) {

                filePath =  relativePath + i + "." + fileName + '.log';
                stats = fileSystem.statSync(filePath);
            }
        }
        catch (err) {

            if (i > 1) {

                filePath =  relativePath + (i - 1) + "." + fileName + '.log';

                stats = fileSystem.statSync(filePath);
                const fileSizeInBytes = stats.size;

                if (fileSizeInBytes > 10240000) {

                    filePath =  relativePath + i + "." + fileName + '.log';
                }

                return filePath;

            } else {

                return filePath;

            }

        }

    }

    function pad(str, max) {
        str = str.toString();
        return str.length < max ? pad("0" + str, max) : str;
    }

    function deleteLoopFolder(pFolderPath) {

        let rimraf = require('rimraf');
        let fs = require('fs');
        let errosFound = false;

        try {

            let fileCount;
            let filesChecked = 0;

            fs.readdir(pFolderPath, onfileCount);

            function onfileCount(err, files) {

                if (err) { return;}

                fileCount = files.length;

                fs.readdirSync(pFolderPath).forEach(fileName => {

                    fs.readFile(pFolderPath + "/" + fileName, onFileRead);

                    function onFileRead(err, file) {

                        try {

                            filesChecked++;

                            if (file.indexOf("[ERROR]") > 0) {

                                errosFound = true;

                            }

                            if (filesChecked === fileCount) {

                                if (errosFound === false) {

                                    rimraf.sync(pFolderPath);

                                }
                            }
                        }
                        catch (err) {
                            console.log("Error trying to delete Loop Folder " + pFolderPath + ".Reading file " + fileName + ". err.message = " + err.message);
                        }
                    }
                })
            } 
        }
        catch (err) {
            return;
        } 
    }
};