refactor: validate query string by using dto class-validator

Author: Jiwon-Woo

Diff for: src/rotation/dto/find-rotation-query.dto.ts

@@ -1,20 +1,31 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsNumber, IsOptional } from 'class-validator';
+import { Transform } from 'class-transformer';
+import { IsNumber, IsOptional, Max, Min } from 'class-validator';
 
 export class FindRotationQueryDto {
+  private currentDate = new Date();
+
+  @Transform((params) => +params.value)
   @ApiProperty({
+    required: false,
     example: 1,
     description: '로테이션 정보를 찾는 기준이 되는 월. 기본값은 다음 달 월입니다.',
   })
   @IsOptional()
   @IsNumber()
-  month?: number;
+  @Min(1)
+  @Max(12)
+  month?: number = this.currentDate.getMonth() + 1;
 
+  @Transform((params) => +params.value)
   @ApiProperty({
+    required: false,
     example: 2024,
     description: '로테이션 정보를 찾는 기준이 되는 연도. 기본값은 다음 달 연도입니다.',
   })
   @IsOptional()
   @IsNumber()
-  year?: number;
+  @Min(2020)
+  @Max(2100)
+  year?: number = this.currentDate.getFullYear();
 }

Diff for: src/rotation/rotations.controller.ts

@@ -41,9 +41,8 @@ import {
 } from 'src/common/dto/error-response.dto';
 import { FindTodayRotationDto } from './dto/find-today-rotation.dto';
 import { FindRegistrationDto } from './dto/find-registration.dto';
-import { MonthValidationPipe } from './pipe/month-validation.pipe';
 import { FindAllRotationDto } from './dto/find-all-rotation.dto';
-import { YearValidationPipe } from './pipe/year-validation.pipe';
+import { FindRotationQueryDto } from './dto/find-rotation-query.dto';
 
 @Controller('rotations')
 @ApiTags('rotations')
@@ -157,9 +156,9 @@ export class RotationsController {
   @ApiBadRequestResponse({ type: BadRequestExceptionBody })
   @ApiInternalServerErrorResponse({ type: InternalServerExceptionBody })
   findAllRotation(
-    @Query('year', new YearValidationPipe()) year: any,
-    @Query('month', new MonthValidationPipe()) month: any,
+    @Query() findRotationQueryDto: FindRotationQueryDto,
   ): Promise<FindAllRotationDto[]> {
+    const { year, month } = findRotationQueryDto;
     return this.rotationsService.findAllRotation(year, month);
   }
 

Diff for: src/rotation/rotations.service.ts

@@ -351,28 +351,13 @@ export class RotationsService {
    * 기본적으로는 모든 로테이션을 반환.
    * 만약 parameter로 month와 year가 들어오면, 해당 스코프에 맞는 레코드를 반환.
    */
-  async findAllRotation(year?: number, month?: number): Promise<FindAllRotationDto[]> {
-    let records: Promise<RotationEntity[]>;
-
-    if (!year && !month) {
-      records = this.rotationRepository.find();
-    } else {
-      const currentDate = new Date();
-      if (!year) {
-        year = currentDate.getFullYear();
-      } else if (!month) {
-        month = currentDate.getMonth() + 1;
-      } else {
-        /* both inputs are exists */
-      }
-
-      records = this.rotationRepository.find({
-        where: {
-          year: year,
-          month: month,
-        },
-      });
-    }
+  async findAllRotation(year: number, month: number): Promise<FindAllRotationDto[]> {
+    const records = this.rotationRepository.find({
+      where: {
+        year: year,
+        month: month,
+      },
+    });
 
     const modifiedRecords = await Promise.all(
       (await records).map(async (record) => {