-
Notifications
You must be signed in to change notification settings - Fork 28.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
net,tls: add abort signal support to connect
Add documentation for net.connect AbortSignal, and add the support to tls.connect as well PR-URL: #37735 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
- Loading branch information
1 parent
8792c7c
commit 669b81c
Showing
7 changed files
with
388 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
'use strict'; | ||
const common = require('../common'); | ||
if (!common.hasCrypto) | ||
common.skip('missing crypto'); | ||
|
||
const assert = require('assert'); | ||
const https = require('https'); | ||
const { once } = require('events'); | ||
const Agent = https.Agent; | ||
const fixtures = require('../common/fixtures'); | ||
|
||
const { getEventListeners } = require('events'); | ||
const agent = new Agent(); | ||
|
||
const options = { | ||
key: fixtures.readKey('agent1-key.pem'), | ||
cert: fixtures.readKey('agent1-cert.pem') | ||
}; | ||
|
||
const server = https.createServer(options); | ||
|
||
server.listen(0, common.mustCall(async () => { | ||
const port = server.address().port; | ||
const host = 'localhost'; | ||
const options = { | ||
port: port, | ||
host: host, | ||
rejectUnauthorized: false, | ||
_agentKey: agent.getName({ port, host }) | ||
}; | ||
|
||
async function postCreateConnection() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
const connection = agent.createConnection({ ...options, signal }); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 1); | ||
ac.abort(); | ||
const [err] = await once(connection, 'error'); | ||
assert.strictEqual(err.name, 'AbortError'); | ||
} | ||
|
||
async function preCreateConnection() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
ac.abort(); | ||
const connection = agent.createConnection({ ...options, signal }); | ||
const [err] = await once(connection, 'error'); | ||
assert.strictEqual(err.name, 'AbortError'); | ||
} | ||
|
||
|
||
async function agentAsParam() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
const request = https.get({ | ||
port: server.address().port, | ||
path: '/hello', | ||
agent: agent, | ||
signal, | ||
}); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 1); | ||
ac.abort(); | ||
const [err] = await once(request, 'error'); | ||
assert.strictEqual(err.name, 'AbortError'); | ||
} | ||
|
||
async function agentAsParamPreAbort() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
ac.abort(); | ||
const request = https.get({ | ||
port: server.address().port, | ||
path: '/hello', | ||
agent: agent, | ||
signal, | ||
}); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 0); | ||
const [err] = await once(request, 'error'); | ||
assert.strictEqual(err.name, 'AbortError'); | ||
} | ||
|
||
await postCreateConnection(); | ||
await preCreateConnection(); | ||
await agentAsParam(); | ||
await agentAsParamPreAbort(); | ||
server.close(); | ||
})); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
'use strict'; | ||
const common = require('../common'); | ||
const net = require('net'); | ||
const assert = require('assert'); | ||
const server = net.createServer(); | ||
const { getEventListeners, once } = require('events'); | ||
|
||
const liveConnections = new Set(); | ||
|
||
server.listen(0, common.mustCall(async () => { | ||
const port = server.address().port; | ||
const host = 'localhost'; | ||
const socketOptions = (signal) => ({ port, host, signal }); | ||
server.on('connection', (connection) => { | ||
liveConnections.add(connection); | ||
connection.on('close', () => { | ||
liveConnections.delete(connection); | ||
}); | ||
}); | ||
|
||
const assertAbort = async (socket, testName) => { | ||
try { | ||
await once(socket, 'close'); | ||
assert.fail(`close ${testName} should have thrown`); | ||
} catch (err) { | ||
assert.strictEqual(err.name, 'AbortError'); | ||
} | ||
}; | ||
|
||
async function postAbort() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
const socket = net.connect(socketOptions(signal)); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 1); | ||
ac.abort(); | ||
await assertAbort(socket, 'postAbort'); | ||
} | ||
|
||
async function preAbort() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
ac.abort(); | ||
const socket = net.connect(socketOptions(signal)); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 0); | ||
await assertAbort(socket, 'preAbort'); | ||
} | ||
|
||
async function tickAbort() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
setImmediate(() => ac.abort()); | ||
const socket = net.connect(socketOptions(signal)); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 1); | ||
await assertAbort(socket, 'tickAbort'); | ||
} | ||
|
||
async function testConstructor() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
ac.abort(); | ||
const socket = new net.Socket(socketOptions(signal)); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 0); | ||
await assertAbort(socket, 'testConstructor'); | ||
} | ||
|
||
async function testConstructorPost() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
const socket = new net.Socket(socketOptions(signal)); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 1); | ||
ac.abort(); | ||
await assertAbort(socket, 'testConstructorPost'); | ||
} | ||
|
||
async function testConstructorPostTick() { | ||
const ac = new AbortController(); | ||
const { signal } = ac; | ||
const socket = new net.Socket(socketOptions(signal)); | ||
assert.strictEqual(getEventListeners(signal, 'abort').length, 1); | ||
setImmediate(() => ac.abort()); | ||
await assertAbort(socket, 'testConstructorPostTick'); | ||
} | ||
|
||
await postAbort(); | ||
await preAbort(); | ||
await tickAbort(); | ||
await testConstructor(); | ||
await testConstructorPost(); | ||
await testConstructorPostTick(); | ||
|
||
// Killing the net.socket without connecting hangs the server. | ||
for (const connection of liveConnections) { | ||
connection.destroy(); | ||
} | ||
server.close(common.mustCall()); | ||
})); |
Oops, something went wrong.