Merge pull request #44 from CS3219-AY2425S1/PEER-232-Match-Initiation-UI

PEER-232: Match Initiation UI

Author: SeeuSim

.eslintrc.json

@@ -11,7 +11,15 @@
     "ecmaVersion": "latest",
     "sourceType": "module"
   },
-  "plugins": ["import", "unused-imports", "react", "@typescript-eslint", "tailwindcss", "simple-import-sort"],
+  "plugins": [
+    "import",
+    "unused-imports",
+    "react",
+    "@typescript-eslint",
+    "tailwindcss",
+    "react-hooks",
+    "simple-import-sort"
+  ],
   "rules": {
     "@typescript-eslint/no-explicit-any": "warn",
     "@typescript-eslint/explicit-module-boundary-types": "off",
@@ -95,4 +103,4 @@
       }
     }
   ]
-}
+}

backend/collaboration/src/controller/collab-controller.ts

@@ -11,13 +11,16 @@ export async function getCollabRoom(req: Request, res: Response) {
     userid2: userid2 as string,
     questionid: questionid as string,
   };
+
   try {
     const result = await getCollabRoomService(payload);
+
     if (result.error) {
       return res.status(result.code).json({
         error: result.error.message ?? 'An error occurred',
       });
     }
+
     return res.status(result.code).json(result.data);
   } catch (err) {
     return res

backend/collaboration/src/lib/y-postgres/index.ts

@@ -1,2 +1,2 @@
-export * from './utils';
 export * from './persistence';
+export * from './utils';

backend/collaboration/src/lib/y-postgres/persistence.ts

@@ -1,8 +1,8 @@
-import * as Y from 'yjs';
 import { PostgresqlPersistence } from 'y-postgresql';
+import * as Y from 'yjs';
 
-import type { IWSSharedDoc } from '@/types/interfaces';
 import { dbConfig } from '@/config';
+import type { IWSSharedDoc } from '@/types/interfaces';
 
 import { setPersistence } from './utils';
 

backend/collaboration/src/lib/y-postgres/utils.ts

@@ -1,9 +1,8 @@
-import * as awarenessProtocol from 'y-protocols/awareness';
-import * as syncProtocol from 'y-protocols/sync';
-
 import * as decoding from 'lib0/decoding';
 import * as encoding from 'lib0/encoding';
 import * as map from 'lib0/map';
+import * as awarenessProtocol from 'y-protocols/awareness';
+import * as syncProtocol from 'y-protocols/sync';
 
 import type { IPersistence, IWSSharedDoc } from '@/types/interfaces';
 
@@ -38,9 +37,11 @@ export const getYDoc = (docname: string, gc = true) =>
   map.setIfUndefined(docs, docname, () => {
     const doc = new WSSharedDoc(docname);
     doc.gc = gc;
+
     if (persistence !== null) {
       persistence.bindState(docname, doc);
     }
+
     docs.set(docname, doc);
     return doc;
   });
@@ -50,6 +51,7 @@ const messageListener = (conn: any, doc: IWSSharedDoc, message: Uint8Array) => {
     const encoder = encoding.createEncoder();
     const decoder = decoding.createDecoder(message);
     const messageType = decoding.readVarUint(decoder);
+
     switch (messageType) {
       case messageSync:
         encoding.writeVarUint(encoder, messageSync);
@@ -61,7 +63,9 @@ const messageListener = (conn: any, doc: IWSSharedDoc, message: Uint8Array) => {
         if (encoding.length(encoder) > 1) {
           send(doc, conn, encoding.toUint8Array(encoder));
         }
+
         break;
+
       case messageAwareness: {
         awarenessProtocol.applyAwarenessUpdate(
           doc.awareness,
@@ -80,9 +84,11 @@ const closeConn = (doc: IWSSharedDoc, conn: any) => {
   if (doc.conns.has(conn)) {
     const controlledIds = doc.conns.get(conn);
     doc.conns.delete(conn);
+
     if (controlledIds) {
       awarenessProtocol.removeAwarenessStates(doc.awareness, Array.from(controlledIds), null);
     }
+
     if (doc.conns.size === 0 && persistence !== null) {
       // if persisted, we store state and destroy ydocument
       persistence.writeState(doc.name, doc).then(() => {
@@ -91,13 +97,15 @@ const closeConn = (doc: IWSSharedDoc, conn: any) => {
       docs.delete(doc.name);
     }
   }
+
   conn.close();
 };
 
 export const send = (doc: IWSSharedDoc, conn: any, m: Uint8Array) => {
   if (conn.readyState !== wsReadyStateConnecting && conn.readyState !== wsReadyStateOpen) {
     closeConn(doc, conn);
   }
+
   try {
     conn.send(m, (err: any) => {
       if (err !== null) {
@@ -128,9 +136,11 @@ export const setupWSConnection = (
       if (doc.conns.has(conn)) {
         closeConn(doc, conn);
       }
+
       clearInterval(pingInterval);
     } else if (doc.conns.has(conn)) {
       pongReceived = false;
+
       try {
         conn.ping();
       } catch (e) {
@@ -146,6 +156,7 @@ export const setupWSConnection = (
   conn.on('pong', () => {
     pongReceived = true;
   });
+
   // put the following in a variables in a block so the interval handlers don't keep in in
   // scope
   {
@@ -155,6 +166,7 @@ export const setupWSConnection = (
     syncProtocol.writeSyncStep1(encoder, doc);
     send(doc, conn, encoding.toUint8Array(encoder));
     const awarenessStates = doc.awareness.getStates();
+
     if (awarenessStates.size > 0) {
       const encoder = encoding.createEncoder();
       encoding.writeVarUint(encoder, messageAwareness);

backend/collaboration/src/lib/y-postgres/ws-shared-doc.ts

@@ -1,11 +1,11 @@
-import * as Y from 'yjs';
-import * as syncProtocol from 'y-protocols/sync';
-import * as awarenessProtocol from 'y-protocols/awareness';
-
 import * as encoding from 'lib0/encoding';
+import * as awarenessProtocol from 'y-protocols/awareness';
+import * as syncProtocol from 'y-protocols/sync';
+import * as Y from 'yjs';
 
-import type { IWSSharedDoc } from '@/types/interfaces';
 import { GC_ENABLED } from '@/config';
+import type { IWSSharedDoc } from '@/types/interfaces';
+
 import { messageAwareness, messageSync } from './constants';
 import { send } from './utils';
 
@@ -44,8 +44,10 @@ export class WSSharedDoc extends Y.Doc implements IWSSharedDoc {
       conn: object | null
     ) => {
       const changedClients = added.concat(updated, removed);
+
       if (conn !== null) {
         const connControlledIDs = /** @type {Set<number>} */ this.conns.get(conn);
+
         if (connControlledIDs !== undefined) {
           added.forEach((clientID) => {
             connControlledIDs.add(clientID);
@@ -55,6 +57,7 @@ export class WSSharedDoc extends Y.Doc implements IWSSharedDoc {
           });
         }
       }
+
       // broadcast awareness update
       const encoder = encoding.createEncoder();
       encoding.writeVarUint(encoder, messageAwareness);
@@ -67,6 +70,7 @@ export class WSSharedDoc extends Y.Doc implements IWSSharedDoc {
         send(this, c, buff);
       });
     };
+
     this.awareness.on('update', awarenessChangeHandler);
     this.on('update', updateHandler);
   }

backend/collaboration/src/routes/room.ts

@@ -1,6 +1,7 @@
-import { getCollabRoom } from '@/controller/collab-controller';
 import express from 'express';
 
+import { getCollabRoom } from '@/controller/collab-controller';
+
 const router = express.Router();
 
 router.get('/', getCollabRoom);

backend/collaboration/src/server.ts

@@ -1,7 +1,7 @@
+import http from 'http';
 import { exit } from 'process';
 
 import cors from 'cors';
-import http from 'http';
 import express, { json } from 'express';
 import { StatusCodes } from 'http-status-codes';
 import pino from 'pino-http';
@@ -10,6 +10,7 @@ import { UI_HOST } from '@/config';
 import { config, db } from '@/lib/db';
 import { logger } from '@/lib/utils';
 import roomRoutes from '@/routes/room';
+
 import { setUpWSServer } from './ws';
 
 const app = express();

backend/collaboration/src/service/get/collab-get-service.ts

@@ -1,11 +1,14 @@
+import crypto from 'crypto';
+
 import { StatusCodes } from 'http-status-codes';
+
 import { IGetCollabRoomPayload, IGetCollabRoomResponse } from './types';
-import crypto from 'crypto';
 
 export async function getCollabRoomService(
   payload: IGetCollabRoomPayload
 ): Promise<IGetCollabRoomResponse> {
   const { userid1, userid2, questionid } = payload;
+
   if (!userid1 || !userid2 || !questionid) {
     return {
       code: StatusCodes.UNPROCESSABLE_ENTITY,
@@ -14,6 +17,7 @@ export async function getCollabRoomService(
       },
     };
   }
+
   const combinedString = `uid1=${userid1}|uid2=${userid2}|qid=${questionid}`;
   const hash = crypto.createHash('sha256');
   const uniqueRoomName = hash.update(combinedString).digest('hex');

backend/collaboration/src/ws.ts

@@ -1,4 +1,5 @@
 import http from 'http';
+
 import { WebSocketServer } from 'ws';
 
 import { setUpPersistence, setupWSConnection } from '@/lib/y-postgres';