test/res.format.js

   1 'use strict'
   2
   3 var after = require('after')
   4 var express = require('../')
   5   , request = require('supertest')
   6   , assert = require('assert');
   7
   8 var app1 = express();
   9
  10 app1.use(function(req, res, next){
  11   res.format({
  12     'text/plain': function(){
  13       res.send('hey');
  14     },
  15
  16     'text/html': function(){
  17       res.send('<p>hey</p>');
  18     },
  19
  20     'application/json': function(a, b, c){
  21       assert(req === a)
  22       assert(res === b)
  23       assert(next === c)
  24       res.send({ message: 'hey' });
  25     }
  26   });
  27 });
  28
  29 app1.use(function(err, req, res, next){
  30   if (!err.types) throw err;
  31   res.send(err.status, 'Supports: ' + err.types.join(', '));
  32 })
  33
  34 var app2 = express();
  35
  36 app2.use(function(req, res, next){
  37   res.format({
  38     text: function(){ res.send('hey') },
  39     html: function(){ res.send('<p>hey</p>') },
  40     json: function(){ res.send({ message: 'hey' }) }
  41   });
  42 });
  43
  44 app2.use(function(err, req, res, next){
  45   res.send(err.status, 'Supports: ' + err.types.join(', '));
  46 })
  47
  48 var app3 = express();
  49
  50 app3.use(function(req, res, next){
  51   res.format({
  52     text: function(){ res.send('hey') },
  53     default: function (a, b, c) {
  54       assert(req === a)
  55       assert(res === b)
  56       assert(next === c)
  57       res.send('default')
  58     }
  59   })
  60 });
  61
  62 var app4 = express();
  63
  64 app4.get('/', function(req, res, next){
  65   res.format({
  66     text: function(){ res.send('hey') },
  67     html: function(){ res.send('<p>hey</p>') },
  68     json: function(){ res.send({ message: 'hey' }) }
  69   });
  70 });
  71
  72 app4.use(function(err, req, res, next){
  73   res.send(err.status, 'Supports: ' + err.types.join(', '));
  74 })
  75
  76 var app5 = express();
  77
  78 app5.use(function (req, res, next) {
  79   res.format({
  80     default: function () { res.send('hey') }
  81   });
  82 });
  83
  84 describe('res', function(){
  85   describe('.format(obj)', function(){
  86     describe('with canonicalized mime types', function(){
  87       test(app1);
  88     })
  89
  90     describe('with extnames', function(){
  91       test(app2);
  92     })
  93
  94     describe('with parameters', function(){
  95       var app = express();
  96
  97       app.use(function(req, res, next){
  98         res.format({
  99           'text/plain; charset=utf-8': function(){ res.send('hey') },
 100           'text/html; foo=bar; bar=baz': function(){ res.send('<p>hey</p>') },
 101           'application/json; q=0.5': function(){ res.send({ message: 'hey' }) }
 102         });
 103       });
 104
 105       app.use(function(err, req, res, next){
 106         res.send(err.status, 'Supports: ' + err.types.join(', '));
 107       });
 108
 109       test(app);
 110     })
 111
 112     describe('given .default', function(){
 113       it('should be invoked instead of auto-responding', function(done){
 114         request(app3)
 115         .get('/')
 116         .set('Accept', 'text/html')
 117         .expect('default', done);
 118       })
 119
 120       it('should work when only .default is provided', function (done) {
 121         request(app5)
 122         .get('/')
 123         .set('Accept', '*/*')
 124         .expect('hey', done);
 125       })
 126
 127       it('should be able to invoke other formatter', function (done) {
 128         var app = express()
 129
 130         app.use(function (req, res, next) {
 131           res.format({
 132             json: function () { res.send('json') },
 133             default: function () {
 134               res.header('x-default', '1')
 135               this.json()
 136             }
 137           })
 138         })
 139
 140         request(app)
 141           .get('/')
 142           .set('Accept', 'text/plain')
 143           .expect(200)
 144           .expect('x-default', '1')
 145           .expect('json')
 146           .end(done)
 147       })
 148     })
 149
 150     describe('in router', function(){
 151       test(app4);
 152     })
 153
 154     describe('in router', function(){
 155       var app = express();
 156       var router = express.Router();
 157
 158       router.get('/', function(req, res, next){
 159         res.format({
 160           text: function(){ res.send('hey') },
 161           html: function(){ res.send('<p>hey</p>') },
 162           json: function(){ res.send({ message: 'hey' }) }
 163         });
 164       });
 165
 166       router.use(function(err, req, res, next){
 167         res.send(err.status, 'Supports: ' + err.types.join(', '));
 168       })
 169
 170       app.use(router)
 171
 172       test(app)
 173     })
 174   })
 175 })
 176
 177 function test(app) {
 178   it('should utilize qvalues in negotiation', function(done){
 179     request(app)
 180     .get('/')
 181     .set('Accept', 'text/html; q=.5, application/json, */*; q=.1')
 182     .expect({"message":"hey"}, done);
 183   })
 184
 185   it('should allow wildcard type/subtypes', function(done){
 186     request(app)
 187     .get('/')
 188     .set('Accept', 'text/html; q=.5, application/*, */*; q=.1')
 189     .expect({"message":"hey"}, done);
 190   })
 191
 192   it('should default the Content-Type', function(done){
 193     request(app)
 194     .get('/')
 195     .set('Accept', 'text/html; q=.5, text/plain')
 196     .expect('Content-Type', 'text/plain; charset=utf-8')
 197     .expect('hey', done);
 198   })
 199
 200   it('should set the correct charset for the Content-Type', function (done) {
 201     var cb = after(3, done)
 202
 203     request(app)
 204     .get('/')
 205     .set('Accept', 'text/html')
 206     .expect('Content-Type', 'text/html; charset=utf-8', cb)
 207
 208     request(app)
 209     .get('/')
 210     .set('Accept', 'text/plain')
 211     .expect('Content-Type', 'text/plain; charset=utf-8', cb)
 212
 213     request(app)
 214     .get('/')
 215     .set('Accept', 'application/json')
 216     .expect('Content-Type', 'application/json; charset=utf-8', cb)
 217   })
 218
 219   it('should Vary: Accept', function(done){
 220     request(app)
 221     .get('/')
 222     .set('Accept', 'text/html; q=.5, text/plain')
 223     .expect('Vary', 'Accept', done);
 224   })
 225
 226   describe('when Accept is not present', function(){
 227     it('should invoke the first callback', function(done){
 228       request(app)
 229       .get('/')
 230       .expect('hey', done);
 231     })
 232   })
 233
 234   describe('when no match is made', function(){
 235     it('should should respond with 406 not acceptable', function(done){
 236       request(app)
 237       .get('/')
 238       .set('Accept', 'foo/bar')
 239       .expect('Supports: text/plain, text/html, application/json')
 240       .expect(406, done)
 241     })
 242   })
 243 }