Skip to content

Commit 2d617ab

Browse files
ronagRafaelGSS
andcommitted
http: add optimizeEmptyRequests server option
Signed-off-by: RafaelGSS <[email protected]> Co-Authored-By: RafaelGSS <[email protected]>
1 parent 2ea31e5 commit 2d617ab

File tree

5 files changed

+103
-4
lines changed

5 files changed

+103
-4
lines changed

doc/api/http.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3537,6 +3537,9 @@ Found'`.
35373537
<!-- YAML
35383538
added: v0.1.13
35393539
changes:
3540+
- version: REPLACEME
3541+
pr-url: https://github.com/nodejs/node/pull/59778
3542+
description: Add optimizeEmptyRequests option.
35403543
- version:
35413544
- v20.1.0
35423545
- v18.17.0
@@ -3632,6 +3635,12 @@ changes:
36323635
* `rejectNonStandardBodyWrites` {boolean} If set to `true`, an error is thrown
36333636
when writing to an HTTP response which does not have a body.
36343637
**Default:** `false`.
3638+
* `optimizeEmptyRequests` {boolean} If set to `true`, requests without `Content-Length`
3639+
or `Transfer-Encoding` headers (indicating no body) will have their lifecycle events
3640+
immediately emitted. For `HEAD` and `GET` requests, this optimization is applied
3641+
regardless of headers. This improves performance for requests without bodies
3642+
across all HTTP methods.
3643+
**Default:** `false`.
36353644
36363645
* `requestListener` {Function}
36373646

lib/_http_server.js

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ const onResponseFinishChannel = dc.channel('http.server.response.finish');
106106
const kServerResponse = Symbol('ServerResponse');
107107
const kServerResponseStatistics = Symbol('ServerResponseStatistics');
108108

109+
const kOptimizeEmptyRequests = Symbol('OptimizeEmptyRequestsOption');
110+
109111
const {
110112
hasObserver,
111113
startPerf,
@@ -452,6 +454,11 @@ function storeHTTPOptions(options) {
452454
validateInteger(maxHeaderSize, 'maxHeaderSize', 0);
453455
this.maxHeaderSize = maxHeaderSize;
454456

457+
const optimizeEmptyRequests = options.optimizeEmptyRequests;
458+
if (optimizeEmptyRequests !== undefined)
459+
validateBoolean(optimizeEmptyRequests, 'options.optimizeEmptyRequests');
460+
this[kOptimizeEmptyRequests] = optimizeEmptyRequests || false;
461+
455462
const insecureHTTPParser = options.insecureHTTPParser;
456463
if (insecureHTTPParser !== undefined)
457464
validateBoolean(insecureHTTPParser, 'options.insecureHTTPParser');
@@ -1102,6 +1109,29 @@ function parserOnIncoming(server, socket, state, req, keepAlive) {
11021109
});
11031110
}
11041111

1112+
// Check if we should optimize empty requests (those without Content-Length or Transfer-Encoding headers)
1113+
const hasBodyHeaders = ('content-length' in req.headers) || ('transfer-encoding' in req.headers);
1114+
const isHeadOrGet = (req.method === 'HEAD' || req.method === 'GET');
1115+
1116+
// Apply optimization for all methods when optimizeEmptyRequests is enabled and there are no body headers
1117+
// For HEAD and GET methods, we optimize regardless of body headers for backward compatibility
1118+
const shouldOptimize = server[kOptimizeEmptyRequests] === true && (isHeadOrGet || !hasBodyHeaders);
1119+
1120+
if (shouldOptimize) {
1121+
// Fast processing where request "has" already emitted all lifecycle events.
1122+
// This avoids a lot of unnecessary overhead otherwise introduced by
1123+
// stream.Readable life cycle rules. The downside is that this will
1124+
// break some servers that read bodies for methods that don't have body headers.
1125+
req._dumped = true;
1126+
req._readableState.ended = true;
1127+
req._readableState.endEmitted = true;
1128+
req._readableState.destroyed = true;
1129+
req._readableState.closed = true;
1130+
req._readableState.closeEmitted = true;
1131+
1132+
req._read();
1133+
}
1134+
11051135
if (socket._httpMessage) {
11061136
// There are already pending outgoing res, append.
11071137
state.outgoing.push(res);

test/parallel/test-http-chunk-extensions-limit.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ const assert = require('assert');
124124
}));
125125

126126
sock.end('' +
127-
'GET / HTTP/1.1\r\n' +
127+
'PUT / HTTP/1.1\r\n' +
128128
`Host: localhost:${port}\r\n` +
129129
'Transfer-Encoding: chunked\r\n\r\n' +
130130
'2;' + 'A'.repeat(10000) + '=bar\r\nAA\r\n' +
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
'use strict';
2+
3+
const common = require('../common');
4+
const assert = require('assert');
5+
const http = require('http');
6+
const net = require('net');
7+
8+
let reqs = 0;
9+
const server = http.createServer({
10+
optimizeEmptyRequests: true
11+
}, (req, res) => {
12+
reqs++;
13+
assert.strictEqual(req._dumped, true);
14+
assert.strictEqual(req._readableState.ended, true);
15+
assert.strictEqual(req._readableState.endEmitted, true);
16+
assert.strictEqual(req._readableState.destroyed, true);
17+
18+
res.writeHead(200);
19+
res.end('ok');
20+
});
21+
22+
server.listen(0, common.mustCall(async () => {
23+
// GET request without Content-Length (should be optimized)
24+
const getRequest = 'GET / HTTP/1.1\r\nHost: localhost\r\n\r\n';
25+
await makeRequest(getRequest);
26+
27+
// HEAD request (should always be optimized regardless of headers)
28+
const headRequest = 'HEAD / HTTP/1.1\r\nHost: localhost\r\n\r\n';
29+
await makeRequest(headRequest);
30+
31+
// POST request without body headers (should be optimized)
32+
const postWithoutBodyHeaders = 'POST / HTTP/1.1\r\nHost: localhost\r\n\r\n';
33+
await makeRequest(postWithoutBodyHeaders);
34+
35+
// DELETE request without body headers (should be optimized)
36+
const deleteWithoutBodyHeaders = 'DELETE / HTTP/1.1\r\nHost: localhost\r\n\r\n';
37+
await makeRequest(deleteWithoutBodyHeaders);
38+
server.close();
39+
40+
assert.strictEqual(reqs, 4);
41+
}));
42+
43+
function makeRequest(str) {
44+
return new Promise((resolve) => {
45+
const client = net.connect({ port: server.address().port }, common.mustCall(() => {
46+
client.on('data', common.mustCall());
47+
client.on('end', common.mustCall(() => {
48+
resolve();
49+
}));
50+
client.write(str);
51+
client.end();
52+
}));
53+
});
54+
}

test/parallel/test-http.js

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,18 @@ const server = http.Server(common.mustCall((req, res) => {
5252
if (expectedRequests.length === 0)
5353
server.close();
5454

55-
req.on('end', () => {
55+
if (req.readableEnded) {
5656
res.writeHead(200, { 'Content-Type': 'text/plain' });
5757
res.write(`The path was ${url.parse(req.url).pathname}`);
5858
res.end();
59-
});
60-
req.resume();
59+
} else {
60+
req.on('end', () => {
61+
res.writeHead(200, { 'Content-Type': 'text/plain' });
62+
res.write(`The path was ${url.parse(req.url).pathname}`);
63+
res.end();
64+
});
65+
req.resume();
66+
}
6167
}, 3));
6268
server.listen(0);
6369

0 commit comments

Comments
 (0)