Compare commits

..

1 Commits

Author SHA1 Message Date
Gareth Jones
67b19aeaf3 changed supported node versions to 0.6 and 0.8 2013-04-02 10:09:02 +11:00
20 changed files with 571 additions and 341 deletions

View File

@@ -1,5 +1,4 @@
language: node_js language: node_js
node_js: node_js:
- "0.10" - 0.6
- "0.8" - 0.8

View File

@@ -17,8 +17,6 @@ Out of the box it supports the following features:
* configurable log message layout/patterns * configurable log message layout/patterns
* different log levels for different log categories (make some parts of your app log as DEBUG, others only ERRORS, etc.) * different log levels for different log categories (make some parts of your app log as DEBUG, others only ERRORS, etc.)
NOTE: version 0.6.0 onwards will only work with node v0.10.x upwards, since it makes use of the new streams API. If you're using node 0.8 or lower, use log4js@0.5.7.
NOTE: from log4js 0.5 onwards you'll need to explicitly enable replacement of node's console.log functions. Do this either by calling `log4js.replaceConsole()` or configuring with an object or json file like this: NOTE: from log4js 0.5 onwards you'll need to explicitly enable replacement of node's console.log functions. Do this either by calling `log4js.replaceConsole()` or configuring with an object or json file like this:
```javascript ```javascript
@@ -130,13 +128,13 @@ If you have already defined an absolute path for one of the FileAppenders in the
] ]
} }
``` ```
Documentation for most of the core appenders can be found on the [wiki](https://github.com/nomiddlename/log4js-node/wiki/Appenders), otherwise take a look at the tests and the examples. Documentation for most of the core appenders can be found on the [wiki](log4js-node/wiki/Appenders), otherwise take a look at the tests and the examples.
## Documentation ## Documentation
See the [wiki](https://github.com/nomiddlename/log4js-node/wiki). Improve the [wiki](https://github.com/nomiddlename/log4js-node/wiki), please. See the [wiki](log4js-node/wiki). Improve the [wiki](log4js-node/wiki), please.
## Contributing ## Contributing
Contributions welcome, but take a look at the [rules](https://github.com/nomiddlename/log4js-node/wiki/Contributing) first. Contributions welcome, but take a look at the [rules](log4js-node/wiki/Contributing) first.
## License ## License

View File

@@ -1,4 +1,4 @@
var log4js = require('../lib/log4js'); var log4js = require('./lib/log4js');
//log the cheese logger messages to a file, and the console ones as well. //log the cheese logger messages to a file, and the console ones as well.
log4js.configure({ log4js.configure({
appenders: [ appenders: [

View File

@@ -1,4 +1,4 @@
var log4js = require('../lib/log4js') var log4js = require('./lib/log4js')
, log , log
, i = 0; , i = 0;
log4js.configure({ log4js.configure({

View File

@@ -22,7 +22,7 @@ process.on('exit', function() {
function appender(filename, pattern, layout) { function appender(filename, pattern, layout) {
layout = layout || layouts.basicLayout; layout = layout || layouts.basicLayout;
var logFile = new streams.DateRollingFileStream(filename, pattern); var logFile = new streams.BufferedWriteStream(new streams.DateRollingFileStream(filename, pattern));
openFiles.push(logFile); openFiles.push(logFile);
return function(logEvent) { return function(logEvent) {

View File

@@ -32,13 +32,15 @@ function fileAppender (file, layout, logSize, numBackups) {
function openTheStream(file, fileSize, numFiles) { function openTheStream(file, fileSize, numFiles) {
var stream; var stream;
if (fileSize) { if (fileSize) {
stream = new streams.RollingFileStream( stream = new streams.BufferedWriteStream(
new streams.RollingFileStream(
file, file,
fileSize, fileSize,
numFiles numFiles
)
); );
} else { } else {
stream = fs.createWriteStream(file, { encoding: "utf8", mode: 0644, flags: 'a' }); stream = new streams.BufferedWriteStream(fs.createWriteStream(file, { encoding: "utf8", mode: 0644, flags: 'a' }));
} }
stream.on("error", function (err) { stream.on("error", function (err) {
console.error("log4js.fileAppender - Writing to file %s, error happened ", file, err); console.error("log4js.fileAppender - Writing to file %s, error happened ", file, err);

View File

@@ -38,6 +38,7 @@ function logServer(config) {
var actualAppender = config.actualAppender, var actualAppender = config.actualAppender,
server = net.createServer(function serverCreated(clientSocket) { server = net.createServer(function serverCreated(clientSocket) {
clientSocket.setEncoding('utf8'); clientSocket.setEncoding('utf8');
clientSocket.on('connect', function clientConnected() {
var logMessage = ''; var logMessage = '';
function logTheMessage(msg) { function logTheMessage(msg) {
@@ -61,7 +62,7 @@ function logServer(config) {
clientSocket.on('data', chunkReceived); clientSocket.on('data', chunkReceived);
clientSocket.on('end', chunkReceived); clientSocket.on('end', chunkReceived);
}); });
});
server.listen(config.loggerPort || 5000, config.loggerHost || 'localhost'); server.listen(config.loggerPort || 5000, config.loggerHost || 'localhost');
return actualAppender; return actualAppender;

View File

@@ -1,28 +1,21 @@
var fs = require('fs'), var fs = require('fs'),
stream, util = require('util');
util = require('util'),
semver = require('semver');
if (semver.satisfies(process.version, '>=0.10.0')) { function debug(message) {
stream = require('stream'); // console.log(message);
} else {
stream = require('readable-stream');
}
var debug;
if (process.env.NODE_DEBUG && /\blog4js\b/.test(process.env.NODE_DEBUG)) {
debug = function(message) { console.error('LOG4JS: (BaseRollingFileStream) %s', message); };
} else {
debug = function() { };
} }
module.exports = BaseRollingFileStream; module.exports = BaseRollingFileStream;
function BaseRollingFileStream(filename, options) { function BaseRollingFileStream(filename, options) {
debug("In BaseRollingFileStream"); debug("In BaseRollingFileStream");
this.filename = filename; this.filename = filename;
this.options = options || { encoding: 'utf8', mode: 0644, flags: 'a' }; this.options = options || { encoding: 'utf8', mode: 0644, flags: 'a' };
this.rolling = false;
this.writesWhileRolling = [];
this.currentSize = 0; this.currentSize = 0;
this.rollBeforeWrite = false;
function currentFileSize(file) { function currentFileSize(file) {
var fileSize = 0; var fileSize = 0;
@@ -42,41 +35,58 @@ function BaseRollingFileStream(filename, options) {
throwErrorIfArgumentsAreNotValid(); throwErrorIfArgumentsAreNotValid();
debug("Calling BaseRollingFileStream.super"); debug("Calling BaseRollingFileStream.super");
BaseRollingFileStream.super_.call(this); BaseRollingFileStream.super_.call(this, this.filename, this.options);
this.openTheStream();
this.currentSize = currentFileSize(this.filename); this.currentSize = currentFileSize(this.filename);
} }
util.inherits(BaseRollingFileStream, stream.Writable); util.inherits(BaseRollingFileStream, fs.FileWriteStream);
BaseRollingFileStream.prototype._write = function(chunk, encoding, callback) { BaseRollingFileStream.prototype.initRolling = function() {
var that = this; var that = this;
function writeTheChunk() {
debug("writing the chunk to the underlying stream"); function emptyRollingQueue() {
that.currentSize += chunk.length; debug("emptying the rolling queue");
that.theStream.write(chunk, encoding, callback); var toWrite;
while ((toWrite = that.writesWhileRolling.shift())) {
BaseRollingFileStream.super_.prototype.write.call(that, toWrite.data, toWrite.encoding);
that.currentSize += toWrite.data.length;
if (that.shouldRoll()) {
that.flush();
return true;
}
}
that.flush();
return false;
} }
debug("in _write"); this.rolling = true;
this.roll(this.filename, function() {
that.currentSize = 0;
that.rolling = emptyRollingQueue();
if (that.rolling) {
process.nextTick(function() { that.initRolling(); });
}
});
};
if (this.shouldRoll()) { BaseRollingFileStream.prototype.write = function(data, encoding) {
this.currentSize = 0; var canWrite = false;
this.roll(this.filename, writeTheChunk); if (this.rolling) {
this.writesWhileRolling.push({ data: data, encoding: encoding });
} else { } else {
writeTheChunk(); if (this.rollBeforeWrite && this.shouldRoll()) {
} this.writesWhileRolling.push({ data: data, encoding: encoding });
}; this.initRolling();
} else {
canWrite = BaseRollingFileStream.super_.prototype.write.call(this, data, encoding);
this.currentSize += data.length;
debug('current size = ' + this.currentSize);
BaseRollingFileStream.prototype.openTheStream = function(cb) { if (!this.rollBeforeWrite && this.shouldRoll()) {
debug("opening the underlying stream"); this.initRolling();
this.theStream = fs.createWriteStream(this.filename, this.options);
if (cb) {
this.theStream.on("open", cb);
} }
}; }
}
BaseRollingFileStream.prototype.closeTheStream = function(cb) { return canWrite;
debug("closing the underlying stream");
this.theStream.end(cb);
}; };
BaseRollingFileStream.prototype.shouldRoll = function() { BaseRollingFileStream.prototype.shouldRoll = function() {

View File

@@ -0,0 +1,78 @@
var events = require('events'),
Dequeue = require('dequeue'),
util = require('util');
module.exports = BufferedWriteStream;
function BufferedWriteStream(stream) {
var that = this;
this.stream = stream;
this.buffer = new Dequeue();
this.canWrite = false;
this.bytes = 0;
this.stream.on("open", function() {
that.canWrite = true;
that.flushBuffer();
});
this.stream.on("error", function (err) {
that.emit("error", err);
});
this.stream.on("drain", function() {
that.canWrite = true;
that.flushBuffer();
});
}
util.inherits(BufferedWriteStream, events.EventEmitter);
Object.defineProperty(
BufferedWriteStream.prototype,
"fd",
{
get: function() { return this.stream.fd; },
set: function(newFd) {
this.stream.fd = newFd;
this.bytes = 0;
}
}
);
Object.defineProperty(
BufferedWriteStream.prototype,
"bytesWritten",
{
get: function() { return this.bytes; }
}
);
BufferedWriteStream.prototype.write = function(data, encoding) {
this.buffer.push({ data: data, encoding: encoding });
this.flushBuffer();
};
BufferedWriteStream.prototype.end = function(data, encoding) {
if (data) {
this.buffer.push({ data: data, encoding: encoding });
}
this.flushBufferEvenIfCannotWrite();
};
BufferedWriteStream.prototype.writeToStream = function(toWrite) {
this.bytes += toWrite.data.length;
this.canWrite = this.stream.write(toWrite.data, toWrite.encoding);
};
BufferedWriteStream.prototype.flushBufferEvenIfCannotWrite = function() {
while (this.buffer.length > 0) {
this.writeToStream(this.buffer.shift());
}
};
BufferedWriteStream.prototype.flushBuffer = function() {
while (this.buffer.length > 0 && this.canWrite) {
this.writeToStream(this.buffer.shift());
}
};

View File

@@ -6,11 +6,8 @@ var BaseRollingFileStream = require('./BaseRollingFileStream'),
module.exports = DateRollingFileStream; module.exports = DateRollingFileStream;
var debug; function debug(message) {
if (process.env.NODE_DEBUG && /\blog4js\b/.test(process.env.NODE_DEBUG)) { // console.log(message);
debug = function(message) { console.error('LOG4JS: (DateRollingFileStream) %s', message); };
} else {
debug = function() { };
} }
function DateRollingFileStream(filename, pattern, options, now) { function DateRollingFileStream(filename, pattern, options, now) {
@@ -26,7 +23,9 @@ function DateRollingFileStream(filename, pattern, options, now) {
debug("this.now is " + this.now + ", now is " + now); debug("this.now is " + this.now + ", now is " + now);
DateRollingFileStream.super_.call(this, filename, options); DateRollingFileStream.super_.call(this, filename, options);
this.rollBeforeWrite = true;
} }
util.inherits(DateRollingFileStream, BaseRollingFileStream); util.inherits(DateRollingFileStream, BaseRollingFileStream);
DateRollingFileStream.prototype.shouldRoll = function() { DateRollingFileStream.prototype.shouldRoll = function() {
@@ -46,12 +45,14 @@ DateRollingFileStream.prototype.roll = function(filename, callback) {
newFilename = filename + this.previousTime; newFilename = filename + this.previousTime;
debug("Starting roll"); debug("Starting roll");
debug("Queueing up data until we've finished rolling");
debug("Flushing underlying stream");
this.flush();
async.series([ async.series([
this.closeTheStream.bind(this),
deleteAnyExistingFile, deleteAnyExistingFile,
renameTheCurrentFile, renameTheCurrentFile,
this.openTheStream.bind(this) openANewFile
], callback); ], callback);
function deleteAnyExistingFile(cb) { function deleteAnyExistingFile(cb) {
@@ -68,4 +69,21 @@ DateRollingFileStream.prototype.roll = function(filename, callback) {
fs.rename(filename, newFilename, cb); fs.rename(filename, newFilename, cb);
} }
function openANewFile(cb) {
debug("Opening a new file");
fs.open(
filename,
that.options.flags,
that.options.mode,
function (err, fd) {
debug("opened new file");
var oldLogFileFD = that.fd;
that.fd = fd;
that.writable = true;
fs.close(oldLogFileFD, cb);
}
);
}
}; };

View File

@@ -4,11 +4,9 @@ var BaseRollingFileStream = require('./BaseRollingFileStream'),
fs = require('fs'), fs = require('fs'),
async = require('async'); async = require('async');
var debug; function debug(message) {
if (process.env.NODE_DEBUG && /\blog4js\b/.test(process.env.NODE_DEBUG)) { // util.debug(message);
debug = function(message) { console.error('LOG4JS: (RollingFileStream) %s', message); }; // console.log(message);
} else {
debug = function() { };
} }
module.exports = RollingFileStream; module.exports = RollingFileStream;
@@ -30,7 +28,6 @@ function RollingFileStream (filename, size, backups, options) {
util.inherits(RollingFileStream, BaseRollingFileStream); util.inherits(RollingFileStream, BaseRollingFileStream);
RollingFileStream.prototype.shouldRoll = function() { RollingFileStream.prototype.shouldRoll = function() {
debug("should roll with current size %d, and max size %d", this.currentSize, this.size);
return this.currentSize >= this.size; return this.currentSize >= this.size;
}; };
@@ -84,11 +81,30 @@ RollingFileStream.prototype.roll = function(filename, callback) {
}); });
} }
debug("Rolling, rolling, rolling"); function openANewFile(cb) {
debug("Opening a new file");
fs.open(
filename,
that.options.flags,
that.options.mode,
function (err, fd) {
debug("opened new file");
var oldLogFileFD = that.fd;
that.fd = fd;
that.writable = true;
fs.close(oldLogFileFD, cb);
}
);
}
debug("Starting roll");
debug("Queueing up data until we've finished rolling");
debug("Flushing underlying stream");
this.flush();
async.series([ async.series([
this.closeTheStream.bind(this),
renameTheFiles, renameTheFiles,
this.openTheStream.bind(this) openANewFile
], callback); ], callback);
}; };

View File

@@ -1,2 +1,3 @@
exports.BufferedWriteStream = require('./BufferedWriteStream');
exports.RollingFileStream = require('./RollingFileStream'); exports.RollingFileStream = require('./RollingFileStream');
exports.DateRollingFileStream = require('./DateRollingFileStream'); exports.DateRollingFileStream = require('./DateRollingFileStream');

View File

@@ -1,6 +1,6 @@
{ {
"name": "log4js", "name": "log4js",
"version": "0.6.2", "version": "0.5.8",
"description": "Port of Log4js to work with node.", "description": "Port of Log4js to work with node.",
"keywords": [ "keywords": [
"logging", "logging",
@@ -18,7 +18,7 @@
"url": "http://github.com/nomiddlename/log4js-node/issues" "url": "http://github.com/nomiddlename/log4js-node/issues"
}, },
"engines": { "engines": {
"node": ">=0.8" "node": "~0.6||~0.8"
}, },
"scripts": { "scripts": {
"test": "vows" "test": "vows"
@@ -29,12 +29,10 @@
}, },
"dependencies": { "dependencies": {
"async": "0.1.15", "async": "0.1.15",
"dequeue": "1.0.3", "dequeue": "1.0.3"
"semver": "~1.1.4",
"readable-stream": "~1.0.2"
}, },
"devDependencies": { "devDependencies": {
"vows": "0.7.0", "vows": "0.6.2",
"sandboxed-module": "0.1.3", "sandboxed-module": "0.1.3",
"hook.io": "0.8.10", "hook.io": "0.8.10",
"underscore": "1.2.1" "underscore": "1.2.1"

View File

@@ -108,13 +108,7 @@ vows.describe('log4js fileAppender').addBatch({
var that = this; var that = this;
//give the system a chance to open the stream //give the system a chance to open the stream
setTimeout(function() { setTimeout(function() {
fs.readdir(__dirname, function(err, files) { fs.readdir(__dirname, that.callback);
if (files) {
that.callback(null, files.sort());
} else {
that.callback(err, files);
}
});
}, 200); }, 200);
}, },
'the log files': { 'the log files': {
@@ -126,30 +120,30 @@ vows.describe('log4js fileAppender').addBatch({
assert.equal(files.length, 3); assert.equal(files.length, 3);
}, },
'should be named in sequence': function (files) { 'should be named in sequence': function (files) {
assert.deepEqual(files, ['fa-maxFileSize-with-backups-test.log', 'fa-maxFileSize-with-backups-test.log.1', 'fa-maxFileSize-with-backups-test.log.2']); assert.deepEqual(files.sort(), ['fa-maxFileSize-with-backups-test.log', 'fa-maxFileSize-with-backups-test.log.1', 'fa-maxFileSize-with-backups-test.log.2']);
}, },
'and the contents of the first file': { 'and the contents of the first file': {
topic: function(logFiles) { topic: function(logFiles) {
fs.readFile(path.join(__dirname, logFiles[0]), "utf8", this.callback); fs.readFile(path.join(__dirname, logFiles[0]), "utf8", this.callback);
}, },
'should be the last log message': function(contents) { 'should be empty because the last log message triggers rolling': function(contents) {
assert.include(contents, 'This is the fourth log message.'); assert.isEmpty(contents);
} }
}, },
'and the contents of the second file': { 'and the contents of the second file': {
topic: function(logFiles) { topic: function(logFiles) {
fs.readFile(path.join(__dirname, logFiles[1]), "utf8", this.callback); fs.readFile(path.join(__dirname, logFiles[1]), "utf8", this.callback);
}, },
'should be the third log message': function(contents) { 'should be the last log message': function(contents) {
assert.include(contents, 'This is the third log message.'); assert.include(contents, 'This is the fourth log message.');
} }
}, },
'and the contents of the third file': { 'and the contents of the third file': {
topic: function(logFiles) { topic: function(logFiles) {
fs.readFile(path.join(__dirname, logFiles[2]), "utf8", this.callback); fs.readFile(path.join(__dirname, logFiles[2]), "utf8", this.callback);
}, },
'should be the second log message': function(contents) { 'should be the third log message': function(contents) {
assert.include(contents, 'This is the second log message.'); assert.include(contents, 'This is the third log message.');
} }
} }
} }

View File

@@ -50,10 +50,9 @@ vows.describe('log4js-abspath').addBatch({
{ {
RollingFileStream: function(file) { RollingFileStream: function(file) {
fileOpened = file; fileOpened = file;
return { },
on: function() {}, BufferedWriteStream: function(other) {
end: function() {} return { on: function() { }, end: function() {} }
};
} }
} }
} }

View File

@@ -183,6 +183,7 @@ vows.describe('Multiprocess Appender').addBatch({
topic: function(net) { topic: function(net) {
var logString = JSON.stringify({ level: { level: 10000, levelStr: 'DEBUG' }, data: ['some debug']}) + '__LOG4JS__'; var logString = JSON.stringify({ level: { level: 10000, levelStr: 'DEBUG' }, data: ['some debug']}) + '__LOG4JS__';
net.cbs['connect']();
net.cbs['data'](JSON.stringify({ level: { level: 40000, levelStr: 'ERROR' }, data: ['an error message'] }) + '__LOG4JS__'); net.cbs['data'](JSON.stringify({ level: { level: 40000, levelStr: 'ERROR' }, data: ['an error message'] }) + '__LOG4JS__');
net.cbs['data'](logString.substring(0, 10)); net.cbs['data'](logString.substring(0, 10));
net.cbs['data'](logString.substring(10)); net.cbs['data'](logString.substring(10));

View File

@@ -1,17 +1,8 @@
var vows = require('vows') var vows = require('vows'),
, assert = require('assert') assert = require('assert'),
, fs = require('fs') fs = require('fs'),
, semver = require('semver') DateRollingFileStream = require('../../lib/streams').DateRollingFileStream,
, streams testTime = new Date(2012, 8, 12, 10, 37, 11);
, DateRollingFileStream
, testTime = new Date(2012, 8, 12, 10, 37, 11);
if (semver.satisfies(process.version, '>=0.10.0')) {
streams = require('stream');
} else {
streams = require('readable-stream');
}
DateRollingFileStream = require('../../lib/streams').DateRollingFileStream
function cleanUp(filename) { function cleanUp(filename) {
return function() { return function() {
@@ -28,16 +19,15 @@ vows.describe('DateRollingFileStream').addBatch({
topic: new DateRollingFileStream(__dirname + '/test-date-rolling-file-stream-1', 'yyyy-mm-dd.hh'), topic: new DateRollingFileStream(__dirname + '/test-date-rolling-file-stream-1', 'yyyy-mm-dd.hh'),
teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-1'), teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-1'),
'should take a filename and a pattern and return a WritableStream': function(stream) { 'should take a filename and a pattern and return a FileWriteStream': function(stream) {
assert.equal(stream.filename, __dirname + '/test-date-rolling-file-stream-1'); assert.equal(stream.filename, __dirname + '/test-date-rolling-file-stream-1');
assert.equal(stream.pattern, 'yyyy-mm-dd.hh'); assert.equal(stream.pattern, 'yyyy-mm-dd.hh');
assert.instanceOf(stream, streams.Writable); assert.instanceOf(stream, fs.FileWriteStream);
}, },
'with default settings for the underlying stream': function(stream) { 'with default settings for the underlying stream': function(stream) {
assert.equal(stream.theStream.mode, 420); assert.equal(stream.mode, 420);
assert.equal(stream.theStream.flags, 'a'); assert.equal(stream.flags, 'a');
//encoding is not available on the underlying stream assert.equal(stream.encoding, 'utf8');
//assert.equal(stream.encoding, 'utf8');
} }
}, },
@@ -55,7 +45,7 @@ vows.describe('DateRollingFileStream').addBatch({
teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-3'), teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-3'),
'should pass them to the underlying stream': function(stream) { 'should pass them to the underlying stream': function(stream) {
assert.equal(stream.theStream.mode, 0666); assert.equal(stream.mode, 0666);
} }
}, },
@@ -64,7 +54,7 @@ vows.describe('DateRollingFileStream').addBatch({
teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-4'), teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-4'),
'should pass them to the underlying stream': function(stream) { 'should pass them to the underlying stream': function(stream) {
assert.equal(stream.theStream.mode, 0666); assert.equal(stream.mode, 0666);
}, },
'should use default pattern': function(stream) { 'should use default pattern': function(stream) {
assert.equal(stream.pattern, '.yyyy-MM-dd'); assert.equal(stream.pattern, '.yyyy-MM-dd');
@@ -75,7 +65,9 @@ vows.describe('DateRollingFileStream').addBatch({
topic: function() { topic: function() {
var that = this, var that = this,
stream = new DateRollingFileStream(__dirname + '/test-date-rolling-file-stream-5', '.yyyy-MM-dd', null, now); stream = new DateRollingFileStream(__dirname + '/test-date-rolling-file-stream-5', '.yyyy-MM-dd', null, now);
stream.write("First message\n", 'utf8', function() { stream.on("open", function() {
stream.write("First message\n");
//wait for the file system to catch up with us
that.callback(null, stream); that.callback(null, stream);
}); });
}, },
@@ -93,7 +85,8 @@ vows.describe('DateRollingFileStream').addBatch({
'when the day changes': { 'when the day changes': {
topic: function(stream) { topic: function(stream) {
testTime = new Date(2012, 8, 13, 0, 10, 12); testTime = new Date(2012, 8, 13, 0, 10, 12);
stream.write("Second message\n", 'utf8', this.callback); stream.write("Second message\n");
setTimeout(this.callback, 100);
}, },
teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-5.2012-09-12'), teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-5.2012-09-12'),

View File

@@ -0,0 +1,130 @@
var vows = require('vows')
, assert = require('assert')
, events = require('events')
, BufferedWriteStream = require('../../lib/streams').BufferedWriteStream;
function FakeStream() {
this.writes = [];
this.canWrite = false;
this.callbacks = {};
}
FakeStream.prototype.on = function(event, callback) {
this.callbacks[event] = callback;
}
FakeStream.prototype.write = function(data, encoding) {
assert.equal("utf8", encoding);
this.writes.push(data);
return this.canWrite;
}
FakeStream.prototype.emit = function(event, payload) {
this.callbacks[event](payload);
}
FakeStream.prototype.block = function() {
this.canWrite = false;
}
FakeStream.prototype.unblock = function() {
this.canWrite = true;
this.emit("drain");
}
vows.describe('BufferedWriteStream').addBatch({
'stream': {
topic: new BufferedWriteStream(new FakeStream()),
'should take a stream as an argument and return a stream': function(stream) {
assert.instanceOf(stream, events.EventEmitter);
}
},
'before stream is open': {
topic: function() {
var fakeStream = new FakeStream(),
stream = new BufferedWriteStream(fakeStream);
stream.write("Some data", "utf8");
stream.write("Some more data", "utf8");
return fakeStream.writes;
},
'should buffer writes': function(writes) {
assert.equal(writes.length, 0);
}
},
'when stream is open': {
topic: function() {
var fakeStream = new FakeStream(),
stream = new BufferedWriteStream(fakeStream);
stream.write("Some data", "utf8");
fakeStream.canWrite = true;
fakeStream.emit("open");
stream.write("Some more data", "utf8");
return fakeStream.writes;
},
'should write data to stream from before stream was open': function (writes) {
assert.equal(writes[0], "Some data");
},
'should write data to stream from after stream was open': function (writes) {
assert.equal(writes[1], "Some more data");
}
},
'when stream is blocked': {
topic: function() {
var fakeStream = new FakeStream(),
stream = new BufferedWriteStream(fakeStream);
fakeStream.emit("open");
fakeStream.block();
stream.write("will not know it is blocked until first write", "utf8");
stream.write("so this one will be buffered, but not the previous one", "utf8");
return fakeStream.writes;
},
'should buffer writes': function (writes) {
assert.equal(writes.length, 1);
assert.equal(writes[0], "will not know it is blocked until first write");
}
},
'when stream is unblocked': {
topic: function() {
var fakeStream = new FakeStream(),
stream = new BufferedWriteStream(fakeStream);
fakeStream.emit("open");
fakeStream.block();
stream.write("will not know it is blocked until first write", "utf8");
stream.write("so this one will be buffered, but not the previous one", "utf8");
fakeStream.unblock();
return fakeStream.writes;
},
'should send buffered data': function (writes) {
assert.equal(writes.length, 2);
assert.equal(writes[1], "so this one will be buffered, but not the previous one");
}
},
'when stream is closed': {
topic: function() {
var fakeStream = new FakeStream(),
stream = new BufferedWriteStream(fakeStream);
fakeStream.emit("open");
fakeStream.block();
stream.write("first write to notice stream is blocked", "utf8");
stream.write("data while blocked", "utf8");
stream.end();
return fakeStream.writes;
},
'should send any buffered writes to the stream': function (writes) {
assert.equal(writes.length, 2);
assert.equal(writes[1], "data while blocked");
}
},
'when stream errors': {
topic: function() {
var fakeStream = new FakeStream(),
stream = new BufferedWriteStream(fakeStream);
stream.on("error", this.callback);
fakeStream.emit("error", "oh noes!");
},
'should emit error': function(err, value) {
assert.equal(err, "oh noes!");
}
}
}).exportTo(module);

View File

@@ -1,18 +1,8 @@
var vows = require('vows') var vows = require('vows')
, async = require('async')
, assert = require('assert') , assert = require('assert')
, events = require('events') , events = require('events')
, fs = require('fs') , fs = require('fs')
, semver = require('semver') , RollingFileStream = require('../../lib/streams').RollingFileStream;
, streams
, RollingFileStream;
if (semver.satisfies(process.version, '>=0.10.0')) {
streams = require('stream');
} else {
streams = require('readable-stream');
}
RollingFileStream = require('../../lib/streams').RollingFileStream;
function remove(filename) { function remove(filename) {
try { try {
@@ -28,17 +18,16 @@ vows.describe('RollingFileStream').addBatch({
remove(__dirname + "/test-rolling-file-stream"); remove(__dirname + "/test-rolling-file-stream");
return new RollingFileStream("test-rolling-file-stream", 1024, 5); return new RollingFileStream("test-rolling-file-stream", 1024, 5);
}, },
'should take a filename, file size in bytes, number of backups as arguments and return a Writable': function(stream) { 'should take a filename, file size in bytes, number of backups as arguments and return a FileWriteStream': function(stream) {
assert.instanceOf(stream, streams.Writable); assert.instanceOf(stream, fs.FileWriteStream);
assert.equal(stream.filename, "test-rolling-file-stream"); assert.equal(stream.filename, "test-rolling-file-stream");
assert.equal(stream.size, 1024); assert.equal(stream.size, 1024);
assert.equal(stream.backups, 5); assert.equal(stream.backups, 5);
}, },
'with default settings for the underlying stream': function(stream) { 'with default settings for the underlying stream': function(stream) {
assert.equal(stream.theStream.mode, 420); assert.equal(stream.mode, 420);
assert.equal(stream.theStream.flags, 'a'); assert.equal(stream.flags, 'a');
//encoding isn't a property on the underlying stream assert.equal(stream.encoding, 'utf8');
//assert.equal(stream.theStream.encoding, 'utf8');
} }
}, },
'with stream arguments': { 'with stream arguments': {
@@ -47,7 +36,7 @@ vows.describe('RollingFileStream').addBatch({
return new RollingFileStream('test-rolling-file-stream', 1024, 5, { mode: 0666 }); return new RollingFileStream('test-rolling-file-stream', 1024, 5, { mode: 0666 });
}, },
'should pass them to the underlying stream': function(stream) { 'should pass them to the underlying stream': function(stream) {
assert.equal(stream.theStream.mode, 0666); assert.equal(stream.mode, 0666);
} }
}, },
'without size': { 'without size': {
@@ -75,10 +64,13 @@ vows.describe('RollingFileStream').addBatch({
topic: function() { topic: function() {
remove(__dirname + "/test-rolling-file-stream-write-less"); remove(__dirname + "/test-rolling-file-stream-write-less");
var that = this, stream = new RollingFileStream(__dirname + "/test-rolling-file-stream-write-less", 100); var that = this, stream = new RollingFileStream(__dirname + "/test-rolling-file-stream-write-less", 100);
stream.write("cheese", "utf8", function() { stream.on("open", function() { that.callback(null, stream); });
},
'(when open)': {
topic: function(stream) {
stream.write("cheese", "utf8");
stream.end(); stream.end();
fs.readFile(__dirname + "/test-rolling-file-stream-write-less", "utf8", that.callback); fs.readFile(__dirname + "/test-rolling-file-stream-write-less", "utf8", this.callback);
});
}, },
'should write to the file': function(contents) { 'should write to the file': function(contents) {
assert.equal(contents, "cheese"); assert.equal(contents, "cheese");
@@ -91,17 +83,19 @@ vows.describe('RollingFileStream').addBatch({
assert.equal(files.filter(function(file) { return file.indexOf('test-rolling-file-stream-write-less') > -1; }).length, 1); assert.equal(files.filter(function(file) { return file.indexOf('test-rolling-file-stream-write-less') > -1; }).length, 1);
} }
} }
}
}, },
'writing more than the file size': { 'writing more than the file size': {
topic: function() { topic: function() {
remove(__dirname + "/test-rolling-file-stream-write-more"); remove(__dirname + "/test-rolling-file-stream-write-more");
remove(__dirname + "/test-rolling-file-stream-write-more.1"); remove(__dirname + "/test-rolling-file-stream-write-more.1");
var that = this, stream = new RollingFileStream(__dirname + "/test-rolling-file-stream-write-more", 45); var that = this, stream = new RollingFileStream(__dirname + "/test-rolling-file-stream-write-more", 45);
async.forEach([0, 1, 2, 3, 4, 5, 6], function(i, cb) { stream.on("open", function() {
stream.write(i +".cheese\n", "utf8", cb); for (var i=0; i < 7; i++) {
}, function() { stream.write(i +".cheese\n", "utf8");
stream.end(); }
that.callback(); //wait for the file system to catch up with us
setTimeout(that.callback, 100);
}); });
}, },
'the number of files': { 'the number of files': {
@@ -109,9 +103,7 @@ vows.describe('RollingFileStream').addBatch({
fs.readdir(__dirname, this.callback); fs.readdir(__dirname, this.callback);
}, },
'should be two': function(files) { 'should be two': function(files) {
assert.equal(files.filter( assert.equal(files.filter(function(file) { return file.indexOf('test-rolling-file-stream-write-more') > -1; }).length, 2);
function(file) { return file.indexOf('test-rolling-file-stream-write-more') > -1; }
).length, 2);
} }
}, },
'the first file': { 'the first file': {