Feedback

.github/workflows/matching-service.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: matching-service
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'npm'
+      - run: npm ci
+      - run: |
+          npm run start &
+          npm test

.gitignore

@@ -0,0 +1,11 @@
+# Node.js
+node_modules/
+./matching-service/node_modules
+./frontend/node_modules
+
+# JetBrains
+.idea/
+
+# PeerPrep
+.env
+/matching-service/dev.sqlite

README.md

@@ -1,14 +1,22 @@
-# CS3219-AY22-23-Project-Skeleton
+# Running this app locally
 
-This is a template repository for CS3219 project.
+1. Make a copy of the `env.sample` file in the root directory of the project and name it `.env`
 
-## User Service
-1. Rename `.env.sample` file to `.env`.
-2. Create a Cloud DB URL using Mongo Atlas.
-3. Enter the DB URL created as `DB_CLOUD_URI` in `.env` file.
-4. Install npm packages using `npm i`.
-5. Run User Service using `npm run dev`.
+2. Fill up the `.env` file
 
-## Frontend
-1. Install npm packages using `npm i`.
-2. Run Frontend using `npm start`.
+   > Fields in the `.env` file that you may want to change or fill up:
+   >
+   > - `USER_SERVICE_MONGO_ENV`: By default this should be `PROD`, which will allow the user service database to use `USER_SERVICE_MONGO_URI_CLOUD` as the cloud URI. You can change it to `DEV` and run a local MongoDB, then putting the URI in the `USER_SERVICE_MONGO_URI_LOCAL` field.
+   > - `USER_SERVICE_MONGO_URI_CLOUD`: If you did not change the previous field, you will need to provide an URI to your own cloud MongoDB.
+   > - `USER_SERVICE_JWT_SECRET_KEY`: You can put your generated secret key here. Or you can use an example secret key: `b00f21108ef28c3984ca9dea05e8bf297a11688779376356e34406543991c0fc36b0ee5a6cf9a30b79e835746088e11932a637553beb82d0f8bc736584697a03` 
+   > - `MATCHING_SERVICE_POSTGRES_PASSWORD`: You can put a new initial postgres password here or leave it as it is. **Do not leave it blank or the Postgres container will fail upon startup.**
+   >
+   > 
+   >
+   > Note: `QUESTION_SERVICE_MONGO_URI_CLOUD` is the URI to the cloud database for question bank which is provided by default as it contains prepared question for the question service. Please do not edit this URI.
+
+3. Run `./startup.sh` and you should see the `.env` file being copied to all backend service folders. **If your computer does not support shell script execution, you can manually copy the `.env` file into *user-service*, *matching-service*, *question-service*, *editor-service* and *chat-service* folders.**
+
+4. Run `docker-compose --env-file ./.env up --build`
+
+5. Wait until all containers are compiled and running, visit `localhost:3000` . (The frontend usually take the longest to compile)

api-gateway/Dockerfile

@@ -0,0 +1,3 @@
+FROM nginx
+
+COPY ./nginx.conf.template /etc/nginx/conf.d/nginx.conf.template

api-gateway/nginx.conf.template

@@ -0,0 +1,23 @@
+server {
+  listen ${API_GATEWAY_PORT};
+
+  location ${USER_SERVICE_PREFIX} {
+    proxy_pass http://${USER_SERVICE_HOST}:${USER_SERVICE_PORT}${USER_SERVICE_PREFIX};
+  }
+
+  location ${MATCHING_SERVICE_SOCKETIO_PATH} {
+    proxy_pass http://${MATCHING_SERVICE_HOST}:${MATCHING_SERVICE_PORT}${MATCHING_SERVICE_SOCKETIO_PATH};
+  }
+
+  location ${QUESTION_SERVICE_PREFIX} {
+    proxy_pass http://${QUESTION_SERVICE_HOST}:${QUESTION_SERVICE_PORT}${QUESTION_SERVICE_PREFIX};
+  }
+
+  location ${EDITOR_SERVICE_SOCKETIO_PATH} {
+    proxy_pass http://${EDITOR_SERVICE_HOST}:${EDITOR_SERVICE_PORT}${EDITOR_SERVICE_SOCKETIO_PATH};
+  }
+
+  location ${CHAT_SERVICE_SOCKETIO_PATH} {
+    proxy_pass http://${CHAT_SERVICE_HOST}:${CHAT_SERVICE_PORT}${CHAT_SERVICE_SOCKETIO_PATH};
+  }
+}

chat-service/.dockerignore

@@ -0,0 +1 @@
+node_modules/

chat-service/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:16
+
+WORKDIR /
+
+COPY package*.json ./
+
+RUN npm install
+
+COPY . .
+
+CMD [ "npm", "start" ]

chat-service/controller/chat-controller.js

@@ -0,0 +1,77 @@
+import axios from 'axios';
+import { joinRoom, newMessage } from '../service/chat-service.js';
+import * as dotenv from 'dotenv';
+import * as dotenvExpand from 'dotenv-expand';
+dotenvExpand.expand(dotenv.config());
+const USER_SRV_PREFIX = process.env.USER_SERVICE_PREFIX;
+const GATEWAY_HOST = process.env.API_GATEWAY_HOST;
+const GATEWAY_PORT = process.env.API_GATEWAY_PORT;
+
+async function authenticateUser(username, token) {
+  let authSuccess;
+  await axios.get(`http://${GATEWAY_HOST}:${GATEWAY_PORT}${USER_SRV_PREFIX}/authentication`, {
+    params: {
+      username: username,
+      auth: token,
+    },
+  }).then(() => {
+    authSuccess = true;
+  }).catch(() => {
+    authSuccess = false;
+  });
+  return authSuccess;
+}
+
+export async function handleJoinRoom(data, socket) {
+  try {
+    const { token, username, roomId } = data;
+    if (token && username && roomId) {
+      const authSuccess = await authenticateUser(username, token);
+      if (!authSuccess) {
+        socket.emit('join room failure', {
+          status: 403,
+          message: 'Not allowed to access this resource',
+        });
+        return;
+      }
+      joinRoom(roomId, socket);
+    } else {
+      socket.emit('join room failure', {
+        status: 400,
+        message: 'Missing token and/or username and/or roomId',
+      });
+    }
+  } catch (err) {
+    socket.emit('join room failure', {
+      status: 500,
+      message: `The server encounters an error: ${err}`,
+    });
+  }
+}
+
+export async function handleNewMessage(data, socket) {
+  try {
+    const { token, username, message } = data;
+    if (token && username && (message !== undefined)) {
+      const authSuccess = await authenticateUser(username, token);
+      if (!authSuccess) {
+        socket.emit('message failure', {
+          status: 403,
+          message: 'Not allowed to access this resource',
+        });
+        return;
+      }
+      newMessage(username, message, socket);
+    } else {
+      socket.emit('message failure', {
+        status: 400,
+        message: 'Missing token and/or username and/or message',
+      });
+    }
+  } catch (err) {
+    socket.emit('message failure', {
+      status: 500,
+      message: `The server encounters an error: ${err}`,
+    });
+  }
+}

chat-service/index.js

@@ -0,0 +1,49 @@
+import cors from 'cors';
+
+import * as dotenv from 'dotenv';
+import * as dotenvExpand from 'dotenv-expand';
+import express from 'express';
+import { createServer } from 'http';
+import { Server } from 'socket.io';
+import { handleJoinRoom, handleNewMessage } from './controller/chat-controller.js';
+
+dotenvExpand.expand(dotenv.config());
+const PORT = process.env.CHAT_SERVICE_PORT;
+
+const app = express();
+
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+app.use(cors()); // config cors so that front-end can use
+app.options('*', cors());
+
+const server = createServer(app);
+const io = new Server(server, {
+  cors: { origin: '*' },
+  path: process.env.CHAT_SERVICE_SOCKETIO_PATH,
+});
+
+io.on('connection', (socket) => {
+  console.log('a user connected, socket id: ' + socket.id); // ojIckSD2jqNzOqIrAGzL
+
+  socket.on('join room', (data) => {
+    // emitted when user enters the room (page) after matching
+    handleJoinRoom(data, socket);
+  });
+
+  socket.on('message', (data) => {
+    // emitted when either user sends a new message
+    handleNewMessage(data, socket);
+  });
+
+  socket.on('disconnect', () => {
+    // nothing to handle
+    console.log('a user disconnected, socket id: ' + socket.id);
+  });
+});
+
+server.listen(PORT, () => {
+  console.log('Chat service server started on port ' + PORT);
+});
+
+export default io;