Lynn/126 successful match

.dockerignore

@@ -0,0 +1,9 @@
+**/node_modules
+**/.next
+**/dist
+**/coverage
+.git
+.gitignore
+.vscode
+.github
+.husky

.eslintrc.js

@@ -0,0 +1,4 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+    extends: ['@repo/eslint-config/eslint-base.js'],
+}

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+    push:
+        branches: ['main']
+    pull_request:
+        types: [opened, synchronize]
+
+jobs:
+    build:
+        name: Build and Test
+        timeout-minutes: 15
+        runs-on: ubuntu-latest
+        # To use Remote Caching, uncomment the next lines and follow the steps below.
+        # env:
+        #  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+        #  TURBO_TEAM: ${{ vars.TURBO_TEAM }}
+        #  TURBO_REMOTE_ONLY: true
+
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 2
+
+            - name: Setup Node.js environment
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+                  cache: 'npm'
+
+            - name: Install dependencies
+              run: npm install
+
+            - name: Build
+              run: npm run build
+
+            - name: Test
+              run: npm run test

.gitignore

@@ -0,0 +1,19 @@
+.git
+.vscode
+
+/node_modules
+**/node_modules
+
+**/.env
+**/.env.*
+
+**/dist
+**/coverage
+
+**/*.log
+
+**/.turbo
+
+**/*.tsbuildinfo
+
+/nginx/ssl

.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint-staged

.prettierignore

@@ -0,0 +1,4 @@
+# Ignore artifacts:
+**/coverage/*
+**/dist/*
+**/public/*

.prettierrc

@@ -0,0 +1,7 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": false,
+    "singleQuote": true,
+    "printWidth": 120
+}

CODEOWNERS

@@ -0,0 +1 @@
+* @shishirbychapur @glemenneo @Daviancold @lynnlow175 @yunruu

README.md

@@ -1,7 +1,13 @@
+![build_test_workflow](https://github.com/CS3219-AY2425S1/cs3219-ay2425s1-project-g31/actions/workflows/ci.yml/badge.svg)
+
 # CS3219 Project (PeerPrep) - AY2425S1
-## Group: Gxx
 
-### Note: 
-- You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice. 
-- In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator. 
-- The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements. 
+## Group: G31
+
+### Note:
+
+-   You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice.
+-   In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator.
+-   The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements.
+
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/bzPrOe11)

backend/matching-service/.eslintrc.js

@@ -0,0 +1,9 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+    extends: ['@repo/eslint-config/eslint-service.js'],
+    parserOptions: {
+        root: true,
+        tsconfigRootDir: __dirname,
+        sourceType: 'module',
+    },
+}

backend/matching-service/.prettierignore

@@ -0,0 +1,4 @@
+# Ignore artifacts:
+**/coverage/*
+**/dist/*
+**/public/*

backend/matching-service/Dockerfile

@@ -0,0 +1,39 @@
+# ---- Node 22 on Alpine Linux ----
+FROM node:22-alpine AS base
+
+FROM base AS builder
+RUN apk update && apk add --no-cache libc6-compat
+
+WORKDIR /app
+
+COPY . .
+
+# Generate a partial monorepo with a pruned lockfile for the app
+RUN npx turbo prune --scope=matching-service --docker
+
+FROM base AS installer
+RUN apk update && apk add --no-cache libc6-compat
+WORKDIR /app
+
+#############################################
+# ----  Dependencies ----
+COPY --from=builder /app/out/json/ .
+RUN npm install
+
+#############################################
+# ----  App ----
+COPY --from=builder /app/out/full/ .
+RUN npx turbo build --filter=matching-service
+
+#############################################
+# ----  Start ----
+FROM base AS runner
+WORKDIR /app
+
+# Don't run production as root
+RUN addgroup --system --gid 1001 nodejs && adduser --system --uid 1001 matching-service
+USER matching-service
+
+COPY --from=installer /app .
+
+CMD ["node", "backend/matching-service/dist/server"]

backend/matching-service/__mocks__/config.mock.ts

@@ -0,0 +1,19 @@
+import { generateKeyPairSync } from 'crypto'
+
+// Generate RSA key pair for testing
+const { publicKey, privateKey } = generateKeyPairSync('rsa', {
+    modulusLength: 2048,
+    publicKeyEncoding: { type: 'spki', format: 'pem' },
+    privateKeyEncoding: { type: 'pkcs8', format: 'pem' },
+})
+
+export default {
+    NODE_ENV: 'test',
+    PORT: '8000',
+    ACCESS_TOKEN_PUBLIC_KEY: Buffer.from(publicKey).toString('base64'),
+    ACCESS_TOKEN_PRIVATE_KEY: Buffer.from(privateKey).toString('base64'),
+    RMQ_USER: 'test',
+    RMQ_PASSWORD: 'test',
+    RMQ_HOST: 'test',
+    DB_URL: 'test',
+}

backend/matching-service/jest.config.js

@@ -0,0 +1,19 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    // [...]
+    extensionsToTreatAsEsm: ['.ts'],
+    moduleNameMapper: {
+        '^(\\.{1,2}/.*)\\.js$': '$1',
+    },
+    transform: {
+        // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
+        // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
+        '^.+\\.tsx?$': [
+            'ts-jest',
+            {
+                useESM: true,
+            },
+        ],
+    },
+    collectCoverage: true,
+}

backend/matching-service/package.json

@@ -0,0 +1,58 @@
+{
+    "name": "matching-service",
+    "version": "1.0.0",
+    "main": "index.js",
+    "scripts": {
+        "build": "tsc",
+        "test": "jest --passWithNoTests",
+        "lint": "eslint . --fix --no-error-on-unmatched-pattern && prettier --write --ignore-unknown .",
+        "start": "npm run build && node dist/server.js",
+        "dev": "nodemon src/server.ts",
+        "format": "prettier --write \"./**/*.{js,jsx,mjs,cjs,ts,tsx,json}\""
+    },
+    "author": "",
+    "license": "ISC",
+    "description": "",
+    "dependencies": {
+        "amqplib": "^0.10.4",
+        "axios": "^1.7.7",
+        "class-validator": "^0.14.1",
+        "cors": "^2.8.5",
+        "dotenv": "^16.4.5",
+        "express": "^4.21.0",
+        "express-async-errors": "^3.1.1",
+        "helmet": "^7.1.0",
+        "mongoose": "^8.6.3",
+        "passport": "^0.7.0",
+        "passport-jwt": "^4.0.1",
+        "winston": "^3.14.2",
+        "ws": "^8.18.0"
+    },
+    "devDependencies": {
+        "@repo/eslint-config": "*",
+        "@repo/request-types": "*",
+        "@repo/typescript-config": "*",
+        "@repo/user-types": "*",
+        "@repo/question-types": "*",
+        "@testcontainers/mongodb": "^10.13.1",
+        "@types/amqplib": "^0.10.5",
+        "@types/cors": "^2.8.17",
+        "@types/dotenv": "^6.1.1",
+        "@types/express": "^4.17.21",
+        "@types/helmet": "^0.0.48",
+        "@types/jest": "^29.5.13",
+        "@types/jsonwebtoken": "^9.0.7",
+        "@types/node": "^22.5.5",
+        "@types/passport": "^1.0.16",
+        "@types/passport-jwt": "^4.0.1",
+        "@types/supertest": "^6.0.2",
+        "globals": "^15.9.0",
+        "jest": "^29.7.0",
+        "jsonwebtoken": "^9.0.2",
+        "nodemon": "^3.1.7",
+        "supertest": "^7.0.0",
+        "ts-jest": "^29.2.5",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.6.2"
+    }
+}

backend/matching-service/src/common/config.util.ts

@@ -0,0 +1,13 @@
+import { ValidationError } from 'class-validator'
+import { Config } from '../types/Config'
+import logger from './logger.util'
+
+const config: Config = Config.fromEnv(process.env)
+config.validateOrReject().catch((errors: ValidationError[]) => {
+    logger.error(
+        `[Config] Invalid or missing configuration: ${errors.map((error: ValidationError) => error.property).join(', ')}`
+    )
+    process.exit(1)
+})
+
+export default config

backend/matching-service/src/common/logger.util.ts

@@ -0,0 +1,16 @@
+import Winston from 'winston'
+
+export default Winston.createLogger({
+    level: 'info',
+    format: Winston.format.combine(
+        Winston.format.printf(({ level, message }) => {
+            return `[${level}]: ${message}`
+        })
+    ),
+    defaultMeta: { service: 'matching-service' },
+    transports: [
+        new Winston.transports.Console(),
+        new Winston.transports.File({ filename: 'error.log', level: 'error' }),
+        new Winston.transports.File({ filename: 'combined.log' }),
+    ],
+})

backend/matching-service/src/common/mongodb.util.ts

@@ -0,0 +1,16 @@
+import config from './config.util'
+import { connect } from 'mongoose'
+import logger from './logger.util'
+
+export default async (connectionString: string): Promise<void> => {
+    await connect(connectionString, {
+        autoCreate: config.NODE_ENV !== 'production',
+        autoIndex: config.NODE_ENV !== 'production',
+    })
+        .then(() => {
+            logger.info(`[Init] Connected to database`)
+        })
+        .catch((error: Error) => {
+            logger.error(`[Init] Failed to connect to database: ${error.message}`)
+        })
+}

backend/matching-service/src/common/rabbitmq.util.ts

@@ -0,0 +1,12 @@
+import mqConnection from '../services/rabbitmq.service'
+import logger from './logger.util'
+
+export default async () => {
+    await mqConnection.connect()
+    await mqConnection.entryQueueConsumer().then(() => {
+        logger.info(`[Entry-Queue] Listening to Entry Queue...`)
+    })
+    await mqConnection.listenToDeadLetterQueue().then(() => {
+        logger.info(`[DeadLetter-Queue] Listening to DeadLetter Queue...`)
+    })
+}

backend/matching-service/src/controllers/matching.controller.ts

@@ -0,0 +1,64 @@
+import { ITypedBodyRequest } from '@repo/request-types'
+import { Response } from 'express'
+import { UserQueueRequest, UserQueueRequestDto } from '../types/UserQueueRequestDto'
+import mqConnection from '../services/rabbitmq.service'
+import { randomUUID } from 'crypto'
+import { WebSocketMessageType } from '@repo/ws-types'
+import wsConnection from '../services/ws.service'
+import { IMatch } from '../types/IMatch'
+import { MatchDto } from '../types/MatchDto'
+import { createMatch, isUserInMatch } from '../models/matching.repository'
+
+export async function generateWS(request: ITypedBodyRequest<void>, response: Response): Promise<void> {
+    const userHasMatch = await isUserInMatch(request.user.id)
+    if (userHasMatch) {
+        response.status(403).send('USER_ALREADY_IN_MATCH')
+        return
+    }
+
+    if (mqConnection.userCurrentlyConnected(request.user.id)) {
+        response.status(409).send('USER_ALREADY_IN_QUEUE')
+        return
+    }
+    mqConnection.addUserConnected(request.user.id)
+
+    const websocketID = randomUUID()
+    response.status(200).send({ websocketID: websocketID })
+}
+
+export async function addUserToMatchmaking(data: UserQueueRequest): Promise<void> {
+    const userHasMatch = await isUserInMatch(data.userId)
+    if (userHasMatch) {
+        wsConnection.sendMessageToUser(data.websocketId, JSON.stringify({ type: WebSocketMessageType.DUPLICATE }))
+        return
+    }
+    const createDto = UserQueueRequestDto.fromJSON(data)
+    const errors = await createDto.validate()
+    if (errors.length) {
+        return
+    }
+    await mqConnection.sendToEntryQueue(createDto)
+}
+
+export async function removeUserFromMatchingQueue(websocketId: string, userId: string): Promise<void> {
+    await mqConnection.cancelUser(websocketId, userId)
+    wsConnection.sendMessageToUser(websocketId, JSON.stringify({ type: WebSocketMessageType.CANCEL }))
+}
+
+export async function handleCreateMatch(data: IMatch, ws1: string, ws2: string): Promise<IMatch> {
+    const isAnyUserInMatch = (await isUserInMatch(data.user1Id)) || (await isUserInMatch(data.user2Id))
+    if (isAnyUserInMatch) {
+        wsConnection.sendMessageToUser(ws1, JSON.stringify({ type: WebSocketMessageType.DUPLICATE }))
+        wsConnection.sendMessageToUser(ws2, JSON.stringify({ type: WebSocketMessageType.DUPLICATE }))
+    }
+    data.questionId = randomUUID() // TODO: replace with actual question ID
+    const createDto = MatchDto.fromJSON(data)
+    const errors = await createDto.validate()
+    if (errors.length) {
+        throw new Error('Invalid match data')
+    }
+    const dto = await createMatch(createDto)
+    wsConnection.sendMessageToUser(ws1, JSON.stringify({ type: WebSocketMessageType.SUCCESS, matchId: dto.id }))
+    wsConnection.sendMessageToUser(ws2, JSON.stringify({ type: WebSocketMessageType.SUCCESS, matchId: dto.id }))
+    return dto
+}