@rvncom/socket-bun-engine 1.0.0 → 1.0.1

package/README.md

@@ -1,5 +1,8 @@
 # @rvncom/socket-bun-engine
 
+[![npm version](https://img.shields.io/npm/v/@rvncom/socket-bun-engine.svg)](https://www.npmjs.com/package/@rvncom/socket-bun-engine)
+[![npm downloads](https://img.shields.io/npm/dm/@rvncom/socket-bun-engine.svg)](https://www.npmjs.com/package/@rvncom/socket-bun-engine)
+
 Engine.IO server implementation for the Bun runtime. Provides native WebSocket and HTTP long-polling transports for [Socket.IO](https://socket.io/).
 
 Fork of `@socket.io/bun-engine` with bug fixes, improved API, and active maintenance.
@@ -7,13 +10,13 @@ Fork of `@socket.io/bun-engine` with bug fixes, improved API, and active mainten
 ## Installation
 
 ```bash
-bun add @rvn/bun-engine
+bun add @rvncom/socket-bun-engine
 ```
 
 ## Usage
 
 ```ts
-import { Server as Engine } from "@rvn/bun-engine";
+import { Server as Engine } from "@rvncom/socket-bun-engine";
 import { Server } from "socket.io";
 
 const engine = new Engine({

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,3 +1,4 @@
 export { Server } from "./server";
+export { Socket } from "./socket";
 export {} from "./parser";
 export {} from "./transports/websocket";

package/dist/server.d.ts

@@ -73,7 +73,7 @@ export declare class Server extends EventEmitter<Record<never, never>, Record<ne
      * @param req
      * @param server
      */
-    handleRequest(req: Request, server: Bun.Server<WebSocketData>): Promise<Response>;
+    handleRequest(req: Request, server: Bun.Server<WebSocketData>, _url?: URL): Promise<Response>;
     onWebSocketOpen(ws: BunWebSocket): void;
     onWebSocketMessage(ws: BunWebSocket, message: RawData): void;
     onWebSocketClose(ws: BunWebSocket, code: number, message: string): void;
@@ -96,9 +96,17 @@ export declare class Server extends EventEmitter<Record<never, never>, Record<ne
      */
     private handshake;
     /**
-     * Closes all clients.
+     * Returns an iterator over all connected sockets.
      */
-    close(): void;
+    get sockets(): IterableIterator<Socket>;
+    /**
+     * Returns the socket with the given id, if any.
+     */
+    getSocket(id: string): Socket | undefined;
+    /**
+     * Closes all clients and returns a Promise that resolves when all are closed.
+     */
+    close(): Promise<void>;
     /**
      * Creates a request handler.
      *

package/dist/server.js

@@ -48,8 +48,8 @@ export class Server extends EventEmitter {
      * @param req
      * @param server
      */
-    async handleRequest(req, server) {
-        const url = new URL(req.url);
+    async handleRequest(req, server, _url) {
+        const url = _url ?? new URL(req.url);
         debug(`handling ${req.method} ${req.url}`);
         const responseHeaders = new Headers();
         if (this.opts.cors) {
@@ -279,11 +279,37 @@ export class Server extends EventEmitter {
         return promise;
     }
     /**
-     * Closes all clients.
+     * Returns an iterator over all connected sockets.
+     */
+    get sockets() {
+        return this.clients.values();
+    }
+    /**
+     * Returns the socket with the given id, if any.
+     */
+    getSocket(id) {
+        return this.clients.get(id);
+    }
+    /**
+     * Closes all clients and returns a Promise that resolves when all are closed.
      */
     close() {
         debug("closing all open clients");
-        this.clients.forEach((client) => client.close());
+        if (this.clients.size === 0) {
+            return Promise.resolve();
+        }
+        return new Promise((resolve) => {
+            let remaining = this.clients.size;
+            const onClose = () => {
+                if (--remaining === 0) {
+                    resolve();
+                }
+            };
+            this.clients.forEach((client) => {
+                client.once("close", onClose);
+                client.close();
+            });
+        });
     }
     /**
      * Creates a request handler.
@@ -323,7 +349,7 @@ export class Server extends EventEmitter {
             fetch: (req, server) => {
                 const url = new URL(req.url);
                 if (url.pathname === this.opts.path) {
-                    return this.handleRequest(req, server);
+                    return this.handleRequest(req, server, url);
                 }
                 else {
                     return new Response(null, { status: 404 });

package/dist/transports/websocket.js

@@ -11,13 +11,19 @@ export class WS extends Transport {
         return [];
     }
     send(packets) {
-        for (const packet of packets) {
-            const data = Parser.encodePacket(packet, true);
-            if (this.writable && this.socket?.readyState === WebSocket.OPEN) {
-                // TODO use ws.cork() once https://github.com/oven-sh/bun/issues/21588 is resolved
-                this.socket.send(data);
-            }
+        if (!this.writable || !this.socket || this.socket.readyState !== WebSocket.OPEN) {
+            return;
+        }
+        if (packets.length === 1) {
+            this.socket.send(Parser.encodePacket(packets[0], true));
+            return;
         }
+        // Batch multiple packets into a single syscall via cork()
+        this.socket.cork(() => {
+            for (const packet of packets) {
+                this.socket.send(Parser.encodePacket(packet, true));
+            }
+        });
     }
     doClose() {
         this.socket?.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rvncom/socket-bun-engine",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Engine.IO server implementation for Bun runtime",
   "type": "module",
   "main": "./dist/index.js",
@@ -32,5 +32,10 @@
   "peerDependencies": {
     "typescript": "^5"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "homepage": "https://github.com/rvncom/socket-bun-engine#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rvncom/socket-bun-engine.git"
+  }
 }