Merge pull request #457 from anna2130/change-node-multi-level-properties

Change node can set msg property to another msg property. Closes #456
This commit is contained in:
Nick O'Leary 2014-10-28 16:07:42 +00:00
commit d242f67be3
3 changed files with 403 additions and 283 deletions

View File

@ -61,7 +61,9 @@
action: {value:"replace",required:true},
property: {value:"payload",required:true},
from: {value:"",validate: function(v) {
if (this.action == "change" && this.reg) {
if (this.action === "change" && !this.from) {
return false;
} else if (this.action === "change" && this.reg) {
try {
var re = new RegExp(this.from, "g");
return true;

View File

@ -16,6 +16,7 @@
module.exports = function(RED) {
"use strict";
function ChangeNode(n) {
RED.nodes.createNode(this, n);
this.action = n.action;
@ -43,18 +44,39 @@ module.exports = function(RED) {
propertyParts = node.property.split(".");
try {
propertyParts.reduce(function(obj, i) {
var to = node.to;
// Set msg from property to another msg property
if (node.action === "replace" && node.to.indexOf("msg.") === 0) {
var parts = to.substring(4);
var msgPropParts = parts.split(".");
try {
msgPropParts.reduce(function(ob, j) {
to = (typeof ob[j] !== "undefined" ? ob[j] : undefined);
return to;
}, msg);
} catch (err) {}
}
if (++depth === propertyParts.length) {
if (node.action === "change") {
if (typeof obj[i] === "string") {
obj[i] = obj[i].replace(node.re, node.to);
}
} else if (node.action === "replace") {
obj[i] = node.to;
if (typeof to === "undefined") {
delete(obj[i]);
} else {
obj[i] = to;
}
} else if (node.action === "delete") {
delete(obj[i]);
}
} else {
if (!obj[i]) {
// to property doesn't exist, don't create empty object
if (typeof to === "undefined") {
return;
// setting a non-existent multilevel object, create empty parent
} else if (!obj[i]) {
obj[i] = {};
}
return obj[i];

View File

@ -30,6 +30,7 @@ describe('ChangeNode', function() {
helper.stopServer(done);
});
describe('#replace' , function() {
it('should be loaded', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"payload","from":"","to":"","reg":false,"name":"changeNode","wires":[[]]}];
helper.load(changeNode, flow, function() {
@ -93,6 +94,134 @@ describe('ChangeNode', function() {
});
});
it('sets the value of a message property to another message property', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"foo","from":"","to":"msg.fred","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
msg.foo.should.equal("bar");
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({fred:"bar"});
});
});
it('sets the value of a multi-level message property to another multi-level message property', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"foo.bar","from":"","to":"msg.fred.red","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
msg.foo.bar.should.equal("bar");
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({fred:{red:"bar"}});
});
});
it('doesn\'t set the value of a message property when the \'to\' message property does not exist', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"foo.bar","from":"","to":"msg.fred.red","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
should.not.exist(msg.foo);
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({});
});
});
it('overrides the value of a message property when the \'to\' message property does not exist', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"payload","from":"","to":"msg.foo","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
should.not.exist(msg.payload);
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({payload:"Hello"});
});
});
it('sets the message property to null when the \'to\' message property equals null', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"payload","from":"","to":"msg.foo","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
(msg.payload === null).should.be.true;
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({payload:"Hello", foo:null});
});
});
it('does not set other properties using = inside to property', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"payload","from":"","to":"msg.otherProp=10","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
should.not.exist(msg.payload);
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({payload:"changeMe"});
});
});
it('splits dot delimited properties into objects', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"pay.load","from":"","to":"10","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
msg.pay.load.should.equal("10");
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({pay:{load:"changeMe"}});
});
});
});
describe('#change', function() {
it('changes the value of the message property', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"change","property":"payload","from":"Hello","to":"Goodbye","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
@ -223,7 +352,9 @@ describe('ChangeNode', function() {
changeNode1.receive({payload:"This is irrelevant"});
});
});
});
describe("#delete", function() {
it('deletes the value of the message property', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"delete","property":"payload","from":"","to":"","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
@ -297,41 +428,6 @@ describe('ChangeNode', function() {
changeNode1.receive({payload:"payload"});
});
});
it('does not change other properties', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"payload","from":"","to":"msg.otherProp=10","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
msg.payload.should.not.equal(10);
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({payload:"changeMe"});
});
});
it('splits dot delimited properties into objects', function(done) {
var flow = [{"id":"changeNode1","type":"change","action":"replace","property":"pay.load","from":"","to":"10","reg":false,"name":"changeNode","wires":[["helperNode1"]]},
{id:"helperNode1", type:"helper", wires:[]}];
helper.load(changeNode, flow, function() {
var changeNode1 = helper.getNode("changeNode1");
var helperNode1 = helper.getNode("helperNode1");
helperNode1.on("input", function(msg) {
try {
msg.pay.load.should.equal("10");
done();
} catch(err) {
done(err);
}
});
changeNode1.receive({pay:{load:"changeMe"}});
});
});
});