Feature/checkin form endpoints

CHANGELOG.md

@@ -40,6 +40,8 @@ Another example [here](https://co-pilot.dev/changelog)
 - Add swagger access info, add forms authorization and e2e tests ([#160](https://github.com/chingu-x/chingu-dashboard-be/pull/160))
 - Add voyages unit test, also had to update all files (seed, tests, services) to meet strict null rule due to prismaMock requirements ([#163](https://github.com/chingu-x/chingu-dashboard-be/pull/163))
 - Add e2e tests for users controller ([#165](https://github.com/chingu-x/chingu-dashboard-be/pull/165))
+- Add GET endpoint for check-in form responses ([#166](https://github.com/chingu-x/chingu-dashboard-be/pull/166))
+
 
 ### Changed
 

src/sprints/dto/get-checkin-form-response.ts

@@ -0,0 +1,21 @@
+import { IsOptional, IsUUID, IsInt } from "class-validator";
+import { Type } from "class-transformer";
+
+export class CheckinQueryDto {
+    @IsOptional()
+    @IsInt()
+    @Type(() => Number)
+    teamId?: number;
+
+    @IsOptional()
+    @IsInt()
+    @Type(() => Number)
+    sprintNumber?: number;
+
+    @IsOptional()
+    voyageNumber?: string;
+
+    @IsOptional()
+    @IsUUID()
+    userId?: string;
+}

src/sprints/sprints.controller.ts

@@ -10,11 +10,18 @@ import {
     ValidationPipe,
     HttpStatus,
     Request,
+    Query,
 } from "@nestjs/common";
 import { SprintsService } from "./sprints.service";
 import { UpdateTeamMeetingDto } from "./dto/update-team-meeting.dto";
 import { CreateTeamMeetingDto } from "./dto/create-team-meeting.dto";
-import { ApiOperation, ApiParam, ApiResponse, ApiTags } from "@nestjs/swagger";
+import {
+    ApiOperation,
+    ApiParam,
+    ApiQuery,
+    ApiResponse,
+    ApiTags,
+} from "@nestjs/swagger";
 import { CreateAgendaDto } from "./dto/create-agenda.dto";
 import { UpdateAgendaDto } from "./dto/update-agenda.dto";
 import { FormInputValidationPipe } from "../pipes/form-input-validation";
@@ -38,6 +45,9 @@ import { FormResponse, ResponseResponse } from "../forms/forms.response";
 import { CreateCheckinFormDto } from "./dto/create-checkin-form.dto";
 import { CustomRequest } from "../global/types/CustomRequest";
 import { VoyageTeamMemberValidationPipe } from "../pipes/voyage-team-member-validation";
+import { CheckinQueryDto } from "./dto/get-checkin-form-response";
+import { Action } from "../ability/ability.factory/ability.factory";
+import { CheckAbilities } from "../global/decorators/abilities.decorator";
 
 @Controller()
 @ApiTags("Voyage - Sprints")
@@ -542,4 +552,56 @@ export class SprintsController {
             createCheckinFormResponse,
         );
     }
+
+    @ApiOperation({
+        summary:
+            "[Admin only]: gets checkin forms given a sprintNumber, voyageId, userId, or teamId",
+        description:
+            "Takes any 1 of 4 keys: sprintNumber, voyageId, userId, or teamId",
+    })
+    @ApiResponse({
+        status: HttpStatus.OK,
+        description: "successfully gets checkin form responses",
+        type: CheckinSubmissionResponse,
+    })
+    @ApiResponse({
+        status: HttpStatus.NOT_FOUND,
+        description: "no matching checkin form response found",
+        type: NotFoundErrorResponse,
+    })
+    @ApiResponse({
+        status: HttpStatus.BAD_REQUEST,
+        description: "invalid key",
+        type: BadRequestErrorResponse,
+    })
+    @ApiResponse({
+        status: HttpStatus.UNAUTHORIZED,
+        description: "User is not logged in or doesn't have admin access",
+        type: UnauthorizedErrorResponse,
+    })
+    @ApiQuery({
+        name: "teamId",
+        required: false,
+        description: "Example: 1",
+    })
+    @ApiQuery({
+        name: "sprintNumber",
+        required: false,
+        description: "Example: 1",
+    })
+    @ApiQuery({
+        name: "voyageNumber",
+        required: false,
+        description: "Example: 46",
+    })
+    @ApiQuery({
+        name: "userId",
+        required: false,
+        description: "Example: 6bd33861-04c0-4270-8e96-62d4fb587527",
+    })
+    @CheckAbilities({ action: Action.Manage, subject: "all" })
+    @Get("check-in")
+    getCheckinFormResponse(@Query() query: CheckinQueryDto) {
+        return this.sprintsService.getCheckinFormResponse(query);
+    }
 }

src/sprints/sprints.response.ts

@@ -222,3 +222,32 @@ export class CheckinSubmissionResponse {
     @ApiProperty({ example: "2023-11-30T06:47:11.694Z" })
     createdAt: Date;
 }
+
+export class CheckinFormResponse {
+    @ApiProperty({ example: 1 })
+    id: number;
+
+    @ApiProperty({ example: 1 })
+    voyageTeamMemberId: number;
+
+    @ApiProperty({ example: 1 })
+    voyageTeamId: number;
+
+    @ApiProperty({ example: 1 })
+    sprintId: number;
+
+    @ApiProperty({ example: "Great job!" })
+    adminComments: string;
+
+    @ApiProperty({ example: true })
+    feedbackSent: boolean;
+
+    @ApiProperty({ example: 1 })
+    responseGroupId: number;
+
+    @ApiProperty({ example: "2023-11-30T06:47:11.694Z" })
+    createdAt: Date;
+
+    @ApiProperty({ example: "2023-11-30T06:47:11.694Z" })
+    updatedAt: Date;
+}

src/sprints/sprints.service.ts

@@ -15,6 +15,7 @@ import { CreateCheckinFormDto } from "./dto/create-checkin-form.dto";
 import { GlobalService } from "../global/global.service";
 import { FormTitles } from "../global/constants/formTitles";
 import { CustomRequest } from "../global/types/CustomRequest";
+import { CheckinQueryDto } from "./dto/get-checkin-form-response";
 
 @Injectable()
 export class SprintsService {
@@ -615,4 +616,112 @@ export class SprintsService {
             }
         }
     }
+
+    async getCheckinFormResponse(query: CheckinQueryDto) {
+        // convert query's key/val pair into strings for error handling
+        const queryObjectStringified = Object.entries(query).filter(
+            ([_, v]) => v,
+        );
+        // just grab the first key if there are multiple provided by accident
+        const [key, val] = queryObjectStringified[0] || [];
+
+        if (!key) {
+            throw new BadRequestException("No query provided");
+        }
+
+        let checkinFormResponse;
+
+        switch (key) {
+            case "teamId":
+                checkinFormResponse =
+                    await this.prisma.voyageTeamMember.findMany({
+                        where: {
+                            voyageTeamId: val,
+                        },
+                        include: {
+                            checkinForms: true,
+                        },
+                    });
+                break;
+            case "sprintNumber":
+                checkinFormResponse =
+                    await this.prisma.formResponseCheckin.findMany({
+                        where: {
+                            sprintId: val,
+                        },
+                        include: {
+                            voyageTeamMember: {
+                                select: {
+                                    voyageTeamId: true,
+                                },
+                            },
+                        },
+                        orderBy: {
+                            voyageTeamMember: {
+                                voyageTeamId: "asc",
+                            },
+                        },
+                    });
+                break;
+            case "voyageNumber":
+                checkinFormResponse = await this.prisma.sprint.findMany({
+                    where: {
+                        voyage: {
+                            number: val,
+                        },
+                    },
+                    include: {
+                        checkinForms: {
+                            include: {
+                                voyageTeamMember: {
+                                    select: {
+                                        voyageTeamId: true,
+                                    },
+                                },
+                            },
+                        },
+                    },
+                });
+                break;
+            case "userId":
+                checkinFormResponse =
+                    await this.prisma.voyageTeamMember.findMany({
+                        where: {
+                            userId: val,
+                        },
+                        include: {
+                            checkinForms: {
+                                include: {
+                                    voyageTeamMember: {
+                                        select: {
+                                            voyageTeamId: true,
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    });
+                break;
+            default:
+                throw new BadRequestException(
+                    `Query ${key} did not match any keywords`,
+                );
+        }
+
+        // make responses uniform and get rid of empty arrays
+        checkinFormResponse = checkinFormResponse.flatMap(
+            (item) => item.checkinForms || [item],
+        );
+        checkinFormResponse = checkinFormResponse.filter(
+            (item) => Object.keys(item).length > 0,
+        );
+
+        if (checkinFormResponse.length < 1) {
+            throw new NotFoundException(
+                `Query ${key} with value ${val} did not match any check-in form responses`,
+            );
+        }
+
+        return checkinFormResponse;
+    }
 }