Merge pull request #27 from CS3219-AY2425S1/anun/question-get

get endpoints for questions

Author: TabrizPlv

backend/question/src/controller/search-controller.ts

@@ -1,18 +1,73 @@
 import { Request, Response } from 'express';
-import { searchQuestionsByTitleService } from '../services/get/index';
+import {
+  getQuestionsService,
+  getQuestionDetailsService,
+  getRandomQuestionService,
+  searchQuestionsByTitleService,
+} from '../services/get/';
+import {
+  IGetQuestionsPayload,
+  IGetQuestionPayload,
+  IGetRandomQuestionPayload,
+} from '../services/get/types';
+
+export const getQuestions = async (req: Request, res: Response): Promise<Response> => {
+  const payload: IGetQuestionsPayload = {
+    questionName: req.query.questionName as string,
+    difficulty: req.query.difficulty as string,
+    topic: req.query.topic as string[],
+    pageNum: parseInt(req.query.pageNum as string) || 0,
+    recordsPerPage: parseInt(req.query.recordsPerPage as string) || 20,
+  };
+
+  try {
+    const result = await getQuestionsService(payload);
+    return res.status(result.code).json(result);
+  } catch (error) {
+    return res.status(500).json({ success: false, message: 'An error occurred', error });
+  }
+};
+
+export const getQuestionDetails = async (req: Request, res: Response): Promise<Response> => {
+  const payload: IGetQuestionPayload = {
+    questionId: parseInt(req.params.questionId),
+  };
+
+  try {
+    const result = await getQuestionDetailsService(payload);
+    return res.status(result.code).json(result);
+  } catch (error) {
+    return res.status(500).json({ success: false, message: 'An error occurred', error });
+  }
+};
+
+export const getRandomQuestion = async (req: Request, res: Response): Promise<Response> => {
+  const payload: IGetRandomQuestionPayload = {
+    userId: parseInt(req.params.userId),
+    difficulty: req.query.difficulty as string,
+    topic: req.query.topic as string[],
+  };
+
+  try {
+    const result = await getRandomQuestionService(payload);
+    return res.status(result.code).json(result);
+  } catch (error) {
+    return res.status(500).json({ success: false, message: 'An error occurred', error });
+  }
+};
 
 export const searchQuestionsByTitle = async (req: Request, res: Response): Promise<Response> => {
   const { title } = req.query;
   const page = parseInt(req.query.page as string) || 1;
   const limit = parseInt(req.query.limit as string) || 10;
 
   if (!title) {
-    return res.status(200);
+    return res.status(400).json({ success: false, message: 'Title is required' });
   }
 
   try {
     const result = await searchQuestionsByTitleService(title.toString(), page, limit);
-    return res.status(200).json(result);
+    return res.status(result.code).json(result);
   } catch (error) {
     return res.status(500).json({ success: false, message: 'An error occurred', error });
   }

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

@@ -1,8 +1,19 @@
 import { Router } from 'express';
-import { searchQuestionsByTitle } from '../controller/search-controller';
+import {
+  searchQuestionsByTitle,
+  getQuestions,
+  getQuestionDetails,
+  getRandomQuestion,
+} from '../controller/search-controller';
 
 const router = Router();
 
 router.get('/search', searchQuestionsByTitle);
 
+router.get('/', getQuestions);
+
+router.get('/:questionId', getQuestionDetails);
+
+router.get('/random', getRandomQuestion);
+
 export default router;

backend/question/src/services/get/index.ts

@@ -1,7 +1,129 @@
 import { db } from '../../lib/db/index';
-import { sql } from 'drizzle-orm';
+import { and, arrayOverlaps, eq, ilike, sql } from 'drizzle-orm';
 import { questions } from '../../lib/db/schema';
-import { IGetQuestionsResponse } from '../get/types';
+import {
+  IGetQuestionsPayload,
+  IGetQuestionsResponse,
+  IGetQuestionPayload,
+  IGetQuestionResponse,
+  IGetRandomQuestionPayload,
+  IGetRandomQuestionResponse,
+} from '../get/types';
+
+export const getQuestionsService = async (
+  payload: IGetQuestionsPayload
+): Promise<IGetQuestionsResponse> => {
+  const { questionName, difficulty, topic, pageNum = 0, recordsPerPage = 20 } = payload;
+  const offset = pageNum * recordsPerPage;
+
+  const whereClause = [];
+
+  if (questionName) {
+    whereClause.push(ilike(questions.title, `%${questionName}%`));
+  }
+  if (difficulty) {
+    whereClause.push(eq(questions.difficulty, difficulty));
+  }
+  if (topic && topic.length > 0) {
+    whereClause.push(arrayOverlaps(questions.topic, topic));
+  }
+
+  const query = db
+    .select()
+    .from(questions)
+    .where(and(...whereClause))
+    .limit(recordsPerPage)
+    .offset(offset);
+
+  const [results, totalCount] = await Promise.all([
+    query,
+    db
+      .select({ count: questions.id })
+      .from(questions)
+      .where(and(...whereClause))
+      .then((res) => res.length),
+  ]);
+
+  return {
+    code: 200,
+    data: {
+      questions: results.map((q) => ({
+        id: q.id,
+        title: q.title,
+        difficulty: q.difficulty,
+        topic: q.topic,
+      })),
+      totalQuestions: totalCount,
+    },
+  };
+};
+
+export const getQuestionDetailsService = async (
+  payload: IGetQuestionPayload
+): Promise<IGetQuestionResponse> => {
+  const { questionId } = payload;
+
+  const result = await db
+    .select()
+    .from(questions)
+    .where(sql`${questions.id} = ${questionId}`)
+    .limit(1);
+
+  if (result.length === 0) {
+    return {
+      code: 404,
+      data: { question: null },
+      error: {
+        message: 'Question not found',
+      },
+    };
+  }
+
+  return {
+    code: 200,
+    data: { question: result[0] },
+  };
+};
+
+export const getRandomQuestionService = async (
+  payload: IGetRandomQuestionPayload
+): Promise<IGetRandomQuestionResponse> => {
+  const { difficulty, topic } = payload;
+  const whereClause = [];
+
+  if (difficulty) {
+    whereClause.push(eq(questions.difficulty, difficulty));
+  }
+
+  if (topic && topic.length > 0) {
+    whereClause.push(arrayOverlaps(questions.topic, topic));
+  }
+
+  // randomize the order of questions
+  const query = db
+    .select()
+    .from(questions)
+    .where(and(...whereClause))
+    .orderBy(sql`RANDOM()`)
+    .limit(1);
+
+  const result = await query;
+
+  if (result.length === 0) {
+    return {
+      code: 404,
+      data: { question: null },
+      error: {
+        message: 'No matching questions found',
+      },
+    };
+  }
+
+  return {
+    code: 200,
+    data: { question: result[0] },
+  };
+};
 
 export const searchQuestionsByTitleService = async (
   title: string,

backend/question/src/services/get/types.ts

@@ -28,22 +28,17 @@ export type IGetQuestionsResponse = IServiceResponse<{
 // /details
 //=============================================================================
 export type IGetQuestionPayload = {
-  questionNum: number;
+  questionId: number;
 };
 
 export type IGetQuestionResponse = IServiceResponse<{
   // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-  question: {
-    // TODO: Add schema from db
-    /**
-     * - name
-     * - number
-     * - description
-     * - difficulty
-     * - topic
-     * - submissionHistory?: TBC
-     */
-  };
+  question?: {
+    title: string; // name or title of the question
+    description: string; // question description
+    difficulty: string; // difficulty level (e.g., 'easy', 'medium', 'hard')
+    topic: Array<string>; // array of topics the question belongs to
+  } | null;
 }>;
 
 //=============================================================================
@@ -56,16 +51,10 @@ export type IGetRandomQuestionPayload = {
 };
 
 export type IGetRandomQuestionResponse = IServiceResponse<{
-  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   question: {
-    // TODO: Add schema from db
-    /**
-     * - name
-     * - number
-     * - description
-     * - difficulty
-     * - topic
-     * - submissionHistory?: TBC
-     */
-  };
+    title: string; // name or title of the question
+    description: string; // question description
+    difficulty: string; // difficulty level (e.g., 'easy', 'medium', 'hard')
+    topic: Array<string>; // array of topics the question belongs to
+  } | null;
 }>;