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

Signed-off-by: SeeuSim <[email protected]>

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

.eslintrc.json

@@ -17,10 +17,10 @@
     "react",
     "@typescript-eslint",
     "tailwindcss",
-    "react-hooks"
+    "react-hooks",
+    "simple-import-sort"
   ],
   "rules": {
-    // "@next/next/no-img-element": "off",
     "@typescript-eslint/no-explicit-any": "warn",
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/explicit-function-return-type": 0,
@@ -36,11 +36,21 @@
     "@typescript-eslint/no-empty-interface": "off",
     "@typescript-eslint/no-unused-vars": 0,
     "@typescript-eslint/no-use-before-define": 0,
+    
     // Basic
     "array-callback-return": "warn",
     "no-console": "warn",
+    "no-multiple-empty-lines": ["error", { "max":1 }],
     "no-prototype-builtins": 0,
-    // "no-expected-multiline": "warn", // can't find rule definition
+    // "no-expected-multiline": "warn", // can"t find rule definition
+
+    "padding-line-between-statements": [
+      "warn",
+      { "blankLine": "always", "prev": "*", "next": "block" },
+      { "blankLine": "always", "prev": "block", "next": "*" },
+      { "blankLine": "always", "prev": "*", "next": "block-like" },
+      { "blankLine": "always", "prev": "block-like", "next": "*" }
+    ],
 
     // React
     "react/display-name": 0,
@@ -54,6 +64,8 @@
       }
     ],
     "react-hooks/rules-of-hooks": "off",
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
     "tailwindcss/enforces-negative-arbitrary-values": "off",
     "unused-imports/no-unused-imports": "error",
     "unused-imports/no-unused-vars": [
@@ -73,6 +85,22 @@
       "rules": {
         "react/prop-types": "off"
       }
+    },
+    {
+      "files": ["*.js", "*.ts", "*.tsx"],
+      "rules": {
+        "simple-import-sort/imports": [
+          "error",
+          {
+            "groups": [
+              ["^(?:os|path|http|fs|crypto|util|events|stream|url|zlib|querystring|tls|dgram|net|dns|child_process|cluster|readline|vm|assert|buffer|process|timers)(\/.*)?$"],
+              ["^(?!(@\/|\\.\\.\/|\\.\/))"],
+              ["^@\/"],
+              ["^(?:\\.\/|\\.\\.\/|\\.)"]
+            ]
+          }
+        ]
+      }
     }
   ]
 }

.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 && github.event.pull_request.title != 'Feedback' }}
     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';