Merge pull request #13 from AnujPanthri/server_new_id

server/package-lock.json

@@ -10,6 +10,7 @@
       "license": "ISC",
       "dependencies": {
         "@types/ws": "^8.5.9",
+        "base-x": "^4.0.0",
         "express": "^4.18.2",
         "pino": "^8.16.2",
         "ws": "^8.14.2",
@@ -341,6 +342,11 @@
       "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
       "dev": true
     },
+    "node_modules/base-x": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/base-x/-/base-x-4.0.0.tgz",
+      "integrity": "sha512-FuwxlW4H5kh37X/oW59pwTzzTKRzfrrQwhmyspRM7swOEZcHtDZSCt45U6oKgtuFE+WYPblePMVIPR4RZrh/hw=="
+    },
     "node_modules/base64-js": {
       "version": "1.5.1",
       "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",

server/package.json

@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "@types/ws": "^8.5.9",
+    "base-x": "^4.0.0",
     "express": "^4.18.2",
     "pino": "^8.16.2",
     "ws": "^8.14.2",

server/src/helpers.ts

@@ -1,7 +1,15 @@
 import * as crypto from "crypto";
+import basex from "base-x";
 
 export function generateSessionToken(length: number): string {
-    if (length < 1) throw new Error("invalid length. length must be greater than 0")
-    return crypto.randomBytes(length).toString("hex");
-}
+    if (length < 1) throw new Error("invalid length. length must be greater than 0");
+    const base31Tokens = "ABCDEFGHJKMNPQRSTUVWXYZ23456789";
+    const base31 = basex(base31Tokens);
+
+    const byteLength = Math.ceil((length * Math.log(256)) / Math.log(base31Tokens.length)) + 2;
 
+    const buffer = crypto.randomBytes(Math.ceil(byteLength));
+    const token = base31.encode(buffer);
+
+    return token.substring(0, length);
+}

server/src/socket/hapticLinkServer.ts

@@ -12,13 +12,14 @@ export interface Route<T> {
 }
 
 export class User {
+    static userIdLength: number = 32
     id: string;
     username?: string;
     socket: WebSocketInterface;
     currentRoom?: Room;
 
     constructor(socket: WebSocketInterface) {
-        this.id = generateSessionToken(16);
+        this.id = generateSessionToken(32);
         this.socket = socket;
     }
 }

server/src/socket/room.ts

@@ -9,10 +9,11 @@ export interface UserData {
 }
 
 export class Room {
+    static roomIdLength: number = 6;
     id: string;
     users: User[];
     constructor(roomId?: string) {
-        this.id = roomId || generateSessionToken(16);
+        this.id = roomId || generateSessionToken(Room.roomIdLength);
         this.users = [];
     }
 

server/src/socket/routes/join_room.ts

@@ -1,6 +1,5 @@
 import { z } from "zod";
-import { Context, Route } from "../hapticLinkServer";
-import { generateSessionToken } from "../../helpers";
+import { Context } from "../hapticLinkServer";
 import { Room } from "../room";
 
 export interface JoinRoomPayload {
@@ -18,17 +17,26 @@ export function JoinRoomHandler(ctx: Context<JoinRoomPayload>) {
         ctx.user.username = ctx.payload.username;
     }
 
+    if (ctx.payload.roomId) ctx.payload.roomId = ctx.payload.roomId.toUpperCase();
+
     let room: Room;
 
     if (ctx.payload.roomId && !ctx.server.rooms[ctx.payload.roomId]) {
         // User sent roomId, but room doesn't exist
-        room = new Room(ctx.payload.roomId);
-        ctx.server.rooms[room.id] = room;
+        return ctx.ws.send(JSON.stringify({
+            "message": "join_room_response",
+            "status": "room doesn't exist",
+        }))
+        // Custom ID Code:
+        // room = new Room(ctx.payload.roomId);
+        // room.id = room.id.toUpperCase();
+        // ctx.server.rooms[room.id] = room;
 
     } else if (!ctx.payload.roomId) {
         // Didn't include RoomID, creating new one
-        ctx.payload.roomId = generateSessionToken(12);
         room = new Room(ctx.payload.roomId);
+        room.id = room.id.toUpperCase();
+        ctx.payload.roomId = room.id;
         ctx.server.rooms[room.id] = room;
 
     } else {

server/test/helpers.spec.ts

@@ -8,12 +8,12 @@ describe('Helpers', () => {
 
     // Since the token is hexadecimal, its string length should be twice the byte length
     expect(token).to.be.a('string');
-    expect(token.length).to.equal(length * 2);
+    expect(token.length).to.equal(length);
   });
 
   it('should generate a unique token each time', () => {
     const tokens = new Set<string>();
-    const tokenCount = 100; // Generate a number of tokens to test uniqueness
+    const tokenCount = 1000; // Generate a number of tokens to test uniqueness
     const length = 16;
 
     for (let i = 0; i < tokenCount; i++) {

server/test/socket/routes/join_room.spec.ts

@@ -43,6 +43,16 @@ describe("Join Room", () => {
     expect(ctx.payload.roomId!).to.satisfy((id: string) => id.length > 3, "room id not generated");
     expect(user.username).to.equal("test", "didn't set username");
   });
+  
+  it("should fail to join not existant room", () => {
+    ctx.payload.roomId = "testid"
+    JoinRoomHandler(ctx);
+    const resData = (ws.sendData as string);
+    const res = JSON.parse(resData);
+    expect(res.message).to.eq("join_room_response", "didn't get server response");
+    const roomNowExists = server.rooms["testid"]
+    expect(roomNowExists).to.equal(undefined, "server allowed to join non-existant room");
+  });
 
   it("should join existing room", () => {
     testJoinRoom(1); // Initial user joins and creates room
@@ -58,4 +68,16 @@ describe("Join Room", () => {
     JoinRoomHandler(ctx);
     expect(server.rooms[ctx.payload.roomId!].users.length).to.equal(2, "user joined twice");
   });
+
+  it("should have case insensitive IDs", () => {
+    testJoinRoom(1); // Initial user joins and creates room
+
+    // Set up second user to join the same room
+    ctx.payload.username = "test2";
+    ctx.user = user2;
+    ctx.ws = ws2;
+    ctx.payload.roomId = ctx.payload.roomId?.toLowerCase();
+
+    testJoinRoom(2); // Second user joins the existing room
+  })
 });

server/test/socket/routes/send_touch.spec.ts

@@ -24,13 +24,13 @@ describe("Send Vibration", () => {
     ctx = {
       ws: ws,
       user: user,
-      payload: { username: "test", roomId: "testRoom" },
+      payload: { username: "test" },
       server: server,
     };
     ctx2 = {
       ws: ws2,
       user: user2,
-      payload: { username: "test2", roomId: "testRoom" },
+      payload: { username: "test2" },
       server: server,
     };
 
@@ -54,6 +54,8 @@ describe("Send Vibration", () => {
 
   it("should broadcast vibration", () => {
     JoinRoomHandler(ctx)
+    const resData = JSON.parse(ws.sendData as string)
+    ctx2.payload.roomId = resData.roomId
     JoinRoomHandler(ctx2)
     ws.sendData = "";
     ws2.sendData = "";