streaming view rendering

Allows for a view engine to return a stream upon being asked to render a
path. This allows for the engine to simply stream out data as it is
loaded from disk (or other IO location) without having to collect it all
first and then send it.

Fallback mode for all existing engines that call `fn` upon completion
takes over if no stream is returned. This works for both app.render and
res.render

.travis.yml

@@ -1,4 +1,4 @@
 language: node_js
 node_js:
   - "0.8"
-  - "0.10"
+  - "0.10"

History.md

@@ -1,38 +1,77 @@
+3.4.4 / 2013-10-29
+==================
 
-3.3.7 / 2013-08-28 
+ * update connect
+ * update supertest
+ * update methods
+ * express(1): replace bodyParser() with urlencoded() and json() #1795 @chirag04
+
+3.4.3 / 2013-10-23
 ==================
 
  * update connect
 
-3.3.6 / 2013-08-27 
+3.4.2 / 2013-10-18
+==================
+
+ * update connect
+ * downgrade commander
+
+3.4.1 / 2013-10-15
+==================
+
+ * update connect
+ * update commander
+ * jsonp: check if callback is a function
+ * router: wrap encodeURIComponent in a try/catch #1735 (@lxe)
+ * res.format: now includes chraset @1747 (@sorribas)
+ * res.links: allow multiple calls @1746 (@sorribas)
+
+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 
+3.3.4 / 2013-07-08
 ==================
 
  * update send and connect
 
-3.3.3 / 2013-07-04 
+3.3.3 / 2013-07-04
 ==================
 
  * update connect
 
-3.3.2 / 2013-07-03 
+3.3.2 / 2013-07-03
 ==================
 
  * update connect
  * update send
  * remove .version export
 
-3.3.1 / 2013-06-27 
+3.3.1 / 2013-06-27
 ==================
 
  * update connect
 
-3.3.0 / 2013-06-26 
+3.3.0 / 2013-06-26
 ==================
 
  * update connect
@@ -41,12 +80,12 @@
  * change: return actual booleans from req.accept* functions
  * fix jsonp callback array throw
 
-3.2.6 / 2013-06-02 
+3.2.6 / 2013-06-02
 ==================
 
  * update connect
 
-3.2.5 / 2013-05-21 
+3.2.5 / 2013-05-21
 ==================
 
  * update connect
@@ -54,23 +93,23 @@
  * add: throw a meaningful error when there is no default engine
  * change generation of ETags with res.send() to GET requests only. Closes #1619
 
-3.2.4 / 2013-05-09 
+3.2.4 / 2013-05-09
 ==================
-  
+
   * fix `req.subdomains` when no Host is present
   * fix `req.host` when no Host is present, return undefined
 
-3.2.3 / 2013-05-07 
+3.2.3 / 2013-05-07
 ==================
 
   * update connect / qs
 
-3.2.2 / 2013-05-03 
+3.2.2 / 2013-05-03
 ==================
 
   * update qs
 
-3.2.1 / 2013-04-29 
+3.2.1 / 2013-04-29
 ==================
 
   * add app.VERB() paths array deprecation warning
@@ -78,27 +117,27 @@
   * update qs and remove all ~ semver crap
   * fix: accept number as value of Signed Cookie
 
-3.2.0 / 2013-04-15 
+3.2.0 / 2013-04-15
 ==================
 
   * add "view" constructor setting to override view behaviour
   * add req.acceptsEncoding(name)
   * add req.acceptedEncodings
   * revert cookie signature change causing session race conditions
-  * fix sorting of Accept values of the same quality  
+  * fix sorting of Accept values of the same quality
 
-3.1.2 / 2013-04-12 
+3.1.2 / 2013-04-12
 ==================
 
   * add support for custom Accept parameters
   * update cookie-signature
 
-3.1.1 / 2013-04-01 
+3.1.1 / 2013-04-01
 ==================
 
   * add X-Forwarded-Host support to `req.host`
-  * fix relative redirects  
-  * update mkdirp 
+  * fix relative redirects
+  * update mkdirp
   * update buffer-crc32
   * remove legacy app.configure() method from app template.
 

Makefile

@@ -9,6 +9,7 @@ test: test-unit test-acceptance
 test-unit:
 	@NODE_ENV=test ./node_modules/.bin/mocha \
 		--reporter $(REPORTER) \
+		--globals setImmediate,clearImmediate \
 		$(MOCHA_OPTS)
 
 test-acceptance:

Readme.md

@@ -1,6 +1,8 @@
-![express logo](http://f.cl.ly/items/0V2S1n0K1i3y1c122g04/Screen%20Shot%202012-04-11%20at%209.59.42%20AM.png)
+[![express logo](http://f.cl.ly/items/0V2S1n0K1i3y1c122g04/Screen%20Shot%202012-04-11%20at%209.59.42%20AM.png)](http://expressjs.com/)
 
-  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)
+  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) [![Gittip](http://img.shields.io/gittip/visionmedia.png)](https://www.gittip.com/visionmedia/)
 
 ```js
 var express = require('express');
@@ -60,6 +62,7 @@ app.listen(3000);
 
 ## More Information
 
+  * [Website and Documentation](http://expressjs.com/) stored at [visionmedia/expressjs.com](https://github.com/visionmedia/expressjs.com)
   * Join #express on freenode
   * [Google Group](http://groups.google.com/group/express-js) for discussion
   * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
@@ -79,6 +82,10 @@ then run whichever tests you want:
 
     $ node examples/content-negotiation
 
+You can also view live examples here
+
+<a href="https://runnable.com/express" target="_blank"><img src="https://runnable.com/external/styles/assets/runnablebtn.png" style="width:67px;height:25px;"></a>
+
 ## Running Tests
 
 To run the test suite first invoke the following command within the repo, installing the development dependencies:
@@ -91,67 +98,7 @@ then run the tests:
 
 ## Contributors
 
-```
-project: express
-commits: 3559
-active : 468 days
-files  : 237
-authors:
- 1891	Tj Holowaychuk          53.1%
- 1285	visionmedia             36.1%
-  182	TJ Holowaychuk          5.1%
-   54	Aaron Heckmann          1.5%
-   34	csausdev                1.0%
-   26	ciaranj                 0.7%
-   21	Robert Sköld            0.6%
-    6	Guillermo Rauch         0.2%
-    3	Dav Glass               0.1%
-    3	Nick Poulden            0.1%
-    2	Randy Merrill           0.1%
-    2	Benny Wong              0.1%
-    2	Hunter Loftis           0.1%
-    2	Jake Gordon             0.1%
-    2	Brian McKinney          0.1%
-    2	Roman Shtylman          0.1%
-    2	Ben Weaver              0.1%
-    2	Dave Hoover             0.1%
-    2	Eivind Fjeldstad        0.1%
-    2	Daniel Shaw             0.1%
-    1	Matt Colyer             0.0%
-    1	Pau Ramon               0.0%
-    1	Pero Pejovic            0.0%
-    1	Peter Rekdal Sunde      0.0%
-    1	Raynos                  0.0%
-    1	Teng Siong Ong          0.0%
-    1	Viktor Kelemen          0.0%
-    1	ctide                   0.0%
-    1	8bitDesigner            0.0%
-    1	isaacs                  0.0%
-    1	mgutz                   0.0%
-    1	pikeas                  0.0%
-    1	shuwatto                0.0%
-    1	tstrimple               0.0%
-    1	ewoudj                  0.0%
-    1	Adam Sanderson          0.0%
-    1	Andrii Kostenko         0.0%
-    1	Andy Hiew               0.0%
-    1	Arpad Borsos            0.0%
-    1	Ashwin Purohit          0.0%
-    1	Benjen                  0.0%
-    1	Darren Torpey           0.0%
-    1	Greg Ritter             0.0%
-    1	Gregory Ritter          0.0%
-    1	James Herdman           0.0%
-    1	Jim Snodgrass           0.0%
-    1	Joe McCann              0.0%
-    1	Jonathan Dumaine        0.0%
-    1	Jonathan Palardy        0.0%
-    1	Jonathan Zacsh          0.0%
-    1	Justin Lilly            0.0%
-    1	Ken Sato                0.0%
-    1	Maciej Małecki          0.0%
-    1	Masahiro Hayashi        0.0%
-```
+  https://github.com/visionmedia/express/graphs/contributors
 
 ## License
 

bin/express

@@ -4,8 +4,7 @@
  * Module dependencies.
  */
 
-var exec = require('child_process').exec
-  , program = require('commander')
+var program = require('commander')
   , mkdirp = require('mkdirp')
   , pkg = require('../package.json')
   , version = pkg.version
@@ -219,11 +218,12 @@ var app = [
   , ''
   , '// all environments'
   , 'app.set(\'port\', process.env.PORT || 3000);'
-  , 'app.set(\'views\', __dirname + \'/views\');'
+  , 'app.set(\'views\', path.join(__dirname, \'views\'));'
   , 'app.set(\'view engine\', \':TEMPLATE\');'
   , 'app.use(express.favicon());'
   , 'app.use(express.logger(\'dev\'));'
-  , 'app.use(express.bodyParser());'
+  , 'app.use(express.json());'
+  , 'app.use(express.urlencoded());'
   , 'app.use(express.methodOverride());{sess}'
   , 'app.use(app.router);{css}'
   , 'app.use(express.static(path.join(__dirname, \'public\')));'
@@ -324,10 +324,10 @@ function createApplicationAt(path) {
     // CSS Engine support
     switch (program.css) {
       case 'less':
-        app = app.replace('{css}', eol + 'app.use(require(\'less-middleware\')({ src: __dirname + \'/public\' }));');
+        app = app.replace('{css}', eol + 'app.use(require(\'less-middleware\')({ src: path.join(__dirname, \'public\') }));');
         break;
       case 'stylus':
-        app = app.replace('{css}', eol + 'app.use(require(\'stylus\').middleware(__dirname + \'/public\'));');
+        app = app.replace('{css}', eol + 'app.use(require(\'stylus\').middleware(path.join(__dirname, \'public\')));');
         break;
       default:
         app = app.replace('{css}', '');

examples/content-negotiation/index.js

@@ -1,8 +1,9 @@
-
 var express = require('../../')
   , app = module.exports = express()
   , users = require('./db');
 
+// so either you can deal with different types of formatting 
+// for expected response in index.js
 app.get('/', function(req, res){
   res.format({
     html: function(){
@@ -24,12 +25,13 @@ app.get('/', function(req, res){
 });
 
 // or you could write a tiny middleware like
-// this to abstract make things a bit more declarative:
+// this to add a layer of abstraction
+// and make things a bit more declarative:
 
-function format(mod) {
-  var obj = require(mod);
+function format(requestHandlerName) {
+  var requestHandler = require(requestHandlerName);
   return function(req, res){
-    res.format(obj);
+    res.format(requestHandler);
   }
 }
 
@@ -38,4 +40,4 @@ app.get('/users', format('./users'));
 if (!module.parent) {
   app.listen(3000);
   console.log('listening on port 3000');
-}
+}

examples/vhost/index.js

@@ -23,7 +23,7 @@ main.get('/', function(req, res){
 });
 
 main.get('/:sub', function(req, res){
-  res.send('requsted ' + req.params.sub);
+  res.send('requested ' + req.params.sub);
 });
 
 // Redirect app

lib/application.js

@@ -10,9 +10,7 @@ var connect = require('connect')
   , locals = require('./utils').locals
   , View = require('./view')
   , utils = connect.utils
-  , path = require('path')
-  , http = require('http')
-  , join = path.join;
+  , http = require('http');
 
 /**
  * Application prototype.
@@ -185,7 +183,7 @@ app.engine = function(ext, fn){
  * could automatically load a user's information from the database without
  * any additional code,
  *
- * The callback uses the same signature as middleware, the only differencing
+ * The callback uses the same signature as middleware, the only difference
  * 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.
@@ -503,7 +501,26 @@ app.render = function(name, options, fn){
 
   // render
   try {
-    view.render(opts, fn);
+    var view_stream = view.render(opts, fn);
+
+    // if the engine returned a stream AND user specified a function
+    // then we will capture data for user
+    if (view_stream && fn) {
+      var body = '';
+      view_stream.on('data', function(chunk) {
+        body += chunk;
+      });
+
+      view_stream.once('error', function(err) {
+        fn(err);
+      });
+
+      view_stream.once('end', function() {
+        fn(null, body);
+      });
+    }
+
+    return view_stream;
   } catch (err) {
     fn(err);
   }

lib/response.js

@@ -14,9 +14,9 @@ var http = require('http')
   , cookie = require('cookie')
   , send = require('send')
   , mime = connect.mime
+  , resolve = require('url').resolve
   , basename = path.basename
-  , extname = path.extname
-  , join = path.join;
+  , extname = path.extname;
 
 /**
  * Response prototype.
@@ -55,7 +55,9 @@ res.status = function(code){
  */
 
 res.links = function(links){
-  return this.set('Link', Object.keys(links).map(function(rel){
+  var link = this.get('Link') || '';
+  if (link) link += ', ';
+  return this.set('Link', link + Object.keys(links).map(function(rel){
     return '<' + links[rel] + '>; rel="' + rel + '"';
   }).join(', '));
 };
@@ -131,7 +133,7 @@ res.send = function(body){
 
   // ETag support
   // TODO: W/ support
-  if (app.settings.etag && len > 1024 && 'GET' == req.method) {
+  if (app.settings.etag && len && 'GET' == req.method) {
     if (!this.get('ETag')) {
       this.set('ETag', etag(body));
     }
@@ -237,10 +239,10 @@ 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 + ');';
+    body = 'typeof ' + cb + ' === \'function\' && ' + cb + '(' + body + ');';
   }
 
   return this.send(body);
@@ -322,10 +324,10 @@ res.sendfile = function(path, options, fn){
   }
 
   // streaming
-  function stream() {
+  function stream(stream) {
     if (done) return;
     cleanup();
-    if (fn) self.on('finish', fn);
+    if (fn) stream.on('end', fn);
   }
 
   // cleanup
@@ -463,10 +465,13 @@ 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);
+    var type = normalizeType(key).value;
+    var charset = mime.charsets.lookup(type);
+    if (charset) type += '; charset=' + charset;
+    this.set('Content-Type', type);
     obj[key](req, this, next);
   } else if (fn) {
     fn();
@@ -629,7 +634,8 @@ res.cookie = function(name, val, options){
 
 res.location = function(url){
   var app = this.app
-    , req = this.req;
+    , req = this.req
+    , path;
 
   // setup redirect map
   var map = { back: req.get('Referrer') || '/' };
@@ -639,12 +645,11 @@ res.location = function(url){
 
   // relative
   if (!~url.indexOf('://') && 0 != url.indexOf('//')) {
-    var path
-
     // relative to path
     if ('.' == url[0]) {
-      path = req.originalUrl.split('?')[0]
-      url =  path + ('/' == path[path.length - 1] ? '' : '/') + url;
+      path = req.originalUrl.split('?')[0];
+      path = path + ('/' == path[path.length - 1] ? '' : '/');
+      url = resolve(path, url);
       // relative to mount-point
     } else if ('/' != url[0]) {
       path = app.path();
@@ -679,8 +684,7 @@ res.location = function(url){
  */
 
 res.redirect = function(url){
-  var app = this.app
-    , head = 'HEAD' == this.req.method
+  var head = 'HEAD' == this.req.method
     , status = 302
     , body;
 
@@ -720,6 +724,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
@@ -750,12 +792,49 @@ res.render = function(view, options, fn){
   // merge res.locals
   options._locals = self.locals;
 
-  // default callback to respond
-  fn = fn || function(err, str){
+  // support for non streaming view rendering
+  // if renderer uses streams, this will not be called
+  // see below for how streams are handled
+  var respond = fn || function(err, str){
+    if (view_stream) return;
+
     if (err) return req.next(err);
     self.send(str);
   };
 
-  // render
-  app.render(view, options, fn);
+  var view_stream = app.render(view, options, respond);
+
+  // old style, will have already called respond for us
+  if (!view_stream) {
+    return;
+  }
+
+  // user wants to handle sending themselves
+  if (fn) {
+    var body = '';
+    view_stream.on('data', function(chunk) {
+      body += chunk;
+    });
+
+    view_stream.once('error', function(err) {
+      fn(err);
+    });
+
+    view_stream.once('end', function() {
+      fn(null, body);
+    });
+
+    return;
+  }
+
+  // set response headers
+  self.statusCode = 200;
+  if (!self.get('Content-Type')) {
+    self.charset = self.charset || 'utf-8';
+    self.type('html');
+  }
+  self.setHeader('Transfer-Encoding', 'chunked');
+
+  // start streaming the response
+  view_stream.pipe(self);
 };

lib/router/index.js

@@ -283,7 +283,7 @@ Router.prototype.route = function(method, path, callbacks){
   if (!path) throw new Error('Router#' + method + '() requires a path');
 
   // ensure all callbacks are functions
-  callbacks.forEach(function(fn, i){
+  callbacks.forEach(function(fn){
     if ('function' == typeof fn) return;
     var type = {}.toString.call(fn);
     var msg = '.' + method + '() requires callback functions but got a ' + type;

lib/router/route.js

@@ -58,7 +58,7 @@ Route.prototype.match = function(path){
     var key = keys[i - 1];
 
     var val = 'string' == typeof m[i]
-      ? decodeURIComponent(m[i])
+      ? utils.decode(m[i])
       : m[i];
 
     if (key) {

lib/utils.js

@@ -34,7 +34,7 @@ exports.etag = function(body){
  * @api private
  */
 
-exports.locals = function(obj){
+exports.locals = function(){
   function locals(obj){
     for (var key in obj) locals[key] = obj[key];
     return obj;
@@ -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
 };
 
 /**
@@ -311,3 +312,22 @@ exports.pathRegexp = function(path, keys, sensitive, strict) {
     .replace(/\*/g, '(.*)');
   return new RegExp('^' + path + '$', sensitive ? '' : 'i');
 }
+
+
+/**
+ * Decodes a URI component. Returns
+ * the original string if the component
+ * is malformed.
+ *
+ * @param  {String} str
+ * @return {String}
+ * @api private
+ */
+
+exports.decode = function(str) {
+  try {
+    return decodeURIComponent(str);
+  } catch (e) {
+    return str;
+  }
+}

lib/view.js

@@ -73,5 +73,5 @@ View.prototype.lookup = function(path){
  */
 
 View.prototype.render = function(options, fn){
-  this.engine(this.path, options, fn);
+  return this.engine(this.path, options, fn);
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "express",
   "description": "Sinatra inspired web development framework",
-  "version": "3.3.7",
+  "version": "3.4.4",
   "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "contributors": [
     {
@@ -22,28 +22,28 @@
     }
   ],
   "dependencies": {
-    "connect": "2.8.6",
-    "commander": "1.2.0",
+    "connect": "2.11.0",
+    "commander": "1.3.2",
     "range-parser": "0.0.4",
     "mkdirp": "0.3.5",
     "cookie": "0.1.0",
     "buffer-crc32": "0.2.1",
     "fresh": "0.2.0",
-    "methods": "0.0.1",
+    "methods": "0.1.0",
     "send": "0.1.4",
     "cookie-signature": "1.0.1",
-    "debug": "*"
+    "debug": ">= 0.7.3 < 1"
   },
   "devDependencies": {
-    "ejs": "*",
-    "mocha": "*",
+    "ejs": ">= 0.8.4 < 1",
+    "mocha": ">= 1.13.0 < 2",
     "jade": "0.30.0",
-    "hjs": "*",
-    "stylus": "*",
-    "should": "*",
-    "connect-redis": "*",
-    "marked": "*",
-    "supertest": "0.6.0"
+    "hjs": ">= 0.0.6 < 1",
+    "stylus": ">= 0.39.1 < 1",
+    "should": ">= 2.0.2 < 3",
+    "connect-redis": ">= 1.4.5 < 2",
+    "marked": ">= 0.2.9 < 1",
+    "supertest": ">= 0.8.1 < 1"
   },
   "keywords": [
     "express",
@@ -66,6 +66,6 @@
     "test": "make test"
   },
   "engines": {
-    "node": "*"
+    "node": ">= 0.8.0"
   }
 }

test/app.engine.js

@@ -1,5 +1,6 @@
 
 var express = require('../')
+  , request = require('./support/http')
   , fs = require('fs');
 
 function render(path, options, fn) {
@@ -10,6 +11,10 @@ function render(path, options, fn) {
   });
 }
 
+function streaming_render(path, options, fn) {
+  return fs.createReadStream(path, { encoding: 'utf-8' });
+}
+
 describe('app', function(){
   describe('.engine(ext, fn)', function(){
     it('should map a template engine', function(done){
@@ -76,5 +81,42 @@ describe('app', function(){
         done();
       })
     })
+
+    it('should support streaming engines', function(done) {
+      var app = express();
+      app.set('views', __dirname + '/fixtures');
+      app.engine('.html', streaming_render);
+      app.set('view engine', '.html');
+      app.locals.user = { name: 'tobi' };
+
+      // using function should just call the function when done
+      app.render('user', function(err, str){
+        if (err) return done(err);
+        str.should.equal('<p>{{user.name}}</p>');
+        done();
+      })
+    });
+
+    it('should render a response using the streaming engine', function(done) {
+      var app = express();
+      app.set('views', __dirname + '/fixtures');
+      app.engine('.html', streaming_render);
+      app.set('view engine', '.html');
+      app.locals.user = { name: 'tobi' };
+
+      app.get('/', function(req, res) {
+        res.render('user');
+      });
+
+      request(app)
+      .get('/')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) return done(err);
+        res.header['transfer-encoding'].should.equal('chunked');
+        res.text.should.equal('<p>{{user.name}}</p>');
+        done();
+      });
+    });
   })
 })

test/app.param.js

@@ -52,13 +52,13 @@ describe('app', function(){
 
       app.get('/post/:id', function(req, res){
         var id = req.params.id;
-        id.should.be.a('number');
+        id.should.be.a.Number;
         res.send('' + id);
       });
 
       app.get('/user/:uid', function(req, res){
         var id = req.params.id;
-        id.should.be.a('number');
+        id.should.be.a.Number;
         res.send('' + id);
       });
 
@@ -87,7 +87,7 @@ describe('app', function(){
 
       app.get('/user/:id', function(req, res){
         var id = req.params.id;
-        id.should.be.a('number');
+        id.should.be.a.Number;
         res.send('' + id);
       });
 

test/app.router.js

@@ -39,6 +39,18 @@ describe('app.router', function(){
     .expect('foo/bar', done);
   })
 
+  it('should accept params in malformed paths', function(done) {
+    var app = express();
+
+    app.get('/:name', function(req, res, next){
+      res.send(req.params.name);
+    });
+
+    request(app)
+    .get('/%foobar')
+    .expect('%foobar', done);
+  })
+
   it('should be .use()able', function(done){
     var app = express();
 

test/exports.js

@@ -15,19 +15,19 @@ describe('exports', function(){
   })
 
   it('should expose Router', function(){
-    express.Router.should.be.a('function');
+    express.Router.should.be.a.Function;
   })
 
   it('should expose the application prototype', function(){
-    express.application.set.should.be.a('function');
+    express.application.set.should.be.a.Function;
   })
 
   it('should expose the request prototype', function(){
-    express.request.accepts.should.be.a('function');
+    express.request.accepts.should.be.a.Function;
   })
 
   it('should expose the response prototype', function(){
-    express.response.send.should.be.a('function');
+    express.response.send.should.be.a.Function;
   })
 
   it('should permit modifying the .application prototype', function(){

test/req.acceptedEncodings.js

@@ -29,6 +29,7 @@ describe('req', function(){
 
         request(app)
         .get('/')
+        .set('Accept-Encoding', '')
         .expect(200, done);
       })
     })

test/req.accepts.js

@@ -69,7 +69,7 @@ describe('req', function(){
     .expect('json', done);
   })
 
-  describe('.accept(types)', function(){
+  describe('.accepts(types)', function(){
     it('should return the first when Accept is not present', function(done){
       var app = express();
 

test/req.signedCookies.js

@@ -5,55 +5,34 @@ var express = require('../')
 describe('req', function(){
   describe('.signedCookies', function(){
     it('should return a signed JSON cookie', function(done){
-      var app = express()
-        , cookieHeader
-        , val;
-
-      /* So we use the same serialization for expected results. */
-      var replacer = app.get('json replacer')
-        , spaces = app.get('json spaces');
+      var app = express();
 
       app.use(express.cookieParser('secret'));
 
       app.use(function(req, res){
-        res.send(req.signedCookies);
+        if ('/set' == req.path) {
+          res.cookie('obj', { foo: 'bar' }, { signed: true });
+          res.end();
+        } else {
+          res.send(req.signedCookies);
+        }
       });
 
-      app.response.req = { secret: 'secret' };
-      app.response.cookie('obj', { foo: 'bar' }, { signed: true });
-      cookieHeader = app.response.get('set-cookie');
-
-      val = JSON.stringify({ obj: { foo: 'bar' } }, replacer, spaces);
       request(app)
-      .get('/')
-      .set('Cookie', cookieHeader)
-      .expect(val, done);
-    })
+      .get('/set')
+      .end(function(err, res){
+        if (err) return done(err);
+        var cookie = res.header['set-cookie'];
 
-    it('should return a signed cookie', function(done){
-      var app = express()
-        , cookieHeader
-        , val;
-
-      /* So we use the same serialization for expected results. */
-      var replacer = app.get('json replacer')
-        , spaces = app.get('json spaces');
-
-      app.use(express.cookieParser('secret'));
-
-      app.use(function(req, res){
-        res.send(req.signedCookies);
+        request(app)
+        .get('/')
+        .set('Cookie', cookie)
+        .end(function(err, res){
+          if (err) return don(err);
+          res.body.should.eql({ obj: { foo: 'bar' } });
+          done();
+        });
       });
-
-      app.response.req = { secret: 'secret' };
-      app.response.cookie('foo', 'bar', { signed: true });
-      cookieHeader = app.response.get('set-cookie');
-
-      val = JSON.stringify({ foo: 'bar' }, replacer, spaces);
-      request(app)
-      .get('/')
-      .set('Cookie', cookieHeader)
-      .expect(val, done);
     })
   })
 })

test/req.subdomains.js

@@ -15,7 +15,7 @@ describe('req', function(){
         request(app)
         .get('/')
         .set('Host', 'tobi.ferrets.example.com')
-        .expect('["ferrets","tobi"]', done);
+        .expect(["ferrets","tobi"], done);
       })
     })
 
@@ -30,7 +30,7 @@ describe('req', function(){
         request(app)
         .get('/')
         .set('Host', 'example.com')
-        .expect('[]', done);
+        .expect([], done);
       })
     })
 
@@ -45,7 +45,7 @@ describe('req', function(){
 
         request(app)
         .get('/')
-        .expect('[]', done);
+        .expect([], done);
       })
     })
 
@@ -62,7 +62,7 @@ describe('req', function(){
           request(app)
           .get('/')
           .set('Host', 'tobi.ferrets.sub.example.com')
-          .expect('["com","example","sub","ferrets","tobi"]', done);
+          .expect(["com","example","sub","ferrets","tobi"], done);
         })
       })
 
@@ -78,7 +78,7 @@ describe('req', function(){
           request(app)
           .get('/')
           .set('Host', 'tobi.ferrets.sub.example.com')
-          .expect('["ferrets","tobi"]', done);
+          .expect(["ferrets","tobi"], done);
         })
       })
 
@@ -94,7 +94,7 @@ describe('req', function(){
           request(app)
           .get('/')
           .set('Host', 'sub.example.com')
-          .expect('[]', done);
+          .expect([], done);
         })
       })
     })

test/res.format.js

@@ -93,10 +93,27 @@ function test(app) {
     request(app)
     .get('/')
     .set('Accept', 'text/html; q=.5, text/plain')
-    .expect('Content-Type', 'text/plain')
+    .expect('Content-Type', 'text/plain; charset=UTF-8')
     .expect('hey', done);
   })
 
+  it('should set the correct  charset for the Content-Type', function() {
+    request(app)
+    .get('/')
+    .set('Accept', 'text/html')
+    .expect('Content-Type', 'text/html; charset=UTF-8');
+
+    request(app)
+    .get('/')
+    .set('Accept', 'text/plain')
+    .expect('Content-Type', 'text/plain; charset=UTF-8');
+
+    request(app)
+    .get('/')
+    .set('Accept', 'application/json')
+    .expect('Content-Type', 'application/json');
+  })
+
   it('should Vary: Accept', function(done){
     request(app)
     .get('/')

test/res.jsonp.js

@@ -16,11 +16,27 @@ describe('res', function(){
       .get('/?callback=something')
       .end(function(err, res){
         res.headers.should.have.property('content-type', 'text/javascript; charset=utf-8');
-        res.text.should.equal('something && something({"count":1});');
+        res.text.should.equal('typeof something === \'function\' && something({"count":1});');
         done();
       })
     })
 
+    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('typeof something === \'function\' && something({"count":1});');
+            done();
+          })
+    })
+
     it('should allow renaming callback', function(done){
       var app = express();
 
@@ -34,10 +50,10 @@ describe('res', function(){
       .get('/?clb=something')
       .end(function(err, res){
         res.headers.should.have.property('content-type', 'text/javascript; charset=utf-8');
-        res.text.should.equal('something && something({"count":1});');
+        res.text.should.equal('typeof something === \'function\' && something({"count":1});');
         done();
       })
-    })      
+    })
 
     it('should allow []', function(done){
       var app = express();
@@ -50,7 +66,7 @@ describe('res', function(){
       .get('/?callback=callbacks[123]')
       .end(function(err, res){
         res.headers.should.have.property('content-type', 'text/javascript; charset=utf-8');
-        res.text.should.equal('callbacks[123] && callbacks[123]({"count":1});');
+        res.text.should.equal('typeof callbacks[123] === \'function\' && callbacks[123]({"count":1});');
         done();
       })
     })
@@ -66,7 +82,7 @@ describe('res', function(){
       .get('/?callback=foo;bar()')
       .end(function(err, res){
         res.headers.should.have.property('content-type', 'text/javascript; charset=utf-8');
-        res.text.should.equal('foobar && foobar({});');
+        res.text.should.equal('typeof foobar === \'function\' && foobar({});');
         done();
       })
     })
@@ -82,7 +98,7 @@ describe('res', function(){
       .get('/?callback=foo')
       .end(function(err, res){
         res.headers.should.have.property('content-type', 'text/javascript; charset=utf-8');
-        res.text.should.equal('foo && foo({"str":"\\u2028 \\u2029 woot"});');
+        res.text.should.equal('typeof foo === \'function\' && foo({"str":"\\u2028 \\u2029 woot"});');
         done();
       });
     });
@@ -122,7 +138,7 @@ describe('res', function(){
         })
       })
     })
-    
+
     describe('when given an object', function(){
       it('should respond with json', function(done){
         var app = express();
@@ -195,7 +211,7 @@ describe('res', function(){
       })
     })
   })
-  
+
   describe('.json(status, object)', function(){
     it('should respond with json and set the .statusCode', function(done){
       var app = express();

test/res.links.js

@@ -3,6 +3,11 @@ var express = require('../')
   , res = express.response;
 
 describe('res', function(){
+
+  beforeEach(function() {
+    res.removeHeader('link');
+  });
+
   describe('.links(obj)', function(){
     it('should set Link header field', function(){
       res.links({
@@ -15,5 +20,22 @@ describe('res', function(){
           '<http://api.example.com/users?page=2>; rel="next", '
         + '<http://api.example.com/users?page=5>; rel="last"');
     })
+
+    it('should set Link header field for multiple calls', function() {
+      res.links({
+        next: 'http://api.example.com/users?page=2',
+        last: 'http://api.example.com/users?page=5'
+      });
+
+      res.links({
+        prev: 'http://api.example.com/users?page=1',
+      });
+
+      res.get('link')
+      .should.equal(
+          '<http://api.example.com/users?page=2>; rel="next", '
+        + '<http://api.example.com/users?page=5>; rel="last", '
+        + '<http://api.example.com/users?page=1>; rel="prev"');
+    })
   })
 })

test/res.location.js

@@ -64,7 +64,7 @@ describe('res', function(){
         request(app)
         .get('/post/1')
         .end(function(err, res){
-          res.headers.should.have.property('location', '/post/1/./edit');
+          res.headers.should.have.property('location', '/post/1/edit');
           done();
         })
       })
@@ -81,7 +81,24 @@ describe('res', function(){
         request(app)
         .get('/post/1')
         .end(function(err, res){
-          res.headers.should.have.property('location', '/post/1/../new');
+          res.headers.should.have.property('location', '/post/new');
+          done();
+        })
+      })
+    })
+
+    describe('with leading ./ and containing ..', function(){
+      it('should construct path-relative urls', function(done){
+        var app = express();
+
+        app.use(function(req, res){
+          res.location('./skip/../../new').end();
+        });
+
+        request(app)
+        .get('/post/1')
+        .end(function(err, res){
+          res.headers.should.have.property('location', '/post/new');
           done();
         })
       })

test/res.redirect.js

@@ -210,17 +210,17 @@ describe('res', function(){
       request(root)
       .get('/depth1')
       .end(function(err, res){
-        res.headers.should.have.property('location', '/depth1/./index');
+        res.headers.should.have.property('location', '/depth1/index');
 
         request(root)
         .get('/depth1/depth2')
         .end(function(err, res){
-          res.headers.should.have.property('location', '/depth1/depth2/./index');
+          res.headers.should.have.property('location', '/depth1/depth2/index');
 
           request(root)
           .get('/depth1/depth2/depth3')
           .end(function(err, res){
-            res.headers.should.have.property('location', '/depth1/depth2/depth3/./index');
+            res.headers.should.have.property('location', '/depth1/depth2/depth3/index');
             done();
           })
         })
@@ -231,11 +231,11 @@ describe('res', function(){
       request(root)
       .get('/depth2')
       .end(function(err, res){
-        res.headers.should.have.property('location', '/depth2/./index');
+        res.headers.should.have.property('location', '/depth2/index');
         request(root)
         .get('/depth3')
         .end(function(err, res){
-          res.headers.should.have.property('location', '/depth3/./index');
+          res.headers.should.have.property('location', '/depth3/index');
           done();
         })
       })

test/res.send.js

@@ -321,6 +321,21 @@ describe('res', function(){
 
   describe('"etag" setting', function(){
     describe('when enabled', function(){
+      it('should send ETag even when content-length < 1024', function(done){
+        var app = express();
+
+        app.use(function(req, res){
+          res.send('kajdslfkasdf');
+        });
+
+        request(app)
+        .get('/')
+        .end(function(err, res){
+          res.headers.should.have.property('etag');
+          done();
+        });
+      })
+
       it('should send ETag ', function(done){
         var app = express();
 

test/res.sendfile.js

@@ -51,7 +51,7 @@ describe('res', function(){
       .get('/')
       .end(function(err, res){
         assert(1 == calls, 'called too many times');
-        res.text.should.equal("ENOENT, stat 'test/fixtures/nope.html'");
+        res.text.should.startWith("ENOENT, stat");
         res.statusCode.should.equal(200);
         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');
+    })
+  })
+})