Add tests

Author: nicolelim02

backend/communication-service/package-lock.json

@@ -24,10 +24,12 @@
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.14",
     "@types/socket.io": "^3.0.1",
+    "@types/socket.io-client": "^1.4.36",
     "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.2",

backend/communication-service/package.json

@@ -1,7 +1,92 @@
-// todo: add test cases
+import { createServer } from "node:http";
+import { type AddressInfo } from "node:net";
+import ioc from "socket.io-client";
+import { Server, Socket } from "socket.io";
 
-describe("Test web socket", () => {
-  it("Test", () => {
-    expect(true);
+import { BOT_NAME } from "../src/utils/constants";
+import { CommunicationEvents, MessageTypes } from "../src/utils/types";
+
+describe("Communication 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("User joined acknowledgement", (done) => {
+    const createdAt = Date.now();
+    const messageSent = "User has joined the chat";
+    clientSocket.on(
+      CommunicationEvents.USER_JOINED,
+      ({
+        from,
+        type,
+        message,
+        createdTime,
+      }: {
+        from: string;
+        type: string;
+        message: string;
+        createdTime: number;
+      }) => {
+        expect(from).toBe(BOT_NAME);
+        expect(type).toBe(MessageTypes.BOT_GENERATED);
+        expect(message).toBe(messageSent);
+        expect(createdTime).toBe(createdAt);
+        done();
+      }
+    );
+    serverSocket.emit(CommunicationEvents.USER_JOINED, {
+      from: BOT_NAME,
+      type: MessageTypes.BOT_GENERATED,
+      message: messageSent,
+      createdTime: createdAt,
+    });
+  });
+
+  it("Message received", (done) => {
+    const createdAt = Date.now();
+    const messageSent = "Hello";
+    const username = "user";
+    clientSocket.on(
+      CommunicationEvents.TEXT_MESSAGE_RECEIVED,
+      ({
+        from,
+        type,
+        message,
+        createdTime,
+      }: {
+        from: string;
+        type: string;
+        message: string;
+        createdTime: number;
+      }) => {
+        expect(from).toBe(username);
+        expect(type).toBe(MessageTypes.USER_GENERATED);
+        expect(message).toBe(messageSent);
+        expect(createdTime).toBe(createdAt);
+        done();
+      }
+    );
+    serverSocket.emit(CommunicationEvents.TEXT_MESSAGE_RECEIVED, {
+      from: username,
+      type: MessageTypes.USER_GENERATED,
+      message: messageSent,
+      createdTime: createdAt,
+    });
   });
 });