Merge pull request #40 from CS3219-AY2425S1/PEER-220-Matching-Logic

PEER-220: Matching Logic

Author: SeeuSim

.env.local

@@ -1,23 +1,22 @@
 USER_SERVICE_NAME=user-express
-USER_EXPRESS_DB_PORT=5431
-USER_EXPRESS_ENV=compose
 USER_EXPRESS_PORT=9001
+USER_EXPRESS_DB_PORT=5431
 USER_PGDATA="/data/user-db"
 
 QUESTION_SERVICE_NAME=question-express
 QUESTION_EXPRESS_PORT=9002
-QUESTION_EXPRESS_ENV=compose
 QUESTION_EXPRESS_DB_PORT=5433
 QUESTION_PGDATA="/data/qn-db"
 
 COLLAB_SERVICE_NAME=collab-express
-COLLAB_EXPRESS_ENV=compose
 COLLAB_EXPRESS_PORT=9003
 
 MATCHING_SERVICE_NAME=match-express
-MATCHING_EXPRESS_ENV=compose
 MATCHING_EXPRESS_PORT=9004
+MATCHING_DB_USERNAME="peerprep-match-express"
+MATCHING_DB_PASSWORD="password"
+MATCHING_DB_HOST_PORT=6379
+MATCHING_DB_HOST_MGMT_PORT=3001
 
 FRONTEND_SERVICE_NAME=frontend
-FRONTEND_ENV=compose
 FRONTEND_PORT=3000

backend/matching/.env.compose

@@ -2,3 +2,11 @@
 # PEERPREP_UI_HOST="http://frontend:3000"
 
 EXPRESS_PORT=9004
+
+# MATCHING_DB_HOSTNAME="match-db"
+MATCHING_DB_PORT=6379
+
+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"
+

backend/matching/.env.docker

@@ -1,3 +1,9 @@
-PEERPREP_UI_HOST="http://host.docker.internal:5173"
+PEERPREP_UI_HOST=http://host.docker.internal:5173
 
 EXPRESS_PORT=9004
+
+MATCHING_DB_HOSTNAME=host.docker.internal
+MATCHING_DB_PORT=6379
+
+MATCHING_DB_USERNAME=peerprep-match-express
+MATCHING_DB_PASSWORD=G7jBgyz9wGAFQ5La

backend/matching/.env.local

@@ -1,3 +1,10 @@
 PEERPREP_UI_HOST="http://localhost:5173"
 
 EXPRESS_PORT=9004
+
+MATCHING_DB_HOSTNAME="localhost"
+MATCHING_DB_PORT=6379
+
+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"

backend/matching/README.md

@@ -1 +1,29 @@
 # Matching Service
+
+## Running with Docker (Standalone)
+
+1. Run this command to build:
+    ```sh
+    docker build \
+      -t match-express-local \
+      --build-arg port=9004 \
+      -f express.Dockerfile .
+    ```
+2. Run this command, from the root folder:
+    ```sh
+    make db-up
+    ```
+
+3. Run the necessary migrate and seed commands, if you haven't yet.
+
+4. Run this command to expose the container:
+    ```sh
+    docker run -p 9004:9004 --env-file ./.env.docker match-express-local
+    ```
+5. To stop the process, use the Docker UI or CLI with `docker rm -f <container_id>` (The child process loop has issues terminating)
+
+## Running with Docker-Compose (Main config)
+
+Edit the variables in the `.env.compose` file and run `make up` from the root folder.
+
+Any startup instructions will be run from `entrypoint.sh` instead.

backend/matching/entrypoint.sh

@@ -1,5 +1,9 @@
 #!/bin/sh
 
-# To insert MQ health checks
+npm run db:seed:prod
+
+rm -rf src tsconfig.json
+
+npm uninstall tsx
 
 npm run start

backend/matching/express.Dockerfile

@@ -12,6 +12,10 @@ COPY --from=build --chown=node:node /data/match-express/dist ./dist
 
 RUN npm ci --omit=dev
 
+COPY src/lib/db ./src/lib/db
+COPY src/lib/utils ./src/lib/utils
+COPY src/config.ts ./src
+COPY tsconfig.json .
 COPY entrypoint.sh .
 
 ARG port

backend/matching/package.json

@@ -8,6 +8,8 @@
     "start": "node dist/index.js",
     "build:local": "env-cmd -f .env.local tsc && tsc-alias",
     "start:local": "env-cmd -f .env.local node dist/index.js",
+    "db:seed": "env-cmd -f .env.local tsx src/lib/db/seed.ts",
+    "db:seed:prod": "tsx src/lib/db/seed.ts",
     "fmt": "prettier --config .prettierrc src --write",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -16,22 +18,26 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
+    "async": "^3.2.6",
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "env-cmd": "^10.1.0",
     "express": "^4.21.0",
     "http-status-codes": "^2.3.0",
     "pino": "^9.4.0",
-    "pino-http": "^10.3.0"
+    "pino-http": "^10.3.0",
+    "redis": "^4.7.0",
+    "socket.io": "^4.8.0",
+    "tsx": "^4.19.1"
   },
   "devDependencies": {
+    "@types/async": "^3.2.24",
     "@types/cors": "^2.8.17",
     "@types/express": "^4.17.21",
     "@types/node": "^22.5.5",
     "nodemon": "^3.1.4",
     "pino-pretty": "^11.2.2",
     "ts-node": "^10.9.2",
-    "tsc-alias": "^1.8.10",
-    "tsx": "^4.19.1"
+    "tsc-alias": "^1.8.10"
   }
 }

backend/matching/src/config.ts

@@ -3,3 +3,12 @@ import 'dotenv/config';
 export const UI_HOST = process.env.PEERPREP_UI_HOST!;
 
 export const EXPRESS_PORT = process.env.EXPRESS_PORT;
+
+const DB_USERNAME = process.env.MATCHING_DB_USERNAME;
+const DB_PASSWORD = process.env.MATCHING_DB_PASSWORD;
+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}`;
+// export const DB_URL = `redis://${DB_HOSTNAME}:${DB_PORT}`;
+
+export const NODE_ENV = process.env.NODE_ENV;

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

@@ -0,0 +1,35 @@
+import type { Request, Response } from 'express';
+import { StatusCodes } from 'http-status-codes';
+
+import { client } from '@/lib/db';
+import type { IRedisClient, IRequestMatchPayload } from '@/types';
+import { createNotifSocket, queueingService } from '@/services';
+
+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');
+  }
+
+  if (!redisClient || !redisClient.isOpen || !redisClient.isReady) {
+    redisClient = await client.connect();
+  }
+
+  // TODO: Assign a proper socket to the user
+  const socketRoom = createNotifSocket(userId);
+
+  // TODO: Test if room logic works and notif socket can connect
+  // Send socket to user first for them to subscribe
+  res
+    .status(StatusCodes.OK)
+    .json({
+      socketPort: socketRoom,
+    })
+    .end();
+
+  // TODO: Wait for user to connect to notif socket, or add a time buffer
+
+  await queueingService(redisClient, { userId, difficulty, topic, socketPort: socketRoom });
+};