Send complete HTML document in redirect & error responses

dougwilson · dougwilson · commit 4698f179ca31 · 2017-02-19T00:49:28.000-05:00
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,3 +1,8 @@
+unreleased
+==========
+
+  * Send complete HTML document in redirect & error responses
+
 0.14.2 / 2017-01-23
 ===================
 
diff --git a/index.js b/index.js
@@ -278,7 +278,8 @@ SendStream.prototype.error = function error (status, error) {
   }
 
   var res = this.res
-  var msg = statuses[status]
+  var msg = statuses[status] || String(status)
+  var doc = createHtmlDocument('Error', escapeHtml(msg))
 
   // clear existing headers
   clearHeaders(res)
@@ -290,10 +291,10 @@ SendStream.prototype.error = function error (status, error) {
 
   // send basic response
   res.statusCode = status
-  res.setHeader('Content-Type', 'text/plain; charset=UTF-8')
-  res.setHeader('Content-Length', Buffer.byteLength(msg))
+  res.setHeader('Content-Type', 'text/html; charset=UTF-8')
+  res.setHeader('Content-Length', Buffer.byteLength(doc))
   res.setHeader('X-Content-Type-Options', 'nosniff')
-  res.end(msg)
+  res.end(doc)
 }
 
 /**
@@ -446,16 +447,17 @@ SendStream.prototype.redirect = function redirect (path) {
   }
 
   var loc = encodeUrl(collapseLeadingSlashes(path + '/'))
-  var msg = 'Redirecting to <a href="' + escapeHtml(loc) + '">' + escapeHtml(loc) + '</a>\n'
+  var doc = createHtmlDocument('Redirecting', 'Redirecting to <a href="' + escapeHtml(loc) + '">' +
+    escapeHtml(loc) + '</a>')
   var res = this.res
 
   // redirect
   res.statusCode = 301
   res.setHeader('Content-Type', 'text/html; charset=UTF-8')
-  res.setHeader('Content-Length', Buffer.byteLength(msg))
+  res.setHeader('Content-Length', Buffer.byteLength(doc))
   res.setHeader('X-Content-Type-Options', 'nosniff')
   res.setHeader('Location', loc)
-  res.end(msg)
+  res.end(doc)
 }
 
 /**
@@ -892,6 +894,26 @@ function contentRange (type, size, range) {
   return type + ' ' + (range ? range.start + '-' + range.end : '*') + '/' + size
 }
 
+/**
+ * Create a minimal HTML document.
+ *
+ * @param {string} title
+ * @param {string} body
+ * @private
+ */
+
+function createHtmlDocument (title, body) {
+  return '<!DOCTYPE html>\n' +
+    '<html lang="en">\n' +
+    '<head>\n' +
+    '<meta charset="utf-8">\n' +
+    '<title>' + title + '</title>\n' +
+    '</head>\n' +
+    '<body>\n' +
+    '<pre>' + body + '</pre>\n' +
+    '</body>\n'
+}
+
 /**
  * decodeURIComponent.
  *
diff --git a/test/send.js b/test/send.js
@@ -171,7 +171,6 @@ describe('send(file).pipe(res)', function () {
 
     request(app)
     .get('/name.txt')
-    .expect('Content-Type', /plain/)
     .expect(404, done)
   })
 
@@ -340,7 +339,7 @@ describe('send(file).pipe(res)', function () {
       .get('/pets')
       .expect('Location', '/pets/')
       .expect('Content-Type', /html/)
-      .expect(301, 'Redirecting to <a href="/pets/">/pets/</a>\n', done)
+      .expect(301, />Redirecting to <a href="\/pets\/">\/pets\/<\/a></, done)
     })
 
     it('should not redirect to protocol-relative locations', function (done) {
@@ -360,15 +359,15 @@ describe('send(file).pipe(res)', function () {
       .get('/snow')
       .expect('Location', '/snow%20%E2%98%83/')
       .expect('Content-Type', /html/)
-      .expect(301, 'Redirecting to <a href="/snow%20%E2%98%83/">/snow%20%E2%98%83/</a>\n', done)
+      .expect(301, />Redirecting to <a href="\/snow%20%E2%98%83\/">\/snow%20%E2%98%83\/<\/a></, done)
     })
   })
 
   describe('when no "error" listeners are present', function () {
     it('should respond to errors directly', function (done) {
       request(createServer({root: fixtures}))
       .get('/foobar')
-      .expect(404, 'Not Found', done)
+      .expect(404, />Not Found</, done)
     })
   })
 
