test/res.send.js

   1
   2 var assert = require('assert')
   3 var Buffer = require('safe-buffer').Buffer
   4 var express = require('..');
   5 var methods = require('methods');
   6 var request = require('supertest');
   7 var utils = require('./support/utils');
   8
   9 describe('res', function(){
  10   describe('.send()', function(){
  11     it('should set body to ""', function(done){
  12       var app = express();
  13
  14       app.use(function(req, res){
  15         res.send();
  16       });
  17
  18       request(app)
  19       .get('/')
  20       .expect(200, '', done);
  21     })
  22   })
  23
  24   describe('.send(null)', function(){
  25     it('should set body to ""', function(done){
  26       var app = express();
  27
  28       app.use(function(req, res){
  29         res.send(null);
  30       });
  31
  32       request(app)
  33       .get('/')
  34       .expect('Content-Length', '0')
  35       .expect(200, '', done);
  36     })
  37   })
  38
  39   describe('.send(undefined)', function(){
  40     it('should set body to ""', function(done){
  41       var app = express();
  42
  43       app.use(function(req, res){
  44         res.send(undefined);
  45       });
  46
  47       request(app)
  48       .get('/')
  49       .expect(200, '', done);
  50     })
  51   })
  52
  53   describe('.send(code)', function(){
  54     it('should set .statusCode', function(done){
  55       var app = express();
  56
  57       app.use(function(req, res){
  58         res.send(201)
  59       });
  60
  61       request(app)
  62       .get('/')
  63       .expect('Created')
  64       .expect(201, done);
  65     })
  66   })
  67
  68   describe('.send(code, body)', function(){
  69     it('should set .statusCode and body', function(done){
  70       var app = express();
  71
  72       app.use(function(req, res){
  73         res.send(201, 'Created :)');
  74       });
  75
  76       request(app)
  77       .get('/')
  78       .expect('Created :)')
  79       .expect(201, done);
  80     })
  81   })
  82
  83   describe('.send(body, code)', function(){
  84     it('should be supported for backwards compat', function(done){
  85       var app = express();
  86
  87       app.use(function(req, res){
  88         res.send('Bad!', 400);
  89       });
  90
  91       request(app)
  92       .get('/')
  93       .expect('Bad!')
  94       .expect(400, done);
  95     })
  96   })
  97
  98   describe('.send(code, number)', function(){
  99     it('should send number as json', function(done){
 100       var app = express();
 101
 102       app.use(function(req, res){
 103         res.send(200, 0.123);
 104       });
 105
 106       request(app)
 107       .get('/')
 108       .expect('Content-Type', 'application/json; charset=utf-8')
 109       .expect(200, '0.123', done);
 110     })
 111   })
 112
 113   describe('.send(String)', function(){
 114     it('should send as html', function(done){
 115       var app = express();
 116
 117       app.use(function(req, res){
 118         res.send('<p>hey</p>');
 119       });
 120
 121       request(app)
 122       .get('/')
 123       .expect('Content-Type', 'text/html; charset=utf-8')
 124       .expect(200, '<p>hey</p>', done);
 125     })
 126
 127     it('should set ETag', function (done) {
 128       var app = express();
 129
 130       app.use(function (req, res) {
 131         var str = Array(1000).join('-');
 132         res.send(str);
 133       });
 134
 135       request(app)
 136       .get('/')
 137       .expect('ETag', 'W/"3e7-qPnkJ3CVdVhFJQvUBfF10TmVA7g"')
 138       .expect(200, done);
 139     })
 140
 141     it('should not override Content-Type', function(done){
 142       var app = express();
 143
 144       app.use(function(req, res){
 145         res.set('Content-Type', 'text/plain').send('hey');
 146       });
 147
 148       request(app)
 149       .get('/')
 150       .expect('Content-Type', 'text/plain; charset=utf-8')
 151       .expect(200, 'hey', done);
 152     })
 153
 154     it('should override charset in Content-Type', function(done){
 155       var app = express();
 156
 157       app.use(function(req, res){
 158         res.set('Content-Type', 'text/plain; charset=iso-8859-1').send('hey');
 159       });
 160
 161       request(app)
 162       .get('/')
 163       .expect('Content-Type', 'text/plain; charset=utf-8')
 164       .expect(200, 'hey', done);
 165     })
 166
 167     it('should keep charset in Content-Type for Buffers', function(done){
 168       var app = express();
 169
 170       app.use(function(req, res){
 171         res.set('Content-Type', 'text/plain; charset=iso-8859-1').send(Buffer.from('hi'))
 172       });
 173
 174       request(app)
 175       .get('/')
 176       .expect('Content-Type', 'text/plain; charset=iso-8859-1')
 177       .expect(200, 'hi', done);
 178     })
 179   })
 180
 181   describe('.send(Buffer)', function(){
 182     it('should send as octet-stream', function(done){
 183       var app = express();
 184
 185       app.use(function(req, res){
 186         res.send(Buffer.from('hello'))
 187       });
 188
 189       request(app)
 190       .get('/')
 191       .expect(200)
 192       .expect('Content-Type', 'application/octet-stream')
 193       .expect(shouldHaveBody(Buffer.from('hello')))
 194       .end(done)
 195     })
 196
 197     it('should set ETag', function (done) {
 198       var app = express();
 199
 200       app.use(function (req, res) {
 201         res.send(Buffer.alloc(999, '-'))
 202       });
 203
 204       request(app)
 205       .get('/')
 206       .expect('ETag', 'W/"3e7-qPnkJ3CVdVhFJQvUBfF10TmVA7g"')
 207       .expect(200, done);
 208     })
 209
 210     it('should not override Content-Type', function(done){
 211       var app = express();
 212
 213       app.use(function(req, res){
 214         res.set('Content-Type', 'text/plain').send(Buffer.from('hey'))
 215       });
 216
 217       request(app)
 218       .get('/')
 219       .expect('Content-Type', 'text/plain; charset=utf-8')
 220       .expect(200, 'hey', done);
 221     })
 222
 223     it('should not override ETag', function (done) {
 224       var app = express()
 225
 226       app.use(function (req, res) {
 227         res.type('text/plain').set('ETag', '"foo"').send(Buffer.from('hey'))
 228       })
 229
 230       request(app)
 231       .get('/')
 232       .expect('ETag', '"foo"')
 233       .expect(200, 'hey', done)
 234     })
 235   })
 236
 237   describe('.send(Object)', function(){
 238     it('should send as application/json', function(done){
 239       var app = express();
 240
 241       app.use(function(req, res){
 242         res.send({ name: 'tobi' });
 243       });
 244
 245       request(app)
 246       .get('/')
 247       .expect('Content-Type', 'application/json; charset=utf-8')
 248       .expect(200, '{"name":"tobi"}', done)
 249     })
 250   })
 251
 252   describe('when the request method is HEAD', function(){
 253     it('should ignore the body', function(done){
 254       var app = express();
 255
 256       app.use(function(req, res){
 257         res.send('yay');
 258       });
 259
 260       request(app)
 261       .head('/')
 262       .expect(200)
 263       .expect(shouldNotHaveBody())
 264       .end(done)
 265     })
 266   })
 267
 268   describe('when .statusCode is 204', function(){
 269     it('should strip Content-* fields, Transfer-Encoding field, and body', function(done){
 270       var app = express();
 271
 272       app.use(function(req, res){
 273         res.status(204).set('Transfer-Encoding', 'chunked').send('foo');
 274       });
 275
 276       request(app)
 277       .get('/')
 278       .expect(utils.shouldNotHaveHeader('Content-Type'))
 279       .expect(utils.shouldNotHaveHeader('Content-Length'))
 280       .expect(utils.shouldNotHaveHeader('Transfer-Encoding'))
 281       .expect(204, '', done);
 282     })
 283   })
 284
 285   describe('when .statusCode is 304', function(){
 286     it('should strip Content-* fields, Transfer-Encoding field, and body', function(done){
 287       var app = express();
 288
 289       app.use(function(req, res){
 290         res.status(304).set('Transfer-Encoding', 'chunked').send('foo');
 291       });
 292
 293       request(app)
 294       .get('/')
 295       .expect(utils.shouldNotHaveHeader('Content-Type'))
 296       .expect(utils.shouldNotHaveHeader('Content-Length'))
 297       .expect(utils.shouldNotHaveHeader('Transfer-Encoding'))
 298       .expect(304, '', done);
 299     })
 300   })
 301
 302   it('should always check regardless of length', function(done){
 303     var app = express();
 304     var etag = '"asdf"';
 305
 306     app.use(function(req, res, next){
 307       res.set('ETag', etag);
 308       res.send('hey');
 309     });
 310
 311     request(app)
 312     .get('/')
 313     .set('If-None-Match', etag)
 314     .expect(304, done);
 315   })
 316
 317   it('should respond with 304 Not Modified when fresh', function(done){
 318     var app = express();
 319     var etag = '"asdf"';
 320
 321     app.use(function(req, res){
 322       var str = Array(1000).join('-');
 323       res.set('ETag', etag);
 324       res.send(str);
 325     });
 326
 327     request(app)
 328     .get('/')
 329     .set('If-None-Match', etag)
 330     .expect(304, done);
 331   })
 332
 333   it('should not perform freshness check unless 2xx or 304', function(done){
 334     var app = express();
 335     var etag = '"asdf"';
 336
 337     app.use(function(req, res, next){
 338       res.status(500);
 339       res.set('ETag', etag);
 340       res.send('hey');
 341     });
 342
 343     request(app)
 344     .get('/')
 345     .set('If-None-Match', etag)
 346     .expect('hey')
 347     .expect(500, done);
 348   })
 349
 350   it('should not support jsonp callbacks', function(done){
 351     var app = express();
 352
 353     app.use(function(req, res){
 354       res.send({ foo: 'bar' });
 355     });
 356
 357     request(app)
 358     .get('/?callback=foo')
 359     .expect('{"foo":"bar"}', done);
 360   })
 361
 362   it('should be chainable', function (done) {
 363     var app = express()
 364
 365     app.use(function (req, res) {
 366       assert.equal(res.send('hey'), res)
 367     })
 368
 369     request(app)
 370     .get('/')
 371     .expect(200, 'hey', done)
 372   })
 373
 374   describe('"etag" setting', function () {
 375     describe('when enabled', function () {
 376       it('should send ETag', function (done) {
 377         var app = express();
 378
 379         app.use(function (req, res) {
 380           res.send('kajdslfkasdf');
 381         });
 382
 383         app.enable('etag');
 384
 385         request(app)
 386         .get('/')
 387         .expect('ETag', 'W/"c-IgR/L5SF7CJQff4wxKGF/vfPuZ0"')
 388         .expect(200, done);
 389       });
 390
 391       methods.forEach(function (method) {
 392         if (method === 'connect') return;
 393
 394         it('should send ETag in response to ' + method.toUpperCase() + ' request', function (done) {
 395           var app = express();
 396
 397           app[method]('/', function (req, res) {
 398             res.send('kajdslfkasdf');
 399           });
 400
 401           request(app)
 402           [method]('/')
 403           .expect('ETag', 'W/"c-IgR/L5SF7CJQff4wxKGF/vfPuZ0"')
 404           .expect(200, done);
 405         })
 406       });
 407
 408       it('should send ETag for empty string response', function (done) {
 409         var app = express();
 410
 411         app.use(function (req, res) {
 412           res.send('');
 413         });
 414
 415         app.enable('etag');
 416
 417         request(app)
 418         .get('/')
 419         .expect('ETag', 'W/"0-2jmj7l5rSw0yVb/vlWAYkK/YBwk"')
 420         .expect(200, done);
 421       })
 422
 423       it('should send ETag for long response', function (done) {
 424         var app = express();
 425
 426         app.use(function (req, res) {
 427           var str = Array(1000).join('-');
 428           res.send(str);
 429         });
 430
 431         app.enable('etag');
 432
 433         request(app)
 434         .get('/')
 435         .expect('ETag', 'W/"3e7-qPnkJ3CVdVhFJQvUBfF10TmVA7g"')
 436         .expect(200, done);
 437       });
 438
 439       it('should not override ETag when manually set', function (done) {
 440         var app = express();
 441
 442         app.use(function (req, res) {
 443           res.set('etag', '"asdf"');
 444           res.send(200);
 445         });
 446
 447         app.enable('etag');
 448
 449         request(app)
 450         .get('/')
 451         .expect('ETag', '"asdf"')
 452         .expect(200, done);
 453       });
 454
 455       it('should not send ETag for res.send()', function (done) {
 456         var app = express();
 457
 458         app.use(function (req, res) {
 459           res.send();
 460         });
 461
 462         app.enable('etag');
 463
 464         request(app)
 465         .get('/')
 466         .expect(utils.shouldNotHaveHeader('ETag'))
 467         .expect(200, done);
 468       })
 469     });
 470
 471     describe('when disabled', function () {
 472       it('should send no ETag', function (done) {
 473         var app = express();
 474
 475         app.use(function (req, res) {
 476           var str = Array(1000).join('-');
 477           res.send(str);
 478         });
 479
 480         app.disable('etag');
 481
 482         request(app)
 483         .get('/')
 484         .expect(utils.shouldNotHaveHeader('ETag'))
 485         .expect(200, done);
 486       });
 487
 488       it('should send ETag when manually set', function (done) {
 489         var app = express();
 490
 491         app.disable('etag');
 492
 493         app.use(function (req, res) {
 494           res.set('etag', '"asdf"');
 495           res.send(200);
 496         });
 497
 498         request(app)
 499         .get('/')
 500         .expect('ETag', '"asdf"')
 501         .expect(200, done);
 502       });
 503     });
 504
 505     describe('when "strong"', function () {
 506       it('should send strong ETag', function (done) {
 507         var app = express();
 508
 509         app.set('etag', 'strong');
 510
 511         app.use(function (req, res) {
 512           res.send('hello, world!');
 513         });
 514
 515         request(app)
 516         .get('/')
 517         .expect('ETag', '"d-HwnTDHB9U/PRbFMN1z1wps51lqk"')
 518         .expect(200, done);
 519       })
 520     })
 521
 522     describe('when "weak"', function () {
 523       it('should send weak ETag', function (done) {
 524         var app = express();
 525
 526         app.set('etag', 'weak');
 527
 528         app.use(function (req, res) {
 529           res.send('hello, world!');
 530         });
 531
 532         request(app)
 533         .get('/')
 534         .expect('ETag', 'W/"d-HwnTDHB9U/PRbFMN1z1wps51lqk"')
 535         .expect(200, done)
 536       })
 537     })
 538
 539     describe('when a function', function () {
 540       it('should send custom ETag', function (done) {
 541         var app = express();
 542
 543         app.set('etag', function (body, encoding) {
 544           var chunk = !Buffer.isBuffer(body)
 545             ? Buffer.from(body, encoding)
 546             : body;
 547           chunk.toString().should.equal('hello, world!');
 548           return '"custom"';
 549         });
 550
 551         app.use(function (req, res) {
 552           res.send('hello, world!');
 553         });
 554
 555         request(app)
 556         .get('/')
 557         .expect('ETag', '"custom"')
 558         .expect(200, done);
 559       })
 560
 561       it('should not send falsy ETag', function (done) {
 562         var app = express();
 563
 564         app.set('etag', function (body, encoding) {
 565           return undefined;
 566         });
 567
 568         app.use(function (req, res) {
 569           res.send('hello, world!');
 570         });
 571
 572         request(app)
 573         .get('/')
 574         .expect(utils.shouldNotHaveHeader('ETag'))
 575         .expect(200, done);
 576       })
 577     })
 578   })
 579 })
 580
 581 function shouldHaveBody (buf) {
 582   return function (res) {
 583     var body = !Buffer.isBuffer(res.body)
 584       ? Buffer.from(res.text)
 585       : res.body
 586     assert.ok(body, 'response has body')
 587     assert.strictEqual(body.toString('hex'), buf.toString('hex'))
 588   }
 589 }
 590
 591 function shouldNotHaveBody () {
 592   return function (res) {
 593     assert.ok(res.text === '' || res.text === undefined)
 594   }
 595 }