From cf84ec78fac706f0aaf788b89684b9cdc9b1c5ff Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Mon, 28 Sep 2020 21:10:23 +0100 Subject: [PATCH] Allow trigger node delay to be overridden with msg.delay --- .../nodes/core/function/89-trigger.html | 13 +++- .../nodes/core/function/89-trigger.js | 11 +++- .../locales/en-US/function/89-trigger.html | 5 +- .../nodes/locales/en-US/messages.json | 1 + test/nodes/core/function/89-trigger_spec.js | 59 +++++++++++++++++++ 5 files changed, 83 insertions(+), 6 deletions(-) diff --git a/packages/node_modules/@node-red/nodes/core/function/89-trigger.html b/packages/node_modules/@node-red/nodes/core/function/89-trigger.html index edbb84e5a..b017dba1b 100644 --- a/packages/node_modules/@node-red/nodes/core/function/89-trigger.html +++ b/packages/node_modules/@node-red/nodes/core/function/89-trigger.html @@ -42,6 +42,10 @@ +
+ + +
@@ -89,6 +93,7 @@ op2type: {value:"val"}, duration: {value:"250",required:true,validate:RED.validators.number()}, extend: {value:"false"}, + overrideDelay: {value:"false"}, units: {value:"ms"}, reset: {value:""}, bytopic: {value:"all"}, @@ -126,7 +131,7 @@ if (this.outputs == 2) { $("#node-input-second").prop('checked', true) } else { $("#node-input-second").prop('checked', false) } - + $("#node-input-second").change(function() { if ($("#node-input-second").is(":checked")) { $("#node-input-outputs").val(2); @@ -208,7 +213,11 @@ } else { $("#node-input-extend").prop("checked",false); } - + if (this.overrideDelay === "true" || this.overrideDelay === true) { + $("#node-input-overrideDelay").prop("checked",true); + } else { + $("#node-input-overrideDelay").prop("checked",false); + } }, oneditsave: function() { if ($("#node-then-type").val() == "block") { diff --git a/packages/node_modules/@node-red/nodes/core/function/89-trigger.js b/packages/node_modules/@node-red/nodes/core/function/89-trigger.js index cda1afadf..478f772e3 100644 --- a/packages/node_modules/@node-red/nodes/core/function/89-trigger.js +++ b/packages/node_modules/@node-red/nodes/core/function/89-trigger.js @@ -48,6 +48,7 @@ module.exports = function(RED) { } } this.extend = n.extend || "false"; + this.overrideDelay = n.overrideDelay || false; this.units = n.units || "ms"; this.reset = n.reset || ''; this.duration = parseFloat(n.duration); @@ -117,12 +118,16 @@ module.exports = function(RED) { var l = Object.keys(node.topics).length; if (l === 0) { return {} } else if (l === 1) { return {fill:"blue",shape:"dot"} } - else return {fill:"blue",shape:"dot",text:l}; + else return {fill:"blue",shape:"dot",text:l}; } var processMessage = function(msg) { var topic = RED.util.getMessageProperty(msg,node.topic) || "_none"; var promise; + var delayDuration = node.duration; + if (node.overrideDelay && msg.hasOwnProperty("delay") && !isNaN(parseFloat(msg.delay))) { + delayDuration = parseFloat(msg.delay); + } if (node.bytopic === "all") { topic = "_none"; } node.topics[topic] = node.topics[topic] || {}; if (msg.hasOwnProperty("reset") || ((node.reset !== '') && msg.hasOwnProperty("payload") && (msg.payload !== null) && msg.payload.toString && (msg.payload.toString() == node.reset)) ) { @@ -217,7 +222,7 @@ module.exports = function(RED) { node.status(stat()); } - }, node.duration); + }, delayDuration); } } node.status(stat()); @@ -262,7 +267,7 @@ module.exports = function(RED) { }).catch(err => { node.error(err); }); - }, node.duration); + }, delayDuration); } // else { // if (node.op2type === "payl") {node.topics[topic].m2 = RED.util.cloneMessage(msg.payload); } diff --git a/packages/node_modules/@node-red/nodes/locales/en-US/function/89-trigger.html b/packages/node_modules/@node-red/nodes/locales/en-US/function/89-trigger.html index 1ba4e53b9..3b5d96604 100644 --- a/packages/node_modules/@node-red/nodes/locales/en-US/function/89-trigger.html +++ b/packages/node_modules/@node-red/nodes/locales/en-US/function/89-trigger.html @@ -19,6 +19,8 @@

Inputs

+
delay number
+
Sets the delay, in milliseconds, to be applied to the message. This option only applies if the node is configured to allow the message to override the configured default delay interval. This does not apply when the node is configured to send at repeated intervals.
reset
If a message is received with this property, any timeout or repeat currently in progress will be cleared and no message triggered.
@@ -35,6 +37,7 @@ act as a watchdog timer; only sending a message if nothing is received within the set interval.

If set to a string type, the node supports the mustache template syntax.

+

The delay between sending messages can be overridden by msg.delay if that option is enabled in the node. The value must be provided in milliseconds.

If the node receives a message with a reset property, or a payload that matches that configured in the node, any timeout or repeat currently in progress will be cleared and no message triggered.

@@ -42,6 +45,6 @@ is reset by a received message.

Optionally, the node can be configured to treat messages as if they are separate streams, using a msg property to identify each stream. Default msg.topic.

-

The status indicates the node is currently active. If multiple streams are used the status +

The status indicates the node is currently active. If multiple streams are used the status indicates the number of streams being held.

diff --git a/packages/node_modules/@node-red/nodes/locales/en-US/messages.json b/packages/node_modules/@node-red/nodes/locales/en-US/messages.json index e6d5da063..eb623ce20 100755 --- a/packages/node_modules/@node-red/nodes/locales/en-US/messages.json +++ b/packages/node_modules/@node-red/nodes/locales/en-US/messages.json @@ -320,6 +320,7 @@ "h": "Hours" }, "extend": " extend delay if new message arrives", + "override": "override delay with msg.delay", "second": " send second message to separate output", "label": { "trigger": "trigger", diff --git a/test/nodes/core/function/89-trigger_spec.js b/test/nodes/core/function/89-trigger_spec.js index 5502796ec..dd77b37d9 100644 --- a/test/nodes/core/function/89-trigger_spec.js +++ b/test/nodes/core/function/89-trigger_spec.js @@ -233,6 +233,65 @@ describe('trigger node', function() { }); }); + it('should ignore msg.delay if overrideDelay not set', function(done) { + var flow = [ + {"id":"n1", "type":"trigger", "name":"triggerNode", duration:"50",wires:[["n2"]] }, + {id:"n2", type:"helper"} + ]; + helper.load(triggerNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + var firstTime; + n2.on("input", function(msg) { + if (c === 0) { + firstTime = Date.now(); + } else if (c === 1) { + try { + var delta = Date.now() - firstTime; + delta.should.be.greaterThan(30); + delta.should.be.lessThan(100); + done(); + } catch(err) { + done(err); + } + } + c++; + }); + n1.emit("input", {payload:null, delay: 300}); + }); + }); + + it('should use msg.delay if overrideDelay is set', function(done) { + var flow = [ + {"id":"n1", "type":"trigger", "name":"triggerNode", overrideDelay: true, duration:"50",wires:[["n2"]] }, + {id:"n2", type:"helper"} + ]; + helper.load(triggerNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + var firstTime; + n2.on("input", function(msg) { + if (c === 0) { + firstTime = Date.now(); + } else if (c === 1) { + try { + var delta = Date.now() - firstTime; + delta.should.be.greaterThan(270); + delta.should.be.lessThan(380); + done(); + } catch(err) { + done(err); + } + } + c++; + }); + n1.emit("input", {payload:null, delay: 300}); + }); + }); + + it('should handle true and false as strings and delay of 0', function(done) { var flow = [{"id":"n1", "type":"trigger", "name":"triggerNode", op1:"true",op1type:"val",op2:"false",op2type:"val",duration:"30", wires:[["n2"]] }, {id:"n2", type:"helper"} ];