origintrail-node/src/logger/logger.js

OriginTrail Node - Decentralized Knowledge Graph Node Library

import { pino } from 'pino';
import pretty from 'pino-pretty';

/**
 * Class for logging messages.
 */
class Logger {
    /**
     * Create a new logger.
     * @param {string} logLevel - The log level to use for the logger.
     */
    constructor(logLevel = 'trace', pinoInstance = null) {
        this.logLevel = logLevel;
        this._timers = new Map();
        if (!pinoInstance) this.initialize(logLevel);
        else this.pinoLogger = pinoInstance;
    }

    /**
     * Initialize the logger.
     * @param {string} logLevel - The log level to use for the logger.
     */
    initialize(logLevel) {
        try {
            const stream = pretty({
                colorize: true,
                level: this.logLevel,
                translateTime: 'yyyy-mm-dd HH:MM:ss',
                ignore: 'pid,hostname,Event_name,Operation_name,Id_operation',
                hideObject: true,
                messageFormat: (log, messageKey) => {
                    const { commandId, commandName, operationId } = log;
                    let context = '';
                    if (operationId) context += `{Operation ID: ${operationId}} `;
                    if (commandName) context += `[${commandName}] `;
                    if (commandId) context += `(Command ID: ${commandId}) `;
                    return `${context} ${log[messageKey]}`;
                },
            });
            this.pinoLogger = pino(
                {
                    customLevels: {
                        emit: 15,
                        api: 25,
                    },
                    level: logLevel,
                },
                stream,
            );
        } catch (e) {
            // eslint-disable-next-line no-console
            console.error(`Failed to create logger. Error message: ${e.message}`);
        }
    }

    /**
     * Create a child logger with the given bindings.
     * @param {pino.Bindings} bindings - The bindings to use for the child logger.
     * @return {Logger} The child logger.
     */
    child(bindings) {
        return new Logger(this.logLevel, this.pinoLogger.child(bindings, {}));
    }

    /**
     * Restart the logger.
     */
    restart() {
        this.initialize(this.logLevel, true);
    }

    // ===========================
    // =====   TIMERS    ========
    // ===========================

    /**
     * Start a timer countdown. Equivalent to console.time(label).
     * @param {string} label - The label to use for the timer.
     */
    startTimer(label) {
        // TODO: Maybe add dedicated level just for timers?
        // if (this.pinoLogger.levelVal > this.pinoLogger.levels.values.trace)
        //     return;

        this._timers.set(label, process.hrtime.bigint());
    }

    /**
     * End a timer countdown. Should be used only in trace level, equivalent to console.timeEnd(label).
     * @note Requires startTimer to be called first.
     * @param {string} label - The label to use for the timer.
     */
    endTimer(label) {
        const start = this._timers.get(label);
        if (!start) return;

        this._timers.delete(label);
        const diffNs = process.hrtime.bigint() - start;
        // TODO: Fix precision on micro/nano seconds scale
        // eslint-disable-next-line no-undef
        const diffMs = Number(diffNs / BigInt(1e6)).toFixed(2);

        this.pinoLogger.trace(`${label} - ${diffMs}ms`);
    }

    // ===========================
    // ====   LOG LEVELS    ======
    // ===========================

    /**
     * Log a silent message.
     * @param {any} obj - The object to log.
     */
    silent(obj) {
        this.pinoLogger.silent(obj);
    }

    /**
     * Log a fatal message.
     * @param {any} obj - The object to log.
     */
    fatal(obj) {
        this.pinoLogger.fatal(obj);
    }

    /**
     * Log an error message.
     * @param {any} obj - The object to log.
     */
    error(obj) {
        this.pinoLogger.error(obj);
    }

    /**
     * Log a warning message.
     * @param {any} obj - The object to log.
     */
    warn(obj) {
        this.pinoLogger.warn(obj);
    }

    /**
     * Log an info message.
     * @param {any} obj - The object to log.
     */
    info(obj) {
        this.pinoLogger.info(obj);
    }

    /**
     * Log a debug message.
     * @param {any} obj - The object to log.
     */
    debug(obj) {
        this.pinoLogger.debug(obj);
    }

    /**
     * Log an emit message.
     * @param {any} obj - The object to log.
     */
    emit(obj) {
        // TODO: Check if confused with node.js event emitter
        this.pinoLogger.emit(obj);
    }

    /**
     * Log a trace message.
     * @param {any} obj - The object to log.
     */
    trace(obj) {
        this.pinoLogger.trace(obj);
    }

    /**
     * Log an API message.
     * @param {any} obj - The object to log.
     */
    api(obj) {
        this.pinoLogger.api(obj);
    }

    /**
     * Close the logger.
     * @param {string} closingMessage - The message to log when closing the logger.
     */
    closeLogger(closingMessage) {
        const finalLogger = pino.final(this.pinoLogger);
        finalLogger.info(closingMessage);
    }
}

export default Logger;