MMM-Logging.js

/* global Module */

/* MagicMirror²
 * Module: MMM-Logging
 *
 * By shbatm
 * MIT Licensed.
 */

/* jshint esversion: 6 */

Module.register("MMM-Logging", {
    defaults: {
        useColor: true,
        format: "{{timestamp}} <{{title}}> {{message}} ({{folder}}/{{file}}:{{line}} {{method}})",
        overwriteConsoleMethods: true,
        overwriteBrowserMethods: false,
        echoModuleNotifications: 'notification',
        echoErrors: true,
        dateformat: "yyyy-mm-dd'T'HH:MM:ss",
        ignoreModules: [ 'calendar', 'newsfeed', 'clock' ]
    },

    requiresVersion: "2.1.0", // Required version of MagicMirror

    start: function() {
        this.sendSocketNotification("INITIALIZE_LOGGING", this.config);
        if (this.config.overwriteBrowserMethods) {
            this.config.overwriteConsoleMethods = true;
            // Overwrite the Main Console
            this.console = Tracer.console(this.config);
            // Overwrite MagicMirror's Log functions.
            Log.log = console.log;
            Log.info = console.info;
            Log.warn = console.warn;
            Log.error = console.error;
            Log.debug = (console.debug || console.log);
        }
        console.info("MMM-Logging updated window.console.");

        if (this.config.echoErrors) {
            console.error = (text) => {
                this.sendSocketNotification("BROWSER_ERROR", text);
                this.console.error(text);
            };
            window.addEventListener('error', (event) => {
                this.sendSocketNotification("BROWSER_ERROR", event);
            });
        }
        this.initialized = true;
    },

    getScripts: function() {
        return ['tracer-bundle.js'];
    },

    getStyles: function() {
        return [];
    },

    // socketNotificationReceived from helper
    socketNotificationReceived: function(notification, payload) {
        // Do nothing.
    },

    notificationReceived: function(notification, payload, sender) {
        if (this.config.echoModuleNotifications) {
            if (sender && this.config.ignoreModules && this.config.ignoreModules.indexOf(sender.name) !== -1) { return; }
            this.sendSocketNotification("NOTIFICATION_TO_CONSOLE", {
                notification: notification,
                payload: (payload && this.config.echoModuleNotifications === "payload") ? payload : undefined,
                sender: (sender) ? sender.name : undefined
            });
        }
    },

});