Include HTML link in redirect response

Author: dougwilson

History.md

@@ -1,3 +1,8 @@
+unreleased
+==========
+
+  * Include HTML link in redirect response
+
 1.2.3 / 2014-06-11
 ==================
 

index.js

@@ -69,29 +69,38 @@ exports = module.exports = function(root, options){
     var originalUrl = url.parse(req.originalUrl || req.url);
     var path = parseurl(req).pathname;
 
-    if (path == '/' && originalUrl.pathname[originalUrl.pathname.length - 1] != '/') {
-      return directory();
+    if (path === '/' && originalUrl.pathname[originalUrl.pathname.length - 1] !== '/') {
+      // make sure redirect occurs at mount
+      path = ''
     }
 
-    function directory() {
-      if (!redirect) return next();
-      var target;
-      originalUrl.pathname += '/';
-      target = url.format(originalUrl);
-      res.statusCode = 303;
-      res.setHeader('Location', target);
-      res.end('Redirecting to ' + escapeHtml(target));
-    }
+    // create send stream
+    var stream = send(req, path, opts)
+
+    if (redirect) {
+      // redirect relative to originalUrl
+      stream.on('directory', function redirect() {
+        originalUrl.pathname += '/'
 
-    function error(err) {
-      if (404 == err.status) return next();
-      next(err);
+        var target = url.format(originalUrl)
+
+        res.statusCode = 303
+        res.setHeader('Content-Type', 'text/html; charset=utf-8')
+        res.setHeader('Location', target)
+        res.end('Redirecting to <a href="' + escapeHtml(target) + '">' + escapeHtml(target) + '</a>\n')
+      })
+    } else {
+      // forward to next middleware on directory
+      stream.on('directory', next)
     }
 
-    send(req, path, opts)
-      .on('error', error)
-      .on('directory', directory)
-      .pipe(res);
+    // forward non-404 errors
+    stream.on('error', function error(err) {
+      next(err.status === 404 ? null : err)
+    })
+
+    // pipe
+    stream.pipe(res)
   };
 };
 

test/test.js

@@ -54,24 +54,6 @@ describe('serveStatic()', function(){
       .expect(404, done);
     });
 
-    it('should redirect directories with query string', function (done) {
-      request(server)
-      .get('/users?name=john')
-      .expect('Location', '/users/?name=john', done);
-    });
-
-    it('should redirect directories', function(done){
-      request(server)
-      .get('/users')
-      .expect(303, done);
-    });
-
-    it('should not redirect incorrectly', function (done) {
-      request(server)
-      .get('/')
-      .expect(404, done);
-    });
-
     it('should support index.html', function(done){
       request(server)
       .get('/users/')
@@ -159,6 +141,53 @@ describe('serveStatic()', function(){
     });
   });
 
+  describe('redirect', function () {
+    var server;
+    before(function () {
+      server = createServer(fixtures)
+    })
+
+    it('should redirect directories', function(done){
+      request(server)
+      .get('/users')
+      .expect('Location', '/users/')
+      .expect(303, done)
+    })
+
+    it('should include HTML link', function(done){
+      request(server)
+      .get('/users')
+      .expect('Location', '/users/')
+      .expect(303, /<a href="\/users\/">/, done)
+    })
+
+    it('should redirect directories with query string', function (done) {
+      request(server)
+      .get('/users?name=john')
+      .expect('Location', '/users/?name=john')
+      .expect(303, done)
+    })
+
+    it('should not redirect incorrectly', function (done) {
+      request(server)
+      .get('/')
+      .expect(404, done)
+    })
+
+    describe('when false', function () {
+      var server;
+      before(function () {
+        server = createServer(fixtures, {'redirect': false})
+      })
+
+      it('should disable redirect', function (done) {
+        request(server)
+        .get('/users')
+        .expect(404, done)
+      })
+    })
+  })
+
   describe('when traversing passed root', function(){
     var server;
     before(function () {