From a5247cc1808ec1cd79c85b0c4f48dd3cc3e08e10 Mon Sep 17 00:00:00 2001
From: "Mark S. Everitt" <mark.s.everitt@gmail.com>
Date: Wed, 6 Feb 2019 22:17:23 +0000
Subject: [PATCH] http: makes response.writeHead return the response

Fixes: https://github.com/nodejs/node/issues/25935

PR-URL: https://github.com/nodejs/node/pull/25974
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
---
 doc/api/http.md                               | 16 +++++++++++---
 lib/_http_server.js                           |  2 ++
 ...st-http-response-writehead-returns-this.js | 22 +++++++++++++++++++
 3 files changed, 37 insertions(+), 3 deletions(-)
 create mode 100644 test/parallel/test-http-response-writehead-returns-this.js

diff --git a/doc/api/http.md b/doc/api/http.md
index fc80ca8513355b..0f1d98b6d2aa5c 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -1444,6 +1444,10 @@ the request body should be sent. See the [`'checkContinue'`][] event on
 <!-- YAML
 added: v0.1.30
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/25974
+    description: Return `this` from `writeHead()` to allow chaining with
+                 `end()`.
   - version: v5.11.0, v4.4.5
     pr-url: https://github.com/nodejs/node/pull/6291
     description: A `RangeError` is thrown if `statusCode` is not a number in
@@ -1453,17 +1457,23 @@ changes:
 * `statusCode` {number}
 * `statusMessage` {string}
 * `headers` {Object}
+* Returns: {http.ServerResponse}
 
 Sends a response header to the request. The status code is a 3-digit HTTP
 status code, like `404`. The last argument, `headers`, are the response headers.
 Optionally one can give a human-readable `statusMessage` as the second
 argument.
 
+Returns a reference to the `ServerResponse`, so that calls can be chained.
+
 ```js
 const body = 'hello world';
-response.writeHead(200, {
-  'Content-Length': Buffer.byteLength(body),
-  'Content-Type': 'text/plain' });
+response
+  .writeHead(200, {
+    'Content-Length': Buffer.byteLength(body),
+    'Content-Type': 'text/plain'
+  })
+  .end(body);
 ```
 
 This method must only be called once on a message and it must
diff --git a/lib/_http_server.js b/lib/_http_server.js
index f680d06bc10bc5..a22189b486f612 100644
--- a/lib/_http_server.js
+++ b/lib/_http_server.js
@@ -268,6 +268,8 @@ function writeHead(statusCode, reason, obj) {
   }
 
   this._storeHeader(statusLine, headers);
+
+  return this;
 }
 
 // Docs-only deprecated: DEP0063
diff --git a/test/parallel/test-http-response-writehead-returns-this.js b/test/parallel/test-http-response-writehead-returns-this.js
new file mode 100644
index 00000000000000..a62c2eca03585c
--- /dev/null
+++ b/test/parallel/test-http-response-writehead-returns-this.js
@@ -0,0 +1,22 @@
+'use strict';
+require('../common');
+const http = require('http');
+const assert = require('assert');
+
+const server = http.createServer((req, res) => {
+  res.writeHead(200, { 'a-header': 'a-header-value' }).end('abc');
+});
+
+server.listen(0, () => {
+  http.get({ port: server.address().port }, (res) => {
+    assert.strictEqual(res.headers['a-header'], 'a-header-value');
+
+    const chunks = [];
+
+    res.on('data', (chunk) => chunks.push(chunk));
+    res.on('end', () => {
+      assert.strictEqual(Buffer.concat(chunks).toString(), 'abc');
+      server.close();
+    });
+  });
+});