new version for alwaysIncludePattern

Fix node engine in package.json

.travis.yml

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

README.md

@@ -17,8 +17,6 @@ Out of the box it supports the following features:
 * 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.)
 
-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:
 
 ```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](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](https://github.com/nomiddlename/log4js-node/wiki/Appenders), otherwise take a look at the tests and the examples.
 
 ## Documentation
-See the [wiki](log4js-node/wiki). Improve the [wiki](log4js-node/wiki), please.
+See the [wiki](https://github.com/nomiddlename/log4js-node/wiki). Improve the [wiki](https://github.com/nomiddlename/log4js-node/wiki), please.
 
 ## Contributing
-Contributions welcome, but take a look at the [rules](log4js-node/wiki/Contributing) first.
+Contributions welcome, but take a look at the [rules](https://github.com/nomiddlename/log4js-node/wiki/Contributing) first.
 
 ## License
 

lib/appenders/dateFile.js

@@ -19,10 +19,10 @@ process.on('exit', function() {
  *          also used to check when to roll files - defaults to '.yyyy-MM-dd'
  * @layout layout function for log messages - defaults to basicLayout
  */
-function appender(filename, pattern, layout) {
+function appender(filename, pattern, alwaysIncludePattern, layout) {
     layout = layout || layouts.basicLayout;
 
-    var logFile = new streams.DateRollingFileStream(filename, pattern);
+    var logFile = new streams.DateRollingFileStream(filename, pattern, { alwaysIncludePattern: alwaysIncludePattern });
     openFiles.push(logFile);
 
     return function(logEvent) {
@@ -35,14 +35,18 @@ function configure(config, options) {
     var layout;
 
     if (config.layout) {
-	layout = layouts.layout(config.layout.type, config.layout);
+	    layout = layouts.layout(config.layout.type, config.layout);
+    }
+    
+    if (!config.alwaysIncludePattern) {
+        config.alwaysIncludePattern = false;
     }
 
     if (options && options.cwd && !config.absolute) {
         config.filename = path.join(options.cwd, config.filename);
     }
 
-    return appender(config.filename, config.pattern, layout);
+    return appender(config.filename, config.pattern, config.alwaysIncludePattern, layout);
 }
 
 exports.appender = appender;

lib/appenders/multiprocess.js

@@ -38,31 +38,30 @@ function logServer(config) {
     var actualAppender = config.actualAppender,
         server = net.createServer(function serverCreated(clientSocket) {
             clientSocket.setEncoding('utf8');
-            clientSocket.on('connect', function clientConnected() {
-                var logMessage = '';
+            var logMessage = '';
 
-                function logTheMessage(msg) {
-                    if (logMessage.length > 0) {
-                        actualAppender(deserializeLoggingEvent(clientSocket, msg));
-                    }
+            function logTheMessage(msg) {
+                if (logMessage.length > 0) {
+                    actualAppender(deserializeLoggingEvent(clientSocket, msg));
                 }
+            }
 
-                function chunkReceived(chunk) {
-                    var event;
-                    logMessage += chunk || '';
-                    if (logMessage.indexOf(END_MSG) > -1) {
-                        event = logMessage.substring(0, logMessage.indexOf(END_MSG));
-                        logTheMessage(event);
-                        logMessage = logMessage.substring(event.length + END_MSG.length) || '';
-                        //check for more, maybe it was a big chunk
-                        chunkReceived();
-                    }
+            function chunkReceived(chunk) {
+                var event;
+                logMessage += chunk || '';
+                if (logMessage.indexOf(END_MSG) > -1) {
+                    event = logMessage.substring(0, logMessage.indexOf(END_MSG));
+                    logTheMessage(event);
+                    logMessage = logMessage.substring(event.length + END_MSG.length) || '';
+                    //check for more, maybe it was a big chunk
+                    chunkReceived();
                 }
+            }
 
-                clientSocket.on('data', chunkReceived);
-                clientSocket.on('end', chunkReceived);
-            });
+            clientSocket.on('data', chunkReceived);
+            clientSocket.on('end', chunkReceived);
         });
+        
     server.listen(config.loggerPort || 5000, config.loggerHost || 'localhost');
 
     return actualAppender;

lib/streams/BaseRollingFileStream.js

@@ -1,9 +1,19 @@
 var fs = require('fs'),
-stream = require('stream'),
-util = require('util');
+stream,
+util = require('util'),
+semver = require('semver');
 
-function debug(message) {
-//    console.log(message);
+if (semver.satisfies(process.version, '>=0.10.0')) {
+  stream = require('stream');
+} 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;
@@ -66,7 +76,7 @@ BaseRollingFileStream.prototype.openTheStream = function(cb) {
 
 BaseRollingFileStream.prototype.closeTheStream = function(cb) {
   debug("closing the underlying stream");
-  this.theStream.end(null, null, cb);
+  this.theStream.end(cb);
 };
 
 BaseRollingFileStream.prototype.shouldRoll = function() {

lib/streams/DateRollingFileStream.js

@@ -6,23 +6,37 @@ var BaseRollingFileStream = require('./BaseRollingFileStream'),
 
 module.exports = DateRollingFileStream;
 
-function debug(message) {
-//    console.log(message);
+var debug;
+if (process.env.NODE_DEBUG && /\blog4js\b/.test(process.env.NODE_DEBUG)) {
+    debug = function(message) { console.error('LOG4JS: (DateRollingFileStream) %s', message); };
+} else {
+    debug = function() { };
 }
 
 function DateRollingFileStream(filename, pattern, options, now) {
-    debug("Now is " + now);
-    if (pattern && typeof(pattern) === 'object') {
-        now = options;
-        options = pattern;
-        pattern = null;
+  debug("Now is " + now);
+  if (pattern && typeof(pattern) === 'object') {
+    now = options;
+    options = pattern;
+    pattern = null;
+  }
+  this.pattern = pattern || '.yyyy-MM-dd';
+  this.now = now || Date.now;
+  this.lastTimeWeWroteSomething = format.asString(this.pattern, new Date(this.now()));
+  this.baseFilename = filename;
+    
+  if (options) {
+    if (options.alwaysIncludePattern) {
+      filename = filename + this.lastTimeWeWroteSomething;
     }
-    this.pattern = pattern || '.yyyy-MM-dd';
-    this.now = now || Date.now;
-    this.lastTimeWeWroteSomething = format.asString(this.pattern, new Date(this.now()));
-    debug("this.now is " + this.now + ", now is " + now);
+    delete options.alwaysIncludePattern;
+    if (options === {}) { 
+      options = null; 
+    }
+  }
+  debug("this.now is " + this.now + ", now is " + now);
 
-    DateRollingFileStream.super_.call(this, filename, options);
+  DateRollingFileStream.super_.call(this, filename, options);
 }
 util.inherits(DateRollingFileStream, BaseRollingFileStream);
 
@@ -40,7 +54,7 @@ DateRollingFileStream.prototype.shouldRoll = function() {
 
 DateRollingFileStream.prototype.roll = function(filename, callback) {
     var that = this,
-        newFilename = filename + this.previousTime;
+        newFilename = this.baseFilename + this.previousTime;
 
     debug("Starting roll");
 

lib/streams/RollingFileStream.js

@@ -4,9 +4,11 @@ var BaseRollingFileStream = require('./BaseRollingFileStream'),
     fs = require('fs'),
     async = require('async');
 
-function debug() {
-//    util.debug(message);
-//  console.log.apply(console, arguments);
+var debug;
+if (process.env.NODE_DEBUG && /\blog4js\b/.test(process.env.NODE_DEBUG)) {
+    debug = function(message) { console.error('LOG4JS: (RollingFileStream) %s', message); };
+} else {
+    debug = function() { };
 }
 
 module.exports = RollingFileStream;

package.json

@@ -1,40 +1,42 @@
 {
-   "name": "log4js",
-   "version": "0.6.1",
-   "description": "Port of Log4js to work with node.",
-   "keywords": [
-       "logging",
-       "log",
-       "log4j",
-       "node"
-   ],
-   "main": "./lib/log4js",
-   "author": "Gareth Jones <gareth.jones@sensis.com.au>",
-   "repository": {
-       "type": "git",
-       "url": "https://github.com/nomiddlename/log4js-node.git"
-   },
-   "bugs": {
-       "url": "http://github.com/nomiddlename/log4js-node/issues"
-   },
-   "engines": {
-     "node":  "~0.10"
-   },
-   "scripts": {
-       "test": "vows"
-   },
-   "directories": {
-       "test": "test",
-       "lib": "lib"
-   },
-   "dependencies": {
-       "async": "0.1.15",
-       "dequeue": "1.0.3"
-   },
-   "devDependencies": {
-       "vows": "0.7.0",
-       "sandboxed-module": "0.1.3",
-       "hook.io": "0.8.10",
-       "underscore": "1.2.1"
-   }
+  "name": "log4js",
+  "version": "0.6.4",
+  "description": "Port of Log4js to work with node.",
+  "keywords": [
+    "logging",
+    "log",
+    "log4j",
+    "node"
+  ],
+  "main": "./lib/log4js",
+  "author": "Gareth Jones <gareth.jones@sensis.com.au>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nomiddlename/log4js-node.git"
+  },
+  "bugs": {
+    "url": "http://github.com/nomiddlename/log4js-node/issues"
+  },
+  "engines": {
+    "node": ">=0.8"
+  },
+  "scripts": {
+    "test": "vows"
+  },
+  "directories": {
+    "test": "test",
+    "lib": "lib"
+  },
+  "dependencies": {
+    "async": "0.1.15",
+    "dequeue": "1.0.3",
+    "semver": "~1.1.4",
+    "readable-stream": "~1.0.2"
+  },
+  "devDependencies": {
+    "vows": "0.7.0",
+    "sandboxed-module": "0.1.3",
+    "hook.io": "0.8.10",
+    "underscore": "1.2.1"
+  }
 }

test/dateFileAppender-test.js

@@ -72,27 +72,58 @@ vows.describe('../lib/appenders/dateFile').addBatch({
 
     }
 }).addBatch({
-    'configure': {
-        'with dateFileAppender': {
+  'configure': {
+    'with dateFileAppender': {
 	    topic: function() {
-	        var log4js = require('../lib/log4js')
-                  , logger;
-	        //this config file defines one file appender (to ./date-file-test.log)
-	        //and sets the log level for "tests" to WARN
-                log4js.configure('test/with-dateFile.json');
-                logger = log4js.getLogger('tests');
-	        logger.info('this should not be written to the file');
-	        logger.warn('this should be written to the file');
-
-                fs.readFile(path.join(__dirname, 'date-file-test.log'), 'utf8', this.callback);
+	      var log4js = require('../lib/log4js')
+        , logger;
+	      //this config file defines one file appender (to ./date-file-test.log)
+	      //and sets the log level for "tests" to WARN
+        log4js.configure('test/with-dateFile.json');
+        logger = log4js.getLogger('tests');
+	      logger.info('this should not be written to the file');
+	      logger.warn('this should be written to the file');
+        
+        fs.readFile(path.join(__dirname, 'date-file-test.log'), 'utf8', this.callback);
 	    },
-            teardown: removeFile('date-file-test.log'),
-
+      teardown: removeFile('date-file-test.log'),
+      
 	    'should load appender configuration from a json file': function(err, contents) {
-	        assert.include(contents, 'this should be written to the file\n');
-                assert.equal(contents.indexOf('this should not be written to the file'), -1);
+	      assert.include(contents, 'this should be written to the file' + require('os').EOL);
+        assert.equal(contents.indexOf('this should not be written to the file'), -1);
 	    }
-        }
-
-    }
+    },
+	  'with options.alwaysIncludePattern': {
+	    topic: function() {
+	      var log4js = require('../lib/log4js')
+	      , format = require('../lib/date_format')
+	      , logger
+	      , options = {
+		      "appenders": [
+		        {
+		          "category": "tests", 
+		          "type": "dateFile", 
+		          "filename": "test/date-file-test",
+		          "pattern": "-from-MM-dd.log",
+		          "alwaysIncludePattern": true,
+		          "layout": { 
+			          "type": "messagePassThrough" 
+		          }
+		        }
+		      ]
+		    }
+	      , thisTime = format.asString(options.appenders[0].pattern, new Date());
+	      log4js.clearAppenders();
+	      log4js.configure(options);
+	      logger = log4js.getLogger('tests');
+	      logger.warn('this should be written to the file with the appended date');
+        this.teardown = removeFile('date-file-test' + thisTime);
+	      fs.readFile(path.join(__dirname, 'date-file-test' + thisTime), 'utf8', this.callback);
+	    },
+	    'should create file with the correct pattern': function(contents) {
+	      assert.include(contents, 'this should be written to the file with the appended date');
+	    }
+	  }
+      
+  }
 }).exportTo(module);

test/multiprocess-test.js

@@ -30,24 +30,24 @@ function makeFakeNet() {
             };
         },
         createServer: function(cb) {
-            var fakeNet = this;
-            cb({
-                remoteAddress: '1.2.3.4',
-                remotePort: '1234',
-                setEncoding: function(encoding) {
-                    fakeNet.encoding = encoding;
-                },
-                on: function(event, cb) {
-                    fakeNet.cbs[event] = cb;
-                }
-            });
+          var fakeNet = this;
+          cb({
+            remoteAddress: '1.2.3.4',
+            remotePort: '1234',
+            setEncoding: function(encoding) {
+              fakeNet.encoding = encoding;
+            },
+            on: function(event, cb) {
+              fakeNet.cbs[event] = cb;
+            }
+          });
 
-            return {
-                listen: function(port, host) {
-                    fakeNet.port = port;
-                    fakeNet.host = host;
-                }
-            };
+          return {
+            listen: function(port, host) {
+              fakeNet.port = port;
+              fakeNet.host = host;
+            }
+          };
         }
     };
 }
@@ -183,7 +183,6 @@ vows.describe('Multiprocess Appender').addBatch({
             topic: function(net) {
               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'](logString.substring(0, 10));
                 net.cbs['data'](logString.substring(10));

test/streams/DateRollingFileStream-test.js

@@ -1,10 +1,18 @@
 var vows = require('vows')
 , assert = require('assert')
-, streams = require('stream')
 , fs = require('fs')
-, DateRollingFileStream = require('../../lib/streams').DateRollingFileStream
+, semver = require('semver')
+, streams
+, 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) {
     return function() {
         fs.unlink(filename);
@@ -68,8 +76,8 @@ vows.describe('DateRollingFileStream').addBatch({
           var that = this,
           stream = new DateRollingFileStream(__dirname + '/test-date-rolling-file-stream-5', '.yyyy-MM-dd', null, now);
           stream.write("First message\n", 'utf8', function() {
-	    that.callback(null, stream);
-	  });
+	          that.callback(null, stream);
+	        });
         },
         teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-5'),
 

test/streams/rollingFileStream-test.js

@@ -3,8 +3,16 @@ var vows = require('vows')
 , assert = require('assert')
 , events = require('events')
 , fs = require('fs')
-, streams = require('stream')
-, RollingFileStream = require('../../lib/streams').RollingFileStream;
+, semver = require('semver')
+, 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) {
     try {