test(workerd): add tests for WebSocket

package.json

@@ -594,6 +594,7 @@
     "vite-plugin-fastly-js-compute": "^0.4.2",
     "vitest": "^1.2.2",
     "wrangler": "^3.58.0",
+    "ws": "^8.17.0",
     "zod": "^3.20.2"
   },
   "engines": {

runtime_tests/workerd/index.test.ts

@@ -1,5 +1,6 @@
 import { unstable_dev } from 'wrangler'
 import type { UnstableDevWorker } from 'wrangler'
+import { WebSocket } from 'ws'
 
 describe('workerd', () => {
   let worker: UnstableDevWorker
@@ -29,3 +30,40 @@ describe('workerd', () => {
     expect(await res.text()).toBe('Hono')
   })
 })
+
+describe('workerd with WebSocket', () => {
+  // worker.fetch does not support WebSocket:
+  // https://github.com/cloudflare/workers-sdk/issues/4573#issuecomment-1850420973
+  it('Should handle the WebSocket connection correctly', async () => {
+    const worker = await unstable_dev('./runtime_tests/workerd/index.ts', {
+      experimental: { disableExperimentalWarning: true },
+    })
+    const ws = new WebSocket(`ws://${worker.address}:${worker.port}/ws`)
+
+    const openHandler = vi.fn()
+    const messageHandler = vi.fn()
+    const closeHandler = vi.fn()
+
+    const waitForOpen = new Promise((resolve) => {
+      ws.addEventListener('open', () => {
+        openHandler()
+        ws.send('Hello')
+        resolve(undefined)
+      })
+      ws.addEventListener('close', async () => {
+        closeHandler()
+      })
+      ws.addEventListener('message', async (event) => {
+        messageHandler(event.data)
+        ws.close()
+      })
+    })
+
+    await waitForOpen
+    await worker.stop()
+
+    expect(openHandler).toHaveBeenCalled()
+    expect(messageHandler).toHaveBeenCalledWith('Hello')
+    expect(closeHandler).toHaveBeenCalled()
+  })
+})

runtime_tests/workerd/index.ts

@@ -1,4 +1,5 @@
 import { env, getRuntimeKey } from '../../src/helper/adapter'
+import { upgradeWebSocket } from '../../src/adapter/cloudflare-workers'
 import { Hono } from '../../src/hono'
 
 const app = new Hono()
@@ -10,4 +11,15 @@ app.get('/env', (c) => {
   return c.text(NAME)
 })
 
+app.get(
+  '/ws',
+  upgradeWebSocket(() => {
+    return {
+      onMessage(event, ws) {
+        ws.send(event.data as string)
+      },
+    }
+  })
+)
+
 export default app

yarn.lock

@@ -1,6 +1,6 @@
 # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 # yarn lockfile v1
-# bun ./bun.lockb --hash: BAD784DA2D3E8912-7bb272adaca1c26f-B77747473A8BC735-f20e673ef1d530e3
+# bun ./bun.lockb --hash: 733DAF3BDF9F84ED-89e11d5f0e9dc6ef-7974BC9F6F5A02AD-41e5e99e9db5457f
 
 
 "@aashutoshrathi/word-wrap@^1.2.3":
@@ -6105,6 +6105,11 @@ ws@^8.11.0, ws@^8.13.0:
   resolved "https://registry.npmjs.org/ws/-/ws-8.16.0.tgz"
   integrity sha512-HS0c//TP7Ina87TfiPUz1rQzMhHrl/SG2guqRcTOIUYD2q8uhUdNHZYJUaQ8aTGPzCh+c6oawMKW35nFl1dxyQ==
 
+ws@^8.17.0:
+  version "8.17.0"
+  resolved "https://registry.npmjs.org/ws/-/ws-8.17.0.tgz"
+  integrity sha512-uJq6108EgZMAl20KagGkzCKfMEjxmKvZHG7Tlq0Z6nOky7YF7aq4mOx6xK8TJ/i1LeK4Qus7INktacctDgY8Ow==
+
 xdg-basedir@^4.0.0:
   version "4.0.0"
   resolved "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz"