Add :remote-user token

History.md

@@ -1,6 +1,7 @@
 unreleased
 ==========
 
+  * Add `:remote-user` token
   * Remove non-standard grey color from `dev` format
 
 1.1.1 / 2014-05-20

README.md

@@ -62,6 +62,7 @@ morgan.format('name', 'string or function')
 - `:http-version`
 - `:response-time`
 - `:remote-addr`
+- `:remote-user`
 - `:date`
 - `:method`
 - `:url`

index.js

@@ -10,6 +10,7 @@
  * Module dependencies.
  */
 
+var auth = require('basic-auth')
 var bytes = require('bytes');
 
 /**
@@ -157,13 +158,13 @@ exports.format = function(name, fmt){
  * Default format.
  */
 
-exports.format('default', ':remote-addr - - [:date] ":method :url HTTP/:http-version" :status :res[content-length] ":referrer" ":user-agent"');
+exports.format('default', ':remote-addr - :remote-user [:date] ":method :url HTTP/:http-version" :status :res[content-length] ":referrer" ":user-agent"');
 
 /**
  * Short format.
  */
 
-exports.format('short', ':remote-addr - :method :url HTTP/:http-version :status :res[content-length] - :response-time ms');
+exports.format('short', ':remote-addr :remote-user :method :url HTTP/:http-version :status :res[content-length] - :response-time ms');
 
 /**
  * Tiny format.
@@ -250,6 +251,16 @@ exports.token('remote-addr', function(req){
   return undefined;
 });
 
+/**
+ * remote user
+ */
+
+exports.token('remote-user', function (req) {
+  var creds = auth(req)
+  var user = (creds && creds.name) || '-'
+  return user;
+})
+
 /**
  * HTTP version
  */

package.json

@@ -9,6 +9,7 @@
   "license": "MIT",
   "repository": "expressjs/morgan",
   "dependencies": {
+    "basic-auth": "1.0.0",
     "bytes": "1.0.0"
   },
   "devDependencies": {

test/test.js

@@ -181,6 +181,46 @@ describe('logger()', function () {
       })
     })
 
+    describe(':remote-user', function () {
+      it('should be empty if none present', function (done) {
+        var server = createServer({format: ':remote-user'})
+
+        request(server)
+        .get('/')
+        .end(function (err, res) {
+          if (err) return done(err)
+          lastLogLine.should.equal('-\n')
+          done()
+        })
+      })
+
+      it('should support Basic authorization', function (done) {
+        var server = createServer({format: ':remote-user'})
+
+        request(server)
+        .get('/')
+        .set('Authorization', 'Basic dGo6')
+        .end(function (err, res) {
+          if (err) return done(err)
+          lastLogLine.should.equal('tj\n')
+          done()
+        })
+      })
+
+      it('should be empty for empty Basic authorization user', function (done) {
+        var server = createServer({format: ':remote-user'})
+
+        request(server)
+        .get('/')
+        .set('Authorization', 'Basic Og==')
+        .end(function (err, res) {
+          if (err) return done(err)
+          lastLogLine.should.equal('-\n')
+          done()
+        })
+      })
+    })
+
     describe(':response-time', function () {
       it('should be in milliseconds', function (done) {
         var start = Date.now()