Add base code for History Service

Author: ketamethane

Backend/.gitignore

@@ -1,6 +1,7 @@
 QuestionService/.env
 user-service/.env
 MatchingService/.env
+HistoryService/.env
 QuestionService/insert_questions_script.py
 
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

Backend/HistoryService/Dockerfile

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

Backend/HistoryService/app.js

@@ -0,0 +1,43 @@
+const express = require('express')
+const mongoose = require('mongoose')
+const cors = require('cors')
+const dotenv = require("dotenv")
+const historyRouter = require("./controllers/histories")
+
+dotenv.config()
+
+const app = express()
+app.use(cors())
+app.use(express.json())
+
+const mongoURI = `mongodb+srv://${process.env.DB_USERNAME}:${process.env.DB_PASSWORD}@cs3219.rrxz3.mongodb.net/History-DB?retryWrites=true&w=majority&appName=CS3219`
+mongoose.connect(mongoURI)
+.then(() => console.log('MongoDB connected'))
+.catch(err => console.error('MongoDB connection error:', err));
+
+app.use('/api/histories', questionRouter)
+
+app.get("/", (req, res, next) => {
+    console.log("Sending Greetings!");
+    res.json({
+      message: "Hello World from history-service",
+    });
+  });
+  
+// Handle When No Route Match Is Found
+app.use((req, res, next) => {
+    const error = new Error("Route Not Found");
+    error.status = 404;
+    next(error);
+});
+
+app.use((error, req, res, next) => {
+    res.status(error.status || 500);
+    res.json({
+      error: {
+        message: error.message,
+      },
+    });
+});
+
+module.exports = app

Backend/HistoryService/controllers/histories.js

@@ -0,0 +1,39 @@
+const historyRouter = require('express').Router();
+const HistoryModel = require('../models/History');
+
+// Get all history for the logged-in user
+historyRouter.get("/", async (req, res) => {
+    const userId = req.user.id; // Assuming you're using authentication middleware
+    
+    try {
+        // Fetch all history entries for the logged-in user
+        const history = await HistoryModel.find({ user: userId })
+                                          .populate('question matchedUser') // Populating question and matchedUser details
+                                          .exec();
+        res.status(200).json(history);
+    } catch (error) {
+        res.status(500).json({ error: error.message });
+    }
+});
+
+// Post a new history entry when a user exits a session
+historyRouter.post("/", async (req, res) => {
+    const { user, matchedUser, question, duration, code } = req.body;
+
+    try {
+        const newHistory = new HistoryModel({
+            user,
+            matchedUser,
+            question,
+            duration,
+            code
+        });
+
+        await newHistory.save();
+        res.status(201).json(newHistory);
+    } catch (error) {
+        res.status(500).json({ error: error.message });
+    }
+});
+
+module.exports = historyRouter;

Backend/HistoryService/index.js

@@ -0,0 +1,6 @@
+const app = require('./app')
+
+// Change the port number to listen to a different port but remember to change the port number in frontend too!
+app.listen(3005, () => {
+    console.log("Server is Running")
+})

Backend/HistoryService/models/Histories.js

@@ -0,0 +1,35 @@
+const mongoose = require('mongoose');
+
+const HistorySchema = new mongoose.Schema({
+    user: { 
+        type: mongoose.Schema.Types.ObjectId, 
+        ref: 'User', 
+        required: true // The user for whom this history entry is being created
+    },
+    matchedUser: { 
+        type: mongoose.Schema.Types.ObjectId, 
+        ref: 'User', 
+        required: true // The other user they were matched with
+    },
+    question: {
+        type: mongoose.Schema.Types.ObjectId, // Reference to the Question model
+        ref: 'Question',
+        required: true
+    },
+    datetime: {
+        type: Date, // Time when the session started
+        default: Date.now
+    },
+    duration: {
+        type: Number, // Duration in minutes for the individual user
+        required: true
+    },
+    code: {
+        type: Buffer, // Store the code as binary file
+        required: true
+    }
+});
+
+// Create the History model
+const HistoryModel = mongoose.model('History', HistorySchema, 'History');
+module.exports = HistoryModel;

Backend/HistoryService/package.json

@@ -0,0 +1,23 @@
+{
+    "name": "server",
+    "version": "1.0.0",
+    "description": "",
+    "main": "index.js",
+    "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1",
+      "start": "nodemon index.js"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+      "cors": "^2.8.5",
+      "dotenv": "^16.4.5",
+      "express": "^4.21.0",
+      "mongodb": "^6.9.0",
+      "mongoose": "^8.6.3",
+      "mongosh": "^2.3.1",
+      "nodemon": "^3.1.7"
+    }
+  }
+