@node-red/runtime 2.2.0 → 3.0.0-beta.1

package/lib/api/diagnostics.js

@@ -0,0 +1,202 @@
+
+const os = require('os');
+const fs = require('fs');
+
+let runtime;
+let isContainerCached;
+let isWSLCached;
+
+const isInWsl = () => {
+    if (isWSLCached === undefined) {
+        isWSLCached = getIsInWSL();
+    }
+    return isWSLCached;
+    function getIsInWSL() {
+        if (process.platform !== 'linux') {
+            return false;
+        }
+        try {
+            if (os.release().toLowerCase().includes('microsoft')) {
+                if (isInContainer()) {
+                    return false;
+                }
+                return true;
+            }
+            return fs.readFileSync('/proc/version', 'utf8').toLowerCase().includes('microsoft') ? !isInContainer() : false;
+        } catch (_) {
+            return false;
+        }
+    }
+};
+
+const isInContainer = () => {
+    if (isContainerCached === undefined) {
+        isContainerCached = hasDockerEnv() || hasDockerCGroup();
+    }
+    return isContainerCached;
+    function hasDockerEnv() {
+        try {
+            fs.statSync('/.dockerenv');
+            return true;
+        } catch {
+            return false;
+        }
+    }
+    function hasDockerCGroup() {
+        try {
+            const s = fs.readFileSync('/proc/self/cgroup', 'utf8');
+            if (s.includes('docker')) {
+                return "docker"
+            } else if (s.includes('kubepod')) {
+                return "kubepod"
+            } else if (s.includes('lxc')) {
+                return "lxc"
+            }
+        } catch {
+            return false;
+        }
+    }
+}
+
+function buildDiagnosticReport(scope, callback) {
+    const modules = {};
+    const nl = runtime.nodes.getNodeList();
+    for (let i = 0; i < nl.length; i++) {
+        if (modules[nl[i].module]) {
+            continue;
+        }
+        modules[nl[i].module] = nl[i].version
+    }
+
+    const now = new Date();
+    const {locale, timeZone} = Intl.DateTimeFormat().resolvedOptions();
+    const report = {
+        report: "diagnostics",
+        scope: scope,
+        time: {
+            utc: now.toUTCString(),
+            local: now.toLocaleString(),
+        },
+        intl: {
+            locale, timeZone
+        },
+        nodejs: {
+            version: process.version,
+            arch: process.arch,
+            platform: process.platform,
+            memoryUsage: process.memoryUsage(),
+        },
+        os: {
+            containerised: isInContainer(),
+            wsl: isInWsl(),
+            totalmem: os.totalmem(),
+            freemem: os.freemem(),
+            arch: os.arch(),
+            loadavg: os.loadavg(),
+            platform: os.platform(),
+            release: os.release(),
+            type: os.type(),
+            uptime: os.uptime(),
+            version: os.version(),
+        },
+        runtime: {
+            isStarted: runtime.isStarted(),
+            modules: modules,
+            version: runtime.settings.version,
+            settings: {
+                available: runtime.settings.available(),
+                apiMaxLength: runtime.settings.apiMaxLength || "UNSET",
+                //coreNodesDir: runtime.settings.coreNodesDir,
+                disableEditor: runtime.settings.disableEditor,
+                contextStorage: listContextModules(),
+                debugMaxLength: runtime.settings.debugMaxLength || "UNSET",
+                editorTheme: runtime.settings.editorTheme || "UNSET",
+                flowFile: runtime.settings.flowFile || "UNSET",
+                mqttReconnectTime: runtime.settings.mqttReconnectTime || "UNSET",
+                serialReconnectTime: runtime.settings.serialReconnectTime || "UNSET",
+
+                adminAuth: runtime.settings.adminAuth ? "SET" : "UNSET",
+
+                httpAdminRoot: runtime.settings.httpAdminRoot || "UNSET",
+                httpAdminCors: runtime.settings.httpAdminCors ? "SET" : "UNSET",
+                httpNodeAuth: runtime.settings.httpNodeAuth ? "SET" : "UNSET",
+
+                httpNodeRoot: runtime.settings.httpNodeRoot || "UNSET",
+                httpNodeCors: runtime.settings.httpNodeCors ? "SET" : "UNSET",
+
+                httpStatic: runtime.settings.httpStatic ? "SET" : "UNSET",
+                httpStaticRoot: runtime.settings.httpStaticRoot || "UNSET",
+                httpStaticCors: runtime.settings.httpStaticCors ? "SET" : "UNSET",
+
+                uiHost: runtime.settings.uiHost ? "SET" : "UNSET",
+                uiPort: runtime.settings.uiPort ? "SET" : "UNSET",
+                userDir: runtime.settings.userDir ? "SET" : "UNSET",
+            }
+        }
+    }
+
+    // if (scope == "admin") {
+    //     const moreSettings = {
+    //         adminAuth_type: (runtime.settings.adminAuth && runtime.settings.adminAuth.type) ? runtime.settings.adminAuth.type : "UNSET",
+    //         httpAdminCors: runtime.settings.httpAdminCors ? runtime.settings.httpAdminCors : "UNSET",
+    //         httpNodeCors: runtime.settings.httpNodeCors ? runtime.settings.httpNodeCors : "UNSET",
+    //         httpStaticCors: runtime.settings.httpStaticCors ? "SET" : "UNSET",
+    //         settingsFile: runtime.settings.settingsFile ? runtime.settings.settingsFile : "UNSET",
+    //         uiHost: runtime.settings.uiHost ? runtime.settings.uiHost : "UNSET",
+    //         uiPort: runtime.settings.uiPort ? runtime.settings.uiPort : "UNSET",
+    //         userDir: runtime.settings.userDir ? runtime.settings.userDir : "UNSET",
+    //     }
+    //     const moreNodejs = {
+    //         execPath: process.execPath,
+    //         pid: process.pid,
+    //     }
+    //     const moreOs = {
+    //         cpus: os.cpus(),
+    //         homedir: os.homedir(),
+    //         hostname: os.hostname(),
+    //         networkInterfaces: os.networkInterfaces(),
+    //     }
+    //     report.runtime.settings = Object.assign({}, report.runtime.settings, moreSettings);
+    //     report.nodejs = Object.assign({}, report.nodejs, moreNodejs);
+    //     report.os = Object.assign({}, report.os, moreOs);
+    // }
+
+    callback(report);
+
+    /** gets a sanitised list containing only the module name */
+    function listContextModules() {
+        const keys = Object.keys(runtime.settings.contextStorage);
+        const result = {};
+        keys.forEach(e => {
+            result[e] = {
+                module: String(runtime.settings.contextStorage[e].module)
+            }
+        })
+        return result;
+    }
+}
+
+
+module.exports = {
+    init: function (_runtime) {
+        runtime = _runtime;
+    },
+    /**
+    * Gets the node-red diagnostics report
+    * @param {{scope: string}} opts - settings
+    * @return {Promise} the diagnostics information
+    * @memberof @node-red/diagnostics
+    */
+    get: async function (opts) {
+        return new Promise(function (resolve, reject) {
+            opts = opts || {}
+            try {
+                runtime.log.audit({ event: "diagnostics.get", scope: opts.scope }, opts.req);
+                buildDiagnosticReport(opts.scope, (report) => resolve(report));
+            } catch (error) {
+                error.status = 500;
+                reject(error);
+            }
+        })
+    },
+}

package/lib/api/index.js

@@ -29,6 +29,7 @@ var api = module.exports = {
         api.projects.init(runtime);
         api.context.init(runtime);
         api.plugins.init(runtime);
+        api.diagnostics.init(runtime);
     },
 
     comms: require("./comms"),
@@ -39,6 +40,7 @@ var api = module.exports = {
     projects: require("./projects"),
     context: require("./context"),
     plugins: require("./plugins"),
+    diagnostics: require("./diagnostics"),
 
     isStarted: async function(opts) {
         return runtime.isStarted();

package/lib/api/settings.js

@@ -142,6 +142,13 @@ var api = module.exports = {
             }
 
             safeSettings.flowEncryptionType = runtime.nodes.getCredentialKeyType();
+
+            safeSettings.diagnostics = {
+                //unless diagnostics.ui and diagnostics.enabled are explicitly false, they will default to true.
+                enabled: (runtime.settings.diagnostics && runtime.settings.diagnostics.enabled === false) ? false : true,
+                ui: (runtime.settings.diagnostics && runtime.settings.diagnostics.ui === false) ? false : true
+            }
+
             runtime.settings.exportNodeSettings(safeSettings);
             runtime.plugins.exportPluginSettings(safeSettings);
         }

package/lib/flows/Flow.js

@@ -582,7 +582,7 @@ class Flow {
             reportingNode = node;
         }
         if (!muteStatusEvent) {
-            if (statusMessage.hasOwnProperty("text") && typeof(statusMessage.text !== "string")) {
+            if (statusMessage.hasOwnProperty("text") && typeof statusMessage.text !== "string") {
                 try {
                     statusMessage.text = statusMessage.text.toString();
                 }

package/lib/flows/util.js

@@ -77,15 +77,16 @@ function createNode(flow,config) {
         if (typeof nodeTypeConstructor === "function") {
             var conf = clone(config);
             delete conf.credentials;
-            for (var p in conf) {
-                if (conf.hasOwnProperty(p)) {
-                    mapEnvVarProperties(conf,p,flow,conf);
-                }
-            }
             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 })
+
+                for (var p in conf) {
+                    if (conf.hasOwnProperty(p)) {
+                        mapEnvVarProperties(conf,p,flow,conf);
+                    }
+                }
                 newNode = new nodeTypeConstructor(conf);
             } catch (err) {
                 Log.log({

package/lib/index.js

@@ -207,8 +207,12 @@ function start() {
                 if (settings.readOnly){
                     log.info(log._("settings.readonly-mode"))
                 }
-                if (settings.httpStatic) {
-                    log.info(log._("runtime.paths.httpStatic",{path:path.resolve(settings.httpStatic)}));
+                if (settings.httpStatic && settings.httpStatic.length) {
+                    for (let si = 0; si < settings.httpStatic.length; si++) {
+                        let p = path.resolve(settings.httpStatic[si].path);
+                        let r = settings.httpStatic[si].root || "/";
+                        log.info(log._("runtime.paths.httpStatic",{path:`${p} > ${r}`}));
+                    }
                 }
                 return redNodes.loadContextsPlugin().then(function () {
                     redNodes.loadFlows().then(redNodes.startFlows).catch(function(err) {});
@@ -395,7 +399,12 @@ module.exports = {
     * @memberof @node-red/runtime
     */
     version: externalAPI.version,
-
+    
+    /**
+    * @memberof @node-red/diagnostics
+    */
+    diagnostics:externalAPI.diagnostics,
+    
     storage: storage,
     events: events,
     hooks: hooks,

package/lib/nodes/Node.js

@@ -503,10 +503,25 @@ function log_helper(self, level, msg) {
         o.name = self.name;
     }
     // See https://github.com/node-red/node-red/issues/3327
+    // See https://github.com/node-red/node-red/issues/3389
+
+    let srcError;
+    if (msg instanceof Error) {
+        srcError = msg;//use existing err object for actual stack
+    } else {
+        srcError = new Error(msg);//generate a new error for generate a stack
+    }
     try {
-        self._flow.log(o);
+        if(self instanceof Node && self._flow) {
+            self._flow.log(o);
+        } else {
+            //if self._flow is not present, this is not a node-red Node
+            //Set info to "Node object is not a node-red Node" to point out the `Node type` problem in log
+            logUnexpectedError(self, srcError, "Node object is not a node-red Node")
+        }
     } catch(err) {
-        logUnexpectedError(self, err)
+        //build an unexpected error report indicating using the original error (for better stack trace)
+        logUnexpectedError(self, srcError, `An error occured attempting to make a log entry: ${err}`)
     }
 }
 /**
@@ -531,7 +546,7 @@ Node.prototype.error = function(logMessage,msg) {
         logMessage = logMessage || "";
     }
     var handled = false;
-    if (msg && typeof msg === 'object') {
+    if (this._flow && msg && typeof msg === 'object') {
         handled = this._flow.handleError(this,logMessage,msg);
     }
     if (!handled) {
@@ -619,27 +634,34 @@ function inspectObject(flow) {
     }
 }
 
-function logUnexpectedError(node, error) {
-    let moduleInfo = node._module?`${node._module.module}@${node._module.version}`:"undefined"
-    Log.error(`
+function logUnexpectedError(node, error, info) {
+    const header = `
 ********************************************************************
 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'}
+********************************************************************`;
 
+    const footer = `
 Please report this issue, including the information logged above:
 https://github.com/node-red/node-red/issues/
-********************************************************************
-`)
+********************************************************************`;
+
+    let detail = [`Info:\n ${info || 'No additional info'}`];
+
+    //Include Error info?
+    if(error && error.stack){
+        detail.push(`Stack:\n ${error.stack}`)
+    }
+    //Include Node info?
+    if(node && (node._module || node.type)){
+        const moduleInfo = node._module?`${node._module.module}@${node._module.version}`:"undefined";
+        const id = node._alias||node.id||"undefined";
+        detail.push(`Node:\n Type: ${node.type}\n Module: ${moduleInfo}\n ID: ${id}\n Properties:\n  ${inspectObject(node)}`)
+    }
+    //Include Flow info?
+    if(node && node._flow){
+        detail.push(`Flow: ${node._flow.path}\n Type: ${node._flow.TYPE}\n Properties:\n  ${inspectObject(node._flow)}`)
+    }
+    Log.error(`${header}\n${detail.join("\n")}\n${footer}`);
 }
 
 module.exports = Node;

package/lib/nodes/credentials.js

@@ -239,7 +239,15 @@ var api = module.exports = {
                     throw error;
                 }
             } else {
-                credentialCache = credentials;
+                if (encryptionEnabled) {
+                    // Our config expects the credentials to be encrypted but the encrypted object is not found
+                    log.warn(log._("nodes.credentials.encryptedNotFound"))
+                    credentialCache = credentials;
+                } else {
+                    // credentialSecret is set to False
+                    log.warn(log._("nodes.credentials.unencrypted"))
+                    credentialCache = credentials;
+                }
             }
             if (clearInvalidFlag) {
                 // TODO: this delves too deep into Project structure

package/locales/en-US/runtime.json

@@ -104,7 +104,9 @@
             "error":"Error loading credentials: __message__",
             "error-saving":"Error saving credentials: __message__",
             "not-registered": "Credential type '__type__' is not registered",
-            "system-key-warning": "\n\n---------------------------------------------------------------------\nYour flow credentials file is encrypted using a system-generated key.\n\nIf the system-generated key is lost for any reason, your credentials\nfile will not be recoverable, you will have to delete it and re-enter\nyour credentials.\n\nYou should set your own key using the 'credentialSecret' option in\nyour settings file. Node-RED will then re-encrypt your credentials\nfile using your chosen key the next time you deploy a change.\n---------------------------------------------------------------------\n"
+            "system-key-warning": "\n\n---------------------------------------------------------------------\nYour flow credentials file is encrypted using a system-generated key.\n\nIf the system-generated key is lost for any reason, your credentials\nfile will not be recoverable, you will have to delete it and re-enter\nyour credentials.\n\nYou should set your own key using the 'credentialSecret' option in\nyour settings file. Node-RED will then re-encrypt your credentials\nfile using your chosen key the next time you deploy a change.\n---------------------------------------------------------------------\n",
+            "unencrypted" : "Using unencrypted credentials",
+            "encryptedNotFound" : "Encrypted credentials not found"
         },
         "flows": {
             "safe-mode": "Flows stopped in safe mode. Deploy to start.",

package/package.json

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