Merge branch 'main' of github.com:CS3219-AY2425S1/cs3219-ay2425s1-project-g16 into PEER-221-Matching-WS-Notifications

Signed-off-by: SeeuSim <[email protected]>

Author: SeeuSim

.eslintrc.json

@@ -11,9 +11,8 @@
     "ecmaVersion": "latest",
     "sourceType": "module"
   },
-  "plugins": ["import", "unused-imports", "react", "@typescript-eslint", "tailwindcss"],
+  "plugins": ["import", "unused-imports", "react", "@typescript-eslint", "tailwindcss", "simple-import-sort"],
   "rules": {
-    // "@next/next/no-img-element": "off",
     "@typescript-eslint/no-explicit-any": "warn",
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/explicit-function-return-type": 0,
@@ -29,11 +28,21 @@
     "@typescript-eslint/no-empty-interface": "off",
     "@typescript-eslint/no-unused-vars": 0,
     "@typescript-eslint/no-use-before-define": 0,
+    
     // Basic
     "array-callback-return": "warn",
     "no-console": "warn",
+    "no-multiple-empty-lines": ["error", { "max":1 }],
     "no-prototype-builtins": 0,
-    // "no-expected-multiline": "warn", // can't find rule definition
+    // "no-expected-multiline": "warn", // can"t find rule definition
+
+    "padding-line-between-statements": [
+      "warn",
+      { "blankLine": "always", "prev": "*", "next": "block" },
+      { "blankLine": "always", "prev": "block", "next": "*" },
+      { "blankLine": "always", "prev": "*", "next": "block-like" },
+      { "blankLine": "always", "prev": "block-like", "next": "*" }
+    ],
 
     // React
     "react/display-name": 0,
@@ -47,6 +56,8 @@
       }
     ],
     "react-hooks/rules-of-hooks": "off",
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
     "tailwindcss/enforces-negative-arbitrary-values": "off",
     "unused-imports/no-unused-imports": "error",
     "unused-imports/no-unused-vars": [
@@ -66,6 +77,22 @@
       "rules": {
         "react/prop-types": "off"
       }
+    },
+    {
+      "files": ["*.js", "*.ts", "*.tsx"],
+      "rules": {
+        "simple-import-sort/imports": [
+          "error",
+          {
+            "groups": [
+              ["^(?:os|path|http|fs|crypto|util|events|stream|url|zlib|querystring|tls|dgram|net|dns|child_process|cluster|readline|vm|assert|buffer|process|timers)(\/.*)?$"],
+              ["^(?!(@\/|\\.\\.\/|\\.\/))"],
+              ["^@\/"],
+              ["^(?:\\.\/|\\.\\.\/|\\.)"]
+            ]
+          }
+        ]
+      }
     }
   ]
 }

backend/matching/src/controllers/match-request.ts

@@ -2,14 +2,16 @@ import type { Request, Response } from 'express';
 import { StatusCodes } from 'http-status-codes';
 
 import { client, logQueueStatus } from '@/lib/db';
-import type { IRedisClient, IRequestMatchPayload } from '@/types';
-import { createNotifSocket, queueingService } from '@/services';
 import { logger } from '@/lib/utils';
+import { createNotifSocket, queueingService } from '@/services';
+import type { IRedisClient, IRequestMatchPayload } from '@/types';
 
 let redisClient: IRedisClient;
+
 export const matchRequestController = async (req: Request, res: Response) => {
   const payload: Partial<IRequestMatchPayload> = req.body;
   const { userId, difficulty, topic } = payload;
+
   if (!userId || (!difficulty && !topic)) {
     return res.status(StatusCodes.UNPROCESSABLE_ENTITY).json('Malformed Request');
   }

backend/matching/src/lib/db/log-queue-status.ts

@@ -18,6 +18,7 @@ export const logQueueStatus = async (
   if (!IS_MILESTONE_D4) {
     return;
   }
+
   const queueStatusLog = await getQueueStatusLog(redisClient);
   logger.info(message.replace('<PLACEHOLDER>', queueStatusLog));
 };

backend/matching/src/lib/db/seed.ts

@@ -1,4 +1,5 @@
 import { SchemaFieldTypes } from 'redis';
+
 import { client } from './client';
 import {
   MATCH_PREFIX,
@@ -18,18 +19,23 @@ const logger = {
 
 const main = async () => {
   const redisClient = await client.connect();
+
   if (!redisClient) {
     return;
   }
+
   logger.info('Connected');
   const isSeeded = await redisClient.hGetAll(SEED_KEY);
+
   if (Object.keys(isSeeded).length > 0) {
     const { timeStamp, value } = isSeeded;
+
     if (value === 'true') {
       logger.info('Seeded at: ' + new Date(timeStamp).toLocaleString());
       return;
     }
   }
+
   // Set Search Index
   await redisClient.ft.create(
     POOL_INDEX,

backend/matching/src/routes/match.ts

@@ -1,7 +1,7 @@
-import { matchRequestController } from '@/controllers/match-request';
-
 import { Router } from 'express';
 
+import { matchRequestController } from '@/controllers/match-request';
+
 const route = Router();
 
 route.post('/request', matchRequestController);

backend/matching/src/server.ts

@@ -1,10 +1,12 @@
+import http from 'http';
+
 import cors from 'cors';
 import express, { json } from 'express';
-import http from 'http';
 import { StatusCodes } from 'http-status-codes';
 import pino from 'pino-http';
 
 import matchRouter from '@/routes/match';
+
 import { UI_HOST } from './config';
 import { createWs } from './ws';
 

backend/matching/src/services/index.ts

@@ -1,3 +1,3 @@
 export * from './create-notif-socket';
-export * from './queue';
 export * from './get-match-items';
+export * from './queue';

backend/matching/src/workers/cleaner.ts

@@ -2,6 +2,7 @@ import { client, logQueueStatus } from '@/lib/db';
 import { STREAM_CLEANER, STREAM_GROUP, STREAM_NAME } from '@/lib/db/constants';
 import { decodePoolTicket, getPoolKey } from '@/lib/utils';
 import { MATCH_SVC_EVENT } from '@/ws';
+
 import { connectClient, sendNotif } from './common';
 
 const logger = {
@@ -17,6 +18,7 @@ const cancel = () => {
   stopSignal = true;
   clearTimeout(timeout);
 };
+
 const shutdown = () => {
   cancel();
   client.disconnect().then(() => {
@@ -44,11 +46,13 @@ async function clean() {
     });
     return;
   }
+
   // ACK, Delete
   for (const message of response.messages) {
     if (!message) {
       continue;
     }
+
     logger.info(`Expiring ${JSON.stringify(message)}`);
     const { userId, socketPort: socketRoom } = decodePoolTicket(message);
     const POOL_KEY = getPoolKey(userId);
@@ -70,6 +74,7 @@ async function clean() {
 }
 
 logger.info('Process Healthy');
+
 (function loop() {
   if (stopSignal) {
     return;

backend/matching/src/workers/common.ts

@@ -17,6 +17,7 @@ export const sendNotif = (roomIds: Array<string>, event: IMatchEvent, message?:
 
 export const connectClient = async (importedClient: typeof client) => {
   let redisClient: typeof client;
+
   try {
     redisClient =
       importedClient.isOpen || importedClient.isReady
@@ -29,5 +30,6 @@ export const connectClient = async (importedClient: typeof client) => {
     );
     process.exit(1);
   }
+
   return redisClient;
 };

backend/matching/src/workers/index.ts

@@ -5,9 +5,10 @@ import path from 'path';
 import type { Server } from 'socket.io';
 
 import { logger } from '@/lib/utils';
-import { MATCH_SVC_EVENT, type IChildProcessMessage } from '@/ws';
+import { type IChildProcessMessage, MATCH_SVC_EVENT } from '@/ws';
 
 let nWorkers = 0; // For tracking graceful exit of main process
+
 export const initWorker = (name: string, io: Server) => {
   const lCaseName = name.toLowerCase();
   const worker = fork(path.join(__dirname, `${lCaseName}.js`));
@@ -18,21 +19,25 @@ export const initWorker = (name: string, io: Server) => {
       logger.info({ pid: worker.pid }, `[${upperCaseName}]: ${message}`);
       return;
     }
+
     const messagePayload = message.valueOf();
     logger.info(
       { pid: worker.pid },
       `[${upperCaseName}]: WS Payload: ${JSON.stringify(messagePayload)}`
     );
     const { rooms, event, message: payload } = messagePayload as IChildProcessMessage;
+
     if (event === MATCH_SVC_EVENT.DISCONNECT) {
       io.sockets.in(rooms).disconnectSockets();
       return;
     }
+
     io.sockets.in(rooms).emit(event, payload);
   });
   worker.on('exit', (code) => {
     logger.error({ pid: worker.pid }, `${upperCaseName} exited with code ${code}.`);
     nWorkers -= 1;
+
     if (nWorkers === 0) {
       logger.info('Main Process exiting.');
       process.exit(0);