|
| 1 | +import { serve } from '@hono/node-server' |
| 2 | +import type { ServerType } from '@hono/node-server' |
| 3 | +// eslint-disable-next-line @typescript-eslint/ban-ts-comment |
| 4 | +// @ts-ignore @hono/node-ws may not be typed |
| 5 | +import { createNodeWebSocket } from '@hono/node-ws' |
| 6 | +import { RpcTarget, newWebSocketRpcSession } from 'capnweb' |
| 7 | +import { Hono } from 'hono' |
| 8 | +import { WebSocket } from 'ws' |
| 9 | +import { newRpcResponse } from './index' |
| 10 | + |
| 11 | +class MyApiServer extends RpcTarget { |
| 12 | + hello(name: string) { |
| 13 | + return `Hello, ${name}!` |
| 14 | + } |
| 15 | + |
| 16 | + throwError() { |
| 17 | + throw new Error('Test error') |
| 18 | + } |
| 19 | +} |
| 20 | + |
| 21 | +describe("Cap'n Web middleware - Node.js", () => { |
| 22 | + let app: Hono |
| 23 | + let server: ServerType |
| 24 | + let port: number |
| 25 | + let upgradeWebSocket: ReturnType<typeof createNodeWebSocket>['upgradeWebSocket'] |
| 26 | + |
| 27 | + beforeEach(async () => { |
| 28 | + app = new Hono() |
| 29 | + |
| 30 | + const { injectWebSocket, upgradeWebSocket: upgrade } = createNodeWebSocket({ app }) |
| 31 | + upgradeWebSocket = upgrade |
| 32 | + |
| 33 | + app.all('/api', (c) => { |
| 34 | + return newRpcResponse(c, new MyApiServer(), { upgradeWebSocket }) |
| 35 | + }) |
| 36 | + |
| 37 | + app.all('/no-upgrade', (c) => { |
| 38 | + return newRpcResponse(c, new MyApiServer()) |
| 39 | + }) |
| 40 | + |
| 41 | + server = await new Promise<ServerType>((resolve) => { |
| 42 | + const srv = serve({ fetch: app.fetch, port: 0 }, () => { |
| 43 | + resolve(srv) |
| 44 | + }) |
| 45 | + }) |
| 46 | + |
| 47 | + injectWebSocket(server) |
| 48 | + const address = server.address() |
| 49 | + port = typeof address === 'object' && address ? address.port : 0 |
| 50 | + }) |
| 51 | + |
| 52 | + afterEach(() => { |
| 53 | + server?.close() |
| 54 | + }) |
| 55 | + |
| 56 | + it('can accept WebSocket RPC connections in Node.js', async () => { |
| 57 | + const ws = new WebSocket(`ws://localhost:${port}/api`) |
| 58 | + |
| 59 | + await new Promise<void>((resolve, reject) => { |
| 60 | + ws.on('open', resolve) |
| 61 | + ws.on('error', reject) |
| 62 | + }) |
| 63 | + |
| 64 | + const cap = newWebSocketRpcSession<MyApiServer>(ws as any) |
| 65 | + expect(await cap.hello('Node.js')).toBe('Hello, Node.js!') |
| 66 | + ws.close() |
| 67 | + }) |
| 68 | + |
| 69 | + it('should return 400 when WebSocket upgrade requested without upgradeWebSocket option', async () => { |
| 70 | + const response = await fetch(`http://localhost:${port}/no-upgrade`, { |
| 71 | + method: 'POST', |
| 72 | + headers: { |
| 73 | + 'Content-Type': 'application/json', |
| 74 | + }, |
| 75 | + body: JSON.stringify({ test: 'data' }), |
| 76 | + }) |
| 77 | + expect(response.status).not.toBe(400) |
| 78 | + }) |
| 79 | + |
| 80 | + it('should return 400 when WebSocket upgrade is requested without upgradeWebSocket', async () => { |
| 81 | + const ws = new WebSocket(`ws://localhost:${port}/no-upgrade`) |
| 82 | + |
| 83 | + await new Promise<void>((resolve, reject) => { |
| 84 | + ws.on('error', () => { |
| 85 | + // WebSocket connection will fail with 400, which is expected |
| 86 | + ws.close() |
| 87 | + resolve() |
| 88 | + }) |
| 89 | + |
| 90 | + ws.on('open', () => { |
| 91 | + // Should not reach here |
| 92 | + ws.close() |
| 93 | + reject(new Error('WebSocket connection should not succeed')) |
| 94 | + }) |
| 95 | + }) |
| 96 | + }) |
| 97 | + |
| 98 | + it('should handle WebSocket close event', async () => { |
| 99 | + const ws = new WebSocket(`ws://localhost:${port}/api`) |
| 100 | + |
| 101 | + await new Promise<void>((resolve, reject) => { |
| 102 | + let opened = false |
| 103 | + |
| 104 | + ws.on('open', () => { |
| 105 | + opened = true |
| 106 | + // Close the connection immediately |
| 107 | + ws.close() |
| 108 | + }) |
| 109 | + |
| 110 | + ws.on('close', (code) => { |
| 111 | + // Close event should be triggered |
| 112 | + expect(opened).toBe(true) |
| 113 | + expect(code).toBeDefined() |
| 114 | + resolve() |
| 115 | + }) |
| 116 | + |
| 117 | + ws.on('error', (error) => { |
| 118 | + reject(error) |
| 119 | + }) |
| 120 | + }) |
| 121 | + }) |
| 122 | + |
| 123 | + it('should handle RPC method errors', async () => { |
| 124 | + const ws = new WebSocket(`ws://localhost:${port}/api`) |
| 125 | + |
| 126 | + await new Promise<void>((resolve, reject) => { |
| 127 | + ws.on('open', async () => { |
| 128 | + const cap = newWebSocketRpcSession<MyApiServer>(ws as any) |
| 129 | + try { |
| 130 | + await cap.throwError() |
| 131 | + reject(new Error('Should have thrown an error')) |
| 132 | + } catch (error) { |
| 133 | + // Error from RPC method should be caught |
| 134 | + expect(error).toBeDefined() |
| 135 | + expect((error as Error).message).toContain('Test error') |
| 136 | + ws.close() |
| 137 | + resolve() |
| 138 | + } |
| 139 | + }) |
| 140 | + |
| 141 | + ws.on('error', (error) => { |
| 142 | + reject(error) |
| 143 | + }) |
| 144 | + }) |
| 145 | + }) |
| 146 | +}) |
0 commit comments