Skip to content

Commit c2c9ef4

Browse files
MFA-Gsapphi-red
andauthored
fix(server): handle socket errors on upgrade requests not taken by the HMR server (#23728)
Co-authored-by: sapphi-red <[email protected]>
1 parent 4ea708a commit c2c9ef4

4 files changed

Lines changed: 60 additions & 1 deletion

File tree

‎packages/vite/src/node/server/ws.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,12 @@ export function createWebSocketServer(
231231
parsedUrl.pathname === hmrBase
232232
) {
233233
handleUpgrade(req, socket as Socket, head, protocol === 'vite-ping')
234+
} else {
235+
// Node.js detaches its own socket error handler before emitting
236+
// `upgrade`, so a socket that no listener takes over would crash the
237+
// process when the client resets the connection (e.g. ECONNRESET).
238+
// Other listeners (proxy, plugins) still receive the error as usual.
239+
socket.on('error', noop)
234240
}
235241
}
236242
wsServer.on('upgrade', hmrServerWsListener)
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import { errorMonitor } from 'node:events'
2+
import type { IncomingMessage } from 'node:http'
3+
import type { Socket } from 'node:net'
4+
import type { Duplex } from 'node:stream'
5+
import { expect, test } from 'vitest'
6+
import WebSocket from 'ws'
7+
import { isServe, promiseWithResolvers, viteServer, viteTestUrl } from '~utils'
8+
9+
// https://github.com/vitejs/vite/issues/23727
10+
test.runIf(isServe)(
11+
'does not crash when an unhandled upgrade request is reset',
12+
async () => {
13+
const httpServer = viteServer.httpServer!
14+
const upgrade = promiseWithResolvers<Duplex>()
15+
const onUpgrade = (request: IncomingMessage, socket: Duplex) => {
16+
if (request.url === '/unhandled-upgrade') {
17+
upgrade.resolve(socket)
18+
}
19+
}
20+
httpServer.on('upgrade', onUpgrade)
21+
22+
const wsUrl = new URL('/unhandled-upgrade', viteTestUrl)
23+
wsUrl.protocol = 'ws:'
24+
let socket: Socket
25+
const client = new WebSocket(wsUrl, {
26+
finishRequest(request) {
27+
request.once('socket', (requestSocket) => {
28+
socket = requestSocket
29+
})
30+
request.end()
31+
},
32+
})
33+
// The connection is deliberately reset before the handshake completes.
34+
client.on('error', () => {})
35+
try {
36+
const serverSocket = await upgrade.promise
37+
const socketError = promiseWithResolvers<Error>()
38+
serverSocket.once(errorMonitor, socketError.resolve)
39+
socket!.resetAndDestroy()
40+
41+
await expect(socketError.promise).resolves.toMatchObject({
42+
code: 'ECONNRESET',
43+
})
44+
} finally {
45+
httpServer.off('upgrade', onUpgrade)
46+
client.terminate()
47+
}
48+
},
49+
)

‎playground/hmr/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"preview": "vite preview"
1111
},
1212
"devDependencies": {
13-
"tinyglobby": "^0.2.17"
13+
"tinyglobby": "^0.2.17",
14+
"ws": "^8.22.0"
1415
}
1516
}

‎pnpm-lock.yaml‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)