web-analyst/lib/utils/core.cjs

Web Analyst is a simple back-end tracking system to measure your web app performance.

const {mkdirSync} = require("fs");

const {joinPath} = require("@thimpat/libutils");
const {cloneFile} = require("clonefile");

const {MEANINGFUL_LOG_FILES, SUB_DATA_DIR} = require("../../hybrid/cjs/wa-constants.cjs");
const {getOptions, setOptionProperty, getOptionProperty} = require("./options.cjs");
const TABLE_SEPARATOR = "  |  ";

const getServerLogDir = () => {
    return getOptionProperty("dataDir");
};

const buildDataDir = (outputDir, subDir = SUB_DATA_DIR) => {
    try {
        const dataDir = joinPath(outputDir, subDir);
        setOptionProperty("dataDir", dataDir);

        mkdirSync(dataDir, {recursive: true});
        return dataDir;
    } catch (e) {
        console.error({lid: "WA2145"}, e.message);
    }

    return null;
};

/**
 * Copy web file from web-analyst to the stats directory
 * for independent viewing
 * @returns {boolean}
 * @param outputDir
 */
const buildWebContentDirectory = (outputDir) => {
    try {
        const sourceDir = joinPath(__dirname, "../../web/");

        cloneFile(sourceDir, outputDir, {
            silent: false,
            force: true,
            recursive: true
        });

        return true;
    } catch (e) {
        console.error({lid: "WA2663"}, e.message);
    }

    return false;

};

const buildStatsDirectory = (server, namespace) => {
    try {
        const options = getOptions();

        const outputDir = joinPath(options.outputDir, `${server}.${namespace}/`);

        buildWebContentDirectory(outputDir);
        buildDataDir(outputDir);

        return true;
    } catch (e) {
        console.error({lid: "WA2663"}, e.message);
    }

    return false;

};

/**
 * https://stackoverflow.com/questions/49330139/date-toisostring-but-local-time-instead-of-utc
 * @param {Date} d
 * @returns
 */
function toISOLocal(d) {
    const z = n => ("0" + n).slice(-2);
    const zz = n => ("00" + n).slice(-3);
    let off = d.getTimezoneOffset();
    const sign = off > 0 ? "-" : "+";
    off = Math.abs(off);

    return d.getFullYear() + "-"
        + z(d.getMonth() + 1) + "-" +
        z(d.getDate()) + "T" +
        z(d.getHours()) + ":" +
        z(d.getMinutes()) + ":" +
        z(d.getSeconds()) + "." +
        zz(d.getMilliseconds()) +
        sign + z(off / 60 | 0) + ":" + z(off % 60);
}

/**
 *
 * @param {Date} d
 * @param {boolean} isLocal
 * @returns {string}
 */
function toISODateTime(d, {isLocal = false} = {}) {
    if (isLocal) {
        return toISOLocal(d);
    }

    return d.toISOString();
}

/**
 * Returns stat line or headers
 * @note The column order is important for later split a line. pathname or any other non-empty
 * column should be at the end (not search as it can be empty)
 * @param ip
 * @param acceptLanguage
 * @param userAgent
 * @param pathname
 * @param search
 * @param referer
 * @param token
 * @returns {{}}
 */
const getStructuredLine = function ({
                                        ip = "",
                                        acceptLanguage = "",
                                        userAgent = "",
                                        pathname = "",
                                        search = "",
                                        referer = "",
                                        token = ""
                                    } = {}) {
    const obj = {};

    let now = new Date();
    let nowISO = toISODateTime(now);
    let today = nowISO.slice(0, 10);

    let time = now.toLocaleTimeString();

    if (ip) {
        // Formatted line
        obj.date = today.padEnd(12) + time.padEnd(10);
        obj.ip = ip.padEnd(32);
        obj.acceptLanguage = acceptLanguage.padEnd(60);
        obj.userAgent = userAgent.padEnd(120);
        obj.search = search.padEnd(80);
        obj.pathname = pathname.padEnd(60);
        obj.referer = referer.padEnd(120);
        obj.token = token;
    } else {
        // Headers
        obj.date = "date".padEnd(22);
        obj.ip = "ip".padEnd(32);
        obj.acceptLanguage = "acceptLanguage".padEnd(60);
        obj.userAgent = "userAgent".padEnd(120);
        obj.search = "search".padEnd(80);
        obj.pathname = "pathname".padEnd(60);
        obj.referer = "referer".padEnd(120);
        obj.token = referer.padEnd(40);
    }

    return obj;
};


/**
 * Returns stat line
 * @param ip
 * @param acceptLanguage
 * @param userAgent
 * @param pathname
 * @param search
 * @param referer
 * @param cookieData
 * @param deviceType
 * @param resolution
 * @param viewport
 * @returns {string}
 */
const getLineStats = function ({
                                   ip,
                                   acceptLanguage,
                                   userAgent,
                                   pathname,
                                   search,
                                   referer,
                                   cookieData = null,
                                   deviceType,
                                   resolution,
                                   viewport
                               }) {
    let strLine;
    try {
        const obj = getStructuredLine({
            ip: ip || "",
            acceptLanguage: acceptLanguage || "",
            userAgent: userAgent || "",
            search: search || "",
            pathname: pathname || "",
            referer: referer || "",
            token: cookieData ? cookieData.token : "",
            deviceType: deviceType || "",
            resolution: resolution || "",
            viewport: viewport || "",
        });

        const line = Object.values(obj);
        strLine = line.join(TABLE_SEPARATOR);
    } catch (e) {
        console.error({lid: "WA2445"}, e.message);
    }

    return strLine;
};

/**
 * Returns headers to use in the hit file
 * @returns {string}
 */
const getHeaders = function () {
    let strTitles;
    try {
        const structure = getStructuredLine();
        const obj = Object.values(structure);

        strTitles = obj.join(TABLE_SEPARATOR);
    } catch (e) {
        console.error({lid: "WA2555"}, e.message);
    }

    return strTitles;
};

/**
 * Returns path to log file
 * @returns {string}
 */
const getHitLogsPath = () => {
    const dataDir = getServerLogDir();
    return joinPath(dataDir, MEANINGFUL_LOG_FILES.HITS_LOG_FILENAME);
};

// -----------------------------------------------------------
// Build json file
// -----------------------------------------------------------

module.exports.TABLE_SEPARATOR = TABLE_SEPARATOR;

module.exports.getServerLogDir = getServerLogDir;
module.exports.buildStatsLogDir = buildDataDir;

module.exports.buildStatsDirectory = buildStatsDirectory;
module.exports.buildWebContentDirectory = buildWebContentDirectory;

module.exports.getHeaders = getHeaders;

module.exports.getHitLogsPath = getHitLogsPath;

module.exports.getLineStats = getLineStats;

module.exports.toISODateTime = toISODateTime;