@node-red/runtime 2.1.4 → 2.2.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright JS Foundation and other contributors, http://js.foundation
+Copyright OpenJS Foundation and other contributors, https://openjsf.org/
 
                                  Apache License
                            Version 2.0, January 2004

package/lib/api/projects.js

@@ -99,6 +99,7 @@ var api = module.exports = {
     * @param {Object} opts
     * @param {User} opts.user - the user calling the api
     * @param {String} opts.id - the id of the project to activate
+    * @param {boolean} opts.clearContext - whether to clear context
     * @param {Object} opts.req - the request to log (optional)
     * @return {Promise<Object>} - resolves when complete
     * @memberof @node-red/runtime_projects
@@ -107,7 +108,7 @@ var api = module.exports = {
         var currentProject = runtime.storage.projects.getActiveProject(opts.user);
         runtime.log.audit({event: "projects.set",id:opts.id}, opts.req);
         if (!currentProject || opts.id !== currentProject.name) {
-            return runtime.storage.projects.setActiveProject(opts.user, opts.id);
+            return runtime.storage.projects.setActiveProject(opts.user, opts.id, opts.clearContext);
         }
     },
 

package/lib/flows/Flow.js

@@ -424,6 +424,17 @@ class Flow {
      */
     getGroupEnvSetting(node, group, name) {
         if (group) {
+            if (name === "NR_GROUP_NAME") {
+                return [{
+                    val: group.name
+                }, null];
+            }
+            if (name === "NR_GROUP_ID") {
+                return [{
+                    val: group.id
+                }, null];
+            }
+
             if (group.credentials === undefined) {
                 group.credentials = credentials.get(group.id) || {};
             }
@@ -498,7 +509,13 @@ class Flow {
      * @return {[type]}     [description]
      */
     getSetting(key) {
-        const flow = this.flow; 
+        const flow = this.flow;
+        if (key === "NR_FLOW_NAME") {
+            return flow.label;
+        }
+        if (key === "NR_FLOW_ID") {
+            return flow.id;
+        }
         if (flow.credentials === undefined) {
             flow.credentials = credentials.get(flow.id) || {};
         }

package/lib/flows/Subflow.js

@@ -371,6 +371,17 @@ class Subflow extends Flow {
             name = name.substring(8);
         }
         const node = this.subflowInstance;
+        if (node) {
+            if (name === "NR_NODE_NAME") {
+                return node.name;
+            }
+            if (name === "NR_NODE_ID") {
+                return node.id;
+            }
+            if (name === "NR_NODE_PATH") {
+                return node._path;
+            }
+        }
         if (node.g) {
             const group = this.getGroupNode(node.g);
             const [result, newName] = this.getGroupEnvSetting(node, group, name);

package/lib/flows/util.js

@@ -83,7 +83,9 @@ function createNode(flow,config) {
                 }
             }
             try {
+                Object.defineProperty(conf,'_module', {value: typeRegistry.getNodeInfo(type), enumerable: false, writable: true })
                 Object.defineProperty(conf,'_flow', {value: flow, enumerable: false, writable: true })
+                Object.defineProperty(conf,'_path', {value: `${flow.path}/${config._alias||config.id}`, enumerable: false, writable: true })
                 newNode = new nodeTypeConstructor(conf);
             } catch (err) {
                 Log.log({

package/lib/nodes/Node.js

@@ -59,6 +59,12 @@ function Node(n) {
         // which we can tolerate as they are the same object.
         Object.defineProperty(this,'_flow', {value: n._flow, enumerable: false, writable: true })
     }
+    if (n._module) {
+        Object.defineProperty(this,'_module', {value: n._module, enumerable: false, writable: true })
+    }
+    if (n._path) {
+        Object.defineProperty(this,'_path', {value: n._path, enumerable: false, writable: true })
+    }
     this.updateWires(n.wires);
 }
 
@@ -496,7 +502,12 @@ function log_helper(self, level, msg) {
     if (self.name) {
         o.name = self.name;
     }
-    self._flow.log(o);
+    // See https://github.com/node-red/node-red/issues/3327
+    try {
+        self._flow.log(o);
+    } catch(err) {
+        logUnexpectedError(self, err)
+    }
 }
 /**
  * Log an INFO level message
@@ -576,4 +587,59 @@ Node.prototype.status = function(status) {
     this._flow.handleStatus(this,status);
 };
 
+
+function inspectObject(flow) {
+    try {
+        let properties = new Set()
+        let currentObj = flow
+        do {
+            if (!Object.getPrototypeOf(currentObj)) { break }
+            Object.getOwnPropertyNames(currentObj).map(item => properties.add(item))
+        } while ((currentObj = Object.getPrototypeOf(currentObj)))
+        let propList = [...properties.keys()].map(item => `${item}[${(typeof flow[item])[0]}]`)
+        propList.sort();
+        let result = [];
+        let line = "";
+        while (propList.length > 0) {
+            let prop = propList.shift()
+            if (line.length+prop.length > 80) {
+                result.push(line)
+                line = "";
+            } else {
+                line += " "+prop
+            }
+        }
+        if (line.length > 0) {
+            result.push(line);
+        }
+        return result.join("\n  ")
+
+    } catch(err) {
+        return "Failed to capture object properties: "+err.toString()
+    }
+}
+
+function logUnexpectedError(node, error) {
+    let moduleInfo = node._module?`${node._module.module}@${node._module.version}`:"undefined"
+    Log.error(`
+********************************************************************
+Unexpected Node Error
+${error.stack}
+Node:
+ Type: ${node.type}
+ Module: ${moduleInfo}
+ ID: ${node._alias||node.id}
+ Properties:
+  ${inspectObject(node)}
+Flow: ${node._flow?node._flow.path:'undefined'}
+ Type: ${node._flow?node._flow.TYPE:'undefined'}
+ Properties:
+  ${node._flow?inspectObject(node._flow):'undefined'}
+
+Please report this issue, including the information logged above:
+https://github.com/node-red/node-red/issues/
+********************************************************************
+`)
+}
+
 module.exports = Node;

package/lib/nodes/context/index.js

@@ -14,30 +14,30 @@
  * limitations under the License.
  **/
 
-var clone = require("clone");
-var log = require("@node-red/util").log;
-var util = require("@node-red/util").util;
-var memory = require("./memory");
+const clone = require("clone");
+const log = require("@node-red/util").log;
+const util = require("@node-red/util").util;
+const memory = require("./memory");
 
-var settings;
+let settings;
 
 // A map of scope id to context instance
-var contexts = {};
+let contexts = {};
 
 // A map of store name to instance
-var stores = {};
-var storeList = [];
-var defaultStore;
+let stores = {};
+let storeList = [];
+let defaultStore;
 
 // Whether there context storage has been configured or left as default
-var hasConfiguredStore = false;
+let hasConfiguredStore = false;
 
 // Unknown Stores
-var unknownStores = {};
+let unknownStores = {};
 
 function logUnknownStore(name) {
     if (name) {
-        var count = unknownStores[name] || 0;
+        let count = unknownStores[name] || 0;
         if (count == 0) {
             log.warn(log._("context.unknown-store", {name: name}));
             count++;
@@ -52,8 +52,8 @@ function init(_settings) {
     stores = {};
     storeList = [];
     hasConfiguredStore = false;
-    var seed = settings.functionGlobalContext || {};
-    contexts['global'] = createContext("global",seed);
+    initialiseGlobalContext();
+
     // create a default memory store - used by the unit tests that skip the full
     // `load()` initialisation sequence.
     // If the user has any stores configured, this will be disgarded
@@ -61,6 +61,11 @@ function init(_settings) {
     defaultStore = "memory";
 }
 
+function initialiseGlobalContext() {
+    const seed = settings.functionGlobalContext || {};
+    contexts['global'] = createContext("global",seed);
+}
+
 function load() {
     return new Promise(function(resolve,reject) {
         // load & init plugins in settings.contextStorage
@@ -233,12 +238,15 @@ function validateContextKey(key) {
 
 function createContext(id,seed,parent) {
     // Seed is only set for global context - sourced from functionGlobalContext
-    var scope = id;
-    var obj = seed || {};
-    var seedKeys;
-    var insertSeedValues;
+    const scope = id;
+    const obj = {};
+    let seedKeys;
+    let insertSeedValues;
     if (seed) {
         seedKeys = Object.keys(seed);
+        seedKeys.forEach(key => {
+            obj[key] = seed[key];
+        })
         insertSeedValues = function(keys,values) {
             if (!Array.isArray(keys)) {
                 if (values[0] === undefined) {
@@ -540,8 +548,28 @@ function getContext(nodeId, flowId) {
     return newContext;
 }
 
+/**
+ * Delete the context of the given node/flow/global
+ *
+ * If the user has configured a context store, this
+ * will no-op a request to delete node/flow context.
+ */
 function deleteContext(id,flowId) {
-    if(!hasConfiguredStore){
+    if (id === "global") {
+        // 1. delete global from all configured stores
+        var promises = [];
+        for(var plugin in stores){
+            if(stores.hasOwnProperty(plugin)){
+                promises.push(stores[plugin].delete('global'));
+            }
+        }
+        return Promise.all(promises).then(function() {
+            // 2. delete global context
+            delete contexts['global'];
+            // 3. reinitialise global context
+            initialiseGlobalContext();
+        })
+    } else if (!hasConfiguredStore) {
         // only delete context if there's no configured storage.
         var contextId = id;
         if (flowId) {
@@ -549,12 +577,19 @@ function deleteContext(id,flowId) {
         }
         delete contexts[contextId];
         return stores["_"].delete(contextId);
-    }else{
+    } else {
         return Promise.resolve();
     }
 }
 
+/**
+ * Delete any contexts that are no longer in use
+ * @param flowConfig object includes allNodes as object of id->node
+ *
+ * If flowConfig is undefined, all flow/node contexts will be removed
+ **/
 function clean(flowConfig) {
+    flowConfig = flowConfig || { allNodes: {} };
     var promises = [];
     for(var plugin in stores){
         if(stores.hasOwnProperty(plugin)){
@@ -572,6 +607,16 @@ function clean(flowConfig) {
     return Promise.all(promises);
 }
 
+/**
+ * Deletes all contexts, including global and reinitialises global to
+ * initial state.
+ */
+function clear() {
+    return clean().then(function() {
+        return deleteContext('global')
+    })
+}
+
 function close() {
     var promises = [];
     for(var plugin in stores){
@@ -594,5 +639,6 @@ module.exports = {
     getFlowContext:getFlowContext,
     delete: deleteContext,
     clean: clean,
+    clear: clear,
     close: close
 };

package/lib/nodes/index.js

@@ -206,6 +206,7 @@ module.exports = {
     eachNode: flows.eachNode,
     getContext: context.get,
 
+    clearContext: context.clear,
 
     installerEnabled: registry.installerEnabled,
     installModule: installModule,

package/lib/storage/localfilesystem/projects/index.js

@@ -377,8 +377,17 @@ function getActiveProject(user) {
     return activeProject;
 }
 
-function reloadActiveProject(action) {
+function reloadActiveProject(action, clearContext) {
+    // Stop the current flows
     return runtime.nodes.stopFlows().then(function() {
+        if (clearContext) {
+            // Reset context to remove any old values
+            return runtime.nodes.clearContext()
+        } else {
+            return Promise.resolve()
+        }
+    }).then(function() {
+        // Load the new project flows and start them
         return runtime.nodes.loadFlows(true).then(function() {
             events.emit("runtime-event",{id:"project-update", payload:{ project: activeProject.name, action:action}});
         }).catch(function(err) {
@@ -387,6 +396,9 @@ function reloadActiveProject(action) {
             events.emit("runtime-event",{id:"project-update", payload:{ project: activeProject.name, action:action}});
             throw err;
         });
+    }).catch(function(err) {
+        console.log(err.stack);
+        throw err;
     });
 }
 function createProject(user, metadata) {
@@ -424,7 +436,7 @@ function createProject(user, metadata) {
         return getProject(user, metadata.name);
     })
 }
-function setActiveProject(user, projectName) {
+function setActiveProject(user, projectName, clearContext) {
     return loadProject(projectName).then(function(project) {
         var globalProjectSettings = settings.get("projects")||{};
         globalProjectSettings.activeProject = project.name;
@@ -434,7 +446,7 @@ function setActiveProject(user, projectName) {
             // console.log("Updated file targets to");
             // console.log(flowsFullPath)
             // console.log(credentialsFile)
-            return reloadActiveProject("loaded");
+            return reloadActiveProject("loaded", clearContext);
         })
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/runtime",
-    "version": "2.1.4",
+    "version": "2.2.0",
     "license": "Apache-2.0",
     "main": "./lib/index.js",
     "repository": {
@@ -16,11 +16,11 @@
         }
     ],
     "dependencies": {
-        "@node-red/registry": "2.1.4",
-        "@node-red/util": "2.1.4",
+        "@node-red/registry": "2.2.0",
+        "@node-red/util": "2.2.0",
         "async-mutex": "0.3.2",
         "clone": "2.1.2",
-        "express": "4.17.1",
+        "express": "4.17.2",
         "fs-extra": "10.0.0",
         "json-stringify-safe": "5.0.1"
     }