reply.close(). Closes hapijs#1272

jmonster · Dec 31, 2013 · 879de08 · 879de08
1 parent 6ae0eb5
commit 879de08
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 7 deletions.
diff --git a/docs/Reference.md b/docs/Reference.md
@@ -16,7 +16,7 @@
                 - [`reply([result])`](#replyresult)
                 - [`reply.file(path, options)`](#replyfilepath-options)
                 - [`reply.view(template, [context, [options]])`](#replyviewtemplate-context-options)
-                - [`reply.close()`](#replyclose)
+                - [`reply.close([options])`](#replycloseoptions)
                 - [`reply.proxy(options)`](#replyproxyoptions)
             - [Route prerequisites](#route-prerequisites)
             - [Route not found](#route-not-found)
@@ -836,13 +836,14 @@ server.route({ method: 'GET', path: '/', handler: handler });
 </html>
 ```
 
-###### `reply.close()`
+###### `reply.close([options])`
 
 _Available only within the handler method and only before one of `reply()`, `reply.file()`, `reply.view()`,
 `reply.close()`, or `reply.proxy()`  is called._
 
 Concludes the handler activity by returning control over to the router and informing the router that a response has already been sent back
-directly via `request.raw.res` and that no further response action is needed (the router will ensure the `request.raw.res` was ended).
+directly via `request.raw.res` and that no further response action is needed. Supports the following optional options:
+- `end` - if `false`, the router will not call `request.raw.res.end())` to ensure the response was ended. Defaults to `true`.
 
 No return value.
 

diff --git a/lib/handler.js b/lib/handler.js
@@ -107,9 +107,10 @@ internals.decorateReply = function (request, finalize) {
         return exports.response(result, request, finalize);
     };
 
-    reply.close = function () {
+    reply.close = function (options) {
 
-        finalize({ closed: true });
+        options = options || {};
+        finalize({ closed: true, end: options.end !== false });
     };
 
     var viewsManager = request._route.env.views || request.server._views;

diff --git a/lib/request.js b/lib/request.js
@@ -336,7 +336,9 @@ internals.Request.prototype._reply = function (exit) {
         if (self._response &&                                   // Can be null if response coming from exit
             self._response.closed) {
 
-            self.raw.res.end();                                 // End the response in case it wasn't already closed
+            if (self._response.end) {
+                self.raw.res.end();                             // End the response in case it wasn't already closed
+            }
             return finalize();
         }
 

diff --git a/test/integration/response.js b/test/integration/response.js
@@ -2132,11 +2132,28 @@ describe('Response', function () {
 
     describe('Closed', function () {
 
-        it('returns a reply', function (done) {
+        it('returns a reply with manual end', function (done) {
 
             var handler = function (request, reply) {
 
                 request.raw.res.end();
+                reply.close({ end: false });
+            };
+
+            var server = new Hapi.Server();
+            server.route({ method: 'GET', path: '/', config: { handler: handler } });
+
+            server.inject('/', function (res) {
+
+                expect(res.result).to.equal('');
+                done();
+            });
+        });
+
+        it('returns a reply with auto end', function (done) {
+
+            var handler = function (request, reply) {
+
                 reply.close();
             };