http: OutgoingMessage.end() should return this

PR-URL: #18780 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Feb 19, 2018 · 8118da7 · 8118da7
1 parent f6721c2
commit 8118da7
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 8 deletions.
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -544,11 +544,16 @@ See [`request.socket`][]
 ### request.end([data[, encoding]][, callback])
 <!-- YAML
 added: v0.1.90
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/18780
+    description: This method now returns a reference to `ClientRequest`.
 -->
 
 * `data` {string|Buffer}
 * `encoding` {string}
 * `callback` {Function}
+* Returns: {this}
 
 Finishes sending the request. If any parts of the body are
 unsent, it will flush them to the stream. If the request is
@@ -1041,11 +1046,16 @@ See [`response.socket`][].
 ### response.end([data][, encoding][, callback])
 <!-- YAML
 added: v0.1.90
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/18780
+    description: This method now returns a reference to `ServerResponse`.
 -->
 
 * `data` {string|Buffer}
 * `encoding` {string}
 * `callback` {Function}
+* Returns: {this}
 
 This method signals to the server that all of the response headers and body
 have been sent; that server should consider this message complete.

diff --git a/lib/_http_outgoing.js b/lib/_http_outgoing.js
@@ -736,7 +736,7 @@ OutgoingMessage.prototype.end = function end(chunk, encoding, callback) {
   }
 
   if (this.finished) {
-    return false;
+    return this;
   }
 
   var uncork;
@@ -766,12 +766,11 @@ OutgoingMessage.prototype.end = function end(chunk, encoding, callback) {
 
   var finish = onFinish.bind(undefined, this);
 
-  var ret;
   if (this._hasBody && this.chunkedEncoding) {
-    ret = this._send('0\r\n' + this._trailer + '\r\n', 'latin1', finish);
+    this._send('0\r\n' + this._trailer + '\r\n', 'latin1', finish);
   } else {
     // Force a flush, HACK.
-    ret = this._send('', 'latin1', finish);
+    this._send('', 'latin1', finish);
   }
 
   if (uncork)
@@ -788,7 +787,7 @@ OutgoingMessage.prototype.end = function end(chunk, encoding, callback) {
     this._finish();
   }
 
-  return ret;
+  return this;
 };
 
 

diff --git a/test/parallel/test-http-request-end-twice.js b/test/parallel/test-http-request-end-twice.js
@@ -31,7 +31,7 @@ const server = http.Server(function(req, res) {
 server.listen(0, function() {
   const req = http.get({ port: this.address().port }, function(res) {
     res.on('end', function() {
-      assert.ok(!req.end());
+      assert.strictEqual(req.end(), req);
       server.close();
     });
     res.resume();

diff --git a/test/parallel/test-http-request-end.js b/test/parallel/test-http-request-end.js
@@ -44,7 +44,7 @@ const server = http.Server(function(req, res) {
 });
 
 server.listen(0, function() {
-  http.request({
+  const req = http.request({
     port: this.address().port,
     path: '/',
     method: 'POST'
@@ -54,5 +54,9 @@ server.listen(0, function() {
   }).on('error', function(e) {
     console.log(e.message);
     process.exit(1);
-  }).end(expected);
+  });
+
+  const result = req.end(expected);
+
+  assert.strictEqual(req, result);
 });