Merge branch 'main' of github.com:CS3219-AY2425S1/cs3219-ay2425s1-project-g16 into PEER-232-Match-Initiation-UI

SeeuSim · SeeuSim · commit 3b3283703d76 · 2024-10-20T13:41:35.000+08:00
Signed-off-by: SeeuSim &lt;seeusimong@gmail.com&gt;
diff --git a/backend/matching/.env.docker b/backend/matching/.env.docker
@@ -5,5 +5,9 @@ EXPRESS_PORT=9004
 MATCHING_DB_HOSTNAME=host.docker.internal
 MATCHING_DB_PORT=6379
 
+PEERPREP_USER_HOST=http://host.docker.internal:9001
+PEERPREP_QUESTION_HOST=http://host.docker.internal:9002
+PEERPREP_COLLAB_HOST=http://host.docker.internal:9003
+
 # MATCHING_DB_USERNAME=peerprep-match-express
 # MATCHING_DB_PASSWORD=G7jBgyz9wGAFQ5La
diff --git a/backend/matching/.env.local b/backend/matching/.env.local
@@ -5,6 +5,13 @@ EXPRESS_PORT=9004
 MATCHING_DB_HOSTNAME=localhost
 MATCHING_DB_PORT=6379
 
+
+PEERPREP_USER_HOST="http://localhost:9001"
+PEERPREP_QUESTION_HOST="http://localhost:9002"
+PEERPREP_COLLAB_HOST="http://localhost:9003"
+
+
+
 # MATCHING_DB_USERNAME="peerprep-match-express"
 # MATCHING_DB_PASSWORD="G7jBgyz9wGAFQ5La"
 # REDIS_ARGS="--requirepass G7jBgyz9wGAFQ5La --user ${MATCHING_DB_USERNAME} on >G7jBgyz9wGAFQ5La ~* allcommands --user default off nopass nocommands"
diff --git a/backend/matching/package.json b/backend/matching/package.json
@@ -19,6 +19,7 @@
   "description": "",
   "dependencies": {
     "async": "^3.2.6",
+    "axios": "^1.7.7",
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "env-cmd": "^10.1.0",
diff --git a/backend/matching/src/config.ts b/backend/matching/src/config.ts
@@ -4,6 +4,10 @@ export const UI_HOST = process.env.PEERPREP_UI_HOST!;
 
 export const EXPRESS_PORT = process.env.EXPRESS_PORT;
 
+export const PEERPREP_USER_HOST = process.env.PEERPREP_USER_HOST;
+export const PEERPREP_QUESTION_HOST = process.env.PEERPREP_QUESTION_HOST;
+export const PEERPREP_COLLAB_HOST = process.env.PEERPREP_COLLAB_HOST;
+
 const DB_HOSTNAME = process.env.MATCHING_DB_HOSTNAME;
 const DB_PORT = Number.parseInt(process.env.MATCHING_DB_PORT ?? '6379');
 // export const DB_URL = `redis://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOSTNAME}:${DB_PORT}`;
diff --git a/backend/matching/src/services/collab.ts b/backend/matching/src/services/collab.ts
@@ -0,0 +1,23 @@
+import axios from 'axios';
+
+import { PEERPREP_COLLAB_HOST } from '@/config';
+
+export async function createRoom(
+  userId1: string,
+  userId2: string,
+  questionId: string
+): Promise<string> {
+  const response = await axios.get<{ roomName: string }>(`${PEERPREP_COLLAB_HOST}/room`, {
+    params: {
+      userid1: userId1,
+      userid2: userId2,
+      questionid: questionId,
+    },
+  });
+
+  if (response.status !== 200 || !response.data?.roomName) {
+    throw new Error('Failed to create room');
+  }
+
+  return response.data.roomName;
+}
diff --git a/backend/matching/src/services/get-match-items.ts b/backend/matching/src/services/get-match-items.ts
@@ -1,15 +1,47 @@
-type IGetMatchItemsParams = {
-  userId1: string;
-  userId2: string;
-};
-
-export const getMatchItems = ({ userId1, userId2 }: IGetMatchItemsParams) => {
-  // TODO: Get Match Items
-  const roomId = `${userId1}${userId2}`;
-  const questionId = Math.floor(Math.random() * 20) + 1;
-
-  return {
-    roomId,
-    questionId,
-  };
-};
+import { IMatchItemsResponse, IMatchType } from '../types/index';
+import { createRoom } from './collab';
+import { getRandomQuestion } from './question';
+import { fetchAttemptedQuestions } from './user';
+
+export async function getMatchItems(
+  searchIdentifier: IMatchType,
+  topic?: string,
+  difficulty?: string,
+  userId1?: string,
+  userId2?: string
+): Promise<IMatchItemsResponse | undefined> {
+  try {
+    if (!userId1 || !userId2) {
+      throw new Error('Both user IDs are required');
+    }
+
+    const [attemptedQuestions1, attemptedQuestions2] = await Promise.all([
+      fetchAttemptedQuestions(userId1),
+      fetchAttemptedQuestions(userId2),
+    ]);
+
+    const allAttemptedQuestions = [...new Set([...attemptedQuestions1, ...attemptedQuestions2])];
+
+    const payload = {
+      attemptedQuestions: allAttemptedQuestions,
+      ...(searchIdentifier === 'difficulty' && difficulty ? { difficulty } : {}),
+      ...(searchIdentifier === 'topic' && topic ? { topic } : {}),
+      ...(searchIdentifier === 'exact match' && topic && difficulty ? { topic, difficulty } : {}),
+    };
+
+    // Get a random question
+    const question = await getRandomQuestion(payload);
+
+    const roomName = await createRoom(userId1, userId2, question.id.toString());
+
+    console.log('Successfully got match items');
+    return {
+      roomName,
+      questionId: question.id,
+      question,
+    };
+  } catch (error) {
+    console.error('Error in getMatchItems:', error);
+    return undefined;
+  }
+}
diff --git a/backend/matching/src/services/question.ts b/backend/matching/src/services/question.ts
@@ -0,0 +1,18 @@
+import axios from 'axios';
+
+import { PEERPREP_QUESTION_HOST } from '@/config';
+
+import { IGetRandomQuestionPayload, IQuestion, IServiceResponse } from '../types/index';
+
+export async function getRandomQuestion(payload: IGetRandomQuestionPayload): Promise<IQuestion> {
+  const response = await axios.post<IServiceResponse<{ question: IQuestion }>>(
+    `${PEERPREP_QUESTION_HOST}/questions/random`,
+    payload
+  );
+
+  if (response.status !== 200 || !response.data.data) {
+    throw new Error(response.data.error?.message || 'Failed to get a random question');
+  }
+
+  return response.data.data.question;
+}
diff --git a/backend/matching/src/services/user.ts b/backend/matching/src/services/user.ts
@@ -0,0 +1,31 @@
+import axios from 'axios';
+
+import { PEERPREP_USER_HOST } from '@/config';
+
+export async function fetchAttemptedQuestions(userId: string): Promise<number[]> {
+  const response = await axios.post<number[]>(`${PEERPREP_USER_HOST}/user/attempted-question/get`, {
+    userId,
+  });
+
+  if (response.status !== 200 || !response.data) {
+    throw new Error(`Failed to fetch attempted questions for user ${userId}`);
+  }
+
+  return response.data || [];
+}
+
+export async function updateAttemptedQuestions(
+  userIds: string[],
+  questionId: number
+): Promise<void> {
+  const response = await axios.post<unknown>(`${PEERPREP_USER_HOST}/user/attempted-question/add`, {
+    questionId,
+    userIds,
+  });
+
+  if (response.status !== 200 || !response.data) {
+    throw new Error(`Failed to update attempted questions for users ${userIds}`);
+  }
+
+  return;
+}
diff --git a/backend/matching/src/types/index.ts b/backend/matching/src/types/index.ts
@@ -44,3 +44,30 @@ export type IChildProcessMessage = {
   event: IMatchEvent;
   message?: unknown;
 };
+export type IMatchType = 'difficulty' | 'topic' | 'exact match' | undefined;
+
+export interface IServiceResponse<T> {
+  success: boolean;
+  data?: T;
+  error?: { message: string };
+}
+
+export interface IQuestion {
+  id: number;
+  title: string;
+  description: string;
+  difficulty: string;
+  topic: string[];
+}
+
+export interface IGetRandomQuestionPayload {
+  attemptedQuestions: number[];
+  difficulty?: string;
+  topic?: string;
+}
+
+export interface IMatchItemsResponse {
+  roomName: string;
+  questionId: number;
+  question: IQuestion;
+}
diff --git a/backend/matching/src/workers/matcher.ts b/backend/matching/src/workers/matcher.ts
@@ -2,6 +2,7 @@ import { client, logQueueStatus } from '@/lib/db';
 import { POOL_INDEX, STREAM_GROUP, STREAM_NAME, STREAM_WORKER } from '@/lib/db/constants';
 import { decodePoolTicket, getPoolKey, getStreamId } from '@/lib/utils';
 import { getMatchItems } from '@/services';
+import { IMatchType } from '@/types';
 import { MATCHING_EVENT } from '@/ws/events';
 
 import { connectClient, sendNotif } from './common';
@@ -41,7 +42,9 @@ async function processMatch(
   redisClient: typeof client,
   { requestorUserId, requestorStreamId, requestorSocketPort }: RequestorParams,
   matches: Awaited<ReturnType<(typeof client)['ft']['search']>>,
-  searchIdentifier?: string
+  searchIdentifier?: IMatchType,
+  topic?: string,
+  difficulty?: string
 ) {
   if (matches.total > 0) {
     for (const matched of matches.documents) {
@@ -70,10 +73,17 @@ async function processMatch(
       ]);
 
       // Notify both sockets
-      const { ...matchItems } = getMatchItems({ userId1: requestorUserId, userId2: matchedUserId });
+      const { ...matchItems } = await getMatchItems(
+        searchIdentifier,
+        topic,
+        difficulty,
+        requestorUserId,
+        matchedUserId
+      );
+      logger.info(`Generated Match - ${JSON.stringify(matchItems)}`);
 
-      sendNotif([matchedSocketPort, requestorSocketPort], MATCHING_EVENT.SUCCESS, matchItems);
-      sendNotif([matchedSocketPort, requestorSocketPort], MATCHING_EVENT.DISCONNECT);
+      sendNotif([requestorSocketPort, matchedSocketPort], MATCHING_EVENT.SUCCESS, matchItems);
+      sendNotif([requestorSocketPort, matchedSocketPort], MATCHING_EVENT.DISCONNECT);
 
       await logQueueStatus(logger, redisClient, `Queue Status After Matching: <PLACEHOLDER>`);
       return true;
@@ -86,6 +96,7 @@ async function processMatch(
 
 async function match() {
   const redisClient = await connectClient(client);
+
   const stream = await redisClient.xReadGroup(
     STREAM_GROUP,
     STREAM_WORKER,
@@ -143,7 +154,9 @@ async function match() {
         redisClient,
         requestorParams,
         exactMatches,
-        'exact match'
+        'exact match',
+        topic,
+        difficulty
       );
 
       if (exactMatchFound || !topic || !difficulty) {
@@ -161,7 +174,9 @@ async function match() {
         redisClient,
         requestorParams,
         topicMatches,
-        'topic'
+        'topic',
+        topic,
+        difficulty
       );
 
       if (topicMatchFound) {
@@ -178,7 +193,9 @@ async function match() {
         redisClient,
         requestorParams,
         difficultyMatches,
-        'difficulty'
+        'difficulty',
+        topic,
+        difficulty
       );
 
       if (!hasDifficultyMatch) {
diff --git a/backend/question/src/services/get/types.ts b/backend/question/src/services/get/types.ts
@@ -59,6 +59,7 @@ export type IGetRandomQuestionPayload = {
 
 export type IGetRandomQuestionResponse = IServiceResponse<{
   question: {
+    id: number; // question's unique identifier or number
     title: string; // name or title of the question
     description: string; // question description
     difficulty: string; // difficulty level (e.g., 'easy', 'medium', 'hard')
diff --git a/backend/user/src/controllers/questions/index.ts b/backend/user/src/controllers/questions/index.ts
@@ -0,0 +1,38 @@
+import { StatusCodes } from 'http-status-codes';
+
+import { addAttemptedQuestionService, getAttemptedQuestionsService } from '@/services/questions';
+import type { IRouteHandler } from '@/types';
+
+export const addAttemptedQuestion: IRouteHandler = async (req, res) => {
+  const { questionId, userIds } = req.body; // Assuming the questionId is passed in the request body
+
+  if (!userIds || !questionId) {
+    return res.status(StatusCodes.BAD_REQUEST).json('User ID and Question ID are required');
+  }
+
+  const { code, data, error } = await addAttemptedQuestionService(userIds, questionId);
+
+  if (error || code !== StatusCodes.OK || !data) {
+    const sanitizedErr = error?.message ?? 'An error occurred.';
+    return res.status(code).json(sanitizedErr);
+  }
+
+  return res.status(StatusCodes.OK).json(data);
+};
+
+export const getAttemptedQuestions: IRouteHandler = async (req, res) => {
+  const userId = req.body.userId;
+
+  if (!userId) {
+    return res.status(StatusCodes.BAD_REQUEST).json('User ID is required');
+  }
+
+  const { code, data, error } = await getAttemptedQuestionsService(userId);
+
+  if (error || code !== StatusCodes.OK || !data) {
+    const sanitizedErr = error?.message ?? 'An error occurred.';
+    return res.status(code).json(sanitizedErr);
+  }
+
+  return res.status(StatusCodes.OK).json(data);
+};
diff --git a/backend/user/src/routes/auth.ts b/backend/user/src/routes/auth.ts
@@ -10,6 +10,7 @@ router.post('/logout', logout);
 router.post('/register', register);
 router.post('/username-valid', checkUsernameValid);
 router.post('/email-valid', checkEmailValid);
+
 router.use(limiter);
 
 export default router;
diff --git a/backend/user/src/routes/user.ts b/backend/user/src/routes/user.ts
@@ -0,0 +1,10 @@
+import express from 'express';
+
+import { addAttemptedQuestion, getAttemptedQuestions } from '@/controllers/questions';
+
+const router = express.Router();
+
+router.post('/attempted-question/get', getAttemptedQuestions);
+router.post('/attempted-question/add', addAttemptedQuestion);
+
+export default router;
diff --git a/backend/user/src/server.ts b/backend/user/src/server.ts
@@ -13,6 +13,7 @@ import { db } from '@/lib/db';
 import { logger } from '@/lib/utils';
 import authRoutes from '@/routes/auth';
 import authCheckRoutes from '@/routes/auth-check';
+import userRoutes from '@/routes/user';
 
 const app = express();
 app.use(pino());
@@ -28,6 +29,7 @@ app.use(
 
 app.use('/auth', authRoutes);
 app.use('/auth-check', authCheckRoutes);
+app.use('/user', userRoutes);
 
 // Health Check for Docker
 app.get('/health', (_req, res) => res.status(StatusCodes.OK).send('OK'));
diff --git a/backend/user/src/services/questions/index.ts b/backend/user/src/services/questions/index.ts
diff --git a/docker-compose.yaml b/docker-compose.yaml
diff --git a/package-lock.json b/package-lock.json
