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

add "split/stream" ability to file in node

Browse Source 
and add teste
This commit is contained in:
Dave Conway-Jones 2017-06-22 18:41:49 +01:00
parent 4f34980c9f
commit b91c178200
No known key found for this signature in database
GPG Key ID: 81B04231572A9A2D
3 changed files with 216 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
nodes/core/storage/50-file.html
View File

@ -55,7 +55,9 @@
<label for="node-input-format"><i class="fa fa-sign-out"></i> <span data-i18n="file.label.outputas"></span></label> <label for="node-input-format"><i class="fa fa-sign-out"></i> <span data-i18n="file.label.outputas"></span></label>
<select id="node-input-format"> <select id="node-input-format">
<option value="utf8" data-i18n="file.output.utf8"></option> <option value="utf8" data-i18n="file.output.utf8"></option>
<option value="lines" data-i18n="file.output.lines"></option>
<option value="" data-i18n="file.output.buffer"></option> <option value="" data-i18n="file.output.buffer"></option>
<option value="stream" data-i18n="file.output.stream"></option>
</select> </select>
</div> </div>
<div class="form-row"> <div class="form-row">
@ -83,6 +85,8 @@
<p>The filename should be an absolute path, otherwise it will be relative to <p>The filename should be an absolute path, otherwise it will be relative to
the working directory of the Node-RED process.</p> the working directory of the Node-RED process.</p>
<p>On Windows, path separators may need to be escaped, for example: <code>\\Users\\myUser</code>.</p> <p>On Windows, path separators may need to be escaped, for example: <code>\\Users\\myUser</code>.</p>
<p>Optionally, a text file can be split into lines, outputting one message per line, or a binary file
file into smaller buffer chunks, the chunk size is operating system dependant, but typically 64k (linux/mac) or 41k (Windows).</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">
@ -124,6 +128,7 @@
name: {value:""}, name: {value:""},
filename: {value:""}, filename: {value:""},
format: {value:"utf8"}, format: {value:"utf8"},
chunk: {value:false}
}, },
color:"BurlyWood", color:"BurlyWood",
inputs:1, inputs:1,
@ -137,7 +142,18 @@
}, },
labelStyle: function() { labelStyle: function() {
return this.name?"node_label_italic":""; return this.name?"node_label_italic":"";
},
oneditprepare: function() {
$("#node-input-format").on("change",function() {
if ($("#node-input-format").val() === "utf8") {
$("#buffer-input-type").hide();
$("#line-input-type").show();
}
else {
$("#buffer-input-type").show();
$("#line-input-type").hide();
}
});
} }
}); });
</script> </script>

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

@ -18,6 +18,7 @@ module.exports = function(RED) {
"use strict"; "use strict";
var fs = require("fs-extra"); var fs = require("fs-extra");
var os = require("os"); var os = require("os");
var path = require("path");
function FileNode(n) { function FileNode(n) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
@ -26,15 +27,27 @@ module.exports = function(RED) {
this.overwriteFile = n.overwriteFile.toString(); this.overwriteFile = n.overwriteFile.toString();
this.createDir = n.createDir || false; this.createDir = n.createDir || false;
var node = this; var node = this;
node.wstream = null;
node.data = [];
this.on("input",function(msg) { this.on("input",function(msg) {
var filename = node.filename || msg.filename || ""; var filename = node.filename || msg.filename || "";
if (!node.filename) { if (!node.filename) { node.status({fill:"grey",shape:"dot",text:filename}); }
node.status({fill:"grey",shape:"dot",text:filename}); if (filename === "") { node.warn(RED._("file.errors.nofilename")); }
else if (node.overwriteFile === "delete") {
fs.unlink(filename, function (err) {
if (err) { node.error(RED._("file.errors.deletefail",{error:err.toString()}),msg); }
else if (RED.settings.verbose) { node.log(RED._("file.status.deletedfile",{file:filename})); }
});
} }
if (filename === "") { else if (msg.hasOwnProperty("payload") && (typeof msg.payload !== "undefined")) {
node.warn(RED._("file.errors.nofilename")); var dir = path.dirname(filename);
} else if (msg.hasOwnProperty("payload") && (typeof msg.payload !== "undefined")) { if (node.createDir) {
fs.ensureDir(dir, function(err) {
if (err) { node.error(RED._("file.errors.createfail",{error:err.toString()}),msg); }
});
}
var data = msg.payload; var data = msg.payload;
if ((typeof data === "object") && (!Buffer.isBuffer(data))) { if ((typeof data === "object") && (!Buffer.isBuffer(data))) {
data = JSON.stringify(data); data = JSON.stringify(data);
@ -42,52 +55,26 @@ 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 ((this.appendNewline) && (!Buffer.isBuffer(data))) { data += os.EOL; } if ((this.appendNewline) && (!Buffer.isBuffer(data))) { data += os.EOL; }
data = new Buffer(data); node.data.push(new Buffer(data));
if (this.overwriteFile === "true") {
// using "binary" not {encoding:"binary"} to be 0.8 compatible for a while while (node.data.length > 0) {
//fs.writeFile(filename, data, "binary", function (err) { if (this.overwriteFile === "true") {
fs.writeFile(filename, data, {encoding:"binary"}, function (err) { if (!node.wstream) {
if (err) { node.wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'w' });
if ((err.code === "ENOENT") && node.createDir) { node.wstream.on("error", function(err) {
fs.ensureFile(filename, function (err) { node.error(RED._("file.errors.writefail",{error:err.toString()}),msg);
if (err) { node.error(RED._("file.errors.createfail",{error:err.toString()}),msg); } });
else {
fs.writeFile(filename, data, "binary", function (err) {
if (err) { node.error(RED._("file.errors.writefail",{error:err.toString()}),msg); }
});
}
});
}
else { node.error(RED._("file.errors.writefail",{error:err.toString()}),msg); }
} }
else if (RED.settings.verbose) { node.log(RED._("file.status.wrotefile",{file:filename})); } }
}); else {
} if (!node.wstream) {
else if (this.overwriteFile === "delete") { node.wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'a' });
fs.unlink(filename, function (err) { node.wstream.on("error", function(err) {
if (err) { node.error(RED._("file.errors.deletefail",{error:err.toString()}),msg); } node.error(RED._("file.errors.appendfail",{error:err.toString()}),msg);
else if (RED.settings.verbose) { node.log(RED._("file.status.deletedfile",{file:filename})); } });
});
}
else {
// using "binary" not {encoding:"binary"} to be 0.8 compatible for a while longer
//fs.appendFile(filename, data, "binary", function (err) {
fs.appendFile(filename, data, {encoding:"binary"}, function (err) {
if (err) {
if ((err.code === "ENOENT") && node.createDir) {
fs.ensureFile(filename, function (err) {
if (err) { node.error(RED._("file.errors.createfail",{error:err.toString()}),msg); }
else {
fs.appendFile(filename, data, "binary", function (err) {
if (err) { node.error(RED._("file.errors.appendfail",{error:err.toString()}),msg); }
});
}
});
}
else { node.error(RED._("file.errors.appendfail",{error:err.toString()}),msg); }
} }
else if (RED.settings.verbose) { node.log(RED._("file.status.appendedfile",{file:filename})); } }
}); node.wstream.write(node.data.shift());
} }
} }
}); });
@ -100,14 +87,13 @@ module.exports = function(RED) {
function FileInNode(n) { function FileInNode(n) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
this.filename = n.filename; this.filename = n.filename;
this.format = n.format; this.format = n.format;
this.chunk = false;
if (this.format === "lines") { this.chunk = true; }
if (this.format === "stream") { this.chunk = true; }
var node = this; var node = this;
var options = {};
if (this.format) {
options['encoding'] = this.format;
}
this.on("input",function(msg) { this.on("input",function(msg) {
var filename = node.filename || msg.filename || ""; var filename = node.filename || msg.filename || "";
if (!node.filename) { if (!node.filename) {
@ -115,19 +101,82 @@ module.exports = function(RED) {
} }
if (filename === "") { if (filename === "") {
node.warn(RED._("file.errors.nofilename")); node.warn(RED._("file.errors.nofilename"));
} else { }
else {
msg.filename = filename; msg.filename = filename;
fs.readFile(filename,options,function(err,data) { var lines = new Buffer.from([]);
if (err) { var spare = "";
node.error(err,msg); var count = 0;
msg.error = err; var type = "buffer";
delete msg.payload; var ch = "";
} else { if (node.format === "lines") {
msg.payload = data; ch = "\n";
delete msg.error; type = "string";
} }
node.send(msg); var hwm;
}); var getout = false;
var rs = fs.createReadStream(filename)
.on('readable', function () {
var chunk;
var hwm = rs._readableState.highWaterMark;
while (null !== (chunk = rs.read())) {
if (node.chunk === true) {
getout = true;
if (node.format === "lines") {
spare += chunk.toString();
var bits = spare.split("\n");
for (var i=0; i < bits.length - 1; i++) {
var m = {
payload:bits[i],
topic:msg.topic,
filename:msg.filename,
parts:{index:count, ch:ch, type:type, id:msg._msgid}
}
count += 1;
if ((chunk.length < hwm) && (bits[i+1].length === 0)) {
m.parts.count = count;
}
node.send(m);
}
spare = bits[i];
if (chunk.length !== hwm) { getout = false; }
//console.log("LEFT",bits[i].length,bits[i]);
}
if (node.format === "stream") {
var m = {
payload:chunk,
topic:msg.topic,
filename:msg.filename,
parts:{index:count, ch:ch, type:type, id:msg._msgid}
}
count += 1;
if (chunk.length < hwm) { // last chunk is smaller that high water mark = eof
getout = false;
m.parts.count = count;
}
node.send(m);
}
}
else {
lines = Buffer.concat([lines,chunk]);
}
}
})
.on('error', function(err) {
node.error('Error while reading file.', msg);
})
.on('end', function() {
if (node.chunk === false) {
if (node.format === "utf8") { msg.payload = lines.toString(); }
else { msg.payload = lines; }
node.send(msg);
}
else if (getout) { // last chunk same size as high water mark - have to send empty extra packet.
var m = { parts:{index:count, count:count, ch:ch, type:type, id:msg._msgid} };
node.send(m);
}
});
} }
}); });
this.on('close', function() { this.on('close', function() {

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

@ -183,8 +183,11 @@ describe('file Nodes', function() {
it('should fail to write to a ro file', function(done) { it('should fail to write to a ro file', function(done) {
// Stub file write so we can make writes fail // Stub file write so we can make writes fail
var spy = sinon.stub(fs, 'writeFile', function(arg1,arg2,arg3,arg4) { var spy = sinon.stub(fs, 'createWriteStream', function(arg1,arg2) {
arg4(new Error("Stub error message")); var ws = {};
ws.on = function(e,d) { throw("Stub error message"); }
ws.write = function(e,d) { }
return ws;
}); });
var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest, "appendNewline":false, "overwriteFile":true}]; var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest, "appendNewline":false, "overwriteFile":true}];
@ -198,11 +201,11 @@ describe('file Nodes', function() {
//console.log(logEvents); //console.log(logEvents);
logEvents.should.have.length(1); logEvents.should.have.length(1);
logEvents[0][0].should.have.a.property('msg'); logEvents[0][0].should.have.a.property('msg');
logEvents[0][0].msg.toString().should.startWith("file.errors.writefail"); logEvents[0][0].msg.toString().should.startWith("Stub error message");
done(); done();
} }
catch(e) { done(e); } catch(e) { done(e); }
finally { fs.writeFile.restore(); } finally { fs.createWriteStream.restore(); }
},wait); },wait);
n1.receive({payload:"test"}); n1.receive({payload:"test"});
}); });
@ -210,7 +213,12 @@ describe('file Nodes', function() {
it('should fail to append to a ro file', function(done) { it('should fail to append to a ro file', function(done) {
// Stub file write so we can make writes fail // Stub file write so we can make writes fail
var spy = sinon.stub(fs, 'appendFile', function(arg,arg2,arg3,arg4) { arg4(new Error("Stub error message")); }); var spy = sinon.stub(fs, 'createWriteStream', function(arg1,arg2) {
var ws = {};
ws.on = function(e,d) { throw("Stub error message"); }
ws.write = function(e,d) { }
return ws;
});
var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest, "appendNewline":true, "overwriteFile":false}]; var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest, "appendNewline":true, "overwriteFile":false}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
@ -223,11 +231,11 @@ describe('file Nodes', function() {
//console.log(logEvents); //console.log(logEvents);
logEvents.should.have.length(1); logEvents.should.have.length(1);
logEvents[0][0].should.have.a.property('msg'); logEvents[0][0].should.have.a.property('msg');
logEvents[0][0].msg.toString().should.startWith("file.errors.appendfail"); logEvents[0][0].msg.toString().should.startWith("Stub error message");
done(); done();
} }
catch(e) { done(e); } catch(e) { done(e); }
finally { fs.appendFile.restore(); } finally { fs.createWriteStream.restore(); }
},wait); },wait);
n1.receive({payload:"test2"}); n1.receive({payload:"test2"});
}); });
@ -287,7 +295,7 @@ describe('file Nodes', function() {
it('should try to create a new directory if asked to do so (append)', function(done) { it('should try to create a new directory if asked to do so (append)', function(done) {
// Stub file write so we can make writes fail // Stub file write so we can make writes fail
var fileToTest2 = path.join(resourcesDir,"a","50-file-test-file.txt"); var fileToTest2 = path.join(resourcesDir,"a","50-file-test-file.txt");
var spy = sinon.stub(fs, "ensureFile", function(arg1,arg2,arg3,arg4) { arg2(null); }); var spy = sinon.stub(fs, "ensureDir", function(arg1,arg2,arg3,arg4) { arg2(null); });
var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest2, "appendNewline":true, "overwriteFile":false, "createDir":true}]; var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest2, "appendNewline":true, "overwriteFile":false, "createDir":true}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileNode1"); var n1 = helper.getNode("fileNode1");
@ -303,7 +311,7 @@ describe('file Nodes', function() {
done(); done();
} }
catch(e) { done(e); } catch(e) { done(e); }
finally { fs.ensureFile.restore(); } finally { fs.ensureDir.restore(); }
},wait); },wait);
n1.receive({payload:"test2"}); n1.receive({payload:"test2"});
}); });
@ -338,7 +346,7 @@ describe('file Nodes', function() {
it('should try to create a new directory if asked to do so (overwrite)', function(done) { it('should try to create a new directory if asked to do so (overwrite)', function(done) {
// Stub file write so we can make writes fail // Stub file write so we can make writes fail
var fileToTest2 = path.join(resourcesDir,"a","50-file-test-file.txt"); var fileToTest2 = path.join(resourcesDir,"a","50-file-test-file.txt");
var spy = sinon.stub(fs, "ensureFile", function(arg1,arg2,arg3,arg4) { arg2(null); }); var spy = sinon.stub(fs, "ensureDir", function(arg1,arg2,arg3,arg4) { arg2(null); });
var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest2, "appendNewline":true, "overwriteFile":true, "createDir":true}]; var flow = [{id:"fileNode1", type:"file", name: "fileNode", "filename":fileToTest2, "appendNewline":true, "overwriteFile":true, "createDir":true}];
helper.load(fileNode, flow, function() { helper.load(fileNode, flow, function() {
@ -355,7 +363,7 @@ describe('file Nodes', function() {
done(); done();
} }
catch(e) { done(e); } catch(e) { done(e); }
finally { fs.ensureFile.restore(); } finally { fs.ensureDir.restore(); }
},wait); },wait);
n1.receive({payload:"test2"}); n1.receive({payload:"test2"});
}); });
@ -371,7 +379,7 @@ describe('file Nodes', function() {
var wait = 150; var wait = 150;
beforeEach(function(done) { beforeEach(function(done) {
fs.writeFileSync(fileToTest, "File message line 1\File message line 2\n"); fs.writeFileSync(fileToTest, "File message line 1\nFile message line 2\n");
helper.startServer(done); helper.startServer(done);
}); });
@ -392,60 +400,82 @@ 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");
n2.on("input", function(msg) { n2.on("input", function(msg) {
msg.should.have.property('payload'); msg.should.have.property('payload');
msg.payload.should.have.length(39).and.be.a.Buffer; msg.payload.should.have.length(40).and.be.a.Buffer;
msg.payload.toString().should.equal("File message line 1\File message line 2\n"); msg.payload.toString().should.equal('File message line 1\nFile message line 2\n');
done(); done();
}); });
n1.receive({payload:""}); n1.receive({payload:""});
}); });
}); });
// Commented out to make build pass on node v.0.8 - reinstate when we drop 0.8 support... 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"); n2.on("input", function(msg) {
//n2.on("input", function(msg) { msg.should.have.property('payload');
//msg.should.have.property('payload'); msg.payload.should.have.length(40).and.be.a.string;
//msg.payload.should.have.length(39).and.be.a.string; msg.payload.should.equal("File message line 1\nFile message line 2\n");
//msg.payload.should.equal("File message line 1\File message line 2\n"); done();
//done(); });
//}); n1.receive({payload:""});
//n1.receive({payload:""}); });
//}); });
//});
// Commented out as we no longer need to warn of the very old deprecated behaviour it('should read in a file and output split lines with parts', function(done) {
//it('should warn if msg.props try to overide', 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":"", 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"); var c = 0;
//n2.on("input", function(msg) { n2.on("input", function(msg) {
//msg.should.have.property('payload'); msg.should.have.property('payload');
//msg.payload.should.have.length(39).and.be.a.Buffer; msg.payload.should.have.length(19).and.be.a.string;
//msg.payload.toString().should.equal("File message line 1\File message line 2\n"); if (c === 0) {
//var logEvents = helper.log().args.filter(function(evt) { msg.payload.should.equal("File message line 1");
//return evt[0].type == "file in"; c++;
//}); } else {
//logEvents.should.have.length(1); msg.payload.should.equal("File message line 2");
//logEvents[0][0].should.have.a.property('msg'); msg.should.have.property('parts');
//logEvents[0][0].msg.toString().should.startWith("file.errors.nooverride"); msg.parts.should.have.property('index',1);
//done(); msg.parts.should.have.property('count',2);
//}); msg.parts.should.have.property('type','string');
//n1.receive({payload:"",filename:"foo.txt"}); msg.parts.should.have.property('ch','\n');
//}); done();
//}); }
});
n1.receive({payload:""});
});
});
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"]]},
{id:"n2", type:"helper"}];
helper.load(fileNode, flow, function() {
var n1 = helper.getNode("fileInNode1");
var n2 = helper.getNode("n2");
n2.on("input", function(msg) {
msg.should.have.property('payload');
msg.payload.should.have.length(40).and.be.a.Buffer;
msg.should.have.property('parts');
msg.parts.should.have.property('count',1);
msg.parts.should.have.property('type','buffer');
msg.parts.should.have.property('ch','');
done();
});
n1.receive({payload:""});
});
});
it('should warn if no filename set', function(done) { it('should warn if no filename set', function(done) {
var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", "format":""}]; var flow = [{id:"fileInNode1", type:"file in", name: "fileInNode", "format":""}];
@ -474,8 +504,7 @@ describe('file Nodes', function() {
}); });
logEvents.should.have.length(1); logEvents.should.have.length(1);
logEvents[0][0].should.have.a.property('msg'); logEvents[0][0].should.have.a.property('msg');
//logEvents[0][0].msg.toString().should.equal("Error: ENOENT, open 'badfile'"); logEvents[0][0].msg.toString().should.startWith("Error");
logEvents[0][0].msg.toString().should.startWith("Error: ENOENT");
done(); done();
},wait); },wait);
n1.receive({payload:""}); n1.receive({payload:""});
@ -483,5 +512,4 @@ describe('file Nodes', function() {
}); });
}); });
}); });