Add backend routes for courses and classes (#1013)

* Add routes for adding and removing course

* Update routes by moving validation to controller

* Add route for update course colour

* add OpenAPI for api-docs for backend using swagger library

* Add ApiProperty for user's route

* Add get route for courses and classes with update of routing urls

* Update PUT request for setCourseColour to PATCH request

* Update user routes to using AuthenticatedRequest Type

* Add selectClass & removeClass route

* Remove OpenAPI and Swagger Library, switched to use Postman

* Update route for select and remove class

* Remove unwanted routes with forwarding functions

* Resolve usage of null and undefined

* Resolve PR review comments

* Slim down the Course and Class detail for graphql, and add validation function for update and remove class

* Update routes returning status code

* Refactor user.controller, move all business validation into service level

* Remove duplicate getCourse request in addSelectedClass

* Resolve issues on the PR code review

* Resolve minor issue on function call, optimise prisma call

* Resolve function name typo

* Update service level function name corresponds to control level

Author: jason4193

server/src/graphql/graphql.service.ts

@@ -1,6 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { GraphQLClient } from 'graphql-request';
 import { getSdk } from '../generated/graphql';
+import type { ClassDetails } from './types';
 
 const HASURAGRES_GRAPHQL_API = 'https://graphql.csesoc.app/v1/graphql';
 
@@ -21,4 +22,9 @@ export class GraphqlService {
 
     return courseExists.aggregate != null && courseExists.aggregate.count > 0;
   }
+
+  async getClassDetails(classId: string): Promise<ClassDetails | undefined> {
+    const { classDetails } = await this.sdk.ClassDetails({ classId });
+    return classDetails ? classDetails : undefined;
+  }
 }

server/src/graphql/queries.ts

@@ -11,3 +11,12 @@ export const COURSE_EXISTS = gql(`
     }
   }
 `);
+
+export const CLASS_DETAILS = gql(`
+  query ClassDetails($classId: String!) {
+    classDetails: classes_by_pk(class_id: $classId) {
+      activity
+      section
+    }
+  }
+`);

server/src/graphql/types.ts

@@ -0,0 +1,4 @@
+export class ClassDetails {
+  activity: string;
+  section: string;
+}

server/src/user/types.ts

@@ -15,3 +15,12 @@ export class UserSettings {
   unscheduleClassesByDefault: boolean;
   hideExamClasses: boolean;
 }
+
+export class AddCourseDto {
+  term: string;
+  colour: string;
+}
+export class CourseDetails {
+  id: string;
+  selectedClasses: string[];
+}

server/src/user/user.controller.ts

@@ -1,8 +1,19 @@
-import { Body, Controller, Get, Post, Req, UseGuards } from '@nestjs/common';
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  HttpStatus,
+  Param,
+  Patch,
+  Post,
+  Req,
+  UseGuards,
+} from '@nestjs/common';
 import { UserService } from './user.service';
 import { AuthenticatedGuard } from 'src/auth/authenticated.guard';
 import { Request } from 'express';
-import { UserSettings } from './types';
+import { UserSettings, AddCourseDto } from './types';
 
 interface AuthenticatedRequest extends Request {
   user: {
@@ -49,4 +60,102 @@ export class UserController {
     await this.userService.setSettings(req.user.id, settings);
     return;
   }
+
+  @Get('courses/:timetableId')
+  @UseGuards(AuthenticatedGuard)
+  async getCourseIds(
+    @Req() req: AuthenticatedRequest,
+    @Param('timetableId') timetableId: string,
+  ) {
+    return await this.userService.getCourseIds(req.user.id, timetableId);
+  }
+
+  @Post('course/:timetableId/:courseId')
+  @UseGuards(AuthenticatedGuard)
+  async addCourse(
+    @Req() req: AuthenticatedRequest,
+    @Param('timetableId') timetableId: string,
+    @Param('courseId') courseId: string,
+    @Body() addCourseDto: AddCourseDto,
+  ) {
+    await this.userService.addCourse(
+      req.user.id,
+      timetableId,
+      courseId,
+      addCourseDto,
+    );
+    return HttpStatus.CREATED;
+  }
+
+  @Delete('course/:timetableId/:courseId')
+  @UseGuards(AuthenticatedGuard)
+  async removeCourse(
+    @Req() req: AuthenticatedRequest,
+    @Param('timetableId') timetableId: string,
+    @Param('courseId') courseId: string,
+  ) {
+    await this.userService.removeCourse(req.user.id, timetableId, courseId);
+  }
+
+  @Patch('course/:timetableId/:courseId/colour')
+  @UseGuards(AuthenticatedGuard)
+  async setCourseColour(
+    @Req() req: AuthenticatedRequest,
+    @Param('timetableId') timetableId: string,
+    @Param('courseId') courseId: string,
+    @Body('colour') colour: string,
+  ) {
+    await this.userService.setCourseColour(
+      req.user.id,
+      timetableId,
+      courseId,
+      colour,
+    );
+  }
+
+  @Get('classes/:timetableId/:courseId')
+  @UseGuards(AuthenticatedGuard)
+  async getSelectedClassIds(
+    @Req() req: AuthenticatedRequest,
+    @Param('timetableId') timetableId: string,
+    @Param('courseId') courseId: string,
+  ) {
+    return await this.userService.getSelectedClassIds(
+      req.user.id,
+      timetableId,
+      courseId,
+    );
+  }
+
+  @Patch('class/:timetableId/:courseId')
+  @UseGuards(AuthenticatedGuard)
+  async updateSelectedClass(
+    @Req() req: AuthenticatedRequest,
+    @Param('timetableId') timetableId: string,
+    @Param('courseId') courseId: string,
+    @Body('classId') classId: string,
+  ) {
+    await this.userService.updateSelectedClass(
+      req.user.id,
+      timetableId,
+      courseId,
+      classId,
+    );
+  }
+
+  @Delete('class/:timetableId/:courseId/:classId')
+  @UseGuards(AuthenticatedGuard)
+  async removeSelectedClass(
+    @Req() req: AuthenticatedRequest,
+    @Param('timetableId') timetableId: string,
+    @Param('courseId') courseId: string,
+    @Param('classId') classId: string,
+  ) {
+    await this.userService.removeSelectedClass(
+      req.user.id,
+      timetableId,
+      courseId,
+      classId,
+    );
+  }
 }

server/src/user/user.module.ts

@@ -1,10 +1,11 @@
 import { Module } from '@nestjs/common';
+import { GraphqlService } from 'src/graphql/graphql.service';
 import { PrismaService } from 'src/prisma/prisma.service';
 import { UserService } from './user.service';
 import { UserController } from './user.controller';
 
 @Module({
-  providers: [UserService, PrismaService],
+  providers: [UserService, PrismaService, GraphqlService],
   controllers: [UserController],
 })
 export class UserModule {}