Merge branch 'master' of https://github.com/nomiddlename/log4js-node

examples/example-connect-logger.js

@@ -1,14 +1,46 @@
-var log4js = require('./lib/log4js');
+//The connect/express logger was added to log4js by danbell. This allows connect/express servers to log using log4js.
-log4js.addAppender(log4js.fileAppender('cheese.log'), 'cheese');
+//https://github.com/nomiddlename/log4js-node/wiki/Connect-Logger
 
-var logger = log4js.getLogger('cheese');
+// load modules
-logger.setLevel('INFO');
+var log4js = require('log4js');
+var express = require("express");
+var app = express();
 
-var app = require('express').createServer();
+//config
+log4js.configure({
+	appenders: [
+		{ type: 'console' },
+		{ type: 'file', filename: 'logs/log4jsconnect.log', category: 'log4jslog' }
+	]
+});
+
+//define logger
+var logger = log4js.getLogger('log4jslog');
+
+// set at which time msg is logged print like: only on error & above
+// logger.setLevel('ERROR');
+
+//express app
 app.configure(function() {
-    app.use(log4js.connectLogger(logger, { level: log4js.levels.INFO }));
+	app.use(express.favicon(''));
+	// app.use(log4js.connectLogger(logger, { level: log4js.levels.INFO }));
+	// app.use(log4js.connectLogger(logger, { level: 'auto', format: ':method :url :status' }));
+
+	//### AUTO LEVEL DETECTION
+	//http responses 3xx, level = WARN
+	//http responses 4xx & 5xx, level = ERROR
+	//else.level = INFO
+	app.use(log4js.connectLogger(logger, { level: 'auto' }));
 });
-app.get('*', function(req,res) {
+
-    res.send('hello world\n <a href="/cheese">cheese</a>\n');
+//route
+app.get('/', function(req,res) {
+	res.send('hello world');
 });
+
+//start app
 app.listen(5000);
+
+console.log('server runing at localhost:5000');
+console.log('Simulation of normal response: goto localhost:5000');
+console.log('Simulation of error response: goto localhost:5000/xxx');

lib/connect-logger.js

@@ -5,7 +5,7 @@ var levels = require("./levels");
  * Options:
  *
  *   - `format`        Format string, see below for tokens
- *   - `level`         A log4js levels instance.
+ *   - `level`         A log4js levels instance. Supports also 'auto'
  *
  * Tokens:
  *
@@ -26,7 +26,7 @@ var levels = require("./levels");
  * @api public
  */
 
-function getLogger(logger4js, options) {
+ function getLogger(logger4js, options) {
 	if ('object' == typeof options) {
 		options = options || {};
 	} else if (options) {
@@ -47,8 +47,7 @@ function getLogger(logger4js, options) {
 
 		// nologs
 		if (nolog && nolog.test(req.originalUrl)) return next();
-
+		if (thislogger.isLevelEnabled(level) || options.level === 'auto') {
-	if (thislogger.isLevelEnabled(level)) {
 
 			var start = +new Date
 			, statusCode
@@ -65,6 +64,15 @@ function getLogger(logger4js, options) {
 				res.writeHead(code, headers);
 				res.__statusCode = statusCode = code;
 				res.__headers = headers || {};
+
+				//status code response level handling
+				if(options.level === 'auto'){
+					level = levels.INFO;
+					if(code >= 300) level = levels.WARN;
+					if(code >= 400) level = levels.ERROR;
+				} else {
+					level = levels.toLevel(options.level, levels.INFO)
+				}
 			};
 
 			// proxy end to output a line to the provided logger.
@@ -72,18 +80,20 @@ function getLogger(logger4js, options) {
 				res.end = end;
 				res.end(chunk, encoding);
 				res.responseTime = +new Date - start;
-		if ('function' == typeof fmt) {
+				if (thislogger.isLevelEnabled(level)) {
+					if (typeof fmt === 'function') {
 						var line = fmt(req, res, function(str){ return format(str, req, res); });
 						if (line) thislogger.log(level, line);
 					} else {
 						thislogger.log(level, format(fmt, req, res));
 					}
+				}
 			};
 		}
 
 	//ensure next gets always called
 	next();
-    };
+};
 }
 
 /**
@@ -96,7 +106,7 @@ function getLogger(logger4js, options) {
  * @api private
  */
 
-function format(str, req, res) {
+ function format(str, req, res) {
 	return str
 	.replace(':url', req.originalUrl)
 	.replace(':method', req.method)
@@ -114,7 +124,7 @@ function format(str, req, res) {
 		? (res._headers[field.toLowerCase()] || res.__headers[field])
 		: (res.__headers && res.__headers[field]);
 	});
-}
+ }
 
 /**
  * Return RegExp Object about nolog
@@ -143,7 +153,7 @@ function format(str, req, res) {
  *   3.1 ["\\.jpg$", "\\.png", "\\.gif"]
  *         SAME AS "\\.jpg|\\.png|\\.gif"
  */
-function createNoLogCondition(nolog, type) {
+ function createNoLogCondition(nolog, type) {
 	if(!nolog) return null;
 	type = type || '';
 
@@ -163,6 +173,6 @@ function createNoLogCondition(nolog, type) {
 		var regexps = nolog.map(function(o){ return createNoLogCondition(o, 'string')});
 		return new RegExp(regexps.join('|'));
 	}
-}
+ }
 
-exports.connectLogger = getLogger;
+ exports.connectLogger = getLogger;

lib/streams/DateRollingFileStream.js

@@ -24,13 +24,15 @@ function DateRollingFileStream(filename, pattern, options, now) {
   this.now = now || Date.now;
   this.lastTimeWeWroteSomething = format.asString(this.pattern, new Date(this.now()));
   this.baseFilename = filename;
+  this.alwaysIncludePattern = false;
     
   if (options) {
     if (options.alwaysIncludePattern) {
-      filename = filename + this.lastTimeWeWroteSomething;
+      this.alwaysIncludePattern = true;
+      filename = this.baseFilename + this.lastTimeWeWroteSomething;
     }
     delete options.alwaysIncludePattern;
-    if (options === {}) { 
+    if (Object.keys(options).length === 0) { 
       options = null; 
     }
   }
@@ -53,17 +55,25 @@ DateRollingFileStream.prototype.shouldRoll = function() {
 };
 
 DateRollingFileStream.prototype.roll = function(filename, callback) {
-    var that = this,
+    var that = this;
-        newFilename = this.baseFilename + this.previousTime;
 
     debug("Starting roll");
 
+    if (this.alwaysIncludePattern) {
+        this.filename = this.baseFilename + this.lastTimeWeWroteSomething;
+        async.series([
+          this.closeTheStream.bind(this),
+          this.openTheStream.bind(this)
+        ], callback);
+    } else {
+        var newFilename = this.baseFilename + this.previousTime;
         async.series([
           this.closeTheStream.bind(this),
           deleteAnyExistingFile,
           renameTheCurrentFile,
           this.openTheStream.bind(this)
         ], callback);
+    }
     
     function deleteAnyExistingFile(cb) {
         //on windows, you can get a EEXIST error if you rename a file to an existing file

test/dateFileAppender-test.js

@@ -113,6 +113,7 @@ vows.describe('../lib/appenders/dateFile').addBatch({
 		      ]
 		    }
 	      , thisTime = format.asString(options.appenders[0].pattern, new Date());
+	      fs.writeFileSync(path.join(__dirname, 'date-file-test' + thisTime), "this is existing data" + require('os').EOL, 'utf8');
 	      log4js.clearAppenders();
 	      log4js.configure(options);
 	      logger = log4js.getLogger('tests');
@@ -122,6 +123,9 @@ vows.describe('../lib/appenders/dateFile').addBatch({
 	    },
 	    'should create file with the correct pattern': function(contents) {
 	      assert.include(contents, 'this should be written to the file with the appended date');
+	    },
+	    'should not overwrite the file on open (bug found in issue #132)': function(contents) {
+	      assert.include(contents, 'this is existing data');
 	    }
 	  }
       

test/streams/DateRollingFileStream-test.js

@@ -125,6 +125,63 @@ vows.describe('DateRollingFileStream').addBatch({
                 }
             }
         }
+    },
+
+    'with alwaysIncludePattern': {
+        topic: function() {
+          var that = this,
+	      testTime = new Date(2012, 8, 12, 0, 10, 12),
+	      stream = new DateRollingFileStream(__dirname + '/test-date-rolling-file-stream-pattern', '.yyyy-MM-dd', {alwaysIncludePattern: true}, now);
+	      stream.write("First message\n", 'utf8', function() {
+	        that.callback(null, stream);
+	      });
+        },
+        teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-12'),
+
+        'should create a file with the pattern set': {
+            topic: function(stream) {
+                fs.readFile(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-12', this.callback);
+            },
+            'file should contain first message': function(result) {
+                assert.equal(result.toString(), "First message\n");
+            }
+        },
+
+        'when the day changes': {
+            topic: function(stream) {
+              testTime = new Date(2012, 8, 13, 0, 10, 12);
+              stream.write("Second message\n", 'utf8', this.callback);
+            },
+            teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-13'),
+
+
+            'the number of files': {
+                topic: function() {
+                    fs.readdir(__dirname, this.callback);
+                },
+                'should be two': function(files) {
+                    assert.equal(files.filter(function(file) { return file.indexOf('test-date-rolling-file-stream-pattern') > -1; }).length, 2);
+                }
+            },
+
+            'the file with the later date': {
+                topic: function() {
+                    fs.readFile(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-13', this.callback);
+                },
+                'should contain the second message': function(contents) {
+                    assert.equal(contents.toString(), "Second message\n");
+                }
+            },
+
+            'the file with the date': {
+                topic: function() {
+                    fs.readFile(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-12', this.callback);
+                },
+                'should contain the first message': function(contents) {
+                    assert.equal(contents.toString(), "First message\n");
+                }
+            }
+        }
     }
 
 }).exportTo(module);