Merge pull request #101 from CS3219-AY2425S1/jehou/questiondb

Enable soft deletes

Author: jehousoh

backend/question/src/models/Question.ts

@@ -11,6 +11,7 @@ export type TQuestion = {
   description: string;
   category: [string];
   complexity: string;
+  deleted: boolean;
 };
 
 // Document provides an id field
@@ -34,6 +35,10 @@ const questionSchema: Schema = new Schema(
       type: String,
       required: true,
     },
+    deleted: {
+      type: Boolean,
+      required: true,
+    },
   },
   { collection: "questions" }
 );

backend/question/src/routes/questionRoutes.ts

@@ -36,7 +36,13 @@ router.post(
         });
       }
 
-      const question = { title, description, category, complexity };
+      const question = {
+        title,
+        description,
+        category,
+        complexity,
+        deleted: false,
+      };
       const newQuestion = new Question(question);
       await newQuestion.save();
       return res.status(200).json({
@@ -56,7 +62,7 @@ router.post("/all", async (req: Request, res: Response) => {
   const skip = (pagination - 1) * page_size; // Calculate how many documents to skip
   try {
     const questions = await Question.find(
-      {},
+      { deleted: false },
       {
         questionid: 1,
         title: 1,
@@ -71,7 +77,7 @@ router.post("/all", async (req: Request, res: Response) => {
       .limit(page_size)
       .exec();
 
-    const total = await Question.countDocuments().exec();
+    const total = await Question.countDocuments({ deleted: false }).exec();
     const totalPages = Math.ceil(total / page_size);
     if (totalPages < pagination) pagination = 1;
 
@@ -96,12 +102,22 @@ router.get("/:id", [...idValidators], async (req: Request, res: Response) => {
   try {
     const question = await Question.findOne(
       { questionid: questionId },
-      { questionid: 1, title: 1, description: 1, complexity: 1, category: 1 }
+      {
+        questionid: 1,
+        title: 1,
+        description: 1,
+        complexity: 1,
+        category: 1,
+        deleted: 1,
+      }
     ).exec();
-    if (!question) {
+    if (!question || question.deleted) {
       return res.status(404).json({ message: "Question not found" });
     }
-    return res.json(question);
+
+    const { deleted, ...responseQuestion } = question.toObject();
+
+    return res.json(responseQuestion);
   } catch (error) {
     return res.status(500).send("Internal server error");
   }
@@ -142,6 +158,21 @@ router.post(
     }
 
     try {
+      const question = await Question.findOne(
+        { questionid: questionId },
+        {
+          questionid: 1,
+          title: 1,
+          description: 1,
+          complexity: 1,
+          category: 1,
+          deleted: 1,
+        }
+      ).exec();
+      if (!question || question.deleted) {
+        return res.status(404).json({ message: "Question not found" });
+      }
+
       const updatedQuestion = await Question.findOneAndUpdate(
         { questionid: questionId },
         { $set: updateData },
@@ -170,9 +201,11 @@ router.post(
 
     const questionId = parseInt(req.params.id);
     try {
-      const deletedQuestion = await Question.findOneAndDelete({
-        questionid: questionId,
-      }).exec();
+      const deletedQuestion = await Question.findOneAndUpdate(
+        { questionid: questionId },
+        { $set: { deleted: true } },
+        { new: true }
+      ).exec();
       return res.json(deletedQuestion);
     } catch (error) {
       //to catch pre-middleware defined error

backend/question/src/tests/app.spec.ts

@@ -407,7 +407,7 @@ describe("Test Update", () => {
       .post(`/api/${questionId}/update`)
       .send(updateQuestion);
     expect(res.statusCode).toBe(404);
-    expect(res.body).toBe("Document not found");
+    expect(res.body.message).toBe("Question not found");
   });
 
   // Non-existent id
@@ -423,7 +423,7 @@ describe("Test Update", () => {
       .post(`/api/${questionId}/update`)
       .send(updateQuestion);
     expect(res.statusCode).toBe(404);
-    expect(res.body).toBe("Document not found");
+    expect(res.body.message).toBe("Question not found");
   });
 
   // Duplicate question