refactor: update to Bun 1.3

Author: darrachequesne

.github/workflows/ci.yml

@@ -18,13 +18,19 @@ jobs:
 
     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

bun.lock

@@ -4,7 +4,7 @@
     "": {
       "name": "@socket.io/bun-engine",
       "devDependencies": {
-        "@types/bun": "^1.2.20",
+        "@types/bun": "^1.3.0",
         "hono": "^4.9.8",
         "prettier": "^3.6.2",
         "socket.io": "^4.8.1",
@@ -17,7 +17,7 @@
   "packages": {
     "@socket.io/component-emitter": ["@socket.io/[email protected]", "", {}, "sha512-9BCxFwvbGg/RsZK9tjXd8s4UcwR0MWeFQ1XEKIQVVvAGJyINdrqKMcTRyLoK8Rse1GjzLV9cwjWV1olXRWEXVA=="],
 
-    "@types/bun": ["@types/bun@1.2.20", "", { "dependencies": { "bun-types": "1.2.20" } }, "sha512-dX3RGzQ8+KgmMw7CsW4xT5ITBSCrSbfHc36SNT31EOUg/LA9JWq0VDdEXDRSe1InVWpd2yLUM1FUF/kEOyTzYA=="],
+    "@types/bun": ["@types/bun@1.3.0", "", { "dependencies": { "bun-types": "1.3.0" } }, "sha512-+lAGCYjXjip2qY375xX/scJeVRmZ5cY0wyHYyCYxNcdEXrQ4AOe3gACgd4iQ8ksOslJtW4VNxBJ8llUwc3a6AA=="],
 
     "@types/cors": ["@types/[email protected]", "", { "dependencies": { "@types/node": "*" } }, "sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg=="],
 
@@ -29,7 +29,7 @@
 
     "base64id": ["[email protected]", "", {}, "sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog=="],
 
-    "bun-types": ["bun-types@1.2.20", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-pxTnQYOrKvdOwyiyd/7sMt9yFOenN004Y6O4lCcCUoKVej48FS5cvTw9geRaEcB9TsDZaJKAxPTVvi8tFsVuXA=="],
+    "bun-types": ["bun-types@1.3.0", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-u8X0thhx+yJ0KmkxuEo9HAtdfgCBaM/aI9K90VQcQioAmkVp3SG3FkwWGibUFz3WdXAdcsqOcbU40lK7tbHdkQ=="],
 
     "cookie": ["[email protected]", "", {}, "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w=="],
 

lib/server.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/transports/websocket.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;

package.json

@@ -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"