From fc3f1c3c7106a586b6ec90c97ce1b0196791b89f Mon Sep 17 00:00:00 2001
From: Ian Storm Taylor <ian@ianstormtaylor.com>
Date: Sun, 13 Dec 2020 16:25:14 -0800
Subject: [PATCH] http: attach request as res.req

This change makes it possible for userland http-related modules
to pave over edge cases that require referencing the original request
when handling a response--making a "Lodash for HTTP" library possible.
More information and research in https://github.com/nodejs/node/issues/28673

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

PR-URL: https://github.com/nodejs/node/pull/36505
Reviewed-By: Robert Nagy <ronagy@icloud.com>
---
 doc/api/http.md                               |  9 +++++
 doc/api/http2.md                              |  9 +++++
 lib/_http_server.js                           |  1 +
 lib/internal/http2/compat.js                  |  4 ++
 test/parallel/test-http-server.js             |  2 +
 .../test-http2-compat-serverresponse.js       | 40 +++++++++++++++++++
 6 files changed, 65 insertions(+)
 create mode 100644 test/parallel/test-http2-compat-serverresponse.js

diff --git a/doc/api/http.md b/doc/api/http.md
index 6e6104c88a1599..813d5cf1e96f19 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -1598,6 +1598,15 @@ Removes a header that's queued for implicit sending.
 response.removeHeader('Content-Encoding');
 ```
 
+### `response.req`
+<!-- YAML
+added: REPLACEME
+-->
+
+* {http.IncomingMessage}
+
+A reference to the original HTTP `request` object.
+
 ### `response.sendDate`
 <!-- YAML
 added: v0.7.5
diff --git a/doc/api/http2.md b/doc/api/http2.md
index 9c281fa80b661a..9b13b91a7b3665 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -3437,6 +3437,15 @@ Removes a header that has been queued for implicit sending.
 response.removeHeader('Content-Encoding');
 ```
 
+### `response.req`
+<!-- YAML
+added: REPLACEME
+-->
+
+* {http2.Http2ServerRequest}
+
+A reference to the original HTTP2 `request` object.
+
 #### `response.sendDate`
 <!-- YAML
 added: v8.4.0
diff --git a/lib/_http_server.js b/lib/_http_server.js
index f3ccbdafe596c3..a0b1ea7720066d 100644
--- a/lib/_http_server.js
+++ b/lib/_http_server.js
@@ -181,6 +181,7 @@ function ServerResponse(req) {
 
   if (req.method === 'HEAD') this._hasBody = false;
 
+  this.req = req;
   this.sendDate = true;
   this._sent100 = false;
   this._expect_continue = false;
diff --git a/lib/internal/http2/compat.js b/lib/internal/http2/compat.js
index 44961fb87dd6a0..ddc017a144cfbe 100644
--- a/lib/internal/http2/compat.js
+++ b/lib/internal/http2/compat.js
@@ -529,6 +529,10 @@ class Http2ServerResponse extends Stream {
     return this[kStream].headersSent;
   }
 
+  get req() {
+    return this[kStream][kRequest];
+  }
+
   get sendDate() {
     return this[kState].sendDate;
   }
diff --git a/test/parallel/test-http-server.js b/test/parallel/test-http-server.js
index f591cd59fc63c2..dcefc761728d36 100644
--- a/test/parallel/test-http-server.js
+++ b/test/parallel/test-http-server.js
@@ -49,6 +49,8 @@ const server = http.createServer(function(req, res) {
   res.id = request_number;
   req.id = request_number++;
 
+  assert.strictEqual(res.req, req);
+
   if (req.id === 0) {
     assert.strictEqual(req.method, 'GET');
     assert.strictEqual(url.parse(req.url).pathname, '/hello');
diff --git a/test/parallel/test-http2-compat-serverresponse.js b/test/parallel/test-http2-compat-serverresponse.js
new file mode 100644
index 00000000000000..379677a68f81e1
--- /dev/null
+++ b/test/parallel/test-http2-compat-serverresponse.js
@@ -0,0 +1,40 @@
+'use strict';
+
+const common = require('../common');
+if (!common.hasCrypto)
+  common.skip('missing crypto');
+const assert = require('assert');
+const h2 = require('http2');
+
+// Http2ServerResponse should expose convenience properties
+
+const server = h2.createServer();
+server.listen(0, common.mustCall(function() {
+  const port = server.address().port;
+  server.once('request', common.mustCall(function(request, response) {
+    assert.strictEqual(response.req, request);
+
+    response.on('finish', common.mustCall(function() {
+      process.nextTick(() => {
+        server.close();
+      });
+    }));
+    response.end();
+  }));
+
+  const url = `http://localhost:${port}`;
+  const client = h2.connect(url, common.mustCall(function() {
+    const headers = {
+      ':path': '/foobar',
+      ':method': 'GET',
+      ':scheme': 'http',
+      ':authority': `localhost:${port}`
+    };
+    const request = client.request(headers);
+    request.on('end', common.mustCall(function() {
+      client.close();
+    }));
+    request.end();
+    request.resume();
+  }));
+}));