Improved route in roadmaps and response handling

Implemented a new route in the roadmaps for fetching progress data and updated the Paths constants file with the new route. Also, added response handlers for situations when roadmap progress is found or not found. All these changes were done mainly for enhancement in data retrieval and user experience.

src/constants/Paths.ts

@@ -27,6 +27,7 @@ const Paths = {
     Get: {
       Base: '/:roadmapId([0-9]+)?',
       Roadmap: '/',
+      Progress: '/progress',
     },
     Update: {
       Base: '/:roadmapId([0-9]+)',

src/controllers/roadmapController.ts

@@ -14,7 +14,9 @@ import {
   responseRoadmapCreated,
   responseRoadmapDeleted,
   responseRoadmapNotFound,
-  responseRoadmapNotRated, responseRoadmapProgressUpdated,
+  responseRoadmapNotRated,
+  responseRoadmapProgressFound, responseRoadmapProgressNotFound,
+  responseRoadmapProgressUpdated,
   responseRoadmapRated,
   responseRoadmapUnrated,
   responseRoadmapUpdated,
@@ -513,6 +515,25 @@ export async function removeLikeRoadmap(
   return responseServerError(res);
 }
 
+export async function getProgressDataRoadmap(
+  req: RequestWithSession,
+  res: Response,
+) {
+  const roadmapId = req.params.roadmapId;
+  const userId = req.session?.userId;
+
+  if (!userId) return responseServerError(res);
+  if (!roadmapId) return responseServerError(res);
+
+  const db = new Database();
+
+  const progress = await getRoadmapProgress(db, userId, BigInt(roadmapId));
+
+  if (progress === null) return responseRoadmapProgressNotFound(res);
+
+  return responseRoadmapProgressFound(res, progress);
+}
+
 export async function updateProgressDataRoadmap(
   req: RequestWithBody,
   res: Response,

src/helpers/responses/roadmapResponses.ts

@@ -3,6 +3,7 @@ import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 import { JSONSafety } from '@src/util/misc';
 import { ResRoadmap } from '@src/types/response/ResRoadmap';
 import { ResFullRoadmap } from '@src/types/response/ResFullRoadmap';
+import {RoadmapProgress} from '@src/types/models/RoadmapProgress';
 
 export function responseRoadmap(res: Response, roadmap: ResFullRoadmap): void {
   res
@@ -119,6 +120,21 @@ export function responseRoadmapUnrated(res: Response) {
   });
 }
 
+export function responseRoadmapProgressNotFound(res: Response) {
+  return res.status(HttpStatusCodes.NOT_FOUND).json({
+    message: 'Roadmap progress not found',
+    success: false,
+  });
+}
+
+export function responseRoadmapProgressFound(res: Response, progress: RoadmapProgress) {
+  return res.status(HttpStatusCodes.OK).json({
+    data: progress.data,
+    message: 'Roadmap progress found',
+    success: true,
+  });
+}
+
 export function responseRoadmapProgressUpdated(res: Response) {
   return res.status(HttpStatusCodes.OK).json({
     message: 'Roadmap progress updated',

src/routes/roadmapsRoutes/RoadmapsGet.ts

@@ -1,9 +1,19 @@
 import { Router } from 'express';
 import Paths from '@src/constants/Paths';
-import { getRoadmap } from '@src/controllers/roadmapController';
+import {
+  getProgressDataRoadmap,
+  getRoadmap,
+} from '@src/controllers/roadmapController';
+import validateSession from '@src/middleware/validators/validateSession';
 
 const RoadmapsGet = Router({ mergeParams: true });
 
 RoadmapsGet.get(Paths.Roadmaps.Get.Roadmap, getRoadmap);
 
+RoadmapsGet.get(
+  Paths.Roadmaps.Get.Progress,
+  validateSession,
+  getProgressDataRoadmap,
+);
+
 export default RoadmapsGet;