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

package/lib/api/diagnostics.js

@@ -165,7 +165,7 @@ function buildDiagnosticReport(scope, callback) {
 
     /** gets a sanitised list containing only the module name */
     function listContextModules() {
-        const keys = Object.keys(runtime.settings.contextStorage);
+        const keys = Object.keys(runtime.settings.contextStorage || {});
         const result = {};
         keys.forEach(e => {
             result[e] = {

package/lib/api/flows.js

@@ -255,5 +255,82 @@ var api = module.exports = {
             }
         }
         return sendCredentials;
-    }
+    },
+    /**
+    * Gets running state of runtime flows
+    * @param {Object} opts
+    * @param {User} opts.user - the user calling the api
+    * @param {Object} opts.req - the request to log (optional)
+    * @return {{state:string, started:boolean}} - the current run state of the flows
+    * @memberof @node-red/runtime_flows
+    */
+    getState: async function(opts) {
+        runtime.log.audit({event: "flows.getState"}, opts.req);
+        const result = {
+            state: runtime.flows.state()
+        }
+        return result;
+    },
+    /**
+    * Sets running state of runtime flows
+    * @param {Object} opts
+    * @param {Object} opts.req - the request to log (optional)
+    * @param {User} opts.user - the user calling the api
+    * @param {string} opts.state - the requested state. Valid values are "start" and "stop".
+    * @return {Promise<Flow>} - the active flow configuration
+    * @memberof @node-red/runtime_flows
+    */
+    setState: async function(opts) {
+        opts = opts || {};
+        const makeError = (error, errcode, statusCode) => {
+            const message = typeof error == "object" ? error.message : error
+            const err = typeof error == "object" ? error : new Error(message||"Unexpected Error")
+            err.status = err.status || statusCode || 400;
+            err.code = err.code || errcode || "unexpected_error"
+            runtime.log.audit({
+                event: "flows.setState",
+                state: opts.state || "",
+                error: errcode || "unexpected_error",
+                message: err.code
+            }, opts.req);
+            return err
+        }
+
+        const getState = () => {
+            return {
+                state: runtime.flows.state()
+            }
+        }
+
+        if(!runtime.settings.runtimeState || runtime.settings.runtimeState.enabled !== true) {
+            throw (makeError("Method Not Allowed", "not_allowed", 405))
+        }
+        switch (opts.state) {
+            case "start":
+                try {
+                    try {
+                        runtime.settings.set('runtimeFlowState', opts.state);
+                    } catch(err) {}
+                    if (runtime.settings.safeMode) {
+                        delete runtime.settings.safeMode
+                    }
+                    await runtime.flows.startFlows("full")
+                    return getState()
+                } catch (err) {
+                    throw (makeError(err, err.code, 500))
+                }
+            case "stop":
+                try {
+                    try {
+                        runtime.settings.set('runtimeFlowState', opts.state);
+                    } catch(err) {}
+                    await runtime.flows.stopFlows("full")
+                    return getState()
+                } catch (err) {
+                    throw (makeError(err, err.code, 500))
+                }
+            default:
+                throw (makeError(`Cannot change flows runtime state to '${opts.state}'}`, "invalid_run_state", 400))
+        }
+    },
 }

package/lib/api/settings.js

@@ -91,7 +91,7 @@ var api = module.exports = {
             safeSettings.context = runtime.nodes.listContextStores();
             if (runtime.settings.editorTheme && runtime.settings.editorTheme.codeEditor) {
                 safeSettings.codeEditor = runtime.settings.editorTheme.codeEditor || {};
-                safeSettings.codeEditor.lib = safeSettings.codeEditor.lib || "ace";
+                safeSettings.codeEditor.lib = safeSettings.codeEditor.lib || "monaco";
                 safeSettings.codeEditor.options = safeSettings.codeEditor.options || {};
             }
             safeSettings.libraries = runtime.library.getLibraries();
@@ -148,6 +148,18 @@ var api = module.exports = {
                 enabled: (runtime.settings.diagnostics && runtime.settings.diagnostics.enabled === false) ? false : true,
                 ui: (runtime.settings.diagnostics && runtime.settings.diagnostics.ui === false) ? false : true
             }
+            if(safeSettings.diagnostics.enabled === false) {
+                safeSettings.diagnostics.ui = false; // cannot have UI without endpoint
+            }
+
+            safeSettings.runtimeState = {
+                //unless runtimeState.ui and runtimeState.enabled are explicitly true, they will default to false.
+                enabled: !!runtime.settings.runtimeState && runtime.settings.runtimeState.enabled === true,
+                ui: !!runtime.settings.runtimeState && runtime.settings.runtimeState.ui === true
+            }
+            if(safeSettings.runtimeState.enabled !== true) {
+                safeSettings.runtimeState.ui = false; // cannot have UI without endpoint
+            }
 
             runtime.settings.exportNodeSettings(safeSettings);
             runtime.plugins.exportPluginSettings(safeSettings);

package/lib/flows/index.js

@@ -36,6 +36,8 @@ var activeFlowConfig = null;
 
 var activeFlows = {};
 var started = false;
+var state = 'stop'
+
 var credentialsPendingReset = false;
 
 var activeNodesToFlow = {};
@@ -50,6 +52,7 @@ function init(runtime) {
     storage = runtime.storage;
     log = runtime.log;
     started = false;
+    state = 'stop';
     if (!typeEventRegistered) {
         events.on('type-registered',function(type) {
             if (activeFlowConfig && activeFlowConfig.missingTypes.length > 0) {
@@ -214,19 +217,26 @@ function setFlows(_config,_credentials,type,muteLog,forceStart,user) {
             // Flows are running (or should be)
 
             // Stop the active flows (according to deploy type and the diff)
-            return stop(type,diff,muteLog).then(() => {
+            return stop(type,diff,muteLog,true).then(() => {
                 // Once stopped, allow context to remove anything no longer needed
                 return context.clean(activeFlowConfig)
             }).then(() => {
+                if (!isLoad) {
+                    log.info(log._("nodes.flows.updated-flows"));
+                }
                 // Start the active flows
-                start(type,diff,muteLog).then(() => {
+                start(type,diff,muteLog,true).then(() => {
                     events.emit("runtime-event",{id:"runtime-deploy",payload:{revision:flowRevision},retain: true});
                 });
                 // Return the new revision asynchronously to the actual start
                 return flowRevision;
             }).catch(function(err) { })
         } else {
+            if (!isLoad) {
+                log.info(log._("nodes.flows.updated-flows"));
+            }
             events.emit("runtime-event",{id:"runtime-deploy",payload:{revision:flowRevision},retain: true});
+            return flowRevision;
         }
     });
 }
@@ -259,9 +269,10 @@ function getFlows() {
     return activeConfig;
 }
 
-async function start(type,diff,muteLog) {
-    type = type||"full";
+async function start(type,diff,muteLog,isDeploy) {
+    type = type || "full";
     started = true;
+    state = 'start'
     var i;
     // If there are missing types, report them, emit the necessary runtime event and return
     if (activeFlowConfig.missingTypes.length > 0) {
@@ -283,7 +294,7 @@ async function start(type,diff,muteLog) {
             log.info(log._("nodes.flows.missing-type-install-2"));
             log.info("  "+settings.userDir);
         }
-        events.emit("runtime-event",{id:"runtime-state",payload:{error:"missing-types", type:"warning",text:"notification.warnings.missing-types",types:activeFlowConfig.missingTypes},retain:true});
+        events.emit("runtime-event",{id:"runtime-state",payload:{state: 'stop', error:"missing-types", type:"warning",text:"notification.warnings.missing-types",types:activeFlowConfig.missingTypes},retain:true});
         return;
     }
 
@@ -297,7 +308,7 @@ async function start(type,diff,muteLog) {
             missingModules.push({module:err[i].module.module, error: err[i].error.code || err[i].error.toString()})
             log.info(` - ${err[i].module.spec} [${err[i].error.code || "unknown_error"}]`);
         }
-        events.emit("runtime-event",{id:"runtime-state",payload:{error:"missing-modules", type:"warning",text:"notification.warnings.missing-modules",modules:missingModules},retain:true});
+        events.emit("runtime-event",{id:"runtime-state",payload:{state: 'stop', error:"missing-modules", type:"warning",text:"notification.warnings.missing-modules",modules:missingModules},retain:true});
         return;
     }
 
@@ -306,10 +317,23 @@ async function start(type,diff,muteLog) {
         log.info("*****************************************************************")
         log.info(log._("nodes.flows.safe-mode"));
         log.info("*****************************************************************")
-        events.emit("runtime-event",{id:"runtime-state",payload:{error:"safe-mode", type:"warning",text:"notification.warnings.safe-mode"},retain:true});
+        state = 'safe'
+        events.emit("runtime-event",{id:"runtime-state",payload:{state: 'safe', error:"safe-mode", type:"warning",text:"notification.warnings.safe-mode"},retain:true});
         return;
     }
 
+    let runtimeState
+    try {
+        runtimeState = settings.get('runtimeFlowState') || 'start'
+    } catch (err) {}
+    if (runtimeState === 'stop') {
+        log.info(log._("nodes.flows.stopped-flows"));
+        events.emit("runtime-event",{id:"runtime-state",payload:{ state: 'stop', deploy:isDeploy },retain:true});
+        state = 'stop'
+        started = false
+        return
+    }
+
     if (!muteLog) {
         if (type !== "full") {
             log.info(log._("nodes.flows.starting-modified-"+type));
@@ -364,12 +388,10 @@ async function start(type,diff,muteLog) {
             }
         }
     }
-    // Having created or updated all flows, now start them.
     for (id in activeFlows) {
         if (activeFlows.hasOwnProperty(id)) {
             try {
                 activeFlows[id].start(diff);
-
                 // Create a map of node id to flow id and also a subflowInstance lookup map
                 var activeNodes = activeFlows[id].getActiveNodes();
                 Object.keys(activeNodes).forEach(function(nid) {
@@ -387,7 +409,7 @@ async function start(type,diff,muteLog) {
     if (credentialsPendingReset === true) {
         credentialsPendingReset = false;
     } else {
-        events.emit("runtime-event",{id:"runtime-state",retain:true});
+        events.emit("runtime-event",{id:"runtime-state", payload:{ state: 'start', deploy:isDeploy}, retain:true});
     }
 
     if (!muteLog) {
@@ -400,7 +422,7 @@ async function start(type,diff,muteLog) {
     return;
 }
 
-function stop(type,diff,muteLog) {
+function stop(type,diff,muteLog,isDeploy) {
     if (!started) {
         return Promise.resolve();
     }
@@ -420,6 +442,7 @@ function stop(type,diff,muteLog) {
         }
     }
     started = false;
+    state = 'stop'
     var promises = [];
     var stopList;
     var removedList = diff.removed;
@@ -471,6 +494,8 @@ function stop(type,diff,muteLog) {
             }
         }
         events.emit("flows:stopped",{config: activeConfig, type: type, diff: diff});
+
+        events.emit("runtime-event",{ id:"runtime-state", payload:{ state: 'stop', deploy:isDeploy }, retain:true });
         // Deprecated event
         events.emit("nodes-stopped");
     });
@@ -790,7 +815,7 @@ module.exports = {
     stopFlows: stop,
 
     get started() { return started },
-
+    state: () => { return state },
     // handleError: handleError,
     // handleStatus: handleStatus,
 

package/lib/index.js

@@ -215,7 +215,7 @@ function start() {
                     }
                 }
                 return redNodes.loadContextsPlugin().then(function () {
-                    redNodes.loadFlows().then(redNodes.startFlows).catch(function(err) {});
+                    redNodes.loadFlows().then(() => { redNodes.startFlows() }).catch(function(err) {});
                     started = true;
                 });
             });
@@ -399,12 +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/locales/en-US/runtime.json

@@ -8,7 +8,6 @@
             "httpStatic": "HTTP Static    : __path__"
         }
     },
-
     "server": {
         "loading": "Loading palette nodes",
         "palette-editor": {
@@ -61,7 +60,6 @@
             "function-required": "httpsRefreshInterval requires https property to be a function"
         }
     },
-
     "api": {
         "flows": {
             "error-save": "Error saving flows: __message__",
@@ -79,18 +77,16 @@
             "error-enable": "Failed to enable node:"
         }
     },
-
     "comms": {
         "error": "Communication channel error: __message__",
         "error-server": "Communication server error: __message__",
         "error-send": "Communication send error: __message__"
     },
-
     "settings": {
         "user-not-available": "Cannot save user settings: __message__",
         "not-available": "Settings not available",
         "property-read-only": "Property '__prop__' is read-only",
-        "readonly-mode" : "Runtime in read-only mode. Changes will not be saved."
+        "readonly-mode": "Runtime in read-only mode. Changes will not be saved."
     },
     "library": {
         "unknownLibrary": "Unknown library: __library__",
@@ -101,12 +97,12 @@
     },
     "nodes": {
         "credentials": {
-            "error":"Error loading credentials: __message__",
-            "error-saving":"Error saving credentials: __message__",
+            "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",
-            "unencrypted" : "Using unencrypted credentials",
-            "encryptedNotFound" : "Encrypted credentials not found"
+            "unencrypted": "Using unencrypted credentials",
+            "encryptedNotFound": "Encrypted credentials not found"
         },
         "flows": {
             "safe-mode": "Flows stopped in safe mode. Deploy to start.",
@@ -126,6 +122,7 @@
             "stopped-flows": "Stopped flows",
             "stopped": "Stopped",
             "stopping-error": "Error stopping node: __message__",
+            "updated-flows": "Updated flows",
             "added-flow": "Adding flow: __label__",
             "updated-flow": "Updated flow: __label__",
             "removed-flow": "Removed flow: __label__",
@@ -150,7 +147,6 @@
             }
         }
     },
-
     "storage": {
         "index": {
             "forbidden-flow-name": "forbidden flow name"
@@ -180,7 +176,6 @@
             }
         }
     },
-
     "context": {
         "log-store-init": "Context store  : '__name__' [__info__]",
         "error-loading-module": "Error loading context store: __message__",
@@ -195,5 +190,4 @@
             "error-write": "Error writing context: __message__"
         }
     }
-
 }

package/locales/ja/runtime.json

@@ -100,7 +100,9 @@
             "error": "クレデンシャルの読み込みエラー: __message__",
             "error-saving": "クレデンシャルの保存エラー: __message__",
             "not-registered": "クレデンシャル '__type__' は登録されていません",
-            "system-key-warning": "\n\n---------------------------------------------------------------------\nフローのクレデンシャルファイルはシステム生成キーで暗号化されています。\n\nシステム生成キーを何らかの理由で失った場合、クレデンシャルファイルを\n復元することはできません。その場合、ファイルを削除してクレデンシャルを\n再入力しなければなりません。\n\n設定ファイル内で 'credentialSecret' オプションを使って独自キーを設定\nします。変更を次にデプロイする際、Node-REDは選択したキーを用いてクレ\nデンシャルを再暗号化します。 \n\n---------------------------------------------------------------------\n"
+            "system-key-warning": "\n\n---------------------------------------------------------------------\nフローのクレデンシャルファイルはシステム生成キーで暗号化されています。\n\nシステム生成キーを何らかの理由で失った場合、クレデンシャルファイルを\n復元することはできません。その場合、ファイルを削除してクレデンシャルを\n再入力しなければなりません。\n\n設定ファイル内で 'credentialSecret' オプションを使って独自キーを設定\nします。変更を次にデプロイする際、Node-REDは選択したキーを用いてクレ\nデンシャルを再暗号化します。 \n\n---------------------------------------------------------------------\n",
+            "unencrypted": "暗号化されていないクレデンシャルを使用",
+            "encryptedNotFound": "暗号化されたクレデンシャルが存在しません"
         },
         "flows": {
             "safe-mode": "セーフモードでフローを停止しました。開始するためにはデプロイしてください",

package/package.json

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