Merge pull request #3719 from node-red/pr_3642

Allow flows to be stopped and started manually
2025-03-01 10:36:34 +00:00 · 2022-06-29 20:54:45 +01:00
parent c13d2ac044 1839c1972e
commit 51684d18cf
23 changed files with 565 additions and 71 deletions
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/common/menu.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/common/menu.js
@@ -167,6 +167,9 @@ RED.menu = (function() {
            if (opt.disabled) {
                item.addClass("disabled");
            }
+            if (opt.visible === false) {
+                item.addClass("hide");
+            }
        }


@@ -303,6 +306,14 @@ RED.menu = (function() {
        }
    }

+    function setVisible(id,state) {
+        if (!state) {
+            $("#"+id).parent().addClass("hide");
+        } else {
+            $("#"+id).parent().removeClass("hide");
+        }
+    }
+
    function addItem(id,opt) {
        var item = createMenuItem(opt);
        if (opt !== null && opt.group) {
@@ -359,6 +370,7 @@ RED.menu = (function() {
        isSelected: isSelected,
        toggleSelected: toggleSelected,
        setDisabled: setDisabled,
+        setVisible: setVisible,
        addItem: addItem,
        removeItem: removeItem,
        setAction: setAction,
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/deploy.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/deploy.js
@@ -63,16 +63,18 @@ RED.deploy = (function() {
              '</a>'+
              '<a id="red-ui-header-button-deploy-options" class="red-ui-deploy-button" href="#"><i class="fa fa-caret-down"></i></a>'+
              '</span></li>').prependTo(".red-ui-header-toolbar");
-              RED.menu.init({id:"red-ui-header-button-deploy-options",
-                  options: [
-                      {id:"deploymenu-item-full",toggle:"deploy-type",icon:"red/images/deploy-full.svg",label:RED._("deploy.full"),sublabel:RED._("deploy.fullDesc"),selected: true, onselect:function(s) { if(s){changeDeploymentType("full")}}},
-                      {id:"deploymenu-item-flow",toggle:"deploy-type",icon:"red/images/deploy-flows.svg",label:RED._("deploy.modifiedFlows"),sublabel:RED._("deploy.modifiedFlowsDesc"), onselect:function(s) {if(s){changeDeploymentType("flows")}}},
-                      {id:"deploymenu-item-node",toggle:"deploy-type",icon:"red/images/deploy-nodes.svg",label:RED._("deploy.modifiedNodes"),sublabel:RED._("deploy.modifiedNodesDesc"),onselect:function(s) { if(s){changeDeploymentType("nodes")}}},
-                      null,
-                      {id:"deploymenu-item-reload", icon:"red/images/deploy-reload.svg",label:RED._("deploy.restartFlows"),sublabel:RED._("deploy.restartFlowsDesc"),onselect:"core:restart-flows"},
-
-                  ]
-              });
+            const mainMenuItems = [
+                    {id:"deploymenu-item-full",toggle:"deploy-type",icon:"red/images/deploy-full.svg",label:RED._("deploy.full"),sublabel:RED._("deploy.fullDesc"),selected: true, onselect:function(s) { if(s){changeDeploymentType("full")}}},
+                    {id:"deploymenu-item-flow",toggle:"deploy-type",icon:"red/images/deploy-flows.svg",label:RED._("deploy.modifiedFlows"),sublabel:RED._("deploy.modifiedFlowsDesc"), onselect:function(s) {if(s){changeDeploymentType("flows")}}},
+                    {id:"deploymenu-item-node",toggle:"deploy-type",icon:"red/images/deploy-nodes.svg",label:RED._("deploy.modifiedNodes"),sublabel:RED._("deploy.modifiedNodesDesc"),onselect:function(s) { if(s){changeDeploymentType("nodes")}}},
+                    null
+            ]
+            if (RED.settings.runtimeState && RED.settings.runtimeState.ui === true) {
+                mainMenuItems.push({id:"deploymenu-item-runtime-start", icon:"red/images/start.svg",label:"Start"/*RED._("deploy.startFlows")*/,sublabel:"Start Flows" /*RED._("deploy.startFlowsDesc")*/,onselect:"core:start-flows", visible:false})
+                mainMenuItems.push({id:"deploymenu-item-runtime-stop", icon:"red/images/stop.svg",label:"Stop"/*RED._("deploy.startFlows")*/,sublabel:"Stop Flows" /*RED._("deploy.startFlowsDesc")*/,onselect:"core:stop-flows", visible:false})
+            }
+            mainMenuItems.push({id:"deploymenu-item-reload", icon:"red/images/deploy-reload.svg",label:RED._("deploy.restartFlows"),sublabel:RED._("deploy.restartFlowsDesc"),onselect:"core:restart-flows"})
+            RED.menu.init({id:"red-ui-header-button-deploy-options", options: mainMenuItems });
        } else if (type == "simple") {
            var label = options.label || RED._("deploy.deploy");
            var icon = 'red/images/deploy-full-o.svg';
@@ -100,6 +102,10 @@ RED.deploy = (function() {

        RED.actions.add("core:deploy-flows",save);
        if (type === "default") {
+            if (RED.settings.runtimeState && RED.settings.runtimeState.ui === true) {
+                RED.actions.add("core:stop-flows",function() { stopStartFlows("stop") });
+                RED.actions.add("core:start-flows",function() { stopStartFlows("start") });
+            }
            RED.actions.add("core:restart-flows",restart);
            RED.actions.add("core:set-deploy-type-to-full",function() { RED.menu.setSelected("deploymenu-item-full",true);});
            RED.actions.add("core:set-deploy-type-to-modified-flows",function() { RED.menu.setSelected("deploymenu-item-flow",true); });
@@ -270,18 +276,73 @@ RED.deploy = (function() {
    function sanitize(html) {
        return html.replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;")
    }
-    function restart() {
-        var startTime = Date.now();
-        $(".red-ui-deploy-button-content").css('opacity',0);
-        $(".red-ui-deploy-button-spinner").show();
-        var deployWasEnabled = !$("#red-ui-header-button-deploy").hasClass("disabled");
-        $("#red-ui-header-button-deploy").addClass("disabled");
-        deployInflight = true;
+
+    function shadeShow() {
        $("#red-ui-header-shade").show();
        $("#red-ui-editor-shade").show();
        $("#red-ui-palette-shade").show();
        $("#red-ui-sidebar-shade").show();
-
+    }
+    function shadeHide() {
+        $("#red-ui-header-shade").hide();
+        $("#red-ui-editor-shade").hide();
+        $("#red-ui-palette-shade").hide();
+        $("#red-ui-sidebar-shade").hide();
+    }
+    function deployButtonSetBusy(){
+        $(".red-ui-deploy-button-content").css('opacity',0);
+        $(".red-ui-deploy-button-spinner").show();
+        $("#red-ui-header-button-deploy").addClass("disabled");
+    }
+    function deployButtonClearBusy(){
+        $(".red-ui-deploy-button-content").css('opacity',1);
+        $(".red-ui-deploy-button-spinner").hide();
+    }
+    function stopStartFlows(state) {
+        const startTime = Date.now()
+        const deployWasEnabled = !$("#red-ui-header-button-deploy").hasClass("disabled")
+        deployInflight = true
+        deployButtonSetBusy()
+        shadeShow()
+        $.ajax({
+            url:"flows/state",
+            type: "POST",
+            data: {state: state}
+        }).done(function(data,textStatus,xhr) {
+            if (deployWasEnabled) {
+                $("#red-ui-header-button-deploy").removeClass("disabled")
+            }
+        }).fail(function(xhr,textStatus,err) {
+            if (deployWasEnabled) {
+                $("#red-ui-header-button-deploy").removeClass("disabled")
+            }
+            if (xhr.status === 401) {
+                RED.notify(RED._("notification.error", { message: RED._("user.notAuthorized") }), "error")
+            } else if (xhr.responseText) {
+                const errorDetail = { message: err ? (err + "") : "" }
+                try {
+                    errorDetail.message = JSON.parse(xhr.responseText).message
+                } finally {
+                    errorDetail.message = errorDetail.message || xhr.responseText
+                }
+                RED.notify(RED._("notification.error", errorDetail), "error")
+            } else {
+                RED.notify(RED._("notification.error", { message: RED._("deploy.errors.noResponse") }), "error")
+            }
+        }).always(function() {
+            const delta = Math.max(0, 300 - (Date.now() - startTime))
+            setTimeout(function () {
+                deployButtonClearBusy()
+                shadeHide()
+                deployInflight = false
+            }, delta);
+        });
+    }
+    function restart() {
+        var startTime = Date.now();
+        var deployWasEnabled = !$("#red-ui-header-button-deploy").hasClass("disabled");
+        deployInflight = true;
+        deployButtonSetBusy();
        $.ajax({
            url:"flows",
            type: "POST",
@@ -307,15 +368,10 @@ RED.deploy = (function() {
                RED.notify(RED._("deploy.deployFailed",{message:RED._("deploy.errors.noResponse")}),"error");
            }
        }).always(function() {
-            deployInflight = false;
            var delta = Math.max(0,300-(Date.now()-startTime));
            setTimeout(function() {
-                $(".red-ui-deploy-button-content").css('opacity',1);
-                $(".red-ui-deploy-button-spinner").hide();
-                $("#red-ui-header-shade").hide();
-                $("#red-ui-editor-shade").hide();
-                $("#red-ui-palette-shade").hide();
-                $("#red-ui-sidebar-shade").hide();
+                deployButtonClearBusy();
+                deployInflight = false;
            },delta);
        });
    }
@@ -450,21 +506,14 @@ RED.deploy = (function() {
        const nns = RED.nodes.createCompleteNodeSet();
        const startTime = Date.now();

-        $(".red-ui-deploy-button-content").css('opacity', 0);
-        $(".red-ui-deploy-button-spinner").show();
-        $("#red-ui-header-button-deploy").addClass("disabled");
-
+        deployButtonSetBusy();
        const data = { flows: nns };
-
        if (!force) {
            data.rev = RED.nodes.version();
        }

        deployInflight = true;
-        $("#red-ui-header-shade").show();
-        $("#red-ui-editor-shade").show();
-        $("#red-ui-palette-shade").show();
-        $("#red-ui-sidebar-shade").show();
+        shadeShow();
        $.ajax({
            url: "flows",
            type: "POST",
@@ -550,15 +599,11 @@ RED.deploy = (function() {
                RED.notify(RED._("deploy.deployFailed", { message: RED._("deploy.errors.noResponse") }), "error");
            }
        }).always(function () {
-            deployInflight = false;
            const delta = Math.max(0, 300 - (Date.now() - startTime));
            setTimeout(function () {
-                $(".red-ui-deploy-button-content").css('opacity', 1);
-                $(".red-ui-deploy-button-spinner").hide();
-                $("#red-ui-header-shade").hide();
-                $("#red-ui-editor-shade").hide();
-                $("#red-ui-palette-shade").hide();
-                $("#red-ui-sidebar-shade").hide();
+                deployInflight = false;
+                deployButtonClearBusy()
+                shadeHide()
            }, delta);
        });
    }
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/view.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/view.js
@@ -4877,6 +4877,9 @@ RED.view = (function() {
                        if (d._def.button) {
                            var buttonEnabled = isButtonEnabled(d);
                            this.__buttonGroup__.classList.toggle("red-ui-flow-node-button-disabled", !buttonEnabled);
+                            if (RED.runtime && Object.hasOwn(RED.runtime,'started')) {
+                                this.__buttonGroup__.classList.toggle("red-ui-flow-node-button-stopped", !RED.runtime.started);
+                            }

                            var x = d._def.align == "right"?d.w-6:-25;
                            if (d._def.button.toggle && !d[d._def.button.toggle]) {