fix: expose raw WebSocketServer reference under wss.raw

src/http.ts

@@ -50,6 +50,16 @@ export const kServer = Symbol('kServer')
 export const kServers = Symbol('kServers')
 export const kEmitter = Symbol('kEmitter')
 
+/**
+ * Create a disposable HTTP server.
+ *
+ * @example
+ * await using server = await createTestHttpServer({
+ *   defineRoutes(router) {
+ *     router.get('/resource', () => new Response('Hello world!'))
+ *   }
+ * })
+ */
 export async function createTestHttpServer(
   options?: TestHttpServerOptions,
 ): Promise<TestHttpServer> {

src/ws.ts

@@ -40,6 +40,13 @@ export interface TestWebSocketServerOptions {
   pathname?: string
 }
 
+/**
+ * Attach a disposable WebSocket middleware to the given HTTP test server.
+ *
+ * @example
+ * await using server = await createTestHttpServer()
+ * await using wss = createWebSocketMiddleware({ server })
+ */
 export function createWebSocketMiddleware(options: TestWebSocketServerOptions) {
   const emitter: EventEmitter = Reflect.get(options.server, kEmitter)
   const pathname = options.pathname ?? `/ws/${randomUUID()}`
@@ -75,7 +82,7 @@ export function createWebSocketMiddleware(options: TestWebSocketServerOptions) {
 
   // First, see if the test server already has server instances running.
   // E.g. when calling this middleware inside of a test.
-  const servers = Reflect.get(options.server, kServers) as Array<ServerType>
+  const servers: Array<ServerType> = Reflect.get(options.server, kServers)
   servers.forEach((server) => {
     addUpgradeListener(server)
   })
@@ -91,6 +98,7 @@ export function createWebSocketMiddleware(options: TestWebSocketServerOptions) {
       await this.close()
     },
 
+    raw: wss,
     on: wss.on.bind(wss),
     once: wss.once.bind(wss),
     off: wss.off.bind(wss),

tests/ws.test.ts

@@ -1,6 +1,7 @@
 import { WebSocket } from 'undici'
 import { createTestHttpServer } from '../src/http.js'
 import { createWebSocketMiddleware } from '../src/ws.js'
+import { WebSocketServer } from 'ws'
 
 it('returns correct WebSocket URL', async () => {
   await using server = await createTestHttpServer()
@@ -103,3 +104,10 @@ it('disconnects all clients when closing the server', async () => {
   expect(firstClient.readyState).toBe(WebSocket.CLOSED)
   expect(secondClient.readyState).toBe(WebSocket.CLOSED)
 })
+
+it('exposes the raw WebSocket server reference under `wss.raw`', async () => {
+  await using server = await createTestHttpServer()
+  await using wss = createWebSocketMiddleware({ server })
+
+  expect(wss.raw).toBeInstanceOf(WebSocketServer)
+})