Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

http: use listenerCount when adding noop event #46769

Merged
merged 5 commits into from
Mar 8, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion lib/_http_server.js
Original file line number Diff line number Diff line change
Expand Up @@ -822,10 +822,28 @@ const requestHeaderFieldsTooLargeResponse = Buffer.from(
`HTTP/1.1 431 ${STATUS_CODES[431]}\r\n` +
'Connection: close\r\n\r\n', 'ascii',
);

function warnUnclosedSocket() {
if (warnUnclosedSocket.emitted) {
return;
}

warnUnclosedSocket.emitted = true;
process.emitWarning(
'An error event has already been emitted on the socket. ' +
'Please use the destroy method on the socket while handling a clientError event.',
Copy link
Member

@lpinca lpinca Feb 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to @dougwilson the leak warning is emitted also without adding a listener for the 'clientError' event so this is even more misleading than the original leak warning.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand how is it possible, a repro would be useful.

ShogunPanda marked this conversation as resolved.
Show resolved Hide resolved
);
}

function socketOnError(e) {
// Ignore further errors
this.removeListener('error', socketOnError);
this.on('error', noop);

if (this.listenerCount('error', noop) === 0) {
this.on('error', noop);
} else {
warnUnclosedSocket();
}

if (!this.server.emit('clientError', e, this)) {
// Caution must be taken to avoid corrupting the remote peer.
Expand Down
84 changes: 84 additions & 0 deletions test/parallel/test-http-socket-error-listeners.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
// Flags: --no-warnings

'use strict';

const common = require('../common');
const assert = require('assert');
const http = require('http');
const net = require('net');

// This test sends an invalid character to a HTTP server and purposely
// does not handle clientError (even if it sets an event handler).
//
// The idea is to let the server emit multiple errors on the socket,
// mostly due to parsing error, and make sure they don't result
// in leaking event listeners.

{
let i = 0;
let socket;
process.on('warning', common.mustCall());

const server = http.createServer(common.mustNotCall());

server.on('clientError', common.mustCallAtLeast((err) => {
assert.strictEqual(err.code, 'HPE_INVALID_METHOD');
assert.strictEqual(err.rawPacket.toString(), '*');

if (i === 20) {
socket.end();
} else {
socket.write('*');
i++;
}
}, 1));

server.listen(0, () => {
socket = net.createConnection({ port: server.address().port });

socket.on('connect', () => {
socket.write('*');
});

socket.on('close', () => {
server.close();
});
});
}

{
const valid = 'GET / HTTP/1.1\r\nHost:a\r\nContent-Length:1\r\n\r\n1\r\n';

const server = http.createServer((req, res) => {
const handler = common.mustCall(function handler(error) {
req.socket.removeListener('error', handler);
}, 2);

req.on('end', handler);
req.socket.on('error', handler);

res.removeHeader('date');
res.writeHead(204);
res.end();
});

server.listen(0, () => {
const client = net.createConnection({ host: '127.0.0.1', port: server.address().port });
let data = Buffer.alloc(0);

client.on('data', (chunk) => {
data = Buffer.concat([data, chunk]);
});

client.on('end', () => {
assert.strictEqual(
data.toString('utf-8'),
'HTTP/1.1 204 No Content\r\nConnection: keep-alive\r\nKeep-Alive: timeout=5\r\n\r\n' +
'HTTP/1.1 400 Bad Request\r\nConnection: close\r\n\r\n',
);
server.close();
});

client.write(valid + 'INVALID');
});
ShogunPanda marked this conversation as resolved.
Show resolved Hide resolved
}