frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added support for codefile

Browse Source
This commit is contained in:
Steve Walsh 2023-11-09 14:57:53 +00:00
parent c5ee350d7a
commit 7c0ec67015
4 changed files with 1287 additions and 1218 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -6,10 +6,13 @@ To make a change to the node-red runtime being used by K4 avalanche:
3. PR into this branch 3. PR into this branch
4. Merge on approval 4. Merge on approval
5. Manually bump the package version 5. Manually bump the package version
6. Run `npm run build` 6. Run `npm run build` - note you need to run node 10 to do this, you also need to have xcode installed
7. Manually publish to NPM with `npm publish` - Request creds from ops for this 7. Manually publish to NPM with `npm publish` - Request creds from ops for this
# Dev Work
When doing dev work dont try to link into k4/k5 it just causes issue, instead just go into the node-modules of k4/k5 and make your changes in there
# CHANGE-LOG # CHANGE-LOG
## 0.18.7-patch-11 ## 0.18.7-patch-11

277
nodes/core/core/80-function.js
View File

@ -14,134 +14,147 @@
* limitations under the License. * limitations under the License.
**/ **/
const PayloadValidator = require('../../PayloadValidator') const clone = require("clone");
const PayloadValidator = require("../../PayloadValidator");
module.exports = function(RED) { module.exports = function (RED) {
"use strict"; "use strict";
var util = require("util"); var util = require("util");
var vm2 = require("vm2"); var vm2 = require("vm2");
function sendResults(node,_msgid,msgs) { function sendResults(node, _msgid, msgs) {
if (msgs == null) { if (msgs == null) {
return; return;
} else if (!util.isArray(msgs)) { } else if (!util.isArray(msgs)) {
msgs = [msgs]; msgs = [msgs];
} }
var msgCount = 0; var msgCount = 0;
for (var m=0; m<msgs.length; m++) { for (var m = 0; m < msgs.length; m++) {
if (msgs[m]) { if (msgs[m]) {
if (!util.isArray(msgs[m])) { if (!util.isArray(msgs[m])) {
msgs[m] = [msgs[m]]; msgs[m] = [msgs[m]];
} }
for (var n=0; n < msgs[m].length; n++) { for (var n = 0; n < msgs[m].length; n++) {
var msg = msgs[m][n]; var msg = msgs[m][n];
if (msg !== null && msg !== undefined) { if (msg !== null && msg !== undefined) {
if (typeof msg === 'object' && !Buffer.isBuffer(msg) && !util.isArray(msg)) { if (
typeof msg === "object" &&
!Buffer.isBuffer(msg) &&
!util.isArray(msg)
) {
msg._msgid = _msgid; msg._msgid = _msgid;
msgCount++; msgCount++;
} else { } else {
var type = typeof msg; var type = typeof msg;
if (type === 'object') { if (type === "object") {
type = Buffer.isBuffer(msg)?'Buffer':(util.isArray(msg)?'Array':'Date'); type = Buffer.isBuffer(msg)
? "Buffer"
: util.isArray(msg)
? "Array"
: "Date";
} }
node.error(RED._("function.error.non-message-returned",{ type: type })) node.error(
RED._("function.error.non-message-returned", { type: type })
);
} }
} }
} }
} }
} }
if (msgCount>0) { if (msgCount > 0) {
node.send(msgs); node.send(msgs);
} }
} }
function FunctionNode(n) { function FunctionNode(n) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this, n);
var node = this; var node = this;
this.name = n.name; this.name = n.name;
this.func = n.func; this.func = n.func;
var functionText = "var results = null;"+ var functionText =
"results = (function(msg){ "+ "var results = null;" +
"var __msgid__ = msg._msgid;"+ "results = (function(msg){ " +
"var node = {"+ "var __msgid__ = msg._msgid;" +
"log:__node__.log,"+ "var node = {" +
"error:__node__.error,"+ "log:__node__.log," +
"warn:__node__.warn,"+ "error:__node__.error," +
"debug:__node__.debug,"+ "warn:__node__.warn," +
"trace:__node__.trace,"+ "debug:__node__.debug," +
"on:__node__.on,"+ "trace:__node__.trace," +
"status:__node__.status,"+ "on:__node__.on," +
"send:function(msgs){ __node__.send(__msgid__,msgs);}"+ "status:__node__.status," +
"};\n"+ "send:function(msgs){ __node__.send(__msgid__,msgs);}" +
this.func+"\n"+ "};\n" +
this.func +
"\n" +
"})(msg);"; "})(msg);";
this.topic = n.topic; this.topic = n.topic;
this.outstandingTimers = []; this.outstandingTimers = [];
this.outstandingIntervals = []; this.outstandingIntervals = [];
var sandbox = { var sandbox = {
console: console, console: console,
util:util, util: util,
//Buffer:Buffer, //Buffer:Buffer,
//Date: Date, //Date: Date,
RED: { RED: {
util: RED.util util: RED.util,
}, },
__node__: { __node__: {
log: function() { log: function () {
node.log.apply(node, arguments); node.log.apply(node, arguments);
}, },
error: function() { error: function () {
node.error.apply(node, arguments); node.error.apply(node, arguments);
}, },
warn: function() { warn: function () {
node.warn.apply(node, arguments); node.warn.apply(node, arguments);
}, },
debug: function() { debug: function () {
node.debug.apply(node, arguments); node.debug.apply(node, arguments);
}, },
trace: function() { trace: function () {
node.trace.apply(node, arguments); node.trace.apply(node, arguments);
}, },
send: function(id, msgs) { send: function (id, msgs) {
sendResults(node, id, msgs); sendResults(node, id, msgs);
}, },
on: function() { on: function () {
if (arguments[0] === "input") { if (arguments[0] === "input") {
throw new Error(RED._("function.error.inputListener")); throw new Error(RED._("function.error.inputListener"));
} }
node.on.apply(node, arguments); node.on.apply(node, arguments);
}, },
status: function() { status: function () {
node.status.apply(node, arguments); node.status.apply(node, arguments);
} },
}, },
context: { context: {
set: function() { set: function () {
node.context().set.apply(node,arguments); node.context().set.apply(node, arguments);
}, },
get: function() { get: function () {
return node.context().get.apply(node,arguments); return node.context().get.apply(node, arguments);
}, },
keys: function() { keys: function () {
return node.context().keys.apply(node,arguments); return node.context().keys.apply(node, arguments);
}, },
get global() { get global() {
return node.context().global; return node.context().global;
}, },
get flow() { get flow() {
return node.context().flow; return node.context().flow;
} },
}, },
flow: { flow: {
set: function() { set: function () {
node.context().flow.set.apply(node,arguments); node.context().flow.set.apply(node, arguments);
}, },
get: function() { get: function () {
return node.context().flow.get.apply(node,arguments); return node.context().flow.get.apply(node, arguments);
},
keys: function () {
return node.context().flow.keys.apply(node, arguments);
}, },
keys: function() {
return node.context().flow.keys.apply(node,arguments);
}
}, },
// global: { // global: {
// set: function() { // set: function() {
@ -157,76 +170,155 @@ module.exports = function(RED) {
setTimeout: function () { setTimeout: function () {
var func = arguments[0]; var func = arguments[0];
var timerId; var timerId;
arguments[0] = function() { arguments[0] = function () {
sandbox.clearTimeout(timerId); sandbox.clearTimeout(timerId);
try { try {
func.apply(this,arguments); func.apply(this, arguments);
} catch(err) { } catch (err) {
node.error(err,{}); node.error(err, {});
} }
}; };
timerId = setTimeout.apply(this,arguments); timerId = setTimeout.apply(this, arguments);
node.outstandingTimers.push(timerId); node.outstandingTimers.push(timerId);
return timerId; return timerId;
}, },
clearTimeout: function(id) { clearTimeout: function (id) {
clearTimeout(id); clearTimeout(id);
var index = node.outstandingTimers.indexOf(id); var index = node.outstandingTimers.indexOf(id);
if (index > -1) { if (index > -1) {
node.outstandingTimers.splice(index,1); node.outstandingTimers.splice(index, 1);
} }
}, },
setInterval: function() { setInterval: function () {
var func = arguments[0]; var func = arguments[0];
var timerId; var timerId;
arguments[0] = function() { arguments[0] = function () {
try { try {
func.apply(this,arguments); func.apply(this, arguments);
} catch(err) { } catch (err) {
node.error(err,{}); node.error(err, {});
} }
}; };
timerId = setInterval.apply(this,arguments); timerId = setInterval.apply(this, arguments);
node.outstandingIntervals.push(timerId); node.outstandingIntervals.push(timerId);
return timerId; return timerId;
}, },
clearInterval: function(id) { clearInterval: function (id) {
clearInterval(id); clearInterval(id);
var index = node.outstandingIntervals.indexOf(id); var index = node.outstandingIntervals.indexOf(id);
if (index > -1) { if (index > -1) {
node.outstandingIntervals.splice(index,1); node.outstandingIntervals.splice(index, 1);
}
} }
},
}; };
if (util.hasOwnProperty('promisify')) { if (util.hasOwnProperty("promisify")) {
sandbox.setTimeout[util.promisify.custom] = function(after, value) { sandbox.setTimeout[util.promisify.custom] = function (after, value) {
return new Promise(function(resolve, reject) { return new Promise(function (resolve, reject) {
sandbox.setTimeout(function(){ resolve(value) }, after); sandbox.setTimeout(function () {
resolve(value);
}, after);
}); });
} };
} }
try { try {
this.on("input", function(msg) { this.on("input", async function (msg) {
try { try {
const payloadValidator = new PayloadValidator(msg, this.id) const originalMessage = clone(msg);
const payloadValidator = new PayloadValidator(msg, this.id);
var start = process.hrtime(); var start = process.hrtime();
sandbox.msg = msg; sandbox.msg = msg;
const vm2Instance = new vm2.VM({ sandbox, timeout: 5000 }); const vm2Instance = new vm2.VM({ sandbox, timeout: 5000 });
const beforeVm2 = process.hrtime();
const result = vm2Instance.run(functionText); const result = vm2Instance.run(functionText);
payloadValidator.verify(result) const afterVm2 = process.hrtime(beforeVm2);
sendResults(this,msg._msgid, result); payloadValidator.verify(result);
sendResults(this, msg._msgid, result);
const logger = clone(msg.logger);
let lambdaRequestId;
let {
payload: {
system: { organization },
},
event: {
workers: [{ id: workerId }],
},
} = originalMessage;
const {
settings: {
api: { codefile = false }
},
} = RED;
if (codefile) {
try {
const messageToSend = clone(msg);
delete messageToSend.logger;
const beforeCodefile = process.hrtime();
const {
result: {
Result: { msg: responseMessage },
},
} = await codefile.run({ srcCode: this.func, context: { msg } });
const afterCodefile = process.hrtime(beforeCodefile);
responseMessage.logger = logger;
payloadValidator.verify(responseMessage);
// to make function node return result from code file uncomment this line, and comment out the sendResults above
// sendResults(this,msg._msgid, responseMessage);
workerId = workerId.split(":::")[0];
const nodeId = this.id.split(`${organization}-${workerId}-`)[1];
lambdaRequestId = responseMessage.lambdaRequestId;
const metrics = {
lambdaRequestId: requestId,
organization,
workerId: workerId,
nodeId: nodeId,
rawCode: this.func,
vm2Runtime: `${
Math.floor((afterVm2[0] * 1e9 + afterVm2[1]) / 10000) / 100
}ms`,
codefileRuntime: `${
Math.floor(
(afterCodefile[0] * 1e9 + afterCodefile[1]) / 10000
) / 100
}ms`,
};
logger.info(JSON.stringify(metrics, null, 2));
} catch (e) {
logger.error({
message: "Error running codefile",
error: e,
lambdaRequestId,
organization,
workerId: workerId,
nodeId: nodeId,
rawCode: this.func,
});
}
}
// sendResults(this,msg._msgid, responseMessage);
var duration = process.hrtime(start); var duration = process.hrtime(start);
var converted = Math.floor((duration[0] * 1e9 + duration[1])/10000)/100; var converted =
Math.floor((duration[0] * 1e9 + duration[1]) / 10000) / 100;
this.metric("duration", msg, converted); this.metric("duration", msg, converted);
if (process.env.NODE_RED_FUNCTION_TIME) { if (process.env.NODE_RED_FUNCTION_TIME) {
this.status({fill:"yellow",shape:"dot",text:""+converted}); this.status({ fill: "yellow", shape: "dot", text: "" + converted });
} }
} catch(err) { } catch (err) {
//remove unwanted part //remove unwanted part
var index = err.stack.search(/\n\s*at ContextifyScript.Script.runInContext/); var index = err.stack.search(
err.stack = err.stack.slice(0, index).split('\n').slice(0,-1).join('\n'); /\n\s*at ContextifyScript.Script.runInContext/
);
err.stack = err.stack
.slice(0, index)
.split("\n")
.slice(0, -1)
.join("\n");
var stack = err.stack.split(/\r?\n/); var stack = err.stack.split(/\r?\n/);
//store the error in msg to be used in flows //store the error in msg to be used in flows
@ -236,17 +328,20 @@ module.exports = function(RED) {
var errorMessage; var errorMessage;
var stack = err.stack.split(/\r?\n/); var stack = err.stack.split(/\r?\n/);
if (stack.length > 0) { if (stack.length > 0) {
while (line < stack.length && stack[line].indexOf("ReferenceError") !== 0) { while (
line < stack.length &&
stack[line].indexOf("ReferenceError") !== 0
) {
line++; line++;
} }
if (line < stack.length) { if (line < stack.length) {
errorMessage = stack[line]; errorMessage = stack[line];
var m = /:(\d+):(\d+)$/.exec(stack[line+1]); var m = /:(\d+):(\d+)$/.exec(stack[line + 1]);
if (m) { if (m) {
var lineno = Number(m[1])-1; var lineno = Number(m[1]) - 1;
var cha = m[2]; var cha = m[2];
errorMessage += " (line "+lineno+", col "+cha+")"; errorMessage += " (line " + lineno + ", col " + cha + ")";
} }
} }
} }
@ -263,21 +358,21 @@ module.exports = function(RED) {
this.error(errorMessage, msg); this.error(errorMessage, msg);
} }
}); });
this.on("close", function() { this.on("close", function () {
while (node.outstandingTimers.length > 0) { while (node.outstandingTimers.length > 0) {
clearTimeout(node.outstandingTimers.pop()) clearTimeout(node.outstandingTimers.pop());
} }
while (node.outstandingIntervals.length > 0) { while (node.outstandingIntervals.length > 0) {
clearInterval(node.outstandingIntervals.pop()) clearInterval(node.outstandingIntervals.pop());
} }
this.status({}); this.status({});
}) });
} catch(err) { } catch (err) {
// eg SyntaxError - which v8 doesn't include line number information // eg SyntaxError - which v8 doesn't include line number information
// so we can't do better than this // so we can't do better than this
this.error(err); this.error(err);
} }
} }
RED.nodes.registerType("function",FunctionNode); RED.nodes.registerType("function", FunctionNode);
RED.library.register("functions"); RED.library.register("functions");
} };

1885
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

2
package.json
View File

@ -97,7 +97,7 @@
"grunt-jsonlint": "~1.1.0", "grunt-jsonlint": "~1.1.0",
"grunt-mocha-istanbul": "5.0.2", "grunt-mocha-istanbul": "5.0.2",
"grunt-nodemon": "~0.4.2", "grunt-nodemon": "~0.4.2",
"grunt-sass": "~2.0.0", "grunt-sass": "^2.0.0",
"grunt-simple-mocha": "~0.4.1", "grunt-simple-mocha": "~0.4.1",
"grunt-webdriver": "^2.0.3", "grunt-webdriver": "^2.0.3",
"http-proxy": "^1.16.2", "http-proxy": "^1.16.2",