frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Update Join node implementation

Browse Source
This commit is contained in:
Nick O'Leary 2016-06-09 11:33:40 +01:00
parent e97d9fb0b2
commit fd66569950
2 changed files with 111 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
nodes/core/logic/17-split.html
View File

@ -27,15 +27,13 @@
</script> </script>
<script type="text/x-red" data-help-name="split"> <script type="text/x-red" data-help-name="split">
<p>A function that splits the <code>msg.payload</code> in various ways to create multiple messages out.</p> <p>A function that splits <code>msg.payload</code> into multiple messages.</p>
<p><ul> <p>The behaviour is determined by the type of <code>msg.payload</code>:</p>
<li>splits an <b>array</b> into individual messages, one element per message.</li> <ul>
<li>splits a <b>string</b> on a character - default is <code>""</code>, split on every character. A typical <li><b>string</b> - a message is sent for each part of the string after it is split using the specified character, by default a newline (<code>\n</code>).
use would be <code>\n</code> to split on line breaks. Split is actually a regex value so use <code>\.</code> to <li><b>array</b> - a message is sent for each element of the array</li>
split on a full stop .</li> <li><b>object</b> - a message is sent for each key/value pair of the object. <code>msg.parts.key</code> is set to the key of the property.</li>
<li>splits an <b>object</b> into individual messages, promoting each property value to the <code>msg.payload</code>, </ul>
and saving each property key name as <code>msg.parts.key</code>.
</ul></p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

215
nodes/core/logic/17-split.js
View File

@ -19,8 +19,7 @@ module.exports = function(RED) {
function SplitNode(n) { function SplitNode(n) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
this.splt = n.splt || ""; this.splt = (n.splt || "\\n").replace(/\\n/,"\n").replace(/\\r/,"\r").replace(/\\t/,"\t").replace(/\\e/,"\e").replace(/\\f/,"\f").replace(/\\0/,"\0");
this.split = new RegExp(this.splt);
var node = this; var node = this;
this.on("input", function(msg) { this.on("input", function(msg) {
if (msg.hasOwnProperty("payload")) { if (msg.hasOwnProperty("payload")) {
@ -29,7 +28,7 @@ module.exports = function(RED) {
else { msg.parts = {}; } else { msg.parts = {}; }
msg.parts.id = msg._msgid; // use the existing _msgid by default. msg.parts.id = msg._msgid; // use the existing _msgid by default.
if (typeof msg.payload === "string") { // Split String into array if (typeof msg.payload === "string") { // Split String into array
a = msg.payload.split(node.split); a = msg.payload.split(node.splt);
msg.parts.ch = node.splt; // pass the split char to other end for rejoin msg.parts.ch = node.splt; // pass the split char to other end for rejoin
msg.parts.type = "string"; msg.parts.type = "string";
} }
@ -68,59 +67,43 @@ module.exports = function(RED) {
function JoinNode(n) { function JoinNode(n) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
this.mode = n.mode||"auto";
this.property = n.property||"payload"; this.property = n.property||"payload";
this.propertyType = n.propertyType||"msg"; this.propertyType = n.propertyType||"msg";
this.key = n.key||"topic"; this.key = n.key||"topic";
this.timer = Number(n.timeout || 0); this.timer = (this.mode === "auto") ? 0 : Number(n.timeout || 0);
this.timerr = n.timerr || "send"; this.timerr = n.timerr || "send";
this.count = Number(n.count || 0); this.count = Number(n.count || 0);
this.joiner = n.joiner; this.joiner = (n.joiner||"").replace(/\\n/g,"\n").replace(/\\r/g,"\r").replace(/\\t/g,"\t").replace(/\\e/g,"\e").replace(/\\f/g,"\f").replace(/\\0/g,"\0");
this.build = n.build || "array"; this.build = n.build || "array";
var node = this; var node = this;
var inflight = {}; var inflight = {};
var misc = (this.build === "array") ? [] : {};
var tout;
// if array came from a string then reassemble it and send it var completeSend = function(partId) {
var sendIt = function(m) { var group = inflight[partId];
if (inflight[m.parts.id].ch !== undefined) { // if it was a string - rejoin it using the split char clearTimeout(group.timeout);
var jc = (node.joiner || inflight[m.parts.id].ch).replace(/\\n/,"\n").replace(/\\r/,"\r").replace(/\\t/,"\t").replace(/\\e/,"\e").replace(/\\f/,"\c").replace(/\\0/,"\0"); delete inflight[partId];
m.payload = inflight[m.parts.id].a.join(jc);
} else { // leave it as an array
m.payload = inflight[m.parts.id].a;
}
m._msgid = m.parts.id;
clearTimeout(inflight[m.parts.id].timeout); // unset any timer
delete inflight[m.parts.id]; // remove from the keep track object
if (m.parts.hasOwnProperty("parts")) {
m.parts = m.parts.parts; // pop existing parts
}
else { delete m.parts; } // remove the parts flags
node.send(m);
}
// check all elements of the array are strings (or claim to be). if (group.type === 'string') {
var onlyString = function(a) { // check if the array is all strings group.msg.payload = group.payload.join(group.joinChar);
for (var i = 0; i < a.length; i++) { } else {
if (typeof a[i] !== "string") { return false; } group.msg.payload = group.payload;
} }
return true; if (group.msg.hasOwnProperty('parts') && group.msg.parts.hasOwnProperty('parts')) {
} group.msg.parts = group.msg.parts;
} else {
// send array of misc message that arrived. (convert to string if all were strings and need joining) delete group.msg.parts;
var sendMisc = function(m) {
if (tout) { clearTimeout(tout); tout = null; }
m.payload = misc;
if (node.joiner && onlyString(misc)) { // if the array is all strings and there is a join char set
m.payload = misc.join(node.joiner.replace(/\\n/,"\n").replace(/\\r/,"\r").replace(/\\t/,"\t").replace(/\\e/,"\e").replace(/\\f/,"\c").replace(/\\0/,"\0"));
} }
if (node.build === "array") { misc = []; } node.send(group.msg);
else if (node.build === "object") { misc = {}; }
node.send(m);
} }
this.on("input", function(msg) { this.on("input", function(msg) {
try {
var property; var property;
if (node.mode === 'auto' && (!msg.hasOwnProperty("parts")||!msg.parts.hasOwnProperty("id"))) {
// TODO: log warning - no msg.parts in auto mode, ignoring
return;
}
if (node.propertyType == "full") { if (node.propertyType == "full") {
property = msg; property = msg;
} else { } else {
@ -131,85 +114,95 @@ module.exports = function(RED) {
return; return;
} }
} }
if (msg.hasOwnProperty("parts")) {
// only act if it has parts var partId;
var count = node.count || msg.parts.count || 1; var payloadType;
if (msg.parts.hasOwnProperty("index")) { var propertyKey;
// it's a numbered part (from a split node) var targetCount;
if (!inflight[msg.parts.id]) { var joinChar;
// New message - create new empty array of correct size var propertyIndex;
if (msg.parts.type === "object") { if (node.mode === "auto") {
inflight[msg.parts.id] = {i:0, a:{}, c:msg.parts.count, ch:msg.parts.ch, t:msg.parts.type}; // Use msg.parts to identify all of the group information
} else { partId = msg.parts.id;
// it's an array or string payloadType = msg.parts.type;
inflight[msg.parts.id] = {i:0, a:new Array(msg.parts.count), ch:msg.parts.ch, t:msg.parts.type}; targetCount = msg.parts.count;
} joinChar = msg.parts.ch;
if (node.timer !== 0) { // If there is a timer to set start it now propertyKey = msg.parts.key;
inflight[msg.parts.id].timeout = setTimeout(function() { propertyIndex = msg.parts.index;
if (node.timerr === "send") { sendIt(msg); }
else if (node.timerr === "error") { node.error("Incomplete",msg); }
delete inflight[msg.parts.id];
}, node.timer);
}
}
if (msg.parts.type === "object") {
// Add to the tracking array
inflight[msg.parts.id].a[msg.parts.key] = property;
inflight[msg.parts.id].i = Object.keys(inflight[msg.parts.id].a).length;
} else {
// it's an array or string
// Add to the tracking array
inflight[msg.parts.id].a[msg.parts.index] = property;
// Increment the count
inflight[msg.parts.id].i += 1;
}
if (inflight[msg.parts.id].i >= count) {
// All arrived - send
sendIt(msg);
}
} // otherwise ignore it
if (msg.hasOwnProperty("complete")) { // if set then send right away anyway...
delete(msg.complete);
sendIt(msg);
}
} else { } else {
// The case for any messages arriving without parts - ie random messages you want to join. // Use the node configuration to identify all of the group information
var l; partId = "_";
if (node.build === "array" || node.build === "string") { payloadType = node.build;
// simple case of build the array targetCount = node.count;
// Add the payload to an array joinChar = node.joiner;
misc.push(property); if (targetCount === 0 && msg.hasOwnProperty('parts')) {
l = misc.length; targetCount = msg.parts.count || 0;
} else {
// OK so let's build an object
if (msg.hasOwnProperty(node.key) && msg[node.key] !== "") {
misc[msg[node.key]] = property;
}
l = Object.keys(misc).length;
} }
if (l >= node.count) { if (node.build === 'object') {
// if it's long enough send it propertyKey = RED.util.getMessageProperty(msg,node.key);
sendMisc(msg);
} else if (msg.hasOwnProperty("complete")) {
// if set then send right away anyway...
delete(msg.complete);
sendMisc(msg);
} else if ((node.timer !== 0) && !tout) {
// if not start the timer if there is one.
tout = setTimeout(function() {
if (node.timerr === "send") { sendMisc(msg); }
else if (node.timerr === "error") { node.error("Timeout",msg); }
if (node.build === "array") { misc = []; }
else if (node.build === "object") { misc = {}; }
}, node.timer);
} }
} }
if (payloadType === 'object' && (propertyKey === null || propertyKey === undefined || propertyKey === "")) {
//TODO: log error - no key property found for object
return;
}
if (!inflight.hasOwnProperty(partId)) {
if (payloadType === 'object') {
inflight[partId] = {
currentCount:0,
payload:{},
targetCount:targetCount,
type:"object",
msg:msg
};
} else {
inflight[partId] = {
currentCount:0,
payload:[],
targetCount:targetCount,
type:payloadType,
joinChar: joinChar,
msg:msg
};
if (payloadType === 'string') {
inflight[partId].joinChar = joinChar;
}
}
if (node.timer > 0) {
inflight[partId].timeout = setTimeout(function() {
completeSend(partId)
}, node.timer)
}
}
var group = inflight[partId];
if (payloadType === 'object') {
group.payload[propertyKey] = property;
group.currentCount = Object.keys(group.payload).length;
} else {
if (!isNaN(propertyIndex)) {
group.payload[propertyIndex] = property;
} else {
group.payload.push(property);
}
group.currentCount++;
}
// TODO: currently reuse the last received - add option to pick first received
group.msg = msg;
if (group.currentCount === group.targetCount || msg.hasOwnProperty('complete')) {
delete msg.complete;
completeSend(partId);
}
} catch(err) {
console.log(err.stack);
}
}); });
this.on("close", function() { this.on("close", function() {
if (tout) { clearTimeout(tout); }
for (var i in inflight) { for (var i in inflight) {
if (inflight[i].timeout) { clearTimeout(inflight[i].timeout); } if (inflight.hasOwnProperty(i)) {
clearTimeout(inflight[i].timeout);
}
} }
}); });
} }