Feedback

.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/cd.yml

@@ -0,0 +1,75 @@
+name: CD
+
+on:
+    push:
+        branches: ['main']
+
+jobs:
+    push:
+        name: Build and Push
+        timeout-minutes: 15
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                include:
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-user-service
+                      dockerfile: ./backend/user-service/Dockerfile
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-question-service
+                      dockerfile: ./backend/question-service/Dockerfile
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-matching-service
+                      dockerfile: ./backend/matching-service/Dockerfile
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-collaboration-service
+                      dockerfile: ./backend/collaboration-service/Dockerfile
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 2
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v3
+            - name: Login to Docker Hub
+              uses: docker/login-action@v3
+              with:
+                  username: ${{ secrets.DOCKERHUB_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
+            - name: Build and push
+              uses: docker/build-push-action@v6
+              with:
+                  context: .
+                  file: ${{ matrix.dockerfile }}
+                  push: true
+                  tags: ${{ matrix.image }}:latest
+                  cache-from: type=gha
+                  cache-to: type=gha,mode=max
+    deploy:
+        name: Deploy to VPS
+        needs: push
+        timeout-minutes: 15
+        runs-on: ubuntu-latest
+        steps:
+            - name: Deploy
+              uses: appleboy/ssh-action@v1.1.0
+              env:
+                  VPS_HOST: ${{ secrets.VPS_HOST }}
+                  VPS_SSL_KEY_FILE: ${{ secrets.VPS_SSL_KEY_FILE }}
+                  VPS_SSL_CERT_FILE: ${{ secrets.VPS_SSL_CERT_FILE }}
+                  ACCESS_TOKEN_PUBLIC_KEY: ${{ secrets.ACCESS_TOKEN_PUBLIC_KEY }}
+                  ACCESS_TOKEN_PRIVATE_KEY: ${{ secrets.ACCESS_TOKEN_PRIVATE_KEY }}
+                  NODEMAILER_EMAIL: ${{ secrets.NODEMAILER_EMAIL }}
+                  NODEMAILER_PASSWORD: ${{ secrets.NODEMAILER_PASSWORD }}
+                  RMQ_USER: ${{ secrets.RMQ_USER }}
+                  RMQ_PASSWORD: ${{ secrets.RMQ_PASSWORD }}
+                  MONGO_USER: ${{ secrets.MONGO_USER }}
+                  MONGO_PASSWORD: ${{ secrets.MONGO_PASSWORD }}
+              with:
+                  host: ${{ secrets.VPS_HOST }}
+                  username: ${{ secrets.VPS_USERNAME }}
+                  key: ${{ secrets.SSH_PRIVATE_KEY }}
+                  envs: VPS_HOST,VPS_SSL_KEY_FILE,VPS_SSL_CERT_FILE,ACCESS_TOKEN_PUBLIC_KEY,ACCESS_TOKEN_PRIVATE_KEY,NODEMAILER_EMAIL,NODEMAILER_PASSWORD,RMQ_USER,RMQ_PASSWORD,MONGO_USER,MONGO_PASSWORD
+                  script: |
+                      cd cs3219-ay2425s1-project-g31
+                      git switch main
+                      git pull
+                      docker compose down
+                      docker compose pull
+                      docker compose up -d

.github/workflows/ci.yml

@@ -0,0 +1,95 @@
+name: CI
+
+on:
+    pull_request:
+        types: [opened, synchronize]
+
+jobs:
+    build:
+        name: Build
+        timeout-minutes: 15
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                include:
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-user-service
+                      dockerfile: ./backend/user-service/Dockerfile
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-question-service
+                      dockerfile: ./backend/question-service/Dockerfile
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-matching-service
+                      dockerfile: ./backend/matching-service/Dockerfile
+                    - image: glemenneo/cs3219-ay2425s1-project-g31-collaboration-service
+                      dockerfile: ./backend/collaboration-service/Dockerfile
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 2
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v3
+            - name: Login to Docker Hub
+              uses: docker/login-action@v3
+              with:
+                  username: ${{ secrets.DOCKERHUB_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
+            - name: Build
+              uses: docker/build-push-action@v6
+              with:
+                  context: .
+                  file: ${{ matrix.dockerfile }}
+                  push: false # Do not push to Docker Hub, only cache the image for later use in CD
+                  tags: ${{ matrix.image }}:latest
+                  cache-from: type=gha
+                  cache-to: type=gha,mode=max
+    test:
+        name: 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: Cache node modules
+              id: cache-npm
+              uses: actions/cache@v3
+              env:
+                  cache-name: cache-node-modules
+              with:
+                  # npm cache files are stored in `~/.npm` on Linux/macOS
+                  path: ~/.npm
+                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  restore-keys: |
+                      ${{ runner.os }}-build-${{ env.cache-name }}-
+                      ${{ runner.os }}-build-
+                      ${{ runner.os }}-
+
+            - name: Cache turbo artifacts
+              uses: actions/cache@v4
+              with:
+                  path: .turbo
+                  key: ${{ runner.os }}-turbo-${{ github.sha }}
+                  restore-keys: |
+                      ${{ runner.os }}-turbo-
+
+            - 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 # Required to build the internal
+
+            - name: Test
+              run: npm run test

.gitignore

@@ -0,0 +1,25 @@
+.git
+.vscode
+
+/node_modules
+**/node_modules
+
+**/.env
+**/.env.*
+
+**/dist
+**/coverage
+
+**/*.log
+
+**/.turbo
+
+**/*.tsbuildinfo
+
+/nginx/ssl
+
+# Local Netlify folder
+.netlify
+
+# Local shell scripts
+**/*.sh

.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/collaboration-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/collaboration-service/.prettierignore

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

backend/collaboration-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=collaboration-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=collaboration-service
+
+#############################################
+# ----  Start ----
+FROM base AS runner
+WORKDIR /app
+
+# Don't run production as root
+RUN addgroup --system --gid 1001 nodejs && adduser --system --uid 1001 collaboration-service
+USER collaboration-service
+
+COPY --from=installer /app .
+
+CMD ["node", "backend/collaboration-service/dist/server"]

backend/collaboration-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: '3008',
+    ACCESS_TOKEN_PUBLIC_KEY: Buffer.from(publicKey).toString('base64'),
+    ACCESS_TOKEN_PRIVATE_KEY: Buffer.from(privateKey).toString('base64'),
+    DB_URL: 'mongodb://localhost:27017/user-service',
+    USER_SERVICE_URL: 'http://localhost:3002',
+    QUESTION_SERVICE_URL: 'http://localhost:3004',
+    MATCHING_SERVICE_URL: 'http://localhost:3006',
+}

backend/collaboration-service/__tests__/index.test.ts

@@ -0,0 +1,14 @@
+import request from 'supertest'
+import configMock from '../__mocks__/config.mock'
+import app from '../src/index'
+
+jest.mock('../src/common/config.util', () => configMock)
+
+describe('Index', () => {
+    describe('GET /', () => {
+        it('should return 200 OK', async () => {
+            const response = await request(app).get('/')
+            expect(response.status).toBe(200)
+        })
+    })
+})

backend/collaboration-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,
+}