Compare commits

...

5 Commits

Author SHA1 Message Date
Kevin f184c4f82e
Merge ea95a7df84 into bed23c62f5 2025-04-30 17:30:13 +10:00
github-actions[bot] bed23c62f5
Version Packages (#1147)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-04-29 18:35:32 +09:00
Shotaro Nakamura b8453438b6
fix(node-ws): enhance WebSocket connection handling with CORS support (#1146)
* fix(node-ws): make adapter uncrashable

* add changeset

* unnessesary diff

* fix(node-ws): enhance WebSocket connection handling with CORS support and connection symbols

* fix commentout

* remove unnecessary changese

* update changeset
2025-04-29 18:31:54 +09:00
Kevin De Porre ea95a7df84 Changeset 2025-04-22 08:52:25 +02:00
Kevin De Porre 617d7f17c8 Run validators before route middleware. 2025-04-22 08:51:57 +02:00
6 changed files with 75 additions and 15 deletions

View File

@ -0,0 +1,5 @@
---
'@hono/zod-openapi': patch
---
Run validators before route middleware.

View File

@ -1,5 +1,11 @@
# @hono/node-ws # @hono/node-ws
## 1.1.4
### Patch Changes
- [#1146](https://github.com/honojs/middleware/pull/1146) [`b8453438b66fc9a6af58e33593e9fa21a96c02a7`](https://github.com/honojs/middleware/commit/b8453438b66fc9a6af58e33593e9fa21a96c02a7) Thanks [@nakasyou](https://github.com/nakasyou)! - enhance WebSocket connection handling with CORS support and connection symbols
## 1.1.3 ## 1.1.3
### Patch Changes ### Patch Changes

View File

@ -1,6 +1,6 @@
{ {
"name": "@hono/node-ws", "name": "@hono/node-ws",
"version": "1.1.3", "version": "1.1.4",
"description": "WebSocket helper for Node.js", "description": "WebSocket helper for Node.js",
"type": "module", "type": "module",
"main": "dist/index.js", "main": "dist/index.js",

View File

@ -3,6 +3,7 @@ import { serve } from '@hono/node-server'
// @ts-ignore // @ts-ignore
import type { ServerType } from '@hono/node-server/dist/types' import type { ServerType } from '@hono/node-server/dist/types'
import { Hono } from 'hono' import { Hono } from 'hono'
import { cors } from 'hono/cors'
import type { WSMessageReceive } from 'hono/ws' import type { WSMessageReceive } from 'hono/ws'
import { WebSocket } from 'ws' import { WebSocket } from 'ws'
import { createNodeWebSocket } from '.' import { createNodeWebSocket } from '.'
@ -244,4 +245,42 @@ describe('WebSocket helper', () => {
createNodeWebSocket({ app }) createNodeWebSocket({ app })
}) })
}) })
it('Should client can connect when use cors()', async () => {
app.use(cors())
const mainPromise = new Promise<boolean>((resolve) =>
app.get(
'/',
upgradeWebSocket(() => ({
onOpen() {
resolve(true)
},
}))
)
)
new WebSocket('ws://localhost:3030/')
expect(await mainPromise).toBe(true)
})
it('Should client can connect even if a response has difference', async () => {
app.use(async (c, next) => {
c.res = new Response(null, c.res)
await next()
})
const mainPromise = new Promise<boolean>((resolve) =>
app.get(
'/',
upgradeWebSocket(() => ({
onOpen() {
resolve(true)
},
}))
)
)
new WebSocket('ws://localhost:3030/')
expect(await mainPromise).toBe(true)
})
}) })

View File

@ -23,6 +23,11 @@ export interface NodeWebSocketInit {
baseUrl?: string | URL baseUrl?: string | URL
} }
const generateConnectionSymbol = () => Symbol('connection')
/** @example `c.env[CONNECTION_SYMBOL_KEY]` */
const CONNECTION_SYMBOL_KEY: unique symbol = Symbol('CONNECTION_SYMBOL_KEY')
/** /**
* Create WebSockets for Node.js * Create WebSockets for Node.js
* @param init Options * @param init Options
@ -32,7 +37,7 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
const wss = new WebSocketServer({ noServer: true }) const wss = new WebSocketServer({ noServer: true })
const waiterMap = new Map< const waiterMap = new Map<
IncomingMessage, IncomingMessage,
{ resolve: (ws: WebSocket) => void; response: Response } { resolve: (ws: WebSocket) => void; connectionSymbol: symbol }
>() >()
wss.on('connection', (ws, request) => { wss.on('connection', (ws, request) => {
@ -43,9 +48,9 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
} }
}) })
const nodeUpgradeWebSocket = (request: IncomingMessage, response: Response) => { const nodeUpgradeWebSocket = (request: IncomingMessage, connectionSymbol: symbol) => {
return new Promise<WebSocket>((resolve) => { return new Promise<WebSocket>((resolve) => {
waiterMap.set(request, { resolve, response }) waiterMap.set(request, { resolve, connectionSymbol })
}) })
} }
@ -62,14 +67,18 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
headers.append(key, Array.isArray(value) ? value[0] : value) headers.append(key, Array.isArray(value) ? value[0] : value)
} }
const response = await init.app.request( const env: {
url, incoming: IncomingMessage
{ headers: headers }, outgoing: undefined
{ incoming: request, outgoing: undefined } [CONNECTION_SYMBOL_KEY]?: symbol
) } = {
incoming: request,
outgoing: undefined,
}
await init.app.request(url, { headers: headers }, env)
const waiter = waiterMap.get(request) const waiter = waiterMap.get(request)
if (!waiter || waiter.response !== response) {
if (!waiter || waiter.connectionSymbol !== env[CONNECTION_SYMBOL_KEY]) {
socket.end( socket.end(
'HTTP/1.1 400 Bad Request\r\n' + 'HTTP/1.1 400 Bad Request\r\n' +
'Connection: close\r\n' + 'Connection: close\r\n' +
@ -93,9 +102,10 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
return return
} }
const response = new Response() const connectionSymbol = generateConnectionSymbol()
c.env[CONNECTION_SYMBOL_KEY] = connectionSymbol
;(async () => { ;(async () => {
const ws = await nodeUpgradeWebSocket(c.env.incoming, response) const ws = await nodeUpgradeWebSocket(c.env.incoming, connectionSymbol)
let events: WSEvents<WebSocket> let events: WSEvents<WebSocket>
try { try {
events = await createEvents(c) events = await createEvents(c)
@ -167,7 +177,7 @@ export const createNodeWebSocket = (init: NodeWebSocketInit): NodeWebSocket => {
}) })
})() })()
return response return new Response()
}, },
} }
} }

View File

@ -546,8 +546,8 @@ export class OpenAPIHono<
this.on( this.on(
[route.method], [route.method],
route.path.replaceAll(/\/{(.+?)}/g, '/:$1'), route.path.replaceAll(/\/{(.+?)}/g, '/:$1'),
...middleware,
...validators, ...validators,
...middleware,
handler handler
) )
return this return this