Merge pull request #124 from ruiqi7/qa/test-cases

Add tests for websocket events

backend/collab-service/package.json

@@ -32,11 +32,14 @@
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.7.9",
+    "@types/socket.io": "^3.0.2",
+    "@types/socket.io-client": "^1.4.36",
     "@types/swagger-ui-express": "^4.1.6",
     "cross-env": "^7.0.3",
     "eslint": "^9.13.0",
     "globals": "^15.11.0",
     "jest": "^29.7.0",
+    "socket.io-client": "^4.8.1",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "tsx": "^4.19.1",

backend/collab-service/src/handlers/websocketHandler.ts

@@ -4,7 +4,7 @@ import redisClient from "../config/redis";
 import { Doc, applyUpdateV2, encodeStateAsUpdateV2 } from "yjs";
 import { createQuestionHistory } from "../api/questionHistoryService";
 
-enum CollabEvents {
+export enum CollabEvents {
   // Receive
   JOIN = "join",
   LEAVE = "leave",

backend/collab-service/tests/webSocketHandler.spec.ts

@@ -1,5 +1,130 @@
-describe("Test web socket", () => {
-  it("Test", () => {
-    expect(true);
+import { createServer } from "node:http";
+import { type AddressInfo } from "node:net";
+import ioc from "socket.io-client";
+import { Server, Socket } from "socket.io";
+import { CollabEvents } from "../src/handlers/websocketHandler";
+
+describe("Collab service web socket", () => {
+  let io: Server, serverSocket: Socket, clientSocket: SocketIOClient.Socket;
+
+  beforeAll((done) => {
+    const httpServer = createServer();
+    io = new Server(httpServer);
+    httpServer.listen(() => {
+      const port = (httpServer.address() as AddressInfo).port;
+      clientSocket = ioc(`http://localhost:${port}`);
+      io.on("connection", (socket) => {
+        serverSocket = socket;
+      });
+      clientSocket.on("connect", done);
+    });
+  });
+
+  afterAll(() => {
+    io.close();
+    clientSocket.close();
+  });
+
+  it("Room ready", (done) => {
+    const isRoomReady = true;
+    clientSocket.on(
+      CollabEvents.ROOM_READY,
+      ({ ready }: { ready: boolean }) => {
+        expect(ready).toEqual(isRoomReady);
+        done();
+      }
+    );
+    serverSocket.emit(CollabEvents.ROOM_READY, {
+      ready: isRoomReady,
+    });
+  });
+
+  it("Document ready", (done) => {
+    const questionHistoryIdSent = "123";
+    clientSocket.on(
+      CollabEvents.DOCUMENT_READY,
+      ({ questionHistoryId }: { questionHistoryId: string }) => {
+        expect(questionHistoryId).toEqual(questionHistoryIdSent);
+        done();
+      }
+    );
+    serverSocket.emit(CollabEvents.DOCUMENT_READY, {
+      questionHistoryId: questionHistoryIdSent,
+    });
+  });
+
+  it("Document not found", (done) => {
+    clientSocket.on(CollabEvents.DOCUMENT_NOT_FOUND, () => {
+      done();
+    });
+    serverSocket.emit(CollabEvents.DOCUMENT_NOT_FOUND);
+  });
+
+  it("Document update", (done) => {
+    const updateSent = new Uint8Array([1, 2, 3]);
+    clientSocket.on(
+      CollabEvents.UPDATE,
+      ({ update }: { update: Uint8Array }) => {
+        expect(Array.from(update)).toEqual(Array.from(updateSent));
+        done();
+      }
+    );
+    serverSocket.emit(CollabEvents.UPDATE, {
+      update: updateSent,
+    });
+  });
+
+  it("Cursor update", (done) => {
+    const uidSent = "123";
+    const usernameSent = "user";
+    const fromSent = 1;
+    const toSent = 5;
+    clientSocket.on(
+      CollabEvents.UPDATE_CURSOR,
+      ({
+        uid,
+        username,
+        from,
+        to,
+      }: {
+        uid: string;
+        username: string;
+        from: number;
+        to: number;
+      }) => {
+        expect(uid).toEqual(uidSent);
+        expect(username).toEqual(usernameSent);
+        expect(from).toEqual(fromSent);
+        expect(to).toEqual(toSent);
+        done();
+      }
+    );
+    serverSocket.emit(CollabEvents.UPDATE_CURSOR, {
+      uid: uidSent,
+      username: usernameSent,
+      from: fromSent,
+      to: toSent,
+    });
+  });
+
+  it("End session", (done) => {
+    const sessionDurationSent = 30;
+    clientSocket.on(
+      CollabEvents.END_SESSION,
+      ({ sessionDuration }: { sessionDuration: number }) => {
+        expect(sessionDuration).toEqual(sessionDurationSent);
+        done();
+      }
+    );
+    serverSocket.emit(CollabEvents.END_SESSION, {
+      sessionDuration: sessionDurationSent,
+    });
+  });
+
+  it("Partner disconnected", (done) => {
+    clientSocket.on(CollabEvents.PARTNER_DISCONNECTED, () => {
+      done();
+    });
+    serverSocket.emit(CollabEvents.PARTNER_DISCONNECTED);
   });
 });

backend/communication-service/src/handlers/websocketHandler.ts

@@ -9,7 +9,6 @@ export const handleWebsocketCommunicationEvents = (socket: Socket) => {
     CommunicationEvents.JOIN,
     async ({ roomId, username }: { roomId: string; username: string }) => {
       connectUser(username);
-      console.log(username, roomId);
       const room = io.sockets.adapter.rooms.get(roomId);
       if (room?.has(socket.id)) {
         socket.emit(CommunicationEvents.ALREADY_JOINED);