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

Fix template node handling of nested context tags

Browse Source
This commit is contained in:
Nick O'Leary 2018-08-14 16:21:38 +01:00
parent ee886f98dd
commit f169a68319
No known key found for this signature in database
GPG Key ID: 4F2157149161A6C9
2 changed files with 126 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
nodes/core/core/80-template.js
View File

@ -19,6 +19,19 @@ module.exports = function(RED) {
var mustache = require("mustache"); var mustache = require("mustache");
var yaml = require("js-yaml"); var yaml = require("js-yaml");
function extractTokens(tokens,set) {
set = set || new Set();
tokens.forEach(function(token) {
if (token[0] !== 'text') {
set.add(token[1]);
if (token.length > 4) {
extractTokens(token[4],set);
}
}
});
return set;
}
function parseContext(key) { function parseContext(key) {
var match = /^(flow|global)(\[(\w+)\])?\.(.+)/.exec(key); var match = /^(flow|global)(\[(\w+)\])?\.(.+)/.exec(key);
if (match) { if (match) {
@ -36,22 +49,16 @@ module.exports = function(RED) {
* flow and global context * flow and global context
*/ */
function NodeContext(msg, nodeContext, parent, escapeStrings, promises, results) { function NodeContext(msg, nodeContext, parent, escapeStrings, cachedContextTokens) {
this.msgContext = new mustache.Context(msg,parent); this.msgContext = new mustache.Context(msg,parent);
this.nodeContext = nodeContext; this.nodeContext = nodeContext;
this.escapeStrings = escapeStrings; this.escapeStrings = escapeStrings;
this.promises = promises; this.cachedContextTokens = cachedContextTokens;
this.results = results;
} }
NodeContext.prototype = new mustache.Context(); NodeContext.prototype = new mustache.Context();
NodeContext.prototype.lookup = function (name) { NodeContext.prototype.lookup = function (name) {
var results = this.results;
if (results) {
var val = results.shift();
return val;
}
// try message first: // try message first:
try { try {
var value = this.msgContext.lookup(name); var value = this.msgContext.lookup(name);
@ -64,7 +71,6 @@ module.exports = function(RED) {
value = value.replace(/\f/g, "\\f"); value = value.replace(/\f/g, "\\f");
value = value.replace(/[\b]/g, "\\b"); value = value.replace(/[\b]/g, "\\b");
} }
this.promises.push(Promise.resolve(value));
return value; return value;
} }
@ -76,28 +82,10 @@ module.exports = function(RED) {
var field = context.field; var field = context.field;
var target = this.nodeContext[type]; var target = this.nodeContext[type];
if (target) { if (target) {
var promise = new Promise((resolve, reject) => { return this.cachedContextTokens[name];
var callback = (err, val) => {
if (err) {
reject(err);
} else {
resolve(val);
}
};
target.get(field, store, callback);
});
this.promises.push(promise);
return '';
}
else {
this.promises.push(Promise.resolve(''));
return '';
} }
} }
else { return '';
this.promises.push(Promise.resolve(''));
return '';
}
} }
catch(err) { catch(err) {
throw err; throw err;
@ -105,7 +93,7 @@ module.exports = function(RED) {
} }
NodeContext.prototype.push = function push (view) { NodeContext.prototype.push = function push (view) {
return new NodeContext(view, this.nodeContext, this.msgContext, undefined, this.promises, this.results); return new NodeContext(view, this.nodeContext, this.msgContext, undefined, this.cachedContextTokens);
}; };
function TemplateNode(n) { function TemplateNode(n) {
@ -118,33 +106,36 @@ module.exports = function(RED) {
this.outputFormat = n.output || "str"; this.outputFormat = n.output || "str";
var node = this; var node = this;
node.on("input", function(msg) {
function output(value) {
/* istanbul ignore else */
if (node.outputFormat === "json") {
value = JSON.parse(value);
}
/* istanbul ignore else */
if (node.outputFormat === "yaml") {
value = yaml.load(value);
}
if (node.fieldType === 'msg') { function output(msg,value) {
RED.util.setMessageProperty(msg, node.field, value); /* istanbul ignore else */
node.send(msg); if (node.outputFormat === "json") {
} else if ((node.fieldType === 'flow') || value = JSON.parse(value);
(node.fieldType === 'global')) {
var context = RED.util.parseContextStore(node.field);
var target = node.context()[node.fieldType];
target.set(context.key, value, context.store, function (err) {
if (err) {
node.error(err, msg);
} else {
node.send(msg);
}
});
}
} }
/* istanbul ignore else */
if (node.outputFormat === "yaml") {
value = yaml.load(value);
}
if (node.fieldType === 'msg') {
RED.util.setMessageProperty(msg, node.field, value);
node.send(msg);
} else if ((node.fieldType === 'flow') ||
(node.fieldType === 'global')) {
var context = RED.util.parseContextStore(node.field);
var target = node.context()[node.fieldType];
target.set(context.key, value, context.store, function (err) {
if (err) {
node.error(err, msg);
} else {
node.send(msg);
}
});
}
}
node.on("input", function(msg) {
try { try {
/*** /***
* Allow template contents to be defined externally * Allow template contents to be defined externally
@ -160,19 +151,44 @@ module.exports = function(RED) {
if (node.syntax === "mustache") { if (node.syntax === "mustache") {
var is_json = (node.outputFormat === "json"); var is_json = (node.outputFormat === "json");
var promises = []; var promises = [];
mustache.render(template, new NodeContext(msg, node.context(), null, is_json, promises, null)); var tokens = extractTokens(mustache.parse(template));
Promise.all(promises).then(function (values) { var resolvedTokens = {};
var value = mustache.render(template, new NodeContext(msg, node.context(), null, is_json, null, values)); tokens.forEach(function(name) {
output(value); var context = parseContext(name);
if (context) {
var type = context.type;
var store = context.store;
var field = context.field;
var target = node.context()[type];
if (target) {
var promise = new Promise((resolve, reject) => {
target.get(field, store, (err, val) => {
if (err) {
reject(err);
} else {
resolvedTokens[name] = val;
resolve();
}
});
});
promises.push(promise);
return;
}
}
});
Promise.all(promises).then(function() {
var value = mustache.render(template, new NodeContext(msg, node.context(), null, is_json, resolvedTokens));
output(msg, value);
}).catch(function (err) { }).catch(function (err) {
node.error(err.message); node.error(err.message,msg);
}); });
} else { } else {
output(template); output(msg, template);
} }
} }
catch(err) { catch(err) {
node.error(err.message); node.error(err.message, msg);
} }
}); });
} }

49
test/nodes/core/core/80-template_spec.js
View File

@ -177,6 +177,53 @@ describe('template node', function() {
}); });
}); });
it('should handle nested context tags - property not set', function(done) {
// This comes from the Coursera Node-RED course and is a good example of
// multiple conditional tags
var template = `{{#flow.time}}time={{flow.time}}{{/flow.time}}{{^flow.time}}!time{{/flow.time}}{{#flow.random}}random={{flow.random}}randomtime={{flow.randomtime}}{{/flow.random}}{{^flow.random}}!random{{/flow.random}}`;
var flow = [{id:"n1",z:"t1", type:"template", field:"payload", template:template,wires:[["n2"]]},{id:"n2",z:"t1",type:"helper"}];
helper.load(templateNode, flow, function() {
initContext(function() {
var n1 = helper.getNode("n1");
var n2 = helper.getNode("n2");
n2.on("input", function(msg) {
try {
msg.should.have.property('topic', 'bar');
msg.should.have.property('payload', '!time!random');
done();
} catch(err) {
done(err);
}
});
n1.receive({payload:"foo",topic: "bar"});
});
});
})
it('should handle nested context tags - property set', function(done) {
// This comes from the Coursera Node-RED course and is a good example of
// multiple conditional tags
var template = `{{#flow.time}}time={{flow.time}}{{/flow.time}}{{^flow.time}}!time{{/flow.time}}{{#flow.random}}random={{flow.random}}randomtime={{flow.randomtime}}{{/flow.random}}{{^flow.random}}!random{{/flow.random}}`;
var flow = [{id:"n1",z:"t1", type:"template", field:"payload", template:template,wires:[["n2"]]},{id:"n2",z:"t1",type:"helper"}];
helper.load(templateNode, flow, function() {
initContext(function() {
var n1 = helper.getNode("n1");
var n2 = helper.getNode("n2");
n2.on("input", function(msg) {
try {
msg.should.have.property('topic', 'bar');
msg.should.have.property('payload', 'time=123random=456randomtime=789');
done();
} catch(err) {
done(err);
}
});
n1.context().flow.set(["time","random","randomtime"],["123","456","789"],function (err) {
n1.receive({payload:"foo",topic: "bar"});
});
});
});
})
it('should modify payload from two persistable flow context', function(done) { it('should modify payload from two persistable flow context', function(done) {
var flow = [{id:"n1",z:"t1", type:"template", field:"payload", template:"payload={{flow[memory1].value}}/{{flow[memory2].value}}",wires:[["n2"]]},{id:"n2",z:"t1",type:"helper"}]; var flow = [{id:"n1",z:"t1", type:"template", field:"payload", template:"payload={{flow[memory1].value}}/{{flow[memory2].value}}",wires:[["n2"]]},{id:"n2",z:"t1",type:"helper"}];
helper.load(templateNode, flow, function() { helper.load(templateNode, flow, function() {
@ -429,7 +476,7 @@ describe('template node', function() {
n1.receive({payload:{A:"abc"}}); n1.receive({payload:{A:"abc"}});
}); });
}); });
it('should raise error if passed bad template', function(done) { it('should raise error if passed bad template', function(done) {
var flow = [{id:"n1", type:"template", field: "payload", template: "payload={{payload",wires:[["n2"]]},{id:"n2",type:"helper"}]; var flow = [{id:"n1", type:"template", field: "payload", template: "payload={{payload",wires:[["n2"]]},{id:"n2",type:"helper"}];
helper.load(templateNode, flow, function() { helper.load(templateNode, flow, function() {