Merge branch 'master' into master

Author: cheehongw

question_service/package-lock.json

@@ -2,21 +2,28 @@
   "name": "question_service",
   "version": "1.0.0",
   "description": "Backend service for accessing question bank",
-  "main": "server.js",
+  "main": "index.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "dev": "nodemon server.js",
-    "start": "node server.js"
+    "start": "ts-node src/index.ts"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "adm-zip": "^0.5.10",
     "cors": "^2.8.5",
     "dotenv": "^16.3.1",
     "express": "^4.18.2",
-    "mongoose": "^7.5.3"
+    "mongoose": "^7.5.3",
+    "multer": "^1.4.5-lts.1"
   },
   "devDependencies": {
-    "nodemon": "^3.0.1"
+    "@types/cors": "^2.8.16",
+    "@types/express": "^4.17.21",
+    "@types/multer": "^1.4.10",
+    "nodemon": "^3.0.1",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.2.2"
   }
 }

question_service/package.json

@@ -1,13 +1,13 @@
-const mongoose = require('mongoose')
-const Counter = require('../model/counterModel');
+import mongoose from 'mongoose';
+import Counter from '../model/counterModel';
 
 
 // function to start up and connect to MongoDB database
-const connectDB = async () => {
+export const connectDB = async () => {
     try {
         // attempt to connect to MongoDB database via the connection string specified in .env file
         console.log(`connecting with... ${process.env.MONGODB_URI}`)
-        const con = await mongoose.connect(process.env.MONGODB_URI)
+        const con = await mongoose.connect(process.env.MONGODB_URI ?? '')
         console.log(`MongoDB connected: ${con.connection.host} `)
     } catch (error) {
         console.log(error)
@@ -16,7 +16,7 @@ const connectDB = async () => {
     }
 }
 
-const initCounter = async () => {
+export const initCounter = async () => {
     try {
       const questionIndex = await Counter.findById('questionIndex');
       if (!questionIndex) {
@@ -30,7 +30,3 @@ const initCounter = async () => {
       console.log('Error initializing counter:', error);
     }
 };
-
-// export connection function to be used in index.js
-module.exports = { connectDB, initCounter }
-

question_service/routes/questionRouter.js

@@ -1,11 +1,12 @@
-const Question = require('../model/questionModel');
-const questions = require('./question_data');
-const getNextSequenceValue = require('../controller/counterController')
+import Question from '../model/questionModel';
+import { questions } from './question_data';
+import { getNextSequenceValue } from '../controller/counterController';
+
 
 /**
  * Populates the database if questions dont exist
  */
-async function populateData() {
+export async function populateData() {
   try {
     for (const question of questions) {
 
@@ -24,9 +25,7 @@ async function populateData() {
 
     console.log('Questions population completed.');
 
-  } catch (error) {
+  } catch (error : any) {
     console.log(`Populating questions ran into error: ${error.message}`);
   }
 }
-
-module.exports = populateData;

question_service/config/db.js renamed to question_service/src/config/db.ts

@@ -1,4 +1,13 @@
-const questions = [
+interface QuestionData {
+  title: string;
+  description: string;
+  topics: string[];
+  difficulty: number;
+  id?: number;
+}
+
+
+export const questions : QuestionData[] = [
     {
       title: 'Reverse a string',
       description: `
@@ -280,5 +289,3 @@ const questions = [
         difficulty: 9,
       },
   ];
-  
-  module.exports = questions;

question_service/config/populate_qns.js renamed to question_service/src/config/populate_qns.ts

@@ -1,6 +1,6 @@
-const Counter = require('../model/counterModel');
+import Counter from '../model/counterModel';
 
-const getNextSequenceValue = async (sequenceName) => {
+export const getNextSequenceValue = async (sequenceName : string) => {
     try {
         const sequenceDocument = await Counter.findOneAndUpdate(
             { _id: sequenceName },
@@ -13,5 +13,3 @@ const getNextSequenceValue = async (sequenceName) => {
         throw error;  // or handle this in some other appropriate way
     }
 };
-
-module.exports = getNextSequenceValue;

question_service/config/question_data.js renamed to question_service/src/config/question_data.ts

@@ -1,10 +1,10 @@
-const Question = require('../model/questionModel')
-const getNextSequenceValue = require('./counterController')
+import Question from '../model/questionModel';
+import { getNextSequenceValue } from './counterController';
 
 //@desc     fetch all questions
 //@route    GET /api/questions
 //@access   authenticated users
-const fetchAllQuestions = async (req, res) => {
+export const fetchAllQuestions = async (req : any, res : any) => {
     const questions = await Question.find({})
 
     res.status(200).json(questions)
@@ -14,12 +14,15 @@ const fetchAllQuestions = async (req, res) => {
 //@desc     fetch a question
 //@route    GET /api/questions/:id
 //@access   authenticated users
-const fetchQuestion = async (req, res) => {
+export const fetchQuestion = async (req : any, res : any) => {
     try {
         // function provided by mongoose to find an Question document with a given ID
         // req.params.id is retrieved from /:id in route
         const question = await Question.findById(req.params.id)
 
+        if(question === null) {
+            throw Error('Invalid ID. Question not found in database.');
+        }
         res.status(200).json({
             id : question.id,
             _id: question._id,
@@ -28,6 +31,7 @@ const fetchQuestion = async (req, res) => {
             topics: question.topics,
             difficulty: question.difficulty
         })
+
     } catch (error) {
         res.status(400).json({ message: 'Invalid ID. Question not found in database.' })
     }
@@ -36,7 +40,7 @@ const fetchQuestion = async (req, res) => {
 //@desc     add a question
 //@route    POST /api/questions
 //@access   admin only
-const addQuestion = async (req, res) => {
+export const addQuestion = async (req : any, res : any) => {
     const { title, description, topics, difficulty } = req.body;
 
     if (!title || !description || !topics || !difficulty) {
@@ -58,15 +62,15 @@ const addQuestion = async (req, res) => {
             topics: question.topics,
             difficulty: question.difficulty
         })
-    } catch (error) {
+    } catch (error : any) {
         res.status(400).json({ message: 'Invalid question data', error: error.message })
     }
 }
 
 // @desc    Update a question
 // @route   PUT /api/addresses/:id
 // @access  admin only
-const updateQuestion = async (req, res) => {
+export const updateQuestion = async (req : any, res : any) => {
     const { title, description, topics, difficulty } = req.body
 
     if (!title || !description || !topics || !difficulty) {
@@ -77,6 +81,11 @@ const updateQuestion = async (req, res) => {
         // function provided by mongoose to find an Question document with a given ID
         // req.params.id is retrieved from /:id in route
         const question = await Question.findById(req.params.id)
+
+        if(question === null) {
+            throw Error('Invalid ID. Question not found in database.');
+        }
+
         // update the document
         question.title = title
         question.description = description
@@ -105,17 +114,17 @@ const updateQuestion = async (req, res) => {
 // @desc    Delete a question
 // @route   DELETE /api/addresses/:id
 // @access  admin only
-const deleteQuestion = async (req, res) => {
+export const deleteQuestion = async (req : any, res : any) => {
     try {
         // function provided by mongoose to find an Question document with a given ID
         // req.params.id is retrieved from /:id in route
         const question = await Question.findById(req.params.id);
+        if(question === null) {
+            throw Error('Invalid ID. Question not found in database.');
+        }
         await question.deleteOne();
         res.status(200).json({ message: 'Question removed' });
     } catch (error) {
         res.status(404).json({ message: 'Question not found' })
     }
-}
-
-
-module.exports = { fetchAllQuestions, fetchQuestion, addQuestion, updateQuestion, deleteQuestion }
+}

question_service/controller/counterController.js renamed to question_service/src/controller/counterController.ts

@@ -1,10 +1,12 @@
-const express = require('express')
-const cors = require('cors')
-const dotenv = require('dotenv').config()
-const {connectDB, initCounter } = require('./config/db')
-const populateData = require('./config/populate_qns');
+import express from 'express';
+import cors from 'cors';
+import dotenv from 'dotenv';
+import { connectDB, initCounter } from './config/db';
+import { populateData } from './config/populate_qns';
+import questionRouter from './routes/questionRouter'
 
-require('dotenv').config()
+
+dotenv.config();
 
 connectDB().then((v) => {
     initCounter();
@@ -27,7 +29,7 @@ app.use(express.urlencoded({ extended: false }))
 
 // use the address router to handle requests 
 // at http://localhost:8080/api/addresses
-app.use('/api/questions', require('./routes/questionRouter'))
+app.use('/api/questions', questionRouter)
 
 
 const PORT = process.env.PORT || 8080;
@@ -36,11 +38,3 @@ const PORT = process.env.PORT || 8080;
 app.listen(PORT, () => {
     console.log(`Server is running on port ${ PORT }...`)
 })
-
-
-app.get('/', (req, res) => {
-    res.json({ message: 'Hello World' })
-})
-
-
-module.exports = app

question_service/controller/questionController.js renamed to question_service/src/controller/questionController.ts

@@ -0,0 +1,3 @@
+const multer = require('multer');
+const fs = require('fs');
+const unzipper = require('unzipper');