Release 3.4.0

Updated Util.isAbsolute(path) to return true for Azure absolute paths

History.md

@@ -1,4 +1,43 @@
 
+3.4.0 / 2013-09-07 
+==================
+
+ * add res.vary(). Closes #1682
+ * update connect
+
+3.3.8 / 2013-09-02 
+==================
+
+ * update connect
+
+3.3.7 / 2013-08-28 
+==================
+
+ * update connect
+
+3.3.6 / 2013-08-27 
+==================
+
+ * Revert "remove charset from json responses. Closes #1631" (causes issues in some clients)
+ * add: req.accepts take an argument list
+
+3.3.4 / 2013-07-08 
+==================
+
+ * update send and connect
+
+3.3.3 / 2013-07-04 
+==================
+
+ * update connect
+
+3.3.2 / 2013-07-03 
+==================
+
+ * update connect
+ * update send
+ * remove .version export
+
 3.3.1 / 2013-06-27 
 ==================
 

LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2009-2011 TJ Holowaychuk <tj@vision-media.ca>
+Copyright (c) 2009-2013 TJ Holowaychuk <tj@vision-media.ca>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

Readme.md

@@ -1,6 +1,6 @@
 ![express logo](http://f.cl.ly/items/0V2S1n0K1i3y1c122g04/Screen%20Shot%202012-04-11%20at%209.59.42%20AM.png)
 
-  Fast, unopinionated, minimalist web framework for [node](http://nodejs.org). [![Build Status](https://secure.travis-ci.org/visionmedia/express.png)](http://travis-ci.org/visionmedia/express) [![Dependency Status](https://gemnasium.com/visionmedia/express.png)](https://gemnasium.com/visionmedia/express)
+  Fast, unopinionated, minimalist web framework for [node](http://nodejs.org). [![Build Status](https://secure.travis-ci.org/visionmedia/express.png)](http://travis-ci.org/visionmedia/express)
 
 ```js
 var express = require('express');

bin/express

@@ -16,6 +16,7 @@ var exec = require('child_process').exec
 
 program
   .version(version)
+  .usage('[options] [dir]')
   .option('-s, --sessions', 'add session support')
   .option('-e, --ejs', 'add ejs engine support (defaults to jade)')
   .option('-J, --jshtml', 'add jshtml engine support (defaults to jade)')
@@ -208,11 +209,11 @@ var app = [
   , ' * Module dependencies.'
   , ' */'
   , ''
-  , 'var express = require(\'express\')'
-  , '  , routes = require(\'./routes\')'
-  , '  , user = require(\'./routes/user\')'
-  , '  , http = require(\'http\')'
-  , '  , path = require(\'path\');'
+  , 'var express = require(\'express\');'
+  , 'var routes = require(\'./routes\');'
+  , 'var user = require(\'./routes/user\');'
+  , 'var http = require(\'http\');'
+  , 'var path = require(\'path\');'
   , ''
   , 'var app = express();'
   , ''

lib/application.js

@@ -46,6 +46,7 @@ app.init = function(){
 app.defaultConfiguration = function(){
   // default settings
   this.enable('x-powered-by');
+  this.enable('etag');
   this.set('env', process.env.NODE_ENV || 'development');
   this.set('subdomain offset', 2);
   debug('booting in %s mode', this.get('env'));
@@ -184,7 +185,7 @@ app.engine = function(ext, fn){
  * could automatically load a user's information from the database without
  * any additional code,
  *
- * The callback uses the samesignature as middleware, the only differencing
+ * The callback uses the same signature as middleware, the only differencing
  * being that the value of the placeholder is passed, in this case the _id_
  * of the user. Once the `next()` function is invoked, just like middleware
  * it will continue on to execute the route, or subsequent parameter functions.

lib/express.js

@@ -16,12 +16,6 @@ var connect = require('connect')
 
 exports = module.exports = createApplication;
 
-/**
- * Framework version.
- */
-
-exports.version = '3.2.5';
-
 /**
  * Expose mime.
  */

lib/request.js

@@ -63,6 +63,7 @@ req.header = function(name){
  * The `type` value may be a single mime type string
  * such as "application/json", the extension name
  * such as "json", a comma-delimted list such as "json, html, text/plain",
+ * an argument list such as `"json", "html", "text/plain"`,
  * or an array `["json", "html", "text/plain"]`. When a list
  * or array is given the _best_ match, if any is returned.
  *
@@ -89,6 +90,7 @@ req.header = function(name){
  *
  *     // Accept: text/*;q=.5, application/json
  *     req.accepts(['html', 'json']);
+ *     req.accepts('html', 'json');
  *     req.accepts('html, json');
  *     // => "json"
  *
@@ -98,7 +100,8 @@ req.header = function(name){
  */
 
 req.accepts = function(type){
-  return utils.accepts(type, this.get('Accept'));
+  var args = arguments.length > 1 ? [].slice.apply(arguments) : type;
+  return utils.accepts(args, this.get('Accept'));
 };
 
 /**

lib/response.js

@@ -82,6 +82,9 @@ res.send = function(body){
   var head = 'HEAD' == req.method;
   var len;
 
+  // settings
+  var app = this.app;
+
   // allow status / body
   if (2 == arguments.length) {
     // res.send(body, status) backwards compat
@@ -128,7 +131,7 @@ res.send = function(body){
 
   // ETag support
   // TODO: W/ support
-  if (len > 1024 && 'GET' == req.method) {
+  if (app.settings.etag && len > 1024 && 'GET' == req.method) {
     if (!this.get('ETag')) {
       this.set('ETag', etag(body));
     }
@@ -185,6 +188,7 @@ res.json = function(obj){
   var body = JSON.stringify(obj, replacer, spaces);
 
   // content-type
+  this.charset = this.charset || 'utf-8';
   this.get('Content-Type') || this.set('Content-Type', 'application/json');
 
   return this.send(body);
@@ -233,7 +237,7 @@ res.jsonp = function(obj){
 
   // jsonp
   if (callback) {
-    if (callback instanceof Array) callback = callback[0];
+    if (Array.isArray(callback)) callback = callback[0];
     this.set('Content-Type', 'text/javascript');
     var cb = callback.replace(/[^\[\]\w$.]/g, '');
     body = cb + ' && ' + cb + '(' + body + ');';
@@ -459,7 +463,7 @@ res.format = function(obj){
 
   var key = req.accepts(keys);
 
-  this.set('Vary', 'Accept');
+  this.vary("Accept");
 
   if (key) {
     this.set('Content-Type', normalizeType(key).value);
@@ -716,6 +720,44 @@ res.redirect = function(url){
   this.end(head ? null : body);
 };
 
+/**
+ * Add `field` to Vary. If already present in the Vary set, then
+ * this call is simply ignored.
+ *
+ * @param {Array|String} field
+ * @param {ServerResponse} for chaining
+ * @api public
+ */
+
+res.vary = function(field){
+  var self = this;
+
+  // nothing
+  if (!field) return this;
+
+  // array
+  if (Array.isArray(field)) {
+    field.forEach(function(field){
+      self.vary(field);
+    });
+    return;
+  }
+
+  var vary = this.get('Vary');
+
+  // append  
+  if (vary) {
+    vary = vary.split(/ *, */);
+    if (!~vary.indexOf(field)) vary.push(field);
+    this.set('Vary', vary.join(', '));
+    return this;
+  }
+
+  // set
+  this.set('Vary', field);
+  return this;
+};
+
 /**
  * Render `view` with the given `options` and optional callback `fn`.
  * When a callback function is given a response will _not_ be made

lib/router/index.js

@@ -103,6 +103,9 @@ Router.prototype._dispatch = function(req, res, next){
     // match route
     req.route = route = self.matchRequest(req, i);
 
+    // implied OPTIONS
+    if (!route && 'OPTIONS' == req.method) return self._options(req, res);
+
     // no route
     if (!route) return next(err);
     debug('matched %s %s', route.method, route.path);
@@ -170,6 +173,41 @@ Router.prototype._dispatch = function(req, res, next){
   })(0);
 };
 
+/**
+ * Respond to __OPTIONS__ method.
+ *
+ * @param {IncomingMessage} req
+ * @param {ServerResponse} res
+ * @api private
+ */
+
+Router.prototype._options = function(req, res){
+  var path = parse(req).pathname
+    , body = this._optionsFor(path).join(',');
+  res.set('Allow', body).send(body);
+};
+
+/**
+ * Return an array of HTTP verbs or "options" for `path`.
+ *
+ * @param {String} path
+ * @return {Array}
+ * @api private
+ */
+
+Router.prototype._optionsFor = function(path){
+  var self = this;
+  return methods.filter(function(method){
+    var routes = self.map[method];
+    if (!routes || 'options' == method) return;
+    for (var i = 0, len = routes.length; i < len; ++i) {
+      if (routes[i].match(path)) return true;
+    }
+  }).map(function(method){
+    return method.toUpperCase();
+  });
+};
+
 /**
  * Attempt to match a route for `req`
  * with optional starting index of `i`

lib/utils.js

@@ -54,6 +54,7 @@ exports.locals = function(obj){
 exports.isAbsolute = function(path){
   if ('/' == path[0]) return true;
   if (':' == path[1] && '\\' == path[2]) return true;
+  if ('\\\\' == path.substring(0, 2)) return true; // Microsoft Azure absolute path
 };
 
 /**

package.json

@@ -1,7 +1,7 @@
 {
   "name": "express",
   "description": "Sinatra inspired web development framework",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "contributors": [
     {
@@ -22,15 +22,15 @@
     }
   ],
   "dependencies": {
-    "connect": "2.8.1",
-    "commander": "0.6.1",
+    "connect": "2.9.0",
+    "commander": "1.2.0",
     "range-parser": "0.0.4",
-    "mkdirp": "0.3.4",
+    "mkdirp": "0.3.5",
     "cookie": "0.1.0",
     "buffer-crc32": "0.2.1",
-    "fresh": "0.1.0",
+    "fresh": "0.2.0",
     "methods": "0.0.1",
-    "send": "0.1.1",
+    "send": "0.1.4",
     "cookie-signature": "1.0.1",
     "debug": "*"
   },

test/app.options.js

@@ -0,0 +1,37 @@
+
+var express = require('../')
+  , request = require('./support/http');
+
+describe('OPTIONS', function(){
+  it('should default to the routes defined', function(done){
+    var app = express();
+
+    app.del('/', function(){});
+    app.get('/users', function(req, res){});
+    app.put('/users', function(req, res){});
+
+    request(app)
+    .options('/users')
+    .expect('GET,PUT')
+    .expect('Allow', 'GET,PUT', done);
+  })
+})
+
+describe('app.options()', function(){
+  it('should override the default behavior', function(done){
+    var app = express();
+
+    app.options('/users', function(req, res){
+      res.set('Allow', 'GET');
+      res.send('GET');
+    });
+
+    app.get('/users', function(req, res){});
+    app.put('/users', function(req, res){});
+
+    request(app)
+    .options('/users')
+    .expect('GET')
+    .expect('Allow', 'GET', done);
+  })
+})

test/exports.js

@@ -4,10 +4,6 @@ var express = require('../')
   , assert = require('assert');
 
 describe('exports', function(){
-  it('should have .version', function(){
-    express.should.have.property('version');
-  })
-  
   it('should expose connect middleware', function(){
     express.should.have.property('bodyParser');
     express.should.have.property('session');
@@ -21,15 +17,15 @@ describe('exports', function(){
   it('should expose Router', function(){
     express.Router.should.be.a('function');
   })
-  
+
   it('should expose the application prototype', function(){
     express.application.set.should.be.a('function');
   })
-  
+
   it('should expose the request prototype', function(){
     express.request.accepts.should.be.a('function');
   })
-  
+
   it('should expose the response prototype', function(){
     express.response.send.should.be.a('function');
   })
@@ -51,7 +47,7 @@ describe('exports', function(){
     .get('/')
     .expect('bar', done);
   })
-  
+
   it('should permit modifying the .response prototype', function(done){
     express.response.foo = function(){ this.send('bar'); };
     var app = express();

test/req.accepts.js

@@ -56,6 +56,19 @@ describe('req', function(){
     .expect('html', done);
   })
 
+  it('should accept an argument list of type names', function(done){
+    var app = express();
+
+    app.use(function(req, res, next){
+      res.end(req.accepts('json', 'html'));
+    });
+
+    request(app)
+    .get('/')
+    .set('Accept', 'application/json')
+    .expect('json', done);
+  })
+
   describe('.accept(types)', function(){
     it('should return the first when Accept is not present', function(done){
       var app = express();

test/res.format.js

@@ -53,7 +53,7 @@ app3.use(function(req, res, next){
   })
 });
 
-describe('req', function(){
+describe('res', function(){
   describe('.format(obj)', function(){
     describe('with canonicalized mime types', function(){
       test(app);
@@ -79,14 +79,14 @@ function test(app) {
     request(app)
     .get('/')
     .set('Accept', 'text/html; q=.5, application/json, */*; q=.1')
-    .expect('{"message":"hey"}', done);
+    .expect({"message":"hey"}, done);
   })
 
   it('should allow wildcard type/subtypes', function(done){
     request(app)
     .get('/')
     .set('Accept', 'text/html; q=.5, application/*, */*; q=.1')
-    .expect('{"message":"hey"}', done);
+    .expect({"message":"hey"}, done);
   })
 
   it('should default the Content-Type', function(done){

test/res.json.js

@@ -28,7 +28,7 @@ describe('res', function(){
         request(app)
         .get('/')
         .end(function(err, res){
-          res.headers.should.have.property('content-type', 'application/json');
+          res.headers.should.have.property('content-type', 'application/json; charset=utf-8');
           res.text.should.equal('null');
           done();
         })
@@ -46,13 +46,13 @@ describe('res', function(){
         request(app)
         .get('/')
         .end(function(err, res){
-          res.headers.should.have.property('content-type', 'application/json');
+          res.headers.should.have.property('content-type', 'application/json; charset=utf-8');
           res.text.should.equal('["foo","bar","baz"]');
           done();
         })
       })
     })
-
+    
     describe('when given an object', function(){
       it('should respond with json', function(done){
         var app = express();
@@ -64,7 +64,7 @@ describe('res', function(){
         request(app)
         .get('/')
         .end(function(err, res){
-          res.headers.should.have.property('content-type', 'application/json');
+          res.headers.should.have.property('content-type', 'application/json; charset=utf-8');
           res.text.should.equal('{"name":"tobi"}');
           done();
         })
@@ -125,7 +125,7 @@ describe('res', function(){
       })
     })
   })
-
+  
   describe('.json(status, object)', function(){
     it('should respond with json and set the .statusCode', function(done){
       var app = express();
@@ -138,7 +138,7 @@ describe('res', function(){
       .get('/')
       .end(function(err, res){
         res.statusCode.should.equal(201);
-        res.headers.should.have.property('content-type', 'application/json');
+        res.headers.should.have.property('content-type', 'application/json; charset=utf-8');
         res.text.should.equal('{"id":1}');
         done();
       })
@@ -157,7 +157,7 @@ describe('res', function(){
       .get('/')
       .end(function(err, res){
         res.statusCode.should.equal(201);
-        res.headers.should.have.property('content-type', 'application/json');
+        res.headers.should.have.property('content-type', 'application/json; charset=utf-8');
         res.text.should.equal('{"id":1}');
         done();
       })

test/res.jsonp.js

@@ -21,6 +21,22 @@ describe('res', function(){
       })
     })
 
+    it('should use first callback parameter with jsonp', function(done){
+      var app = express();
+
+      app.use(function(req, res){
+        res.jsonp({ count: 1 });
+      });
+
+      request(app)
+          .get('/?callback=something&callback=somethingelse')
+          .end(function(err, res){
+            res.headers.should.have.property('content-type', 'text/javascript; charset=utf-8');
+            res.text.should.equal('something && something({"count":1});');
+            done();
+          })
+    })
+
     it('should allow renaming callback', function(done){
       var app = express();
 

test/res.send.js

@@ -202,7 +202,7 @@ describe('res', function(){
       request(app)
       .get('/')
       .end(function(err, res){
-        res.headers.should.have.property('content-type', 'application/json');
+        res.headers.should.have.property('content-type', 'application/json; charset=utf-8');
         res.text.should.equal('{"name":"tobi"}');
         done();
       })
@@ -318,4 +318,62 @@ describe('res', function(){
     .get('/?callback=foo')
     .expect('{"foo":"bar"}', done);
   })
+
+  describe('"etag" setting', function(){
+    describe('when enabled', function(){
+      it('should send ETag ', function(done){
+        var app = express();
+
+        app.use(function(req, res){
+          var str = Array(1024 * 2).join('-');
+          res.send(str);
+        });
+
+        request(app)
+        .get('/')
+        .end(function(err, res){
+          res.headers.should.have.property('etag', '"-1498647312"');
+          done();
+        });
+      });
+    });
+
+    describe('when disabled', function(){
+      it('should send no ETag', function(done){
+        var app = express();
+
+        app.use(function(req, res){
+          var str = Array(1024 * 2).join('-');
+          res.send(str);
+        });
+
+        app.disable('etag');
+
+        request(app)
+        .get('/')
+        .end(function(err, res){
+          res.headers.should.not.have.property('etag');
+          done();
+        });
+      });
+
+      it('should send ETag when manually set', function(done){
+        var app = express();
+
+        app.disable('etag');
+
+        app.use(function(req, res){
+          res.set('etag', 1);
+          res.send(200);
+        });
+
+        request(app)
+        .get('/')
+        .end(function(err, res){
+          res.headers.should.have.property('etag');
+          done();
+        });
+      });
+    });
+  })
 })

test/res.vary.js

@@ -0,0 +1,55 @@
+
+var express = require('../')
+  , should = require('should');
+
+function response() {
+  var res = Object.create(express.response);
+  res._headers = {};
+  return res;
+}
+
+describe('res.vary()', function(){
+  describe('with no arguments', function(){
+    it('should not set Vary', function(){
+      var res = response();
+      res.vary();
+      should.not.exist(res.get('Vary'));
+    })
+  })
+
+  describe('with an empty array', function(){
+    it('should not set Vary', function(){
+      var res = response();
+      res.vary([]);
+      should.not.exist(res.get('Vary'));
+    })
+  })
+
+  describe('with an array', function(){
+    it('should set the values', function(){
+      var res = response();
+      res.vary(['Accept', 'Accept-Language', 'Accept-Encoding']);
+      res.get('Vary').should.equal('Accept, Accept-Language, Accept-Encoding');
+    })
+  })
+
+  describe('with a string', function(){
+    it('should set the value', function(){
+      var res = response();
+      res.vary('Accept');
+      res.get('Vary').should.equal('Accept');
+    })
+  })
+
+  describe('when the value is present', function(){
+    it('should not add it again', function(){
+      var res = response();
+      res.vary('Accept');
+      res.vary('Accept-Encoding');
+      res.vary('Accept-Encoding');
+      res.vary('Accept-Encoding');
+      res.vary('Accept');
+      res.get('Vary').should.equal('Accept, Accept-Encoding');
+    })
+  })
+})