Add read endpoints

-implement endpoint to read questions for question list (with filter and search functionality)
-implement endpoint to read question using specific question id

Author: feliciagan

backend/question-service/src/controllers/questionController.ts

@@ -5,6 +5,10 @@ import {
   DUPLICATE_QUESTION_RESPONSE_MESSAGE,
   QN_DESC_EXCEED_CHAR_LIMIT_RESPONSE_MESSAGE,
   QN_DESC_CHAR_LIMIT,
+  QN_CREATED,
+  QN_NOT_FOUND,
+  SERVER_ERROR,
+  QN_RETRIEVED,
 } from "../utils/constants.ts";
 
 export const createQuestion = async (
@@ -39,11 +43,11 @@ export const createQuestion = async (
     await newQuestion.save();
 
     res.status(201).json({
-      message: "Question created successfully",
+      message: QN_CREATED,
       question: newQuestion,
     });
   } catch (error) {
-    res.status(500).json({ message: "Server error", error });
+    res.status(500).json({ message: SERVER_ERROR, error });
   }
 };
 
@@ -57,7 +61,7 @@ export const updateQuestion = async (
 
     const currentQuestion = await Question.findById(id);
     if (!currentQuestion) {
-      res.status(404).json({ message: "Question not found" });
+      res.status(404).json({ message: QN_NOT_FOUND });
       return;
     }
 
@@ -85,6 +89,92 @@ export const updateQuestion = async (
       question: updatedQuestion,
     });
   } catch (error) {
-    res.status(500).json({ message: "Server error", error });
+    res.status(500).json({ message: SERVER_ERROR, error });
+  }
+};
+
+export const readQuestionsList = async (
+  req: Request,
+  res: Response,
+): Promise<void> => {
+  try {
+    const qnLimit = 10;
+
+    const { currPage } = req.params;
+    const currPageInt = parseInt(currPage);
+
+    if (!req.body || Object.keys(req.body).length == 0) {
+      const totalQuestions = await Question.countDocuments();
+      if (totalQuestions == 0) {
+        res.status(404).json({ message: QN_NOT_FOUND });
+        return;
+      }
+      const totalPages = Math.ceil(totalQuestions / qnLimit);
+
+      const currPageQuestions = await Question.find()
+        .skip((currPageInt - 1) * qnLimit)
+        .limit(qnLimit);
+
+      res.status(200).json({
+        message: QN_RETRIEVED,
+        pages: totalPages,
+        questions: currPageQuestions,
+      });
+    } else {
+      const { title, complexities, categories } = req.body;
+      const query: any = {};
+
+      if (title) {
+        query.title = { $regex: new RegExp(title, "i") };
+      }
+
+      if (complexities && complexities.length > 0) {
+        query.complexity = { $in: complexities };
+      }
+
+      if (categories && categories.length > 0) {
+        query.category = { $in: categories };
+      }
+
+      const filteredTotalQuestions = await Question.countDocuments(query);
+      if (filteredTotalQuestions == 0) {
+        res.status(404).json({ message: QN_NOT_FOUND });
+        return;
+      }
+      const filteredTotalPages = Math.ceil(filteredTotalQuestions / qnLimit);
+
+      const filteredQuestions = await Question.find(query)
+        .skip((currPageInt - 1) * qnLimit)
+        .limit(qnLimit);
+
+      res.status(200).json({
+        message: QN_RETRIEVED,
+        pages: filteredTotalPages,
+        questions: filteredQuestions,
+      });
+    }
+  } catch (error) {
+    res.status(500).json({ message: SERVER_ERROR, error });
+  }
+};
+
+export const readQuestionIndiv = async (
+  req: Request,
+  res: Response,
+): Promise<void> => {
+  try {
+    const { id } = req.params;
+
+    const questionDetails = await Question.findById(id);
+    if (!questionDetails) {
+      res.status(404).json({ message: QN_NOT_FOUND });
+      return;
+    }
+    res.status(200).json({
+      message: QN_RETRIEVED,
+      question: questionDetails,
+    });
+  } catch (error) {
+    res.status(500).json({ message: SERVER_ERROR, error });
   }
 };

backend/question-service/src/routes/questionRoutes.ts

@@ -2,6 +2,8 @@ import express from "express";
 import {
   createQuestion,
   updateQuestion,
+  readQuestionsList,
+  readQuestionIndiv,
 } from "../controllers/questionController.ts";
 
 const router = express.Router();
@@ -10,4 +12,8 @@ router.post("/questions", createQuestion);
 
 router.put("/questions/:id", updateQuestion);
 
+router.post("/questionsquery/:currPage", readQuestionsList);
+
+router.get("/questions/:id", readQuestionIndiv);
+
 export default router;

backend/question-service/src/utils/constants.ts

@@ -5,3 +5,11 @@ export const QN_DESC_EXCEED_CHAR_LIMIT_RESPONSE_MESSAGE =
 
 export const DUPLICATE_QUESTION_RESPONSE_MESSAGE =
   "Duplicate question: A question with the same title already exists.";
+
+export const QN_CREATED = "Question created successfully.";
+
+export const QN_NOT_FOUND = "Question not found.";
+
+export const SERVER_ERROR = "Server error.";
+
+export const QN_RETRIEVED = "Question retrieved successfully.";