feat: update to Bun v1.3

References:

- https://bun.com/blog/bun-v1.3
- https://bun.sh/docs/api/websockets#contextual-data

Related: #7

Author: darrachequesne

.github/workflows/ci.yml

@@ -13,25 +13,35 @@ permissions:
 
 jobs:
   test-bun:
+    name: Test with Bun ${{ matrix.bun-version }}
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
     strategy:
       fail-fast: false
+      matrix:
+        bun-version:
+          - 1.2
+          - 1.3
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
       - name: Install Bun
         uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: ${{ matrix.bun-version }}
 
       - name: Install dependencies
         run: bun install
 
       - name: Check format
         run: bun run format:check
 
+      - name: Compile project
+        run: bun compile
+
       - name: Run tests
         run: bun test
 

bun.lock

@@ -1,3 +1,3 @@
 export { Server, type ServerOptions } from "./server";
 export { type RawData } from "./parser";
-export { type BunWebSocket } from "./transports/websocket";
+export { type BunWebSocket, type WebSocketData } from "./transports/websocket";

lib/index.ts

@@ -1,7 +1,11 @@
 import { EventEmitter } from "./event-emitter";
 import { Socket } from "./socket";
 import { Polling } from "./transports/polling";
-import { WS, type BunWebSocket } from "./transports/websocket";
+import {
+  WS,
+  type BunWebSocket,
+  type WebSocketData,
+} from "./transports/websocket";
 import { addCorsHeaders, type CorsOptions } from "./cors";
 import { Transport } from "./transport";
 import { generateId } from "./util";
@@ -42,7 +46,10 @@ export interface ServerOptions {
    * A function that receives a given handshake or upgrade request as its first parameter,
    * and can decide whether to continue or not.
    */
-  allowRequest?: (req: Request, server: Bun.Server) => Promise<void>;
+  allowRequest?: (
+    req: Request,
+    server: Bun.Server<WebSocketData>,
+  ) => Promise<void>;
   /**
    * The options related to Cross-Origin Resource Sharing (CORS)
    */
@@ -53,15 +60,15 @@ export interface ServerOptions {
   editHandshakeHeaders?: (
     responseHeaders: Headers,
     req: Request,
-    server: Bun.Server,
+    server: Bun.Server<WebSocketData>,
   ) => void | Promise<void>;
   /**
    * A function that allows to edit the response headers of all requests
    */
   editResponseHeaders?: (
     responseHeaders: Headers,
     req: Request,
-    server: Bun.Server,
+    server: Bun.Server<WebSocketData>,
   ) => void | Promise<void>;
 }
 
@@ -73,7 +80,11 @@ interface ConnectionError {
 }
 
 interface ServerReservedEvents {
-  connection: (socket: Socket, request: Request, server: Bun.Server) => void;
+  connection: (
+    socket: Socket,
+    request: Request,
+    server: Bun.Server<WebSocketData>,
+  ) => void;
   connection_error: (err: ConnectionError) => void;
 }
 
@@ -127,7 +138,7 @@ export class Server extends EventEmitter<
    */
   public async handleRequest(
     req: Request,
-    server: Bun.Server,
+    server: Bun.Server<WebSocketData>,
   ): Promise<Response> {
     const url = new URL(req.url);
 
@@ -321,7 +332,7 @@ export class Server extends EventEmitter<
    */
   private async handshake(
     req: Request,
-    server: Bun.Server,
+    server: Bun.Server<WebSocketData>,
     responseHeaders: Headers,
   ): Promise<Response> {
     const id = generateId();
@@ -338,7 +349,7 @@ export class Server extends EventEmitter<
       const isSuccess = server.upgrade(req, {
         headers: responseHeaders,
         data: {
-          transport,
+          transport: transport as WS,
         },
       });
 
@@ -415,7 +426,7 @@ export class Server extends EventEmitter<
     const idleTimeoutInSeconds = Math.ceil((2 * this.opts.pingInterval) / 1000);
 
     return {
-      fetch: (req: Request, server: Bun.Server) => {
+      fetch: (req: Request, server: Bun.Server<WebSocketData>) => {
         const url = new URL(req.url);
 
         if (url.pathname === this.opts.path) {

lib/server.ts

@@ -4,9 +4,11 @@ import { debuglog } from "node:util";
 
 const debug = debuglog("engine.io:websocket");
 
-export type BunWebSocket = Bun.ServerWebSocket<{
+export type WebSocketData = {
   transport: WS;
-}>;
+};
+
+export type BunWebSocket = Bun.ServerWebSocket<WebSocketData>;
 
 export class WS extends Transport {
   private socket?: BunWebSocket;

lib/transports/websocket.ts

@@ -13,7 +13,7 @@
     "format:fix": "prettier --write \"lib/**/*.ts\" \"test/**/*.ts\""
   },
   "devDependencies": {
-    "@types/bun": "^1.2.20",
+    "@types/bun": "^1.3.0",
     "hono": "^4.9.8",
     "prettier": "^3.6.2",
     "socket.io": "^4.8.1"

package.json

@@ -1,5 +1,10 @@
 import { describe, it, expect, beforeAll } from "bun:test";
-import { Server, type BunWebSocket, type RawData } from "../lib";
+import {
+  Server,
+  type BunWebSocket,
+  type WebSocketData,
+  type RawData,
+} from "../lib";
 import { createWebSocket, waitFor, sleep } from "./util";
 import { Hono } from "hono";
 import { logger } from "hono/logger";
@@ -36,7 +41,7 @@ function setup() {
 
     app.all("/engine.io/", async (c) => {
       const request = c.req.raw;
-      const server = c.env as Bun.Server;
+      const server = c.env as Bun.Server<WebSocketData>;
       return engine.handleRequest(request, server);
     });
 
@@ -56,6 +61,8 @@ function setup() {
       },
 
       websocket: {
+        data: {} as WebSocketData,
+
         open(ws: BunWebSocket) {
           engine.onWebSocketOpen(ws);
         },