feat: question matching

.github/workflows/test.yml

@@ -36,6 +36,7 @@ jobs:
           MATCHING_SERVICE_PORT: ${{ vars.MATCHING_SERVICE_PORT }}
           MATCHING_SERVICE_TIMEOUT: ${{ vars.MATCHING_SERVICE_TIMEOUT }}
           REDIS_URL: ${{ vars.REDIS_URL }}
+          QUESTION_SERVICE_GRPC_URL: ${{ vars.QUESTION_SERVICE_GPRC_URL }}
         run: |
           cd ./apps/frontend
           echo "NEXT_PUBLIC_QUESTION_SERVICE_URL=$QUESTION_SERVICE_URL" >> .env
@@ -56,6 +57,7 @@ jobs:
           echo "MATCH_TIMEOUT=$MATCHING_SERVICE_TIMEOUT" >> .env
           echo "JWT_SECRET=$JWT_SECRET" >> .env
           echo "REDIS_URL=$REDIS_URL" >> .env
+          echo "QUESTION_SERVICE_GRPC_URL=$QUESTION_SERVICE_GRPC_URL" >> .env
 
       - name: Create Database Credential Files
         env:

apps/README.md

@@ -56,7 +56,7 @@ Once running, you can access:
 
 - The **frontend** at http://localhost:3000
 - The **user service** at http://localhost:3001
-- The **question service** at http://localhost:8080
+- The **question service** at http://localhost:8080 (REST) and http://localhost:50051 (gRPC)
 - The **matching service** at http://localhost:8081
 - The **redis service** at http://localhost:6379
 

apps/docker-compose.yml

@@ -31,6 +31,7 @@ services:
       dockerfile: Dockerfile
     ports:
       - 8080:8080
+      - 50051:50051
     env_file:
       - ./question-service/.env
     networks:

apps/frontend/src/app/matching/modalContent/FindMatchContent.tsx

@@ -94,8 +94,8 @@ const DifficultySelector: React.FC<DifficultySelectorProps> = ({ selectedDifficu
                 <Tag.CheckableTag
                     className={`difficulty-tag ${difficultyOption.value}-tag`}
                     key={difficultyOption.value}
-                    checked={selectedDifficulties.includes(difficultyOption.label)}
-                    onChange={() => handleChange(difficultyOption.label)}
+                    checked={selectedDifficulties.includes(difficultyOption.value)}
+                    onChange={() => handleChange(difficultyOption.value)}
                 >
                     {difficultyOption.label}
                 </Tag.CheckableTag>

apps/frontend/src/app/services/use-matching.ts

@@ -17,17 +17,15 @@ export type MatchRequestParams = {
 }
 
 export type MatchFoundResponse = {
-    type: "match_found",
-    matchId: number,
-    partnerId: number,
-    partnerName: string,
-} | {
-    type: "match_found",
-    matchId: string,
+    type: "match_question_found",
+    match_id: string,
     user: string,
-    matchedUser: string,
-    topic: string | string[],
-    difficulty: string
+    matched_user: string,
+    matched_topics: string[],
+    question_doc_ref_id: string,
+    question_name: string,
+    question_difficulty: string,
+    question_topics: string[],
 }
 
 export type MatchTimeoutResponse = {
@@ -61,7 +59,7 @@ export default function useMatching(): MatchState {
                 return;
             }
 
-            if (responseJson.type == "match_found") {
+            if (responseJson.type == "match_question_found") {
                 setIsSocket(false);
 
                 const info: MatchInfo = parseInfoFromResponse(responseJson);
@@ -136,20 +134,9 @@ export default function useMatching(): MatchState {
 }
 
 function parseInfoFromResponse(responseJson: MatchFoundResponse): MatchInfo {
-    // test whether old or new
-    if ("partnerId" in responseJson) {
-        return {
-            matchId: responseJson.matchId?.toString() ?? "unknown",
-            partnerId: responseJson.partnerId?.toString() ?? "unknown",
-            partnerName: responseJson.partnerName ?? "unknown",
-            myName: "unknown",
-        };
-    } else {
-        return {
-            matchId: responseJson.matchId?.toString() ?? "unknown",
-            partnerId: "unknown",
-            partnerName: responseJson.matchedUser ?? "unknown",
-            myName: responseJson.user ?? "unknown",
-        };
-    }
+    return {
+        matchId: responseJson.match_id?.toString() ?? "unknown",
+        partnerName: responseJson.matched_user ?? "unknown",
+        myName: responseJson.user ?? "unknown",
+    };
 }

apps/frontend/src/contexts/websocketcontext.tsx

@@ -15,7 +15,6 @@ export type SocketState = {
 };
 export type MatchInfo = {
     matchId: string;
-    partnerId: string;
     myName: string;
     partnerName: string;
 }

apps/matching-service/.env.example

@@ -2,8 +2,10 @@ PORT=8081
 MATCH_TIMEOUT=30
 JWT_SECRET=you-can-replace-this-with-your-own-secret
 
-# if you are NOT USING docker, use the below url
+# If you are NOT USING docker, use the below variables
 REDIS_URL=localhost:6379
+QUESTION_SERVICE_GRPC_URL=localhost:50051
 
-# if you are USING docker, use the below url
+# If you are USING docker, use the below variables
 # REDIS_URL=redis-container:6379
+# QUESTION_SERVICE_GRPC_URL=question-service:50051

apps/matching-service/README.md

@@ -75,21 +75,24 @@ Client sends matching parameters:
 {
   "type": "match_request",
   "topics": ["Algorithms", "Arrays"],
-  "difficulties": ["Easy", "Medium"],
-  "username": "Jane Doe"
+  "difficulties": ["easy", "medium"],
+  "username": "1f0myn"
 }
 ```
 
 Server response on successful match:
 
 ```json
 {
-  "type": "match_found",
-  "matchId": "1c018916a34c5bee21af0b2670bd6156",
-  "user": "zkb4px",
-  "matchedUser": "JohnDoe",
-  "topic": "Algorithms",
-  "difficulty": "Medium"
+  "type": "match_question_found",
+  "match_id": "c377f463d380a9bd1dd03242892ef32e",
+  "user": "1f0myn",
+  "matched_user": "jrsznp",
+  "matched_topics": ["Graphs", "Bit Manipulation", "Databases"],
+  "question_doc_ref_id": "5lObMfyyKPgNXSuLcGEm",
+  "question_name": "Repeated DNA Sequences",
+  "question_difficulty": "medium",
+  "question_topics": ["Algorithms", "Bit Manipulation"]
 }
 ```
 
@@ -128,21 +131,27 @@ Before running the following commands, ensure that the URL for the Redis server
 To run the application via Docker, run the following command:
 
 1. Set up the Go Docker container for the matching service
+
 ```bash
 docker build -f Dockerfile -t match-go-app .
 ```
 
 2. Create the Docker network for Redis and Go
+
 ```bash
 docker network create redis-go-network
 ```
 
 3. Start a new Redis container in detached mode using the Redis image from Docker Hub
+
 ```bash
 docker run -d --name redis-container --network redis-go-network redis
 ```
 
 4. Run the Go Docker container for the matching-service
+
 ```bash
 docker run -d -p 8081:8081 --name go-app-container --network redis-go-network match-go-app
 ```
+
+**NOTE:** As there is a dependency on the question-service to return the found questions, the matching-service does not work fully unless the question-service is present.

apps/matching-service/databases/topic.go

@@ -0,0 +1,36 @@
+package databases
+
+import (
+	"context"
+	"log"
+	"matching-service/models"
+	"strings"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// Add user into each specified topic set based on the topics selected by users
+func AddUserToTopicSets(tx *redis.Tx, request models.MatchRequest, ctx context.Context) {
+	for _, topic := range request.Topics {
+		err := tx.SAdd(ctx, strings.ToLower(topic), request.Username).Err()
+		if err != nil {
+			log.Println("Error adding user to topic set:", err)
+		}
+	}
+}
+
+// Remove user from each specified topic set based on the topics selected by users
+func RemoveUserFromTopicSets(tx *redis.Tx, username string, ctx context.Context) {
+	request, err := GetUserDetails(tx, username, ctx)
+	if err != nil {
+		log.Println("Error retrieving user from hashset:", err)
+		return
+	}
+
+	for _, topic := range request.Topics {
+		err := tx.SRem(ctx, strings.ToLower(topic), request.Username).Err()
+		if err != nil {
+			log.Println("Error removing user from topic set:", err)
+		}
+	}
+}

apps/matching-service/databases/user.go

@@ -0,0 +1,22 @@
+package databases
+
+import (
+	"context"
+	"matching-service/models"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// Clean up queue, sets and hashset in Redis
+func CleanUpUser(tx *redis.Tx, username string, ctx context.Context) {
+	DequeueUser(tx, username, ctx)
+	RemoveUserFromTopicSets(tx, username, ctx)
+	RemoveUserDetails(tx, username, ctx)
+}
+
+// Adds the user to the queue, sets and hashsets in Redis
+func AddUser(tx *redis.Tx, matchRequest models.MatchRequest, ctx context.Context) {
+	EnqueueUser(tx, matchRequest.Username, ctx)
+	AddUserToTopicSets(tx, matchRequest, ctx)
+	StoreUserDetails(tx, matchRequest, ctx)
+}