test/res.download.js

   1 'use strict'
   2
   3 var after = require('after');
   4 var assert = require('assert')
   5 var AsyncLocalStorage = require('async_hooks').AsyncLocalStorage
   6
   7 var express = require('..');
   8 var path = require('path')
   9 var request = require('supertest');
  10 var utils = require('./support/utils')
  11
  12 var FIXTURES_PATH = path.join(__dirname, 'fixtures')
  13
  14 describe('res', function(){
  15   describe('.download(path)', function(){
  16     it('should transfer as an attachment', function(done){
  17       var app = express();
  18
  19       app.use(function(req, res){
  20         res.download('test/fixtures/user.html');
  21       });
  22
  23       request(app)
  24       .get('/')
  25       .expect('Content-Type', 'text/html; charset=utf-8')
  26       .expect('Content-Disposition', 'attachment; filename="user.html"')
  27       .expect(200, '<p>{{user.name}}</p>', done)
  28     })
  29
  30     it('should accept range requests', function (done) {
  31       var app = express()
  32
  33       app.get('/', function (req, res) {
  34         res.download('test/fixtures/user.html')
  35       })
  36
  37       request(app)
  38         .get('/')
  39         .expect('Accept-Ranges', 'bytes')
  40         .expect(200, '<p>{{user.name}}</p>', done)
  41     })
  42
  43     it('should respond with requested byte range', function (done) {
  44       var app = express()
  45
  46       app.get('/', function (req, res) {
  47         res.download('test/fixtures/user.html')
  48       })
  49
  50       request(app)
  51         .get('/')
  52         .set('Range', 'bytes=0-2')
  53         .expect('Content-Range', 'bytes 0-2/20')
  54         .expect(206, '<p>', done)
  55     })
  56   })
  57
  58   describe('.download(path, filename)', function(){
  59     it('should provide an alternate filename', function(done){
  60       var app = express();
  61
  62       app.use(function(req, res){
  63         res.download('test/fixtures/user.html', 'document');
  64       });
  65
  66       request(app)
  67       .get('/')
  68       .expect('Content-Type', 'text/html; charset=utf-8')
  69       .expect('Content-Disposition', 'attachment; filename="document"')
  70       .expect(200, done)
  71     })
  72   })
  73
  74   describe('.download(path, fn)', function(){
  75     it('should invoke the callback', function(done){
  76       var app = express();
  77       var cb = after(2, done);
  78
  79       app.use(function(req, res){
  80         res.download('test/fixtures/user.html', cb);
  81       });
  82
  83       request(app)
  84       .get('/')
  85       .expect('Content-Type', 'text/html; charset=utf-8')
  86       .expect('Content-Disposition', 'attachment; filename="user.html"')
  87       .expect(200, cb);
  88     })
  89
  90     describe('async local storage', function () {
  91       it('should presist store', function (done) {
  92         var app = express()
  93         var cb = after(2, done)
  94         var store = { foo: 'bar' }
  95
  96         app.use(function (req, res, next) {
  97           req.asyncLocalStorage = new AsyncLocalStorage()
  98           req.asyncLocalStorage.run(store, next)
  99         })
 100
 101         app.use(function (req, res) {
 102           res.download('test/fixtures/name.txt', function (err) {
 103             if (err) return cb(err)
 104
 105             var local = req.asyncLocalStorage.getStore()
 106
 107             assert.strictEqual(local.foo, 'bar')
 108             cb()
 109           })
 110         })
 111
 112         request(app)
 113           .get('/')
 114           .expect('Content-Type', 'text/plain; charset=utf-8')
 115           .expect('Content-Disposition', 'attachment; filename="name.txt"')
 116           .expect(200, 'tobi', cb)
 117       })
 118
 119       it('should presist store on error', function (done) {
 120         var app = express()
 121         var store = { foo: 'bar' }
 122
 123         app.use(function (req, res, next) {
 124           req.asyncLocalStorage = new AsyncLocalStorage()
 125           req.asyncLocalStorage.run(store, next)
 126         })
 127
 128         app.use(function (req, res) {
 129           res.download('test/fixtures/does-not-exist', function (err) {
 130             var local = req.asyncLocalStorage.getStore()
 131
 132             if (local) {
 133               res.setHeader('x-store-foo', String(local.foo))
 134             }
 135
 136             res.send(err ? 'got ' + err.status + ' error' : 'no error')
 137           })
 138         })
 139
 140         request(app)
 141           .get('/')
 142           .expect(200)
 143           .expect('x-store-foo', 'bar')
 144           .expect('got 404 error')
 145           .end(done)
 146       })
 147     })
 148   })
 149
 150   describe('.download(path, options)', function () {
 151     it('should allow options to res.sendFile()', function (done) {
 152       var app = express()
 153
 154       app.use(function (req, res) {
 155         res.download('test/fixtures/.name', {
 156           dotfiles: 'allow',
 157           maxAge: '4h'
 158         })
 159       })
 160
 161       request(app)
 162         .get('/')
 163         .expect(200)
 164         .expect('Content-Disposition', 'attachment; filename=".name"')
 165         .expect('Cache-Control', 'public, max-age=14400')
 166         .expect(utils.shouldHaveBody(Buffer.from('tobi')))
 167         .end(done)
 168     })
 169
 170     describe('with "headers" option', function () {
 171       it('should set headers on response', function (done) {
 172         var app = express()
 173
 174         app.use(function (req, res) {
 175           res.download('test/fixtures/user.html', {
 176             headers: {
 177               'X-Foo': 'Bar',
 178               'X-Bar': 'Foo'
 179             }
 180           })
 181         })
 182
 183         request(app)
 184           .get('/')
 185           .expect(200)
 186           .expect('X-Foo', 'Bar')
 187           .expect('X-Bar', 'Foo')
 188           .end(done)
 189       })
 190
 191       it('should use last header when duplicated', function (done) {
 192         var app = express()
 193
 194         app.use(function (req, res) {
 195           res.download('test/fixtures/user.html', {
 196             headers: {
 197               'X-Foo': 'Bar',
 198               'x-foo': 'bar'
 199             }
 200           })
 201         })
 202
 203         request(app)
 204           .get('/')
 205           .expect(200)
 206           .expect('X-Foo', 'bar')
 207           .end(done)
 208       })
 209
 210       it('should override Content-Type', function (done) {
 211         var app = express()
 212
 213         app.use(function (req, res) {
 214           res.download('test/fixtures/user.html', {
 215             headers: {
 216               'Content-Type': 'text/x-custom'
 217             }
 218           })
 219         })
 220
 221         request(app)
 222           .get('/')
 223           .expect(200)
 224           .expect('Content-Type', 'text/x-custom')
 225           .end(done)
 226       })
 227
 228       it('should not set headers on 404', function (done) {
 229         var app = express()
 230
 231         app.use(function (req, res) {
 232           res.download('test/fixtures/does-not-exist', {
 233             headers: {
 234               'X-Foo': 'Bar'
 235             }
 236           })
 237         })
 238
 239         request(app)
 240           .get('/')
 241           .expect(404)
 242           .expect(utils.shouldNotHaveHeader('X-Foo'))
 243           .end(done)
 244       })
 245
 246       describe('when headers contains Content-Disposition', function () {
 247         it('should be ignored', function (done) {
 248           var app = express()
 249
 250           app.use(function (req, res) {
 251             res.download('test/fixtures/user.html', {
 252               headers: {
 253                 'Content-Disposition': 'inline'
 254               }
 255             })
 256           })
 257
 258           request(app)
 259             .get('/')
 260             .expect(200)
 261             .expect('Content-Disposition', 'attachment; filename="user.html"')
 262             .end(done)
 263         })
 264
 265         it('should be ignored case-insensitively', function (done) {
 266           var app = express()
 267
 268           app.use(function (req, res) {
 269             res.download('test/fixtures/user.html', {
 270               headers: {
 271                 'content-disposition': 'inline'
 272               }
 273             })
 274           })
 275
 276           request(app)
 277             .get('/')
 278             .expect(200)
 279             .expect('Content-Disposition', 'attachment; filename="user.html"')
 280             .end(done)
 281         })
 282       })
 283     })
 284
 285     describe('with "root" option', function () {
 286       it('should allow relative path', function (done) {
 287         var app = express()
 288
 289         app.use(function (req, res) {
 290           res.download('name.txt', {
 291             root: FIXTURES_PATH
 292           })
 293         })
 294
 295         request(app)
 296           .get('/')
 297           .expect(200)
 298           .expect('Content-Disposition', 'attachment; filename="name.txt"')
 299           .expect(utils.shouldHaveBody(Buffer.from('tobi')))
 300           .end(done)
 301       })
 302
 303       it('should allow up within root', function (done) {
 304         var app = express()
 305
 306         app.use(function (req, res) {
 307           res.download('fake/../name.txt', {
 308             root: FIXTURES_PATH
 309           })
 310         })
 311
 312         request(app)
 313           .get('/')
 314           .expect(200)
 315           .expect('Content-Disposition', 'attachment; filename="name.txt"')
 316           .expect(utils.shouldHaveBody(Buffer.from('tobi')))
 317           .end(done)
 318       })
 319
 320       it('should reject up outside root', function (done) {
 321         var app = express()
 322
 323         app.use(function (req, res) {
 324           var p = '..' + path.sep +
 325             path.relative(path.dirname(FIXTURES_PATH), path.join(FIXTURES_PATH, 'name.txt'))
 326
 327           res.download(p, {
 328             root: FIXTURES_PATH
 329           })
 330         })
 331
 332         request(app)
 333           .get('/')
 334           .expect(403)
 335           .expect(utils.shouldNotHaveHeader('Content-Disposition'))
 336           .end(done)
 337       })
 338
 339       it('should reject reading outside root', function (done) {
 340         var app = express()
 341
 342         app.use(function (req, res) {
 343           res.download('../name.txt', {
 344             root: FIXTURES_PATH
 345           })
 346         })
 347
 348         request(app)
 349           .get('/')
 350           .expect(403)
 351           .expect(utils.shouldNotHaveHeader('Content-Disposition'))
 352           .end(done)
 353       })
 354     })
 355   })
 356
 357   describe('.download(path, filename, fn)', function(){
 358     it('should invoke the callback', function(done){
 359       var app = express();
 360       var cb = after(2, done);
 361
 362       app.use(function(req, res){
 363         res.download('test/fixtures/user.html', 'document', cb)
 364       });
 365
 366       request(app)
 367       .get('/')
 368       .expect('Content-Type', 'text/html; charset=utf-8')
 369       .expect('Content-Disposition', 'attachment; filename="document"')
 370       .expect(200, cb);
 371     })
 372   })
 373
 374   describe('.download(path, filename, options, fn)', function () {
 375     it('should invoke the callback', function (done) {
 376       var app = express()
 377       var cb = after(2, done)
 378       var options = {}
 379
 380       app.use(function (req, res) {
 381         res.download('test/fixtures/user.html', 'document', options, cb)
 382       })
 383
 384       request(app)
 385       .get('/')
 386       .expect(200)
 387       .expect('Content-Type', 'text/html; charset=utf-8')
 388       .expect('Content-Disposition', 'attachment; filename="document"')
 389       .end(cb)
 390     })
 391
 392     it('should allow options to res.sendFile()', function (done) {
 393       var app = express()
 394
 395       app.use(function (req, res) {
 396         res.download('test/fixtures/.name', 'document', {
 397           dotfiles: 'allow',
 398           maxAge: '4h'
 399         })
 400       })
 401
 402       request(app)
 403         .get('/')
 404         .expect(200)
 405         .expect('Content-Disposition', 'attachment; filename="document"')
 406         .expect('Cache-Control', 'public, max-age=14400')
 407         .expect(utils.shouldHaveBody(Buffer.from('tobi')))
 408         .end(done)
 409     })
 410
 411     describe('when options.headers contains Content-Disposition', function () {
 412       it('should be ignored', function (done) {
 413         var app = express()
 414
 415         app.use(function (req, res) {
 416           res.download('test/fixtures/user.html', 'document', {
 417             headers: {
 418               'Content-Type': 'text/x-custom',
 419               'Content-Disposition': 'inline'
 420             }
 421           })
 422         })
 423
 424         request(app)
 425         .get('/')
 426         .expect(200)
 427         .expect('Content-Type', 'text/x-custom')
 428         .expect('Content-Disposition', 'attachment; filename="document"')
 429         .end(done)
 430       })
 431
 432       it('should be ignored case-insensitively', function (done) {
 433         var app = express()
 434
 435         app.use(function (req, res) {
 436           res.download('test/fixtures/user.html', 'document', {
 437             headers: {
 438               'content-type': 'text/x-custom',
 439               'content-disposition': 'inline'
 440             }
 441           })
 442         })
 443
 444         request(app)
 445         .get('/')
 446         .expect(200)
 447         .expect('Content-Type', 'text/x-custom')
 448         .expect('Content-Disposition', 'attachment; filename="document"')
 449         .end(done)
 450       })
 451     })
 452   })
 453
 454   describe('on failure', function(){
 455     it('should invoke the callback', function(done){
 456       var app = express();
 457
 458       app.use(function (req, res, next) {
 459         res.download('test/fixtures/foobar.html', function(err){
 460           if (!err) return next(new Error('expected error'));
 461           res.send('got ' + err.status + ' ' + err.code);
 462         });
 463       });
 464
 465       request(app)
 466       .get('/')
 467       .expect(200, 'got 404 ENOENT', done);
 468     })
 469
 470     it('should remove Content-Disposition', function(done){
 471       var app = express()
 472
 473       app.use(function (req, res, next) {
 474         res.download('test/fixtures/foobar.html', function(err){
 475           if (!err) return next(new Error('expected error'));
 476           res.end('failed');
 477         });
 478       });
 479
 480       request(app)
 481         .get('/')
 482         .expect(utils.shouldNotHaveHeader('Content-Disposition'))
 483         .expect(200, 'failed', done)
 484     })
 485   })
 486 })