fix: store all handshake details on the socket object

Related: #5

Author: darrachequesne

lib/server.ts

@@ -235,7 +235,7 @@ export class Server extends EventEmitter<
 
       return (socket.transport as Polling).onRequest(req, responseHeaders);
     } else {
-      return this.handshake(req, server, responseHeaders);
+      return this.handshake(req, server, url, responseHeaders);
     }
   }
 
@@ -327,12 +327,14 @@ export class Server extends EventEmitter<
    *
    * @param req
    * @param server
+   * @param url
    * @param responseHeaders
    * @private
    */
   private async handshake(
     req: Request,
     server: Bun.Server<WebSocketData>,
+    url: URL,
     responseHeaders: Headers,
   ): Promise<Response> {
     const id = generateId();
@@ -362,7 +364,15 @@ export class Server extends EventEmitter<
 
     debug(`new socket ${id}`);
 
-    const socket = new Socket(id, this.opts, transport, req);
+    const socket = new Socket(id, this.opts, transport, {
+      url: req.url,
+      headers: Object.fromEntries(req.headers.entries()),
+      _query: Object.fromEntries(url.searchParams.entries()),
+      connection: {
+        encrypted: ["https", "wss"].includes(url.protocol),
+      },
+    });
+
     this.clients.set(id, socket);
 
     socket.once("close", (reason) => {

lib/socket.ts

@@ -10,6 +10,17 @@ type ReadyState = "opening" | "open" | "closing" | "closed";
 
 type UpgradeState = "not_upgraded" | "upgrading" | "upgraded";
 
+// this is the format expected by the `socket.io` library
+// see https://github.com/socketio/socket.io/blob/cf6816afcff25c227b14ae6981e421bcad5af331/packages/socket.io/lib/socket.ts#L201-L215
+export interface HandshakeRequestReference {
+  url: string;
+  headers: Record<string, string>;
+  _query: Record<string, string>;
+  connection: {
+    encrypted: boolean;
+  };
+}
+
 export type CloseReason =
   | "transport error"
   | "transport close"
@@ -40,7 +51,7 @@ export class Socket extends EventEmitter<
   public readonly id: string;
   public readyState: ReadyState = "opening";
   public transport: Transport;
-  public readonly request;
+  public readonly request: HandshakeRequestReference;
 
   private readonly opts: ServerOptions;
   private upgradeState: UpgradeState = "not_upgraded";
@@ -55,7 +66,7 @@ export class Socket extends EventEmitter<
     id: string,
     opts: ServerOptions,
     transport: Transport,
-    req: Request,
+    req: HandshakeRequestReference,
   ) {
     super();
 
@@ -65,12 +76,7 @@ export class Socket extends EventEmitter<
     this.transport = transport;
     this.bindTransport(transport);
 
-    // we store the headers of the handshake request, so that they are available in the `socket.handshake` attribute in
-    // the `socket.io` library
-    this.request = {
-      headers: Object.fromEntries(req.headers.entries()),
-      connection: {},
-    };
+    this.request = req;
 
     this.onOpen();
   }

test/socket.test.ts

@@ -38,6 +38,10 @@ function setup() {
 
   io.on("connection", (socket) => {
     expect(socket.handshake.headers).toContainKey("host");
+    expect(socket.handshake.query.EIO).toEqual("4");
+    expect(socket.handshake.url).toStartWith(
+      "http://localhost:3001/socket.io/?EIO=4",
+    );
 
     socket.emit("auth", socket.handshake.auth);