Allow nodes to return additional history entries in onEditSave

Pass full error object in Function node and copy over cause property

CHANGELOG.md

@@ -1,3 +1,10 @@
+#### 3.1.9: Maintenance Release
+
+ - Prevent subflow being added to itself (#4654) @knolleary
+ - Fix use of spawn on windows with cmd files (#4652) @knolleary
+ - Guard refresh of unknown subflow (#4640) @knolleary
+ - Fix subflow module sending messages to debug sidebar (#4642) @knolleary
+
 #### 3.1.8: Maintenance Release
 
  - Add validation and error handling on subflow instance properties (#4632) @knolleary

package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "description": "Low-code programming for event-driven applications",
     "homepage": "https://nodered.org",
     "license": "Apache-2.0",
@@ -74,7 +74,7 @@
         "passport-oauth2-client-password": "0.1.2",
         "raw-body": "2.5.2",
         "semver": "7.5.4",
-        "tar": "6.1.13",
+        "tar": "6.2.1",
         "tough-cookie": "4.1.3",
         "uglify-js": "3.17.4",
         "uuid": "9.0.0",

packages/node_modules/@node-red/editor-api/lib/auth/index.js

@@ -205,9 +205,10 @@ function genericStrategy(adminApp,strategy) {
     passport.use(new strategy.strategy(options, verify));
 
     adminApp.get('/auth/strategy',
-        passport.authenticate(strategy.name, {session:false,
+        passport.authenticate(strategy.name, {
+            session:false,
             failureMessage: true,
-            failureRedirect: settings.httpAdminRoot
+            failureRedirect: settings.httpAdminRoot + '?session_message=Login Failed'
         }),
         completeGenerateStrategyAuth,
         handleStrategyError
@@ -221,7 +222,7 @@ function genericStrategy(adminApp,strategy) {
         passport.authenticate(strategy.name, {
             session:false,
             failureMessage: true,
-            failureRedirect: settings.httpAdminRoot
+            failureRedirect: settings.httpAdminRoot + '?session_message=Login Failed'
         }),
         completeGenerateStrategyAuth,
         handleStrategyError

packages/node_modules/@node-red/editor-api/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/editor-api",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "license": "Apache-2.0",
     "main": "./lib/index.js",
     "repository": {
@@ -16,8 +16,8 @@
         }
     ],
     "dependencies": {
-        "@node-red/util": "3.1.8",
-        "@node-red/editor-client": "3.1.8",
+        "@node-red/util": "3.1.9",
+        "@node-red/editor-client": "3.1.9",
         "bcryptjs": "2.4.3",
         "body-parser": "1.20.2",
         "clone": "2.1.2",

packages/node_modules/@node-red/editor-client/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/editor-client",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "license": "Apache-2.0",
     "repository": {
         "type": "git",

packages/node_modules/@node-red/editor-client/src/js/ui/deploy.js

@@ -612,7 +612,10 @@ RED.deploy = (function() {
                 }
             });
             RED.nodes.eachSubflow(function (subflow) {
+                if (subflow.changed) {
                     subflow.changed = false;
+                    RED.events.emit("subflows:change", subflow);
+                }
             });
             RED.nodes.eachWorkspace(function (ws) {
                 if (ws.changed || ws.added) {

packages/node_modules/@node-red/editor-client/src/js/ui/editor.js

@@ -741,9 +741,16 @@ RED.editor = (function() {
             }
 
             try {
-                var rc = editing_node._def.oneditsave.call(editing_node);
+                const rc = editing_node._def.oneditsave.call(editing_node);
                 if (rc === true) {
                     editState.changed = true;
+                } else if (typeof rc === 'object' && rc !== null ) {
+                    if (rc.changed === true) {
+                        editState.changed = true
+                    }
+                    if (Array.isArray(rc.history) && rc.history.length > 0) {
+                        editState.history = rc.history
+                    }
                 }
             } catch(err) {
                 console.warn("oneditsave",editing_node.id,editing_node.type,err.toString());
@@ -1015,7 +1022,7 @@ RED.editor = (function() {
                                     }
                                 });
                             }
-                            var historyEvent = {
+                            let historyEvent = {
                                 t:'edit',
                                 node:editing_node,
                                 changes:editState.changes,
@@ -1031,6 +1038,15 @@ RED.editor = (function() {
                                     instances:subflowInstances
                                 }
                             }
+
+                            if (editState.history) {
+                                historyEvent = {
+                                    t: 'multi',
+                                    events: [ historyEvent, ...editState.history ],
+                                    dirty: wasDirty
+                                }
+                            }
+
                             RED.history.push(historyEvent);
                         }
                         editing_node.dirty = true;
@@ -1623,8 +1639,8 @@ RED.editor = (function() {
                         }
 
                         if (!isSameObj(old_env, new_env)) {
-                            editing_node.env = new_env;
                             editState.changes.env = editing_node.env;
+                            editing_node.env = new_env;
                             editState.changed = true;
                         }
 

packages/node_modules/@node-red/editor-client/src/js/ui/editors/code-editors/monaco.js

@@ -514,7 +514,7 @@ RED.editor.codeEditor.monaco = (function() {
                 _monaco.languages.json.jsonDefaults.setDiagnosticsOptions(diagnosticOptions);
                 if(modeConfiguration) { _monaco.languages.json.jsonDefaults.setModeConfiguration(modeConfiguration); }
             } catch (error) {
-                console.warn("monaco - Error setting up json options", err)
+                console.warn("monaco - Error setting up json options", error)
             }
         }
 
@@ -526,7 +526,7 @@ RED.editor.codeEditor.monaco = (function() {
                 if(htmlDefaults) { _monaco.languages.html.htmlDefaults.setOptions(htmlDefaults); }
                 if(handlebarDefaults) { _monaco.languages.html.handlebarDefaults.setOptions(handlebarDefaults); }
             } catch (error) {
-                console.warn("monaco - Error setting up html options", err)
+                console.warn("monaco - Error setting up html options", error)
             }
         }
 
@@ -546,7 +546,7 @@ RED.editor.codeEditor.monaco = (function() {
                 if(lessDefaults_modeConfiguration) { _monaco.languages.css.cssDefaults.setDiagnosticsOptions(lessDefaults_modeConfiguration); }
                 if(scssDefaults_modeConfiguration) { _monaco.languages.css.cssDefaults.setDiagnosticsOptions(scssDefaults_modeConfiguration); }
             } catch (error) {
-                console.warn("monaco - Error setting up CSS/SCSS/LESS options", err)
+                console.warn("monaco - Error setting up CSS/SCSS/LESS options", error)
             }
         }
 

packages/node_modules/@node-red/editor-client/src/js/ui/tab-help.js

@@ -158,9 +158,11 @@ RED.sidebar.help = (function() {
 
     function refreshSubflow(sf) {
         var item = treeList.treeList('get',"node-type:subflow:"+sf.id);
+        if (item) {
             item.subflowLabel = sf._def.label().toLowerCase();
             item.treeList.replaceElement(getNodeLabel({_def:sf._def,type:sf._def.label()}));
         }
+    }
 
     function hideTOC() {
         var tocButton = $('#red-ui-sidebar-help-show-toc')

packages/node_modules/@node-red/editor-client/src/js/ui/view.js

@@ -646,6 +646,7 @@ RED.view = (function() {
                 }
                 d3.event = event;
                 var selected_tool = $(ui.draggable[0]).attr("data-palette-type");
+                try {
                     var result = createNode(selected_tool);
                     if (!result) {
                         return;
@@ -761,6 +762,13 @@ RED.view = (function() {
                     if (nn._def.autoedit) {
                         RED.editor.edit(nn);
                     }
+                } catch (error) {
+                    if (error.code != "NODE_RED") {
+                        RED.notify(RED._("notification.error",{message:error.toString()}),"error");
+                    } else {
+                        RED.notify(RED._("notification.error",{message:error.message}),"error");
+                    }
+                }
             }
         });
         chart.on("focus", function() {
@@ -6063,14 +6071,19 @@ RED.view = (function() {
      function createNode(type, x, y, z) {
         const wasDirty = RED.nodes.dirty()
         var m = /^subflow:(.+)$/.exec(type);
-        var activeSubflow = z ? RED.nodes.subflow(z) : null;
+        var activeSubflow = (z || RED.workspaces.active()) ? RED.nodes.subflow(z || RED.workspaces.active()) : null;
+
         if (activeSubflow && m) {
             var subflowId = m[1];
+            let err
             if (subflowId === activeSubflow.id) {
-                throw new Error(RED._("notification.error", { message: RED._("notification.errors.cannotAddSubflowToItself") }))
+                err = new Error(RED._("notification.errors.cannotAddSubflowToItself"))
+            } else if (RED.nodes.subflowContains(m[1], activeSubflow.id)) {
+                err = new Error(RED._("notification.errors.cannotAddCircularReference"))
             }
-            if (RED.nodes.subflowContains(m[1], activeSubflow.id)) {
-                throw new Error(RED._("notification.error", { message: RED._("notification.errors.cannotAddCircularReference") }))
+            if (err) {
+                err.code = 'NODE_RED'
+                throw err
             }
         }
 

packages/node_modules/@node-red/nodes/core/common/21-debug.html

@@ -378,7 +378,7 @@
                             return { id: id, label: RED.nodes.workspace(id).label } //flow id + name
                         } else {
                             const instanceNode = RED.nodes.node(id)
-                            const pathLabel = (instanceNode.name || RED.nodes.subflow(instanceNode.type.substring(8)).name)
+                            const pathLabel = (instanceNode.name || RED.nodes.subflow(instanceNode.type.substring(8))?.name || instanceNode.type)
                             return { id: id, label: pathLabel }
                         }
                     })

packages/node_modules/@node-red/nodes/core/common/60-link.html

@@ -194,27 +194,46 @@
                 nodeMap[node.links[i]].new = true;
             }
         }
-        var n;
-        for (var id in nodeMap) {
+
+        let editHistories = []
+        let n;
+        for (let id in nodeMap) {
             if (nodeMap.hasOwnProperty(id)) {
                 n = RED.nodes.node(id);
                 if (n) {
+                    editHistories.push({
+                        t:'edit',
+                        node: n,
+                        changes: {
+                            links: [...n.links]
+                        },
+                        changed: n.changed
+                    })
                     if (nodeMap[id].old && !nodeMap[id].new) {
                         // Removed id
                         i = n.links.indexOf(node.id);
                         if (i > -1) {
                             n.links.splice(i,1);
+                            n.changed = true
+                            n.dirty = true
                         }
                     } else if (!nodeMap[id].old && nodeMap[id].new) {
                         // Added id
                         i = n.links.indexOf(id);
                         if (i === -1) {
                             n.links.push(node.id);
+                            n.changed = true
+                            n.dirty = true
                         }
                     }
                 }
             }
         }
+        if (editHistories.length > 0) {
+            return {
+                history: editHistories
+            }
+        }
     }
 
     function onAdd() {
@@ -254,13 +273,14 @@
             onEditPrepare(this,"link out");
         },
         oneditsave: function() {
-            onEditSave(this);
+            const result = onEditSave(this);
             // In case the name has changed, ensure any link call nodes on this
             // tab are redrawn with the updated name
             var localCallNodes = RED.nodes.filterNodes({z:RED.workspaces.active(), type:"link call"});
             localCallNodes.forEach(function(node) {
                 node.dirty = true;
             });
+            return result
         },
         onadd: onAdd,
         oneditresize: resizeNodeList
@@ -329,7 +349,7 @@
             onEditPrepare(this,"link in");
         },
         oneditsave: function() {
-            onEditSave(this);
+            return onEditSave(this);
         },
         oneditresize: resizeNodeList
     });
@@ -373,7 +393,7 @@
 
         },
         oneditsave: function() {
-            onEditSave(this);
+            return onEditSave(this);
         },
         onadd: onAdd,
         oneditresize: resizeNodeList

packages/node_modules/@node-red/nodes/core/function/10-function.js

@@ -374,7 +374,7 @@ module.exports = function(RED) {
                         iniOpt.breakOnSigint = true;
                     }
                 }
-                node.script = vm.createScript(functionText, createVMOpt(node, ""));
+                node.script = new vm.Script(functionText, createVMOpt(node, ""));
                 if (node.fin && (node.fin !== "")) {
                     var finText = `(function () {
                         var node = {
@@ -438,10 +438,9 @@ module.exports = function(RED) {
 
                             //store the error in msg to be used in flows
                             msg.error = err;
-
-                            var line = 0;
-                            var errorMessage;
                             if (stack.length > 0) {
+                                let line = 0;
+                                let errorMessage;
                                 while (line < stack.length && stack[line].indexOf("ReferenceError") !== 0) {
                                     line++;
                                 }
@@ -455,11 +454,13 @@ module.exports = function(RED) {
                                         errorMessage += " (line "+lineno+", col "+cha+")";
                                     }
                                 }
+                                if (errorMessage) {
+                                    err.message = errorMessage
                                 }
-                            if (!errorMessage) {
-                                errorMessage = err.toString();
                             }
-                            done(errorMessage);
+                            // Pass the whole error object so any additional properties
+                            // (such as cause) are preserved
+                            done(err);
                         }
                         else if (typeof err === "string") {
                             done(err);

packages/node_modules/@node-red/nodes/core/function/90-exec.js

@@ -20,6 +20,7 @@ module.exports = function(RED) {
     var exec = require('child_process').exec;
     var fs = require('fs');
     var isUtf8 = require('is-utf8');
+    const isWindows = process.platform === 'win32'
 
     function ExecNode(n) {
         RED.nodes.createNode(this,n);
@@ -85,9 +86,12 @@ module.exports = function(RED) {
                         }
                     });
                     var cmd = arg.shift();
+                    // Since 18.20.2/20.12.2, it is invalid to call spawn on Windows with a .bat/.cmd file
+                    // without using shell: true. 
+                    const opts = isWindows ? { ...node.spawnOpt, shell: true } : node.spawnOpt
                     /* istanbul ignore else  */
                     node.debug(cmd+" ["+arg+"]");
-                    child = spawn(cmd,arg,node.spawnOpt);
+                    child = spawn(cmd,arg,opts);
                     node.status({fill:"blue",shape:"dot",text:"pid:"+child.pid});
                     var unknownCommand = (child.pid === undefined);
                     if (node.timer !== 0) {

packages/node_modules/@node-red/nodes/locales/en-US/sequence/17-split.html

@@ -103,7 +103,7 @@
     <h4>Automatic mode</h4>
     <p>Automatic mode uses the <code>parts</code> property of incoming messages to
        determine how the sequence should be joined. This allows it to automatically
-       reverse the action of a <b>split</b> node.
+       reverse the action of a <b>split</b> node.</p>
 
     <h4>Manual mode</h4>
     <p>When configured to join in manual mode, the node is able to join sequences

packages/node_modules/@node-red/nodes/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/nodes",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "license": "Apache-2.0",
     "repository": {
         "type": "git",

packages/node_modules/@node-red/registry/lib/externalModules.js

@@ -273,7 +273,7 @@ async function installModule(moduleDetails) {
                 let extraArgs = triggerPayload.args || [];
                 let args = ['install', ...extraArgs, installSpec]
                 log.trace(NPM_COMMAND + JSON.stringify(args));
-                return exec.run(NPM_COMMAND, args, { cwd: installDir },true)
+                return exec.run(NPM_COMMAND, args, { cwd: installDir, shell: true },true)
             } else {
                 log.trace("skipping npm install");
             }

packages/node_modules/@node-red/registry/lib/installer.js

@@ -25,12 +25,15 @@ const registryUtil = require("./util");
 const library = require("./library");
 const {exec,log,events,hooks} = require("@node-red/util");
 const child_process = require('child_process');
-const npmCommand = process.platform === 'win32' ? 'npm.cmd' : 'npm';
-let installerEnabled = false;
 
+const isWindows = process.platform === 'win32'
+const npmCommand =  isWindows ? 'npm.cmd' : 'npm';
+
+let installerEnabled = false;
 let settings;
+
 const moduleRe = /^(@[^/@]+?[/])?[^/@]+?$/;
-const slashRe = process.platform === "win32" ? /\\|[/]/ : /[/]/;
+const slashRe = isWindows ? /\\|[/]/ : /[/]/;
 const pkgurlRe = /^(https?|git(|\+https?|\+ssh|\+file)):\/\//;
 const localtgzRe = /^([a-zA-Z]:|\/).+tgz$/;
 
@@ -225,7 +228,7 @@ async function installModule(module,version,url) {
                 let extraArgs = triggerPayload.args || [];
                 let args = ['install', ...extraArgs, installName]
                 log.trace(npmCommand + JSON.stringify(args));
-                return exec.run(npmCommand,args,{ cwd: installDir}, true)
+                return exec.run(npmCommand,args,{ cwd: installDir, shell: true }, true)
             } else {
                 log.trace("skipping npm install");
             }
@@ -260,7 +263,7 @@ async function installModule(module,version,url) {
                 log.warn("------------------------------------------");
                 e = new Error(log._("server.install.install-failed")+": "+err.toString());
                 if (err.hook === "postInstall") {
-                    return exec.run(npmCommand,["remove",module],{ cwd: installDir}, false).finally(() => {
+                    return exec.run(npmCommand,["remove",module],{ cwd: installDir, shell: true }, false).finally(() => {
                         throw e;
                     })
                 }
@@ -356,7 +359,7 @@ async function getModuleVersionFromNPM(module, version) {
     }
 
     return new Promise((resolve, reject) => {
-        child_process.execFile(npmCommand,['info','--json',installName],function(err,stdout,stderr) {
+        child_process.execFile(npmCommand,['info','--json',installName],{ shell: true },function(err,stdout,stderr) {
             try {
                 if (!stdout) {
                     log.warn(log._("server.install.install-failed-not-found",{name:module}));
@@ -511,7 +514,7 @@ function uninstallModule(module) {
                     let extraArgs = triggerPayload.args || [];
                     let args = ['remove', ...extraArgs, module]
                     log.trace(npmCommand + JSON.stringify(args));
-                    return exec.run(npmCommand,args,{ cwd: installDir}, true)
+                    return exec.run(npmCommand,args,{ cwd: installDir, shell: true }, true)
                 } else {
                     log.trace("skipping npm uninstall");
                 }
@@ -578,7 +581,7 @@ async function checkPrereq() {
         installerEnabled = false;
     } else {
         return new Promise(resolve => {
-            child_process.execFile(npmCommand,['-v'],function(err,stdout) {
+            child_process.execFile(npmCommand,['-v'],{ shell: true },function(err,stdout) {
                 if (err) {
                     log.info(log._("server.palette-editor.npm-not-found"));
                     installerEnabled = false;

packages/node_modules/@node-red/registry/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/registry",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "license": "Apache-2.0",
     "main": "./lib/index.js",
     "repository": {
@@ -16,11 +16,11 @@
         }
     ],
     "dependencies": {
-        "@node-red/util": "3.1.8",
+        "@node-red/util": "3.1.9",
         "clone": "2.1.2",
         "fs-extra": "11.1.1",
         "semver": "7.5.4",
-        "tar": "6.1.13",
+        "tar": "6.2.1",
         "uglify-js": "3.17.4"
     }
 }

packages/node_modules/@node-red/runtime/lib/flows/Flow.js

@@ -678,6 +678,9 @@ class Flow {
                 if (logMessage.hasOwnProperty('stack')) {
                     errorMessage.error.stack = logMessage.stack;
                 }
+                if (logMessage.hasOwnProperty('cause')) {
+                    errorMessage.error.cause = logMessage.cause;
+                }
                 targetCatchNode.receive(errorMessage);
                 handled = true;
             });

packages/node_modules/@node-red/runtime/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/runtime",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "license": "Apache-2.0",
     "main": "./lib/index.js",
     "repository": {
@@ -16,8 +16,8 @@
         }
     ],
     "dependencies": {
-        "@node-red/registry": "3.1.8",
-        "@node-red/util": "3.1.8",
+        "@node-red/registry": "3.1.9",
+        "@node-red/util": "3.1.9",
         "async-mutex": "0.4.0",
         "clone": "2.1.2",
         "express": "4.19.2",

packages/node_modules/@node-red/util/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/util",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "license": "Apache-2.0",
     "repository": {
         "type": "git",

packages/node_modules/node-red/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red",
-    "version": "3.1.8",
+    "version": "3.1.9",
     "description": "Low-code programming for event-driven applications",
     "homepage": "https://nodered.org",
     "license": "Apache-2.0",
@@ -31,10 +31,10 @@
         "flow"
     ],
     "dependencies": {
-        "@node-red/editor-api": "3.1.8",
-        "@node-red/runtime": "3.1.8",
-        "@node-red/util": "3.1.8",
-        "@node-red/nodes": "3.1.8",
+        "@node-red/editor-api": "3.1.9",
+        "@node-red/runtime": "3.1.9",
+        "@node-red/util": "3.1.9",
+        "@node-red/nodes": "3.1.9",
         "basic-auth": "2.0.1",
         "bcryptjs": "2.4.3",
         "express": "4.19.2",

test/nodes/core/function/10-function_spec.js

@@ -390,7 +390,8 @@ describe('function node', function() {
                     msg.should.have.property('level', helper.log().ERROR);
                     msg.should.have.property('id', 'n1');
                     msg.should.have.property('type', 'function');
-                    msg.should.have.property('msg', 'ReferenceError: retunr is not defined (line 2, col 1)');
+                    msg.should.have.property('msg')
+                    msg.msg.message.should.equal('ReferenceError: retunr is not defined (line 2, col 1)');
                     done();
                 } catch(err) {
                     done(err);
@@ -659,7 +660,8 @@ describe('function node', function() {
                 msg.should.have.property('level', helper.log().ERROR);
                 msg.should.have.property('id', name);
                 msg.should.have.property('type', 'function');
-                msg.should.have.property('msg', 'Error: Callback must be a function');
+                msg.should.have.property('msg')
+                msg.msg.message.should.equal('Callback must be a function');
                 done();
             }
             catch (e) {