Merge pull request #39 from CS3219-AY2425S1/PEER-214

PEER-214 Add Collaboration Service WS Server

Author: SeeuSim

.env.local

@@ -10,6 +10,8 @@ QUESTION_PGDATA="/data/qn-db"
 
 COLLAB_SERVICE_NAME=collab-express
 COLLAB_EXPRESS_PORT=9003
+COLLAB_EXPRESS_DB_PORT=5435
+COLLAB_PGDATA="/data/collab-db"
 
 MATCHING_SERVICE_NAME=match-express
 MATCHING_EXPRESS_PORT=9004

.github/workflows/build-docker.yaml

@@ -1,7 +1,11 @@
 name: Build & publish PeerPrep images
 on:
   pull_request:
-    types: [review_requested, ready_for_review]
+    types: 
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
   push:
     branches: 
       - main
@@ -16,6 +20,7 @@ env:
 
 jobs:
   changes:
+    if: ${{ !github.event.pull_request.draft }}
     runs-on: ubuntu-latest
     # Required permissions
     permissions:

backend/collaboration/.env.compose

@@ -2,3 +2,9 @@
 # PEERPREP_UI_HOST="http://frontend:3000"
 
 EXPRESS_PORT=9003
+EXPRESS_DB_HOST="collab-db"
+EXPRESS_DB_PORT=5435
+POSTGRES_DB="collab"
+POSTGRES_USER="peerprep-collab-express"
+POSTGRES_PASSWORD="6rYE0nIzI2ThzDO"
+PGDATA="/data/collab-db"

backend/collaboration/.env.docker

@@ -1,3 +1,9 @@
-PEERPREP_UI_HOST="http://host.docker.internal:5173"
+PEERPREP_UI_HOST=http://host.docker.internal:5173
 
 EXPRESS_PORT=9003
+EXPRESS_DB_HOST=host.docker.internal
+EXPRESS_DB_PORT=5435
+POSTGRES_DB=collab
+POSTGRES_USER=peerprep-collab-express
+POSTGRES_PASSWORD=6rYE0nIzI2ThzDO
+PGDATA=/data/collab-db

backend/collaboration/.env.local

@@ -1,3 +1,9 @@
 PEERPREP_UI_HOST="http://localhost:5173"
 
 EXPRESS_PORT=9003
+EXPRESS_DB_HOST="localhost"
+EXPRESS_DB_PORT=5435
+POSTGRES_DB="collab"
+POSTGRES_USER="peerprep-collab-express"
+POSTGRES_PASSWORD="6rYE0nIzI2ThzDO"
+PGDATA="/data/collab-db"

backend/collaboration/entrypoint.sh

@@ -1,5 +1,2 @@
 #!/bin/sh
-
-# To insert WS/RTC health checks
-
-npm run start
+npm run start

backend/collaboration/express.Dockerfile

@@ -2,6 +2,7 @@ FROM node:lts-alpine AS build
 WORKDIR /data/collab-express
 COPY package*.json ./
 RUN npm install
+ARG env
 COPY . .
 RUN npm run build
 
@@ -12,6 +13,8 @@ COPY --from=build --chown=node:node /data/collab-express/dist ./dist
 
 RUN npm ci --omit=dev
 
+RUN sed -i 's|./ws|ws|g' ./dist/ws.js
+
 COPY entrypoint.sh .
 
 ARG port

backend/collaboration/package.json

@@ -19,15 +19,23 @@
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "env-cmd": "^10.1.0",
-    "express": "^4.21.0",
+    "express": "^4.21.1",
     "http-status-codes": "^2.3.0",
+    "pg": "^8.13.0",
     "pino": "^9.4.0",
-    "pino-http": "^10.3.0"
+    "pino-http": "^10.3.0",
+    "postgres": "^3.4.4",
+    "redis": "^4.7.0",
+    "ws": "^8.18.0",
+    "y-postgresql": "^1.0.0",
+    "y-websocket": "^2.0.4",
+    "yjs": "^13.6.19"
   },
   "devDependencies": {
     "@types/cors": "^2.8.17",
     "@types/express": "^4.17.21",
     "@types/node": "^22.5.5",
+    "@types/ws": "^8.5.12",
     "nodemon": "^3.1.4",
     "pino-pretty": "^11.2.2",
     "ts-node": "^10.9.2",

backend/collaboration/src/config.ts

@@ -3,3 +3,14 @@ import 'dotenv/config';
 export const UI_HOST = process.env.PEERPREP_UI_HOST!;
 
 export const EXPRESS_PORT = process.env.EXPRESS_PORT;
+
+export const dbConfig = {
+  host: process.env.EXPRESS_DB_HOST!,
+  port: Number.parseInt(process.env.EXPRESS_DB_PORT!),
+  database: process.env.POSTGRES_DB!,
+  user: process.env.POSTGRES_USER,
+  password: process.env.POSTGRES_PASSWORD,
+};
+
+// disable gc when using snapshots!
+export const GC_ENABLED = process.env.GC !== 'false' && process.env.GC !== '0';

backend/collaboration/src/controller/collab-controller.ts

@@ -0,0 +1,27 @@
+import type { Request, Response } from 'express';
+import { StatusCodes } from 'http-status-codes';
+
+import { getCollabRoomService } from '@/service/get/collab-get-service';
+import type { IGetCollabRoomPayload } from '@/service/get/types';
+
+export async function getCollabRoom(req: Request, res: Response) {
+  const { userid1, userid2, questionid } = req.query;
+  const payload: IGetCollabRoomPayload = {
+    userid1: userid1 as string,
+    userid2: userid2 as string,
+    questionid: questionid as string,
+  };
+  try {
+    const result = await getCollabRoomService(payload);
+    if (result.error) {
+      return res.status(result.code).json({
+        error: result.error.message ?? 'An error occurred',
+      });
+    }
+    return res.status(result.code).json(result.data);
+  } catch (err) {
+    return res
+      .status(StatusCodes.INTERNAL_SERVER_ERROR)
+      .json({ success: false, message: 'An error occurred', err });
+  }
+}