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

Merge pull request #1894 from node-red-hitachi/fix-overlapping-file-node-execution

Browse Source 
fix multiple input message processing of file node
This commit is contained in:
Nick O'Leary 2018-10-15 03:15:05 -07:00 committed by GitHub
commit 6a9575e9f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 286 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
nodes/core/storage/50-file.js
View File

@ -28,9 +28,11 @@ module.exports = function(RED) {
this.createDir = n.createDir || false; this.createDir = n.createDir || false;
var node = this; var node = this;
node.wstream = null; node.wstream = null;
node.data = []; node.msgQueue = [];
node.closing = false;
node.closeCallback = null;
this.on("input",function(msg) { function processMsg(msg, done) {
var filename = node.filename || msg.filename || ""; var filename = node.filename || msg.filename || "";
if ((!node.filename) && (!node.tout)) { if ((!node.filename) && (!node.tout)) {
node.tout = setTimeout(function() { node.tout = setTimeout(function() {
@ -41,6 +43,7 @@ module.exports = function(RED) {
} }
if (filename === "") { if (filename === "") {
node.warn(RED._("file.errors.nofilename")); node.warn(RED._("file.errors.nofilename"));
done();
} else if (node.overwriteFile === "delete") { } else if (node.overwriteFile === "delete") {
fs.unlink(filename, function (err) { fs.unlink(filename, function (err) {
if (err) { if (err) {
@ -51,6 +54,7 @@ module.exports = function(RED) {
} }
node.send(msg); node.send(msg);
} }
done();
}); });
} else if (msg.hasOwnProperty("payload") && (typeof msg.payload !== "undefined")) { } else if (msg.hasOwnProperty("payload") && (typeof msg.payload !== "undefined")) {
var dir = path.dirname(filename); var dir = path.dirname(filename);
@ -59,6 +63,7 @@ module.exports = function(RED) {
fs.ensureDirSync(dir); fs.ensureDirSync(dir);
} catch(err) { } catch(err) {
node.error(RED._("file.errors.createfail",{error:err.toString()}),msg); node.error(RED._("file.errors.createfail",{error:err.toString()}),msg);
done();
return; return;
} }
} }
@ -70,85 +75,142 @@ module.exports = function(RED) {
if (typeof data === "boolean") { data = data.toString(); } if (typeof data === "boolean") { data = data.toString(); }
if (typeof data === "number") { data = data.toString(); } if (typeof data === "number") { data = data.toString(); }
if ((node.appendNewline) && (!Buffer.isBuffer(data))) { data += os.EOL; } if ((node.appendNewline) && (!Buffer.isBuffer(data))) { data += os.EOL; }
node.data.push({msg:msg,data:Buffer.from(data)}); if (node.overwriteFile === "true") {
var wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'w', autoClose:true });
while (node.data.length > 0) { node.wstream = wstream;
if (node.overwriteFile === "true") { wstream.on("error", function(err) {
(function(packet) { node.error(RED._("file.errors.writefail",{error:err.toString()}),msg);
node.wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'w', autoClose:true }); done();
node.wstream.on("error", function(err) { });
node.error(RED._("file.errors.writefail",{error:err.toString()}),msg); wstream.on("open", function() {
}); wstream.end(data, function() {
node.wstream.on("open", function() { node.send(msg);
node.wstream.end(packet.data, function() { done();
node.send(packet.msg); });
}); })
}) return;
})(node.data.shift()); }
} else {
else { // Append mode
// Append mode var recreateStream = !node.wstream || !node.filename;
var recreateStream = !node.wstream || !node.filename; if (node.wstream && node.wstreamIno) {
if (node.wstream && node.wstreamIno) { // There is already a stream open and we have the inode
// There is already a stream open and we have the inode // of the file. Check the file hasn't been deleted
// of the file. Check the file hasn't been deleted // or deleted and recreated.
// or deleted and recreated. try {
try { var stat = fs.statSync(filename);
var stat = fs.statSync(filename); // File exists - check the inode matches
// File exists - check the inode matches if (stat.ino !== node.wstreamIno) {
if (stat.ino !== node.wstreamIno) { // The file has been recreated. Close the current
// The file has been recreated. Close the current // stream and recreate it
// stream and recreate it
recreateStream = true;
node.wstream.end();
delete node.wstream;
delete node.wstreamIno;
}
} catch(err) {
// File does not exist
recreateStream = true; recreateStream = true;
node.wstream.end(); node.wstream.end();
delete node.wstream; delete node.wstream;
delete node.wstreamIno; delete node.wstreamIno;
} }
} } catch(err) {
if (recreateStream) { // File does not exist
node.wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'a', autoClose:true }); recreateStream = true;
node.wstream.on("open", function(fd) { node.wstream.end();
try {
var stat = fs.statSync(filename);
node.wstreamIno = stat.ino;
} catch(err) {
}
});
node.wstream.on("error", function(err) {
node.error(RED._("file.errors.appendfail",{error:err.toString()}),msg);
});
}
if (node.filename) {
// Static filename - write and reuse the stream next time
var packet = node.data.shift()
node.wstream.write(packet.data, function() {
node.send(packet.msg);
});
} else {
// Dynamic filename - write and close the stream
var packet = node.data.shift()
node.wstream.end(packet.data, function() {
node.send(packet.msg);
});
delete node.wstream; delete node.wstream;
delete node.wstreamIno; delete node.wstreamIno;
} }
} }
if (recreateStream) {
node.wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'a', autoClose:true });
node.wstream.on("open", function(fd) {
try {
var stat = fs.statSync(filename);
node.wstreamIno = stat.ino;
} catch(err) {
}
});
node.wstream.on("error", function(err) {
node.error(RED._("file.errors.appendfail",{error:err.toString()}),msg);
done();
});
}
if (node.filename) {
// Static filename - write and reuse the stream next time
node.wstream.write(data, function() {
node.send(msg);
done();
});
} else {
// Dynamic filename - write and close the stream
node.wstream.end(data, function() {
node.send(msg);
delete node.wstream;
delete node.wstreamIno;
done();
});
}
} }
} }
else {
done();
}
}
function processQ(queue) {
var msg = queue[0];
processMsg(msg, function() {
queue.shift();
if (queue.length > 0) {
processQ(queue);
}
else if (node.closing) {
closeNode();
}
});
}
this.on("input", function(msg) {
var msgQueue = node.msgQueue;
if (msgQueue.push(msg) > 1) {
// pending write exists
return;
}
try {
processQ(msgQueue);
}
catch (e) {
node.msgQueue = [];
if (node.closing) {
closeNode();
}
throw e;
}
}); });
this.on('close', function() {
function closeNode() {
if (node.wstream) { node.wstream.end(); } if (node.wstream) { node.wstream.end(); }
if (node.tout) { clearTimeout(node.tout); } if (node.tout) { clearTimeout(node.tout); }
node.status({}); node.status({});
var cb = node.closeCallback;
node.closeCallback = null;
node.closing = false;
if (cb) {
cb();
}
}
this.on('close', function(done) {
if (node.closing) {
// already closing
return;
}
node.closing = true;
if (done) {
node.closeCallback = done;
}
if (node.msgQueue.length > 0) {
// close after queue processed
return;
}
else {
closeNode();
}
}); });
} }
RED.nodes.registerType("file",FileNode); RED.nodes.registerType("file",FileNode);

229
test/nodes/core/storage/50-file_spec.js
View File

@ -46,14 +46,14 @@ describe('file Nodes', function() {
it('should be loaded', function(done) { it('should be loaded', function(done) {
var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest, "appendNewline":true, "overwriteFile":true}]; var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest, "appendNewline":true, "overwriteFile":true}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
try { try {
var fileNode1 = helper.getNode("fileNode1"); var fileNode1 = helper.getNode("fileNode1");
fileNode1.should.have.property('name', 'fileNode'); fileNode1.should.have.property('name', 'fileNode');
done(); done();
} }
catch (e) { catch (e) {
done(e); done(e);
} }
}); });
}); });
@ -64,16 +64,16 @@ describe('file Nodes', function() {
var n1 = helper.getNode("fileNode1"); var n1 = helper.getNode("fileNode1");
var n2 = helper.getNode("helperNode1"); var n2 = helper.getNode("helperNode1");
n2.on("input", function(msg) { n2.on("input", function(msg) {
try { try {
var f = fs.readFileSync(fileToTest); var f = fs.readFileSync(fileToTest);
f.should.have.length(4); f.should.have.length(4);
fs.unlinkSync(fileToTest); fs.unlinkSync(fileToTest);
msg.should.have.property("payload", "test"); msg.should.have.property("payload", "test");
done(); done();
} }
catch (e) { catch (e) {
done(e); done(e);
} }
}); });
n1.receive({payload:"test"}); n1.receive({payload:"test"});
}); });
@ -93,26 +93,26 @@ describe('file Nodes', function() {
var data = ["test2", true, 999, [2]]; var data = ["test2", true, 999, [2]];
n2.on("input", function (msg) { n2.on("input", function (msg) {
try { try {
msg.should.have.property("payload"); msg.should.have.property("payload");
data.should.containDeep([msg.payload]); data.should.containDeep([msg.payload]);
if (count === 3) { if (count === 3) {
var f = fs.readFileSync(fileToTest).toString(); var f = fs.readFileSync(fileToTest).toString();
if (os.type() !== "Windows_NT") { if (os.type() !== "Windows_NT") {
f.should.have.length(19); f.should.have.length(19);
f.should.equal("test2\ntrue\n999\n[2]\n"); f.should.equal("test2\ntrue\n999\n[2]\n");
} }
else { else {
f.should.have.length(23); f.should.have.length(23);
f.should.equal("test2\r\ntrue\r\n999\r\n[2]\r\n"); f.should.equal("test2\r\ntrue\r\n999\r\n[2]\r\n");
} }
done(); done();
} }
count++; count++;
} }
catch (e) { catch (e) {
done(e); done(e);
} }
}); });
n1.receive({payload:"test2"}); // string n1.receive({payload:"test2"}); // string
@ -142,37 +142,37 @@ describe('file Nodes', function() {
var count = 0; var count = 0;
n2.on("input", function (msg) { n2.on("input", function (msg) {
try { try {
msg.should.have.property("payload"); msg.should.have.property("payload");
data.should.containDeep([msg.payload]); data.should.containDeep([msg.payload]);
try { try {
if (count === 1) { if (count === 1) {
// Check they got appended as expected // Check they got appended as expected
var f = fs.readFileSync(fileToTest).toString(); var f = fs.readFileSync(fileToTest).toString();
f.should.equal("onetwo"); f.should.equal("onetwo");
// Delete the file // Delete the file
fs.unlinkSync(fileToTest); fs.unlinkSync(fileToTest);
setTimeout(function() { setTimeout(function() {
// Send two more messages to the file // Send two more messages to the file
n1.receive({payload:"three"}); n1.receive({payload:"three"});
n1.receive({payload:"four"}); n1.receive({payload:"four"});
}, wait); }, wait);
} }
if (count === 3) { if (count === 3) {
var f = fs.readFileSync(fileToTest).toString(); var f = fs.readFileSync(fileToTest).toString();
f.should.equal("threefour"); f.should.equal("threefour");
fs.unlinkSync(fileToTest); fs.unlinkSync(fileToTest);
done(); done();
} }
} catch(err) { } catch(err) {
done(err); done(err);
} }
count++; count++;
} }
catch (e) { catch (e) {
done(e); done(e);
} }
}); });
// Send two messages to the file // Send two messages to the file
@ -197,7 +197,7 @@ describe('file Nodes', function() {
n2.on("input", function (msg) { n2.on("input", function (msg) {
try { try {
msg.should.have.property("payload"); msg.should.have.property("payload");
data.should.containDeep([msg.payload]); data.should.containDeep([msg.payload]);
if (count == 1) { if (count == 1) {
// Check they got appended as expected // Check they got appended as expected
var f = fs.readFileSync(fileToTest).toString(); var f = fs.readFileSync(fileToTest).toString();
@ -256,25 +256,25 @@ describe('file Nodes', function() {
var n2 = helper.getNode("helperNode1"); var n2 = helper.getNode("helperNode1");
n2.on("input", function (msg) { n2.on("input", function (msg) {
try { try {
msg.should.have.property("payload", "fine"); msg.should.have.property("payload", "fine");
msg.should.have.property("filename", fileToTest); msg.should.have.property("filename", fileToTest);
var f = fs.readFileSync(fileToTest).toString(); var f = fs.readFileSync(fileToTest).toString();
if (os.type() !== "Windows_NT") { if (os.type() !== "Windows_NT") {
f.should.have.length(5); f.should.have.length(5);
f.should.equal("fine\n"); f.should.equal("fine\n");
} }
else { else {
f.should.have.length(6); f.should.have.length(6);
f.should.equal("fine\r\n"); f.should.equal("fine\r\n");
} }
done(); done();
} }
catch (e) { catch (e) {
done(e); done(e);
} }
}); });
n1.receive({payload:"fine", filename:fileToTest}); n1.receive({payload:"fine", filename:fileToTest});
}); });
@ -540,6 +540,93 @@ describe('file Nodes', function() {
}); });
}); });
it('should write to multiple files', function(done) {
var flow = [{id:"fileNode1", type:"file", name: "fileNode", "appendNewline":true, "overwriteFile":true, "createDir":true, wires: [["helperNode1"]]},
{id:"helperNode1", type:"helper"}];
var tmp_path = path.join(resourcesDir, "tmp");
var len = 1024*1024*10;
var file_count = 5;
helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileNode1");
var n2 = helper.getNode("helperNode1");
var count = 0;
n2.on("input", function(msg) {
try {
count++;
if (count == file_count) {
for(var i = 0; i < file_count; i++) {
var name = path.join(tmp_path, String(i));
var f = fs.readFileSync(name);
f.should.have.length(len);
f[0].should.have.equal(i);
}
fs.removeSync(tmp_path);
done();
}
}
catch (e) {
try {
fs.removeSync(tmp_path);
}
catch (e1) {
}
done(e);
}
});
for(var i = 0; i < file_count; i++) {
var data = new Buffer(len);
data.fill(i);
var name = path.join(tmp_path, String(i));
var msg = {payload:data, filename:name};
n1.receive(msg);
}
});
});
it('should write to multiple files if node is closed', function(done) {
var flow = [{id:"fileNode1", type:"file", name: "fileNode", "appendNewline":true, "overwriteFile":true, "createDir":true, wires: [["helperNode1"]]},
{id:"helperNode1", type:"helper"}];
var tmp_path = path.join(resourcesDir, "tmp");
var len = 1024*1024*10;
var file_count = 5;
helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileNode1");
var n2 = helper.getNode("helperNode1");
var count = 0;
n2.on("input", function(msg) {
try {
count++;
if (count == file_count) {
for(var i = 0; i < file_count; i++) {
var name = path.join(tmp_path, String(i));
var f = fs.readFileSync(name);
f.should.have.length(len);
f[0].should.have.equal(i);
}
fs.removeSync(tmp_path);
done();
}
}
catch (e) {
try {
fs.removeSync(tmp_path);
}
catch (e1) {
}
done(e);
}
});
for(var i = 0; i < file_count; i++) {
var data = new Buffer(len);
data.fill(i);
var name = path.join(tmp_path, String(i));
var msg = {payload:data, filename:name};
n1.receive(msg);
}
n1.close();
});
});
}); });
@ -572,7 +659,7 @@ describe('file Nodes', function() {
it('should read in a file and output a buffer', function(done) { it('should read in a file and output a buffer', function(done) {
var flow = [{id:"fileInNode1", type:"file in", name:"fileInNode", "filename":fileToTest, "format":"", wires:[["n2"]]}, var flow = [{id:"fileInNode1", type:"file in", name:"fileInNode", "filename":fileToTest, "format":"", wires:[["n2"]]},
{id:"n2", type:"helper"}]; {id:"n2", type:"helper"}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileInNode1"); var n1 = helper.getNode("fileInNode1");
var n2 = helper.getNode("n2"); var n2 = helper.getNode("n2");
@ -589,7 +676,7 @@ describe('file Nodes', function() {
it('should read in a file and output a utf8 string', function(done) { it('should read in a file and output a utf8 string', function(done) {
var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", "filename":fileToTest, "format":"utf8", wires:[["n2"]]}, var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", "filename":fileToTest, "format":"utf8", wires:[["n2"]]},
{id:"n2", type:"helper"}]; {id:"n2", type:"helper"}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileInNode1"); var n1 = helper.getNode("fileInNode1");
var n2 = helper.getNode("n2"); var n2 = helper.getNode("n2");
@ -610,7 +697,7 @@ describe('file Nodes', function() {
it('should read in a file and output split lines with parts', function(done) { it('should read in a file and output split lines with parts', function(done) {
var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", filename:fileToTest, format:"lines", wires:[["n2"]]}, var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", filename:fileToTest, format:"lines", wires:[["n2"]]},
{id:"n2", type:"helper"}]; {id:"n2", type:"helper"}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileInNode1"); var n1 = helper.getNode("fileInNode1");
var n2 = helper.getNode("n2"); var n2 = helper.getNode("n2");
@ -648,7 +735,7 @@ describe('file Nodes', function() {
var line = data.join("\n"); var line = data.join("\n");
fs.writeFileSync(fileToTest, line); fs.writeFileSync(fileToTest, line);
var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", filename:fileToTest, format:"lines", wires:[["n2"]]}, var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", filename:fileToTest, format:"lines", wires:[["n2"]]},
{id:"n2", type:"helper"}]; {id:"n2", type:"helper"}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileInNode1"); var n1 = helper.getNode("fileInNode1");
var n2 = helper.getNode("n2"); var n2 = helper.getNode("n2");
@ -681,7 +768,7 @@ describe('file Nodes', function() {
it('should read in a file and output a buffer with parts', function(done) { it('should read in a file and output a buffer with parts', function(done) {
var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", filename:fileToTest, format:"stream", wires:[["n2"]]}, var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", filename:fileToTest, format:"stream", wires:[["n2"]]},
{id:"n2", type:"helper"}]; {id:"n2", type:"helper"}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileInNode1"); var n1 = helper.getNode("fileInNode1");
var n2 = helper.getNode("n2"); var n2 = helper.getNode("n2");