Skip to content

Commit

Permalink
http: client keep-alive for UNIX domain sockets
Browse files Browse the repository at this point in the history
Makes `Connection: keep-alive` behave correctly when making client
connections to UNIX domain sockets.

Prior to this, connections would never be re-used, but the keep-alive
would cause the connections to stick around until they time out. This
would lead to an eventual EMFILE error due to all the connections
staying open. This was due to http.Agent not properly supporting UNIX
domain sockets.

PR-URL: #13214
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
bengl authored and MylesBorins committed Oct 3, 2017
1 parent aabd84d commit 083077b
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 19 deletions.
7 changes: 7 additions & 0 deletions lib/_http_agent.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ Agent.prototype.getName = function getName(options) {
if (options.family === 4 || options.family === 6)
name += ':' + options.family;

if (options.socketPath)
name += ':' + options.socketPath;

return name;
};

Expand All @@ -147,6 +150,8 @@ Agent.prototype.addRequest = function addRequest(req, options, port/*legacy*/,

options = util._extend({}, options);
util._extend(options, this.options);
if (options.socketPath)
options.path = options.socketPath;

if (!options.servername) {
options.servername = options.host;
Expand Down Expand Up @@ -199,6 +204,8 @@ Agent.prototype.createSocket = function createSocket(req, options, cb) {
var self = this;
options = util._extend({}, options);
util._extend(options, self.options);
if (options.socketPath)
options.path = options.socketPath;

if (!options.servername) {
options.servername = options.host;
Expand Down
20 changes: 2 additions & 18 deletions lib/_http_client.js
Original file line number Diff line number Diff line change
Expand Up @@ -241,23 +241,7 @@ function ClientRequest(options, cb) {
this._deferToConnect(null, null, () => this._flush());
};

var newSocket;
if (this.socketPath) {
this._last = true;
this.shouldKeepAlive = false;
var optionsPath = {
path: this.socketPath,
timeout: this.timeout,
rejectUnauthorized: !!options.rejectUnauthorized
};
newSocket = this.agent.createConnection(optionsPath, oncreate);
if (newSocket && !called) {
called = true;
this.onSocket(newSocket);
} else {
return;
}
} else if (this.agent) {
if (this.agent) {
// If there is an agent we should default to Connection:keep-alive,
// but only if the Agent will actually reuse the connection!
// If it's not a keepAlive agent, and the maxSockets==Infinity, then
Expand All @@ -275,7 +259,7 @@ function ClientRequest(options, cb) {
this._last = true;
this.shouldKeepAlive = false;
if (typeof options.createConnection === 'function') {
newSocket = options.createConnection(options, oncreate);
const newSocket = options.createConnection(options, oncreate);
if (newSocket && !called) {
called = true;
this.onSocket(newSocket);
Expand Down
12 changes: 11 additions & 1 deletion test/parallel/test-http-agent-getname.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
'use strict';

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

const agent = new http.Agent();

Expand Down Expand Up @@ -31,6 +32,15 @@ assert.strictEqual(
'0.0.0.0:80:192.168.1.1'
);

// unix socket
const socketPath = path.join(common.tmpDir, 'foo', 'bar');
assert.strictEqual(
agent.getName({
socketPath
}),
`localhost:::${socketPath}`
);

for (const family of [0, null, undefined, 'bogus'])
assert.strictEqual(agent.getName({ family }), 'localhost::');

Expand Down
37 changes: 37 additions & 0 deletions test/parallel/test-http-unix-socket-keep-alive.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
'use strict';
const common = require('../common');
const assert = require('assert');
const http = require('http');

const server = http.createServer((req, res) => res.end());

common.refreshTmpDir();

server.listen(common.PIPE, common.mustCall(() =>
asyncLoop(makeKeepAliveRequest, 10, common.mustCall(() =>
server.getConnections(common.mustCall((err, conns) => {
assert.ifError(err);
assert.strictEqual(conns, 1);
server.close();
}))
))
));

function asyncLoop(fn, times, cb) {
fn(function handler() {
if (--times) {
fn(handler);
} else {
cb();
}
});
}
function makeKeepAliveRequest(cb) {
http.get({
socketPath: common.PIPE,
headers: { connection: 'keep-alive' }
}, (res) => res.on('data', common.mustNotCall())
.on('error', assert.fail)
.on('end', cb)
);
}

0 comments on commit 083077b

Please sign in to comment.