Skip to content

Commit

Permalink
Support stop msg for daemon node (#1018)
Browse files Browse the repository at this point in the history
* add msg.stop handler and docs, msg.start restarts process as per existing doc

* stop process using configured signal

* fix grunt complaint

* remove extra debug, make start only start and change doc to match
  • Loading branch information
gmarzot committed Aug 5, 2023
1 parent 74aeb2d commit b6f5ea8
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 9 deletions.
4 changes: 3 additions & 1 deletion utility/daemon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ to restart the command automatically.

Setting `msg.kill` to a signal name (e.g. SIGINT, SIGHUP) will stop the process - but if the restart flag is set it will then auto restart.

Sending `msg.start` will also re-start the process. Additional arguments can be specified in `msg.args`.
Sending `msg.start` will start the process, if not already running. Additional arguments can be specified in `msg.args`.

Sending `msg.stop` will stop the process and prevent automatic re-start until reset with `msg.start`.

**Note:** Some applications will automatically buffer lines of output. It is advisable to turn off this behaviour.
For example, if running a Python app, the `-u` parameter will stop the output being buffered.
Expand Down
28 changes: 20 additions & 8 deletions utility/daemon/daemon.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module.exports = function(RED) {
this.op = n.op;
this.redo = n.redo;
this.running = false;
this.stopped = false;
this.closer = n.closer || "SIGKILL";
this.autorun = true;
if (n.autorun === false) { this.autorun = false; }
Expand All @@ -32,16 +33,26 @@ module.exports = function(RED) {

function inputlistener(msg) {
if (msg != null) {
if (msg.hasOwnProperty("kill") && node.running) {
if (msg.hasOwnProperty("stop")) {
node.stopped = true;
if (node.running) {
node.child.kill(node.closer);
}
node.status({fill:"grey",shape:"ring",text:RED._("daemon.status.stopped")});
}
else if (msg.hasOwnProperty("kill") && node.running) {
if (typeof msg.kill !== "string" || msg.kill.length === 0 || !msg.kill.toUpperCase().startsWith("SIG") ) { msg.kill = "SIGINT"; }
node.child.kill(msg.kill.toUpperCase());
}
else if (msg.hasOwnProperty("start") && !node.running) {
let args = "";
if (msg.hasOwnProperty("args") && msg.args.length > 0) {
args = parseArgs(msg.args.trim());
else if (msg.hasOwnProperty("start")) {
if (!node.running) {
let args = "";
if (msg.hasOwnProperty("args") && msg.args.length > 0) {
args = parseArgs(msg.args.trim());
}
runit(args);
}
runit(args);
node.stopped = false;
}
else {
if (!Buffer.isBuffer(msg.payload)) {
Expand Down Expand Up @@ -111,7 +122,8 @@ module.exports = function(RED) {
var rc = code;
if (code === null) { rc = signal; }
node.send([null,null,{payload:rc}]);
node.status({fill:"red",shape:"ring",text:RED._("daemon.status.stopped")});
const color = node.stopped ? "grey" : "red";
node.status({fill:color,shape:"ring",text:RED._("daemon.status.stopped")});
});

node.child.on('error', function (err) {
Expand All @@ -138,7 +150,7 @@ module.exports = function(RED) {

if (node.redo === true) {
var loop = setInterval( function() {
if (!node.running) {
if (!node.running && !node.stopped) {
node.warn(RED._("daemon.errors.restarting") + " : " + node.cmd);
runit();
}
Expand Down

0 comments on commit b6f5ea8

Please sign in to comment.