Skip to content
Merged
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
10 changes: 10 additions & 0 deletions packages/transport-tcp/src/socket-to-conn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,16 @@ class TCPSocketMultiaddrConnection extends AbstractMultiaddrConnection {
}

sendReset (): void {
if (this.socket.writableEnded) {
// socket.end() starts the graceful shutdown path, which uses uv_shutdown().
// resetAndDestroy() calls uv_tcp_close_reset(), which cannot be mixed with
// uv_shutdown(), so use destroy() after writable end has started.
// https://docs.libuv.org/en/v1.x/stream.html#c.uv_shutdown
// https://docs.libuv.org/en/v1.x/tcp.html#c.uv_tcp_close_reset
this.socket.destroy()
return
}

this.socket.resetAndDestroy()
}

Expand Down
80 changes: 80 additions & 0 deletions packages/transport-tcp/test/socket-to-conn.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { multiaddr } from '@multiformats/multiaddr'
import { expect } from 'aegir/chai'
import delay from 'delay'
import { pEvent } from 'p-event'
import Sinon from 'sinon'
import { toMultiaddrConnection } from '../src/socket-to-conn.ts'
import type { Server, ServerOpts, SocketConstructorOpts } from 'node:net'

Expand Down Expand Up @@ -51,6 +52,8 @@ describe('socket-to-conn', () => {
let serverSocket: Socket

afterEach(async () => {
Sinon.restore()

if (serverSocket != null) {
serverSocket.destroy()
}
Expand Down Expand Up @@ -509,4 +512,81 @@ describe('socket-to-conn', () => {
// server socket is destroyed
expect(serverSocket.destroyed).to.be.true()
})

it('should close the socket when a reset races graceful shutdown', async () => {
({ server, clientSocket, serverSocket } = await setup())

clientSocket.once('error', () => {})

// resetting a socket whose shutdown is already in flight fails with EINVAL
const socketErrors: Error[] = []
serverSocket.on('error', err => {
socketErrors.push(err)
})

const resetSpy = Sinon.spy(serverSocket, 'resetAndDestroy')

const inboundMaConn = toMultiaddrConnection({
socket: serverSocket,
direction: 'inbound',
log: defaultLogger().forComponent('libp2p:test-maconn')
})
expect(inboundMaConn).to.have.property('status', 'open')

// resolves only on 'close', so it stays true to the test name even if the
// socket also errors
const serverClosed = pEvent(serverSocket, 'close', {
rejectionEvents: [],
signal: AbortSignal.timeout(5_000)
})
// sinks, so an assertion failing before the awaits below cannot turn these
// into unhandled rejections. awaiting them still rejects
serverClosed.catch(() => {})

// nothing has been written, so close() reaches sendClose() -> destroySoon()
// synchronously and puts a shutdown request in flight
const closePromise = inboundMaConn.close()
closePromise.catch(() => {})
expect(serverSocket.writableEnded).to.be.true()
expect(serverSocket.destroyed).to.be.false()

inboundMaConn.abort(new Error('close timed out'))

// the guard has to destroy the socket here. waiting only for 'close' would
// also pass if sendReset() did nothing, because destroySoon() closes the
// socket a tick later anyway
expect(resetSpy.called).to.be.false()
expect(serverSocket.destroyed).to.be.true()

// must stay above the awaits below, it is the fastest and clearest failure
expect(socketErrors).to.be.empty()

// without the guard the socket never emits 'close' and the handle is leaked
await expect(serverClosed).to.eventually.be.fulfilled()
await expect(closePromise).to.eventually.be.fulfilled()
})

it('should still reset a socket aborted before graceful close starts', async () => {
({ server, clientSocket, serverSocket } = await setup())

clientSocket.once('error', () => {})

const resetSpy = Sinon.spy(serverSocket, 'resetAndDestroy')

const inboundMaConn = toMultiaddrConnection({
socket: serverSocket,
direction: 'inbound',
log: defaultLogger().forComponent('libp2p:test-maconn')
})

// the writable end is still open, so the reset path must be used
expect(serverSocket.writableEnded).to.be.false()

inboundMaConn.abort(new Error('Not interested'))

// assert the reset landed, not just that the method was reached. abort()
// swallows a failing resetAndDestroy() and would leave the socket open
expect(resetSpy).to.have.property('callCount', 1)
expect(serverSocket.destroyed).to.be.true()
})
})
Loading