Skip to content

Commit

Permalink
http2: release request()'s "connect" event listener after it runs
Browse files Browse the repository at this point in the history
The `Http2Session#request()` method internally listens to the "connect"
event if the session has not yet established a connection so that the
actual request can be sent after the connection has been established.

This commit removes the event listener after it runs and carries out
the request and is no longer needed. In practice this shouldn't affect
the behavior of the session object since the "connect" event fires only
once anyway, but removing the listener releases its references. The
rest of this class subscribes to the "connect" event with `once`
instead of `on` as well.

Tested by adding a new test that ensures `Http2Session#request()` is
called before the connection is established, indicated by a "connect"
listener that is run. The test also ensures all "connect" listeners are
removed after the connection is established.

Backport-PR-URL: #22850
PR-URL: #21916
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Anatoli Papirovski <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
  • Loading branch information
ide authored and BethGriggs committed Oct 16, 2018
1 parent 745e1e6 commit d602c7a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
2 changes: 1 addition & 1 deletion lib/internal/http2/core.js
Original file line number Diff line number Diff line change
Expand Up @@ -1384,7 +1384,7 @@ class ClientHttp2Session extends Http2Session {

const onConnect = requestOnConnect.bind(stream, headersList, options);
if (this.connecting) {
this.on('connect', onConnect);
this.once('connect', onConnect);
} else {
onConnect();
}
Expand Down
28 changes: 28 additions & 0 deletions test/parallel/test-http2-request-remove-connect-listener.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
'use strict';

const common = require('../common');
if (!common.hasCrypto)
common.skip('missing crypto');
const assert = require('assert');
const http2 = require('http2');


const server = http2.createServer();
server.on('stream', common.mustCall((stream) => {
stream.respond();
stream.end();
}));

server.listen(0, common.mustCall(() => {
const client = http2.connect(`http://localhost:${server.address().port}`);
const req = client.request();
client.once('connect', common.mustCall());

req.on('response', common.mustCall(() => {
assert.strictEqual(client.listenerCount('connect'), 0);
}));
req.on('close', common.mustCall(() => {
server.close();
client.close();
}));
}));

0 comments on commit d602c7a

Please sign in to comment.