Release 3.3.5

Fixed test cases for res.format

History.md

@@ -1,4 +1,35 @@
 
+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 
+==================
+
+ * update connect
+
+3.3.0 / 2013-06-26 
+==================
+
+ * update connect
+ * add support for multiple X-Forwarded-Proto values. Closes #1646
+ * change: remove charset from json responses. Closes #1631
+ * change: return actual booleans from req.accept* functions
+ * fix jsonp callback array throw
+
 3.2.6 / 2013-06-02 
 ==================
 

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'));
@@ -117,7 +118,6 @@ app.use = function(route, fn){
     fn = function(req, res, next) {
       var orig = req.app;
       app.handle(req, res, function(err){
-        req.app = res.app = orig;
         req.__proto__ = orig.request;
         res.__proto__ = orig.response;
         next(err);
@@ -185,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.
  */
@@ -38,8 +32,8 @@ exports.mime = connect.mime;
 function createApplication() {
   var app = connect();
   utils.merge(app, proto);
-  app.request = { __proto__: req };
-  app.response = { __proto__: res };
+  app.request = { __proto__: req, app: app };
+  app.response = { __proto__: res, app: app };
   app.init();
   return app;
 }

lib/middleware.js

@@ -17,7 +17,6 @@ var utils = require('./utils');
 
 exports.init = function(app){
   return function expressInit(req, res, next){
-    req.app = res.app = app;
     if (app.enabled('x-powered-by')) res.setHeader('X-Powered-By', 'Express');
     req.res = res;
     res.req = req;

lib/request.js

@@ -110,7 +110,7 @@ req.accepts = function(type){
  */
 
 req.acceptsEncoding = function(encoding){
-  return ~this.acceptedEncodings.indexOf(encoding);
+  return !! ~this.acceptedEncodings.indexOf(encoding);
 };
 
 /**
@@ -125,7 +125,7 @@ req.acceptsEncoding = function(encoding){
 req.acceptsCharset = function(charset){
   var accepted = this.acceptedCharsets;
   return accepted.length
-    ? ~accepted.indexOf(charset)
+    ? !! ~accepted.indexOf(charset)
     : true;
 };
 
@@ -141,7 +141,7 @@ req.acceptsCharset = function(charset){
 req.acceptsLanguage = function(lang){
   var accepted = this.acceptedLanguages;
   return accepted.length
-    ? ~accepted.indexOf(lang)
+    ? !! ~accepted.indexOf(lang)
     : true;
 };
 
@@ -345,11 +345,10 @@ req.is = function(type){
 
 req.__defineGetter__('protocol', function(){
   var trustProxy = this.app.get('trust proxy');
-  return this.connection.encrypted
-    ? 'https'
-    : trustProxy
-      ? (this.get('X-Forwarded-Proto') || 'http')
-      : 'http';
+  if (this.connection.encrypted) return 'https';
+  if (!trustProxy) return 'http';
+  var proto = this.get('X-Forwarded-Proto') || 'http';
+  return proto.split(/\s*,\s*/)[0];
 });
 
 /**

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,7 +188,6 @@ 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);
@@ -234,6 +236,7 @@ res.jsonp = function(obj){
 
   // jsonp
   if (callback) {
+    if (callback instanceof Array) callback = callback[0];
     this.set('Content-Type', 'text/javascript');
     var cb = callback.replace(/[^\[\]\w$.]/g, '');
     body = cb + ' && ' + cb + '(' + body + ');';

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`

package.json

@@ -1,7 +1,7 @@
 {
   "name": "express",
   "description": "Sinatra inspired web development framework",
-  "version": "3.2.6",
+  "version": "3.3.5",
   "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "contributors": [
     {
@@ -22,22 +22,22 @@
     }
   ],
   "dependencies": {
-    "connect": "2.7.11",
-    "commander": "0.6.1",
+    "connect": "2.8.5",
+    "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.0",
+    "send": "0.1.4",
     "cookie-signature": "1.0.1",
     "debug": "*"
   },
   "devDependencies": {
     "ejs": "*",
     "mocha": "*",
-    "jade": "*",
+    "jade": "0.30.0",
     "hjs": "*",
     "stylus": "*",
     "should": "*",

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.secure.js

@@ -0,0 +1,83 @@
+
+var express = require('../')
+  , request = require('./support/http');
+
+describe('req', function(){
+  describe('.secure', function(){
+    describe('when X-Forwarded-Proto is missing', function(){
+      it('should return false when http', function(done){
+        var app = express();
+
+        app.get('/', function(req, res){
+          res.send(req.secure ? 'yes' : 'no');
+        });
+
+        request(app)
+        .get('/')
+        .expect('no', done)
+      })
+    })
+  })
+
+  describe('.secure', function(){
+    describe('when X-Forwarded-Proto is present', function(){
+      it('should return false when http', function(done){
+        var app = express();
+
+        app.get('/', function(req, res){
+          res.send(req.secure ? 'yes' : 'no');
+        });
+
+        request(app)
+        .get('/')
+        .set('X-Forwarded-Proto', 'https')
+        .expect('no', done)
+      })
+
+      it('should return true when "trust proxy" is enabled', function(done){
+        var app = express();
+
+        app.enable('trust proxy');
+
+        app.get('/', function(req, res){
+          res.send(req.secure ? 'yes' : 'no');
+        });
+
+        request(app)
+        .get('/')
+        .set('X-Forwarded-Proto', 'https')
+        .expect('yes', done)
+      })
+
+      it('should return false when initial proxy is http', function(done){
+        var app = express();
+
+        app.enable('trust proxy');
+
+        app.get('/', function(req, res){
+          res.send(req.secure ? 'yes' : 'no');
+        });
+
+        request(app)
+        .get('/')
+        .set('X-Forwarded-Proto', 'http, https')
+        .expect('no', done)
+      })
+
+      it('should return true when initial proxy is https', function(done){
+        var app = express();
+
+        app.enable('trust proxy');
+
+        app.get('/', function(req, res){
+          res.send(req.secure ? 'yes' : 'no');
+        });
+
+        request(app)
+        .get('/')
+        .set('X-Forwarded-Proto', 'https, http')
+        .expect('yes', done)
+      })
+    })
+  })
+})

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; charset=utf-8');
+          res.headers.should.have.property('content-type', 'application/json');
           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; charset=utf-8');
+          res.headers.should.have.property('content-type', 'application/json');
           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; charset=utf-8');
+          res.headers.should.have.property('content-type', 'application/json');
           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; charset=utf-8');
+        res.headers.should.have.property('content-type', 'application/json');
         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; charset=utf-8');
+        res.headers.should.have.property('content-type', 'application/json');
         res.text.should.equal('{"id":1}');
         done();
       })

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; charset=utf-8');
+        res.headers.should.have.property('content-type', 'application/json');
         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();
+        });
+      });
+    });
+  })
 })