@node-red/util 4.0.9 → 4.1.0-beta.1

package/lib/i18n.js

@@ -80,6 +80,21 @@ function mergeCatalog(fallback,catalog) {
     }
 }
 
+function migrateMessageCatalogV3toV4(catalog) {
+    const keys = Object.keys(catalog)
+    keys.forEach(key => {
+        if (typeof catalog[key] === 'object') {
+            catalog[key] = migrateMessageCatalogV3toV4(catalog[key])
+        } else if (key.endsWith('_plural')) {
+            const otherKey = key.replace('_plural', '_other')
+            if (!catalog[otherKey]) {
+                catalog[otherKey] = catalog[key]
+            }
+            delete catalog[key]
+        }
+    })
+    return catalog
+}
 
 async function readFile(lng, ns) {
     if (/[^a-z\-]/i.test(lng)) {
@@ -92,6 +107,12 @@ async function readFile(lng, ns) {
         const content = await fs.promises.readFile(file, "utf8");
         resourceCache[ns] = resourceCache[ns] || {};
         resourceCache[ns][lng] = JSON.parse(content.replace(/^\uFEFF/, ''));
+
+        // Message catalogues are in i18next v3 format. That is no longer supported
+        // by i18next so we need to migrate any catalog to the v4 format.
+        // This primarily means mapping `FOO_plural` to `FOO_other`
+        resourceCache[ns][lng] = migrateMessageCatalogV3toV4(resourceCache[ns][lng])
+
         var baseLng = lng.split('-')[0];
         if (baseLng !== lng && resourceCache[ns][baseLng]) {
             mergeCatalog(resourceCache[ns][baseLng], resourceCache[ns][lng]);
@@ -139,7 +160,6 @@ function init(settings) {
         initPromise = new Promise((resolve,reject) => {
             i18n.use(MessageFileLoader);
             var opt = {
-                compatibilityJSON: 'v3',
                 // debug: true,
                 defaultNS: "runtime",
                 ns: [],

package/lib/log.js

@@ -23,6 +23,7 @@ var util = require("util");
 var EventEmitter = require("events").EventEmitter;
 
 var i18n = require("./i18n");
+const chalk = require("chalk");
 
 var levels = {
     off:    1,
@@ -47,6 +48,17 @@ var levelNames = {
     99: "metric"
 };
 
+var levelColours = {
+    10: 'red',
+    20: 'red',
+    30: 'yellow',
+    40: '',
+    50: 'cyan',
+    60: 'gray',
+    98: '',
+    99: ''
+};
+
 var logHandlers = [];
 
 var verbose;
@@ -75,28 +87,32 @@ LogHandler.prototype.shouldReportMessage = function(msglevel) {
            msglevel <= this.logLevel;
 }
 
-
 // Older versions of Node-RED used the deprecated util.log function.
 // With Node.js 22, use of that function causes warnings. So here we
 // are replicating the same format output to ensure we don't break any
 // log parsing that happens in the real world.
 const months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
-const utilLog = function (msg) {
+const utilLog = function (msg, level) {
     const d = new Date();
     const time = [
         d.getHours().toString().padStart(2, '0'),
         d.getMinutes().toString().padStart(2, '0'),
         d.getSeconds().toString().padStart(2, '0')
     ].join(':');
-    console.log(`${d.getDate()} ${months[d.getMonth()]} ${time} - ${msg}`)
+    const logLine = `${d.getDate()} ${months[d.getMonth()]} ${time} - ${msg}`
+    if (levelColours[level]) {
+        console.log(chalk[levelColours[level]](logLine))
+    } else {
+        console.log(logLine)
+    }
 }
 
 var consoleLogger = function(msg) {
     if (msg.level == log.METRIC || msg.level == log.AUDIT) {
-        utilLog("["+levelNames[msg.level]+"] "+JSON.stringify(msg));
+        utilLog("["+levelNames[msg.level]+"] "+JSON.stringify(msg), msg.level);
     } else {
         if (verbose && msg.msg && msg.msg.stack) {
-            utilLog("["+levelNames[msg.level]+"] "+(msg.type?"["+msg.type+":"+(msg.name||msg.id)+"] ":"")+msg.msg.stack);
+            utilLog("["+levelNames[msg.level]+"] "+(msg.type?"["+msg.type+":"+(msg.name||msg.id)+"] ":"")+msg.msg.stack, msg.level);
         } else {
             var message = msg.msg;
             try {
@@ -107,7 +123,7 @@ var consoleLogger = function(msg) {
                 message = 'Exception trying to log: '+util.inspect(message);
             }
 
-            utilLog("["+levelNames[msg.level]+"] "+(msg.type?"["+msg.type+":"+(msg.name||msg.id)+"] ":"")+message);
+            utilLog("["+levelNames[msg.level]+"] "+(msg.type?"["+msg.type+":"+(msg.name||msg.id)+"] ":"")+message, msg.level);
         }
     }
 }

package/lib/util.js

@@ -828,18 +828,31 @@ function encodeObject(msg,opts) {
             debuglength = opts.maxLength;
         }
         var msgType = typeof msg.msg;
-        if (msg.msg instanceof Error) {
+        if (msg.msg instanceof Error || /Error/.test(msg.msg?.__proto__?.name)) {
             msg.format = "error";
-            var errorMsg = {};
-            if (msg.msg.name) {
-                errorMsg.name = msg.msg.name;
+
+            const cause = msg.msg.cause
+            const value = {
+                __enc__: true,
+                type: 'error',
+                data: {
+                    name: msg.msg.name,
+                    message: hasOwnProperty.call(msg.msg, 'message') ? msg.msg.message : msg.msg.toString(),
+                    code: msg.msg.code,
+                    cause: cause + "",
+                    stack: msg.msg.stack,
+                }
             }
-            if (hasOwnProperty.call(msg.msg, 'message')) {
-                errorMsg.message = msg.msg.message;
-            } else {
-                errorMsg.message = msg.msg.toString();
+            // We optimistically added these properties to the object
+            // to ensure they are shown above 'stack'. But we don't want
+            // to include them if they are undefined 
+            if (cause === undefined) {
+                delete value.data.cause
             }
-            msg.msg = JSON.stringify(errorMsg);
+            if (msg.msg.code === undefined) {
+                delete value.data.code
+            }
+            msg.msg = JSON.stringify(value);
         } else if (msg.msg instanceof Buffer) {
             msg.format = "buffer["+msg.msg.length+"]";
             msg.msg = msg.msg.toString('hex');
@@ -857,6 +870,7 @@ function encodeObject(msg,opts) {
                 msg.format = "Object";
             }
             if (/error/i.test(msg.format)) {
+                // TODO: check if this is needed
                 msg.msg = JSON.stringify({
                     name: msg.msg.name,
                     message: msg.msg.message
@@ -904,8 +918,29 @@ function encodeObject(msg,opts) {
                                 __enc__: true,
                                 type: "internal"
                             }
-                        } else if (value instanceof Error) {
-                            value = value.toString()
+                        } else if (value instanceof Error || /Error/.test(value?.__proto__?.name)) {
+                            const cause = value.cause
+                            const code = value.code
+                            value = {
+                                __enc__: true,
+                                type: 'error',
+                                data: {
+                                    name: value.name,
+                                    message: hasOwnProperty.call(value, 'message') ? value.message : value.toString(),
+                                    code,
+                                    cause: cause + "",
+                                    stack: value.stack,
+                                }
+                            }
+                            // We optimistically added these properties to the object
+                            // to ensure they are shown above 'stack'. But we don't want
+                            // to include them if they are undefined 
+                            if (cause === undefined) {
+                                delete value.data.cause
+                            }
+                            if (code === undefined) {
+                                delete value.data.code
+                            }
                         } else if (Array.isArray(value) && value.length > debuglength) {
                             value = {
                                 __enc__: true,
@@ -977,8 +1012,19 @@ function encodeObject(msg,opts) {
                         return value;
                     });
                 } else {
-                    try { msg.msg = msg.msg.toString(); }
-                    catch(e) { msg.msg = "[Type not printable]" + util.inspect(msg.msg); }
+                    try {
+                        msg.msg = msg.msg.toString();
+                    } catch(e) {
+                        msg.msg.format = 'error'
+                        msg.msg = JSON.stringify({
+                            __enc__: true,
+                            type: 'error',
+                            data: {
+                                message: "[Type not serializable]",
+                                stack: e.stack
+                            }
+                        })
+                    }
                 }
             }
         } else if (msgType === "function") {
@@ -1009,17 +1055,14 @@ function encodeObject(msg,opts) {
         return msg;
     } catch(e) {
         msg.format = "error";
-        var errorMsg = {};
-        if (e.name) {
-            errorMsg.name = e.name;
-        }
-        if (hasOwnProperty.call(e, 'message')) {
-            errorMsg.message = 'encodeObject Error: ['+e.message + '] Value: '+util.inspect(msg.msg);
-        } else {
-            errorMsg.message = 'encodeObject Error: ['+e.toString() + '] Value: '+util.inspect(msg.msg);
-        }
-        if (errorMsg.message.length > debuglength) {
-            errorMsg.message = errorMsg.message.substring(0,debuglength);
+        const errorMsg = {
+            __enc__: true,
+            type: 'error',
+            data: {
+                name: e.name,
+                message: 'encodeObject Error: ' + (hasOwnProperty.call(e, 'message') ? e.message : e.toString()),
+                stack: e.stack,
+            }
         }
         msg.msg = JSON.stringify(errorMsg);
         return msg;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/util",
-    "version": "4.0.9",
+    "version": "4.1.0-beta.1",
     "license": "Apache-2.0",
     "repository": {
         "type": "git",
@@ -15,12 +15,13 @@
         }
     ],
     "dependencies": {
-        "fs-extra": "11.2.0",
-        "i18next": "21.10.0",
+        "chalk": "^4.1.2",
+        "fs-extra": "11.3.0",
+        "i18next": "24.2.3",
         "json-stringify-safe": "5.0.1",
-        "jsonata": "2.0.5",
+        "jsonata": "2.0.6",
         "lodash.clonedeep": "^4.5.0",
         "moment": "2.30.1",
-        "moment-timezone": "0.5.46"
+        "moment-timezone": "0.5.48"
     }
 }