Skip to content

Handle closing the socket #12

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
50 changes: 34 additions & 16 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,28 @@ const createServer = (server, options) => {
options.handleCommonErrors = true;
}

function onError(err, source) {
// handle common socket errors
function prepareSocket(socket, name) {
socket.setKeepAlive(true); // prevent idle timeout ECONNRESET
if (options.setNoDelay) {
socket.setNoDelay(true); // disable nagle algorithm
}
if (server.timeout) {
socket.setTimeout(server.timeout, () => closeSocket(socket));
}
socket.addListener('error', err => onError(err, name, socket));
}

function closeSocket(socket, err) {
// let the server destroy the connection
// https://github.com/nodejs/node/blob/c30ef3cbd2e42ac1d600f6bd78a601a5496b0877/lib/https.js#L69
server.emit(server._sharedCreds?'tlsClientError':'clientError', err, socket);
}

function onError(err, source, socket) {
if (socket) {
closeSocket(socket, err);
}
// handle common network errors
if (options.handleCommonErrors) {
const errCodes = new Set(['ECONNRESET', 'EPIPE', 'HPE_INVALID_EOF_STATE', 'HPE_HEADER_OVERFLOW']);
if (err && err.code && errCodes.has(err.code)) {
Expand All @@ -32,17 +52,19 @@ const createServer = (server, options) => {
throw err;
}

function listen(proxy, server) {
const port = server.address().port;
server.close();
proxied.listen(port, () => console.log(`PROXY protocol parser listening to port ${port}`));
}

// create proxy protocol processing server
const proxied = require('net').createServer(socket => {
const buf = [];
let bytesRead = 0;
let proxyProtoLength;
let isProxyProto;
socket.setKeepAlive(true); // prevent idle timeout ECONNRESET
if (options.setNoDelay) {
socket.setNoDelay(true); // disable nagle algorithm
}
socket.addListener('error', err => onError(err, 'proxyproto socket'));
prepareSocket(socket, 'proxyproto socket');
socket.addListener('data', onData);
function onData(buffer) {
socket.pause();
Expand Down Expand Up @@ -99,23 +121,19 @@ const createServer = (server, options) => {
configurable: true
});
});
socket.addListener('error', err => onError(err, 'secure socket'));
socket.setKeepAlive(true); // prevent idle timeout ECONNRESET
if (options.setNoDelay) {
socket.setNoDelay(true); // disable nagle algorithm
}
prepareSocket(socket, 'secure socket');
});
} else {
server.on('connection', socket => {
socket.addListener('error', err => onError(err, 'socket'));
prepareSocket(socket, 'socket');
});
}

// listen to listening event
server.on('listening', () => listen(proxied, server));
// if server is already listening, use that port
if (server.listening) {
const port = server.address().port;
server.close();
proxied.listen(port, () => console.log(`PROXY protocol parser listening to port ${port}`));
listen(proxied, server);
}

return proxied;
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "proxyproto",
"version": "1.0.10",
"version": "1.1.0",
"description": "Pre-process PROXY protocol headers from node tcp sockets",
"main": "index.js",
"scripts": {
Expand Down
48 changes: 41 additions & 7 deletions test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,32 @@ module.exports = async t => {
});

t.test('listening port is re-used', async (t) => {
const server = http.createServer();
server.listen(PORT);
const proxied = proxyproto.createServer(server);
t.ok(proxied.listening);
t.notOk(server.listening);
t.same(proxied.address().port, PORT);
proxied.close();
await new Promise(resolve => {
const server = http.createServer();
server.listen(PORT, () => {
const proxied = proxyproto.createServer(server);
t.ok(proxied.listening);
t.notOk(server.listening);
t.same(proxied.address().port, PORT);
proxied.close();
resolve();
});
});
});

t.test('listening event is listened to', async (t) => {
await new Promise(resolve => {
const server = http.createServer();
const proxied = proxyproto.createServer(server);
proxied.on('listening', () => {
t.ok(proxied.listening);
t.notOk(server.listening);
t.same(proxied.address().port, PORT);
proxied.close();
resolve();
});
server.listen(PORT);
});
});

// first load test has ~.2ms added latency
Expand Down Expand Up @@ -304,6 +323,21 @@ module.exports = async t => {
});
});

t.test('closes the proxyproto socket', async (t) => {
await new Promise(resolve => {
const proxied = proxyproto.createServer(httpServer);
proxied.on('connection', socket => {
socket.on('close', err => {
t.notOk(err);
proxied.close();
resolve();
});
});
proxied.listen(PORT);
http.get(`http://localhost:${PORT}`, httpRequestOptions);
});
});

};

if (!module.parent) module.exports(require('tap'));