History Service (#69)

* Initialize history service

* History: Centralize env variables

* History: Create model

* History: Add endpoint

* Collab: Add producers to trigger history

* History: Add history consumers

* Add tests for history service

* Add GHA to history service

* History: Add README

* Collab: Update README

* Minor fixes

* Include new dependency in gateway
* Fix wrong gateway route
* Remove versioning

* Fix typo

Author: samuelim01

.env.sample

@@ -24,6 +24,10 @@ COLLAB_DB_LOCAL_URI=mongodb://collaboration-db:27017/collaboration-service
 YJS_DB_CLOUD_URI=mongodb+srv://<username>:<password>@cluster0.h5ukw.mongodb.net/yjs-documents?retryWrites=true&w=majority&appName=Cluster0
 YJS_DB_LOCAL_URI=mongodb://collaboration-db:27017/yjs-documents
 
+# History Service
+HISTORY_DB_CLOUD_URI=<FILL-THIS-IN>
+HISTORY_DB_LOCAL_URI=mongodb://history-db:27017/history
+
 # Will use cloud MongoDB Atlas database
 ENV=PROD
 

.github/workflows/tests.yml

@@ -36,3 +36,22 @@ jobs:
         run: cd ${{ matrix.service }} && npm run lint
       - name: Build App
         run: cd ${{ matrix.service }} && npm run build
+
+          
+  build-history:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Install Node Modules
+        run: cd services/history && npm ci
+      - name: Linting
+        run: cd services/history && npm run lint
+      - name: Build App
+        run: cd services/history && npm run build
+      - name: Run tests
+        run: cd services/history && npm run test

compose.dev.yml

@@ -52,6 +52,22 @@ services:
     ports:
       - 27020:27017
 
+  collaboration-db:
+    ports:
+      - 27020:27017
+  
+  history:
+    command: npm run dev
+    ports:
+      - 8086:8086
+    volumes:
+      - /app/node_modules
+      - ./services/history:/app
+  
+  history-db:
+    ports:
+      - 27021:27017
+  
   broker:
     ports:
       - 5672:5672

compose.yml

@@ -21,6 +21,7 @@ services:
       - user
       - match
       - collaboration
+      - history
     networks:
       - gateway-network
     restart: always
@@ -167,12 +168,39 @@ services:
     networks:
       - collaboration-db-network
     restart: always
+  
+  history:
+    container_name: history
+    image: history
+    build:
+      context: services/history
+      dockerfile: Dockerfile
+    environment:
+      DB_CLOUD_URI: ${HISTORY_DB_CLOUD_URI}
+      DB_LOCAL_URI: ${HISTORY_DB_LOCAL_URI}
+      BROKER_URL: ${BROKER_URL}
+      JWT_SECRET: ${JWT_SECRET}
+    depends_on:
+      broker:
+        condition: service_healthy
+    networks:
+      - gateway-network
+      - history-db-network
+
+  history-db:
+    container_name: history-db
+    image: mongo:7.0.14
+    volumes:
+      - history-db:/data/db
+    networks:
+      - history-db-network
 
 volumes:
   question-db:
   user-db:
   match-db:
   collaboration-db:
+  history-db:
 
 networks:
   gateway-network:
@@ -184,4 +212,6 @@ networks:
   match-db-network:
     driver: bridge
   collaboration-db-network:
-    driver: bridge
+    driver: bridge
+  history-db-network:
+    driver: bridge

nginx/default.conf

@@ -14,6 +14,10 @@ upstream collaboration-api {
     server collaboration:8084;
 }
 
+upstream history-api {
+    server history:8086;
+}
+
 server {
     listen 8080;
     server_name localhost;
@@ -40,4 +44,9 @@ server {
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection "upgrade";
     }
+
+    location /api/history {
+        proxy_pass http://history-api;
+        proxy_set_header Host $host;
+    }
 }

services/collaboration/README.md

@@ -348,14 +348,16 @@ curl -X PATCH http://localhost:8080/api/collaboration/room/6724e9d892fb3e9f04c2e
 ## Documentation on Queue (RabbitMQ)
 
 The collaboration service uses RabbitMQ as a message broker to facilitate communication between microservices (such as
-the `matching service` and `collaboration service`) in an asynchronous manner. The system consists of a consumer and two
+the `matching service` and `collaboration service`) in an asynchronous manner. The system consists of a consumer and four
 producers:
 
 ### Queues Used
 
 - `QUESTION_FOUND`: Handles messages related to matching users and creating collaboration rooms.
 - `COLLAB_CREATED`: Sends messages indicating that a collaboration room has been successfully created.
 - `MATCH_FAILED`: Sends messages indicating that a collaboration room could not be created.
+- `CREATE_HISTORY`: Sends messages requesting that user history be created for the new collaboration room.
+- `UPDATE_HISTORY`: Sends messages requesting that user history be updated for the new collaboration room.
 
 ---
 
@@ -393,6 +395,53 @@ The producer will send a message to the `MATCH_FAILED` queue when a collaboratio
 }
  ```
 
+The producer will send a message to the `CREATE_HISTORY` queue when a collaboration room was created successfully.
+
+- **Queue**: `CREATE_HISTORY`
+- **Data Produced**
+  - `roomId` - The ID of the collaboration room.
+  - `user1` - The first user associated with the collaboration room.
+  - `user2` - The second user associated with the collaboration room.
+  - `question` - The question associated with the collaboration room.
+
+  ```json
+    {
+      "roomId": "67234d29aa52f2376973f96a",
+      "user1": {
+        "username": "user123",
+        "_id": "671a064a6f536e9af46b0017"
+      },
+      "user2": {
+        "username": "userabc",
+        "_id": "671a06526f536e9af46b001f"
+      },
+      "question": {
+        "id": 1,
+        "title": "Roman to Integer",
+        "description": "Given a roman numeral, convert it to an integer.",
+        "topics": [ "Algorithms" ],
+        "difficulty": "Easy",
+        "_id": "671a0615dc63fe2d5f3bbae5"
+      },
+    },
+  ```
+
+The producer will send a message to the `UPDATE_HISTORY` queue when a user forfeits or completes a collaborative session.
+
+- **Queue**: `UPDATE_HISTORY`
+- **Data Produced**
+  - `roomId` - The ID of the collaboration room.
+  - `userId` - The user associated with the update.
+  - `status` - The new status associated with the collaboration room. It may be `"IN_PROGRESS"`, `"FORFEITED"`, or `"COMPLETED"`.
+
+  ```json
+    {
+      "roomId": "67234d29aa52f2376973f96a",
+      "userId": "671a064a6f536e9af46b0017",
+      "status": "FORFEITED"
+    },
+  ```
+
 ---
 
 ## Consumer

services/collaboration/src/controllers/roomController.ts

@@ -10,6 +10,8 @@ import {
 } from '../services/mongodbService';
 import { handleHttpNotFound, handleHttpSuccess, handleHttpServerError, handleHttpBadRequest } from '../utils/helper';
 import { Room } from './types';
+import { produceUpdateHistory } from '../events/producer';
+import { HistoryStatus } from '../types/message';
 
 export enum Difficulty {
     Easy = 'Easy',
@@ -96,6 +98,12 @@ export const closeRoomController = async (req: Request, res: Response) => {
         }
 
         await deleteYjsDocument(roomId);
+        await Promise.all(
+            room.users
+                .filter(user => !user.isForfeit)
+                .map(user => produceUpdateHistory(roomId, user.id, HistoryStatus.COMPLETED)),
+        );
+
         console.log(`Room ${roomId} closed and Yjs document removed`);
 
         return handleHttpSuccess(res, `Room ${roomId} successfully closed`);
@@ -130,6 +138,7 @@ export const updateUserStatusInRoomController = async (req: Request, res: Respon
             return handleHttpNotFound(res, 'User not found in room');
         }
 
+        await produceUpdateHistory(roomId, userId, HistoryStatus.FORFEITED);
         const allUsersForfeited = updatedRoom.users.every(user => user.isForfeit === true);
         if (allUsersForfeited) {
             const result = await closeRoomById(roomId);

services/collaboration/src/events/consumer.ts

@@ -2,7 +2,7 @@ import { Queues } from './queues';
 import messageBroker from './broker';
 import { createRoomWithQuestion } from '../controllers/roomController';
 import { QuestionFoundEvent } from '../types/event';
-import { produceCollabCreated, produceCollabCreateFailedEvent } from './producer';
+import { produceCollabCreated, produceCollabCreateFailedEvent, produceCreateHistory } from './producer';
 
 async function consumeQuestionFound(message: QuestionFoundEvent) {
     console.log('Attempting to create room:', message);
@@ -15,6 +15,12 @@ async function consumeQuestionFound(message: QuestionFoundEvent) {
     if (roomId) {
         console.log('Room created with ID:', message, roomId);
         await produceCollabCreated(requestId1, requestId2, roomId, question);
+        await produceCreateHistory(
+            roomId,
+            { _id: user1.id, username: user1.username },
+            { _id: user2.id, username: user2.username },
+            question,
+        );
     } else {
         console.log('Failed to create room:', message);
         await produceCollabCreateFailedEvent(requestId1, requestId2);

services/collaboration/src/events/producer.ts

@@ -1,4 +1,5 @@
 import { CollabCreatedEvent, IdType, MatchFailedEvent, Question } from '../types/event';
+import { CreateHistoryMessage, HistoryStatus, UpdateHistoryMessage, User } from '../types/message';
 import messageBroker from './broker';
 import { Queues } from './queues';
 
@@ -18,3 +19,13 @@ export async function produceCollabCreateFailedEvent(requestId1: IdType, request
     const message: MatchFailedEvent = { requestId1, requestId2, reason: COLLAB_CREATED_ERROR };
     await messageBroker.produce(Queues.MATCH_FAILED, message);
 }
+
+export async function produceCreateHistory(roomId: IdType, user1: User, user2: User, question: Question) {
+    const message: CreateHistoryMessage = { roomId, user1, user2, question };
+    await messageBroker.produce(Queues.CREATE_HISTORY, message);
+}
+
+export async function produceUpdateHistory(roomId: IdType, userId: IdType, status: HistoryStatus) {
+    const message: UpdateHistoryMessage = { roomId, userId, status };
+    await messageBroker.produce(Queues.UPDATE_HISTORY, message);
+}

services/collaboration/src/events/queues.ts

@@ -6,4 +6,6 @@ export enum Queues {
     QUESTION_FOUND = 'QUESTION_FOUND',
     COLLAB_CREATED = 'COLLAB_CREATED',
     MATCH_FAILED = 'MATCH_FAILED',
+    CREATE_HISTORY = 'CREATE_HISTORY',
+    UPDATE_HISTORY = 'UPDATE_HISTORY',
 }