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

Leetcode SPA/Question service upgrades

Author: jehousoh

backend/question/README.md

@@ -0,0 +1,18 @@
+# Question Service
+
+## Description
+
+This service is used to manage the programming questions given to the users after matching. It uses MongoDB Atlas to host a cloud database to manage the questions. The service comes with a RESTful API interface to support Create, Read, Update and Delete (CRUD) operations.
+
+This service also includes Jest for unit testing on an isolated Mongo Memory DB server to ensure that all the endpoints work as required.
+
+## Setup
+
+1. Install Node version 18 or above.
+2. Run `npm install` to install the dependencies required.
+3. Create `.env` file in the `/questions` folder, copying the content from `sample.env`, setting `NODE_ENV` as `DEV` and filling in the MONGO_URI.
+4. Run `npm start` to start the service.
+
+## API Documentation
+
+Refer to [`question.yaml`](./docs/question.yaml) file for the API documentation.

backend/question/docs/question.plantuml

@@ -0,0 +1,51 @@
+@startuml Question Service
+
+entity Question {
+  + questionId : number
+  + title : string
+  + description : string
+  + complexity : string
+  + categories : Array<string>
+}
+
+entity EditQuestion {
+  + title : string
+  + description : string
+  + complexity : string
+  + categories : Array<string>
+}
+
+entity Pagination {
+  + pagination : number = 1
+  + pageSize : number = 10
+}
+
+interface IQuestionServiceAPI {
+  + GET /
+  + POST /create [createQuestion: EditQuestion]
+  + POST /all [pagination: Pagination]
+  + GET /{id}
+  + POST /{id}/update [updateQuestion: EditQuestion]
+  + POST /{id}/delete
+}
+
+note right of IQuestionServiceAPI
+  - GET /: Check service status
+  - POST /create: Create a new question
+  - POST /all: Retrieve all questions with pagination
+  - GET /{id}: Retrieve a specific question by ID
+  - POST /{id}/update: Update a specific question by ID
+  - POST /{id}/delete: Delete a specific question by ID
+end note
+
+class QuestionService {
+}
+
+entity QuestionDatabase {
+  + questions: Array<Question>
+}
+
+QuestionService ..|> IQuestionServiceAPI : implements
+QuestionService --> QuestionDatabase : interacts with
+
+@enduml

backend/question/docs/question.yaml

@@ -0,0 +1,300 @@
+openapi: 3.0.0
+info:
+  title: Question Service API
+  description: API for managing questions, including CRUD operations.
+  version: 1.0.0
+servers:
+  # Added by API Auto Mocking Plugin
+  - description: SwaggerHub API Auto Mocking
+    url: https://virtserver.swaggerhub.com/JEHOUSOH/Question/1.0.0
+  - url: http://localhost:3003
+    description: Local development server
+
+paths:
+  /:
+    get:
+      summary: Check service status
+      responses:
+        "200":
+          description: Service status message
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Hello from question service!
+
+  /create:
+    post:
+      summary: Create a new question
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/QuestionCreate"
+      responses:
+        "200":
+          description: Question created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Question created successfully
+                  question:
+                    $ref: "#/components/schemas/Question"
+        "400":
+          description: Bad Request (validation error)
+        "500":
+          description: Internal server error
+
+  /all:
+    post:
+      summary: Retrieve all questions with pagination
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                pagination:
+                  type: integer
+                  default: 1
+                  description: Page number
+                page_size:
+                  type: integer
+                  default: 10
+                  description: Number of questions per page
+      responses:
+        "200":
+          description: List of questions
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/QuestionAll"
+        "500":
+          description: Internal server error
+
+  /{id}:
+    get:
+      summary: Get a specific question by ID
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: integer
+          required: true
+          description: ID of the question
+      responses:
+        "200":
+          description: A specific question
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Question"
+        "400":
+          description: Invalid ID format
+        "404":
+          description: Question not found
+        "500":
+          description: Internal server error
+
+  /{id}/update:
+    post:
+      summary: Update a specific question by ID
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: integer
+          required: true
+          description: ID of the question to update
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/QuestionUpdate"
+      responses:
+        "200":
+          description: Updated question
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/QuestionUpdate"
+        "400":
+          description: Validation or duplicate title error
+        "404":
+          description: Question not found
+        "500":
+          description: Internal server error
+
+  /{id}/delete:
+    post:
+      summary: Delete a specific question by ID
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: integer
+          required: true
+          description: ID of the question to delete
+      responses:
+        "200":
+          description: Deleted question
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Question"
+        "404":
+          description: Question not found
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    Question:
+      type: object
+      properties:
+        questionid:
+          type: integer
+          example: 1
+        title:
+          type: string
+          example: "Two Sum"
+        description:
+          type: string
+          example: "Given an array of integers nums and an integer target, return indices of the two numbers such that they add up to target.You may assume that each input would have exactly one solution, and you may not use the same element twice.You can return the answer in any order."
+        category:
+          type: array
+          items:
+            type: string
+          example: ["Array", "Hash Table"]
+        complexity:
+          type: string
+          example: "Easy"
+
+    QuestionCreate:
+      type: object
+      required:
+        - title
+        - description
+        - category
+        - complexity
+      properties:
+        title:
+          type: string
+          example: "Two Sum"
+        description:
+          type: string
+          example: "Given an array of integers nums and an integer target, return indices of the two numbers such that they add up to target.You may assume that each input would have exactly one solution, and you may not use the same element twice.You can return the answer in any order."
+        category:
+          type: array
+          items:
+            type: string
+          example: ["Array", "Hash Table"]
+        complexity:
+          type: string
+          example: "Easy"
+
+    QuestionAll:
+      type: object
+      properties:
+        questions:
+          type: array
+          items:
+            $ref: "#/components/schemas/Question"
+          example:
+            - _id: "66f925ddfdfb8e1665720acc"
+              questionid: 1
+              title: "Two Sum"
+              description: "Given an array of integers nums and an integer target, return indices of the two numbers such that they add up to target. You may assume that each input would have exactly one solution, and you may not use the same element twice. You can return the answer in any order. "
+              category: ["Array", "Hash Table"]
+              complexity: "Easy"
+            - _id: "66f925ddfdfb8e1665720acd"
+              questionid: 2
+              title: "Add Two Numbers"
+              description: "You are given two non-empty linked lists representing two non-negative integers. The digits are stored in reverse order, and each of their nodes contains a single digit. Add the two numbers and return the sum as a linked list. You may assume the two numbers do not contain any leading zero, except the number 0 itself. "
+              category: ["Linked List", "Math", "Recursion"]
+              complexity: "Medium"
+            - _id: "66f925ddfdfb8e1665720ace"
+              questionid: 3
+              title: "Longest Substring Without Repeating Characters"
+              description: "Given a string s, find the length of the longest substring without repeating characters. "
+              category: ["Hash Table", "String", "Sliding Window"]
+              complexity: "Medium"
+            - _id: "66f925ddfdfb8e1665720acf"
+              questionid: 4
+              title: "Median of Two Sorted Arrays"
+              description: "Given two sorted arrays nums1 and nums2 of size m and n respectively, return the median of the two sorted arrays. The overall run time complexity should be O(log (m+n)). "
+              category: ["Array", "Binary Search", "Divide and Conquer"]
+              complexity: "Hard"
+            - _id: "66f925ddfdfb8e1665720ad0"
+              questionid: 5
+              title: "Longest Palindromic Substring"
+              description: "Given a string s, return the longest palindromic substring in s. "
+              category: ["String", "Dynamic Programming"]
+              complexity: "Medium"
+            - _id: "66f925ddfdfb8e1665720ad1"
+              questionid: 6
+              title: "Reverse Integer"
+              description: "Given a signed 32-bit integer x, return x with its digits reversed. If reversing x causes the value to go outside the signed 32-bit integer range [-231, 231 - 1], then return 0. Assume the environment does not allow you to store 64-bit integers (signed or unsigned). "
+              category: ["Math"]
+              complexity: "Medium"
+            - _id: "66f925ddfdfb8e1665720ad2"
+              questionid: 7
+              title: "Palindrome Number"
+              description: "Given an integer x, return true if x is palindrome integer. An integer is a palindrome when it reads the same backward as forward. "
+              category: ["Math"]
+              complexity: "Easy"
+            - _id: "66f925ddfdfb8e1665720ad3"
+              questionid: 8
+              title: "Container With Most Water"
+              description: "You are given an integer array height of length n. There are n vertical lines drawn such that the two endpoints of the ith line are (i, 0) and (i, height[i]). Find two lines that together with the x-axis form a container, such that the container contains the most water. Return the maximum amount of water a container can store. Notice that you may not slant the container. "
+              category: ["Array", "Two Pointers", "Greedy"]
+              complexity: "Medium"
+            - _id: "66f925ddfdfb8e1665720ad4"
+              questionid: 9
+              title: "Longest Common Prefix"
+              description: 'Write a function to find the longest common prefix string amongst an array of strings. If there is no common prefix, return an empty string "". '
+              category: ["String"]
+              complexity: "Easy"
+            - _id: "66f925ddfdfb8e1665720ad5"
+              questionid: 10
+              title: "3Sum"
+              description: "Given an integer array nums, return all the triplets [nums[i], nums[j], nums[k]] such that i != j, i != k, and j != k, and nums[i] + nums[j] + nums[k] == 0. Notice that the solution set must not contain duplicate triplets. "
+              category: ["Array", "Two Pointers", "Sorting"]
+              complexity: "Medium"
+
+        currentPage:
+          type: integer
+          example: 1
+        totalPages:
+          type: integer
+          example: 10
+        totalQuestions:
+          type: integer
+          example: 100
+
+    QuestionUpdate:
+      type: object
+      properties:
+        title:
+          type: string
+          example: "Two Sum Updated"
+        description:
+          type: string
+          example: "Updated question description"
+        category:
+          type: array
+          items:
+            type: string
+          example: ["Dynamic Programming", "Bit Manipulation"]
+        complexity:
+          type: string
+          example: "Hard"

backend/question/src/routes/questionRoutes.ts

@@ -50,8 +50,8 @@ router.post(
 );
 
 // Retrieve all questions
-router.get("/all", async (req: Request, res: Response) => {
-  const pagination = parseInt(req.body.pagination as string, 10) || 1; // Default page is 1
+router.post("/all", async (req: Request, res: Response) => {
+  let pagination = parseInt(req.body.pagination as string, 10) || 1; // Default page is 1
   const page_size = parseInt(req.body.page_size as string, 10) || 10; // Default limit is 10
   const skip = (pagination - 1) * page_size; // Calculate how many documents to skip
   try {
@@ -72,11 +72,13 @@ router.get("/all", async (req: Request, res: Response) => {
       .exec();
 
     const total = await Question.countDocuments().exec();
+    const totalPages = Math.ceil(total / page_size);
+    if (totalPages < pagination) pagination = 1;
 
     return res.json({
       questions,
       currentPage: pagination,
-      totalPages: Math.ceil(total / page_size),
+      totalPages: totalPages,
       totalQuestions: total,
     });
   } catch (error) {