fix(node-ws): make adapter uncrashable (#1141)

* fix(node-ws): make adapter uncrashable

* add changeset

* unnessesary diff

* update yarn.lock

* make changeset patch
pull/1144/head
Shotaro Nakamura 2025-04-27 20:34:43 +09:00 committed by GitHub
parent 247f7705b3
commit 1765a9a3aa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 75 additions and 22 deletions

View File

@ -0,0 +1,5 @@
---
'@hono/node-ws': patch
---
Make it uncrashable

View File

@ -214,6 +214,26 @@ describe('WebSocket helper', () => {
})
})
it('Should onError works well', async () => {
const mainPromise = new Promise<unknown>((resolve) =>
app.get(
'/',
upgradeWebSocket(
() => {
throw 0
},
{
onError(err) {
resolve(err)
},
}
)
)
)
const ws = new WebSocket('ws://localhost:3030/')
expect(await mainPromise).toBe(0)
})
describe('Types', () => {
it('Should not throw a type error with an app with Variables generics', () => {
const app = new Hono<{

View File

@ -1,5 +1,5 @@
import type { Hono } from 'hono'
import type { UpgradeWebSocket, WSContext } from 'hono/ws'
import type { UpgradeWebSocket, WSContext, WSEvents } from 'hono/ws'
import type { WebSocket } from 'ws'
import { WebSocketServer } from 'ws'
import type { IncomingMessage } from 'http'
@ -9,7 +9,12 @@ import type { Duplex } from 'node:stream'
import { CloseEvent } from './events'
export interface NodeWebSocket {
upgradeWebSocket: UpgradeWebSocket<WebSocket>
upgradeWebSocket: UpgradeWebSocket<
WebSocket,
{
onError: (err: unknown) => void
}
>
injectWebSocket(server: Server | Http2Server | Http2SecureServer): void
}
export interface NodeWebSocketInit {
@ -80,7 +85,7 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
})
})
},
upgradeWebSocket: (createEvents) =>
upgradeWebSocket: (createEvents, options) =>
async function upgradeWebSocket(c, next) {
if (c.req.header('upgrade')?.toLowerCase() !== 'websocket') {
// Not websocket
@ -91,7 +96,14 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
const response = new Response()
;(async () => {
const ws = await nodeUpgradeWebSocket(c.env.incoming, response)
const events = await createEvents(c)
let events: WSEvents<WebSocket>
try {
events = await createEvents(c)
} catch (e) {
;(options?.onError ?? console.error)(e)
ws.close()
return
}
const ctx: WSContext<WebSocket> = {
binaryType: 'arraybuffer',
@ -110,11 +122,16 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
},
url: new URL(c.req.url),
}
events.onOpen?.(new Event('open'), ctx)
try {
events?.onOpen?.(new Event('open'), ctx)
} catch (e) {
;(options?.onError ?? console.error)(e)
}
ws.on('message', (data, isBinary) => {
const datas = Array.isArray(data) ? data : [data]
for (const data of datas) {
events.onMessage?.(
try {
events?.onMessage?.(
new MessageEvent('message', {
data: isBinary
? data instanceof ArrayBuffer
@ -124,18 +141,29 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
}),
ctx
)
} catch (e) {
;(options?.onError ?? console.error)(e)
}
}
})
ws.on('close', (code, reason) => {
events.onClose?.(new CloseEvent('close', { code, reason: reason.toString() }), ctx)
try {
events?.onClose?.(new CloseEvent('close', { code, reason: reason.toString() }), ctx)
} catch (e) {
;(options?.onError ?? console.error)(e)
}
})
ws.on('error', (error) => {
events.onError?.(
try {
events?.onError?.(
new ErrorEvent('error', {
error: error,
}),
ctx
)
} catch (e) {
;(options?.onError ?? console.error)(e)
}
})
})()