Skip to content

Fix Node.js v25 logging prefix and modernize logger #4049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rejas merged 4 commits into from
Mar 6, 2026
Merged

Fix Node.js v25 logging prefix and modernize logger #4049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ea70b3
refactor: replace Error.prepareStackTrace with string stack parsing i…
KristjanESPERANTO Mar 5, 2026
0e7f415
fix: use "gray" instead of "grey" in styleText for Node.js v25 compat
KristjanESPERANTO Mar 5, 2026
9f30fcf
refactor: simplify logger by removing UMD pattern
KristjanESPERANTO Mar 5, 2026
c1b2bd9
refactor: replace console-stamp with native console patching
KristjanESPERANTO Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 103 additions & 119 deletions js/logger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,131 +1,115 @@
// This logger is very simple, but needs to be extended.
(function (root, factory) {
if (typeof exports === "object") {
// Logger for MagicMirror² — works both in Node.js (CommonJS) and the browser (global).
(function () {
if (typeof module !== "undefined") {
if (process.env.mmTestMode !== "true") {
const { styleText } = require("node:util");

// add timestamps in front of log messages
require("console-stamp")(console, {
format: ":date(yyyy-mm-dd HH:MM:ss.l) :label(7) :pre() :msg",
tokens: {
pre: () => {
const err = new Error();
Error.prepareStackTrace = (_, stack) => stack;
const stack = err.stack;
Error.prepareStackTrace = undefined;
try {
for (const line of stack) {
const file = line.getFileName();
if (file && !file.includes("node:") && !file.includes("js/logger.js") && !file.includes("node_modules")) {
const filename = file.replace(/.*\/(.*).js/, "$1");
const filepath = file.replace(/.*\/(.*)\/.*.js/, "$1");
if (filepath === "js") {
return styleText("grey", `[${filename}]`);
} else {
return styleText("grey", `[${filepath}]`);
}
}
}
} catch (err) {
return styleText("grey", "[unknown]");
}
},
label: (arg) => {
const { method, defaultTokens } = arg;
let label = defaultTokens.label(arg);
switch (method) {
case "error":
label = styleText("red", label);
break;
case "warn":
label = styleText("yellow", label);
break;
case "debug":
label = styleText("bgBlue", label);
break;
case "info":
label = styleText("blue", label);
break;
}
return label;
},
msg: (arg) => {
const { method, defaultTokens } = arg;
let msg = defaultTokens.msg(arg);
switch (method) {
case "error":
msg = styleText("red", msg);
break;
case "warn":
msg = styleText("yellow", msg);
break;
case "info":
msg = styleText("blue", msg);
break;
const LABEL_COLORS = { error: "red", warn: "yellow", debug: "bgBlue", info: "blue" };
const MSG_COLORS = { error: "red", warn: "yellow", info: "blue" };

const formatTimestamp = () => {
const d = new Date();
const pad2 = (n) => String(n).padStart(2, "0");
const pad3 = (n) => String(n).padStart(3, "0");
const date = `${d.getFullYear()}-${pad2(d.getMonth() + 1)}-${pad2(d.getDate())}`;
const time = `${pad2(d.getHours())}:${pad2(d.getMinutes())}:${pad2(d.getSeconds())}.${pad3(d.getMilliseconds())}`;
return `[${date} ${time}]`;
};

const getCallerPrefix = () => {
try {
const lines = new Error().stack.split("\n");
for (const line of lines) {
if (line.includes("node:") || line.includes("js/logger.js") || line.includes("node_modules")) continue;
const match = line.match(/\((.+?\.js):\d+:\d+\)/) || line.match(/at\s+(.+?\.js):\d+:\d+/);
if (match) {
const file = match[1];
const baseName = file.replace(/.*\/(.*)\.js/, "$1");
const parentDir = file.replace(/.*\/(.*)\/.*\.js/, "$1");
return styleText("gray", parentDir === "js" ? `[${baseName}]` : `[${parentDir}]`);
}
return msg;
}
}
});
} catch (err) { /* ignore */ }
return styleText("gray", "[unknown]");
};

// Patch console methods to prepend timestamp, level label, and caller prefix.
for (const method of ["debug", "log", "info", "warn", "error"]) {
const original = console[method].bind(console);
const labelRaw = `[${method.toUpperCase()}]`.padEnd(7);
const label = LABEL_COLORS[method] ? styleText(LABEL_COLORS[method], labelRaw) : labelRaw;
console[method] = (...args) => {
const prefix = `${formatTimestamp()} ${label} ${getCallerPrefix()}`;
const msgColor = MSG_COLORS[method];
if (msgColor && args.length > 0 && typeof args[0] === "string") {
original(prefix, styleText(msgColor, args[0]), ...args.slice(1));
} else {
original(prefix, ...args);
}
};
}
}
// Node, CommonJS-like
module.exports = factory(root.config);
} else {
// Browser globals (root is window)
root.Log = factory(root.config);
}
}(this, function (config) {
let logLevel;
let enableLog;
if (typeof exports === "object") {
// in nodejs and not running in test mode
enableLog = process.env.mmTestMode !== "true";
// Node, CommonJS
module.exports = makeLogger();
} else {
// in browser and not running with jsdom
enableLog = typeof window === "object" && window.name !== "jsdom";
// Browser globals
window.Log = makeLogger();
}

if (enableLog) {
logLevel = {
debug: Function.prototype.bind.call(console.debug, console),
log: Function.prototype.bind.call(console.log, console),
info: Function.prototype.bind.call(console.info, console),
warn: Function.prototype.bind.call(console.warn, console),
error: Function.prototype.bind.call(console.error, console),
group: Function.prototype.bind.call(console.group, console),
groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
groupEnd: Function.prototype.bind.call(console.groupEnd, console),
time: Function.prototype.bind.call(console.time, console),
timeEnd: Function.prototype.bind.call(console.timeEnd, console),
timeStamp: console.timeStamp ? Function.prototype.bind.call(console.timeStamp, console) : function () {}
};
/**
* Creates the logger object. Logging is disabled when running in test mode
* (Node.js) or inside jsdom (browser).
* @returns {object} The logger object with log level methods.
*/
function makeLogger () {
const enableLog = typeof module !== "undefined"
? process.env.mmTestMode !== "true"
: typeof window === "object" && window.name !== "jsdom";

logLevel.setLogLevel = function (newLevel) {
if (newLevel) {
Object.keys(logLevel).forEach(function (key) {
if (!newLevel.includes(key.toLocaleUpperCase())) {
logLevel[key] = function () {};
}
});
}
};
} else {
logLevel = {
debug () {},
log () {},
info () {},
warn () {},
error () {},
group () {},
groupCollapsed () {},
groupEnd () {},
time () {},
timeEnd () {},
timeStamp () {}
};
let logLevel;

logLevel.setLogLevel = function () {};
}
if (enableLog) {
logLevel = {
debug: Function.prototype.bind.call(console.debug, console),
log: Function.prototype.bind.call(console.log, console),
info: Function.prototype.bind.call(console.info, console),
warn: Function.prototype.bind.call(console.warn, console),
error: Function.prototype.bind.call(console.error, console),
group: Function.prototype.bind.call(console.group, console),
groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
groupEnd: Function.prototype.bind.call(console.groupEnd, console),
time: Function.prototype.bind.call(console.time, console),
timeEnd: Function.prototype.bind.call(console.timeEnd, console),
timeStamp: console.timeStamp ? Function.prototype.bind.call(console.timeStamp, console) : function () {}
};

logLevel.setLogLevel = function (newLevel) {
if (newLevel) {
Object.keys(logLevel).forEach(function (key) {
if (!newLevel.includes(key.toLocaleUpperCase())) {
logLevel[key] = function () {};
}
});
}
};
} else {
logLevel = {
debug () {},
log () {},
info () {},
warn () {},
error () {},
group () {},
groupCollapsed () {},
groupEnd () {},
time () {},
timeEnd () {},
timeStamp () {}
};

return logLevel;
}));
logLevel.setLogLevel = function () {};
}

return logLevel;
}
}());
Loading