Merge pull request #22 from topcoder-platform/pm-1585_1

fix(PM-1585): qa feedbacks on search scorecards API

Author: hentrymartin

.circleci/config.yml

@@ -77,6 +77,7 @@ workflows:
                               - feat/ai-workflows
                               - feat/scorecards
                               - pm-1503
+                              - pm-1585_1
             - 'build-prod':
                   context: org-global
                   filters:

src/api/scorecard/scorecard.controller.ts

@@ -28,11 +28,11 @@ import {
   ScorecardRequestDto,
   ScorecardResponseDto,
   ScorecardWithGroupResponseDto,
+  SearchScorecardQuery,
 } from 'src/dto/scorecard.dto';
 import { ChallengeTrack } from 'src/shared/enums/challengeTrack.enum';
 import { ScoreCardService } from './scorecard.service';
 import { PaginationHeaderInterceptor } from 'src/interceptors/PaginationHeaderInterceptor';
-import { $Enums } from '@prisma/client';
 import { User } from 'src/shared/decorators/user.decorator';
 import { JwtUser } from 'src/shared/modules/global/jwt.service';
 
@@ -198,40 +198,26 @@ export class ScorecardController {
   })
   @UseInterceptors(PaginationHeaderInterceptor)
   async searchScorecards(
-    @Query('challengeTrack') challengeTrack?: ChallengeTrack | ChallengeTrack[],
-    @Query('challengeType') challengeType?: string | string[],
-    @Query('status') status?: $Enums.ScorecardStatus | $Enums.ScorecardStatus[],
-    @Query('scorecardType')
-    scorecardType?: $Enums.ScorecardType | $Enums.ScorecardType[],
-    @Query('name') name?: string,
-    @Query('page') page: number = 1,
-    @Query('perPage') perPage: number = 10,
+    @Query() query: SearchScorecardQuery,
   ): Promise<ScorecardPaginatedResponseDto> {
-    const challengeTrackArray = Array.isArray(challengeTrack)
-      ? challengeTrack
-      : challengeTrack
-        ? [challengeTrack]
-        : [];
-    const challengeTypeArray = Array.isArray(challengeType)
-      ? challengeType
-      : challengeType
-        ? [challengeType]
-        : [];
-    const scorecardTypesArray = Array.isArray(scorecardType)
-      ? scorecardType
-      : scorecardType
-        ? [scorecardType]
-        : [];
-    const statusArray = Array.isArray(status) ? status : status ? [status] : [];
+    const {
+      challengeTrack = [],
+      challengeType = [],
+      status = [],
+      scorecardType = [],
+      name,
+      page,
+      perPage,
+    } = query;
 
     const result = await this.scorecardService.getScoreCards({
-      challengeTrack: challengeTrackArray,
-      challengeType: challengeTypeArray,
+      challengeTrack,
+      challengeType,
       name,
       page,
       perPage,
-      scorecardTypesArray,
-      statusArray,
+      scorecardType,
+      status,
     });
     return result;
   }

src/api/scorecard/scorecard.service.ts

@@ -9,12 +9,12 @@ import {
   mapScorecardRequestToDto,
   ScorecardGroupBaseDto,
   ScorecardPaginatedResponseDto,
-  ScorecardQueryDto,
   ScorecardQuestionBaseDto,
   ScorecardRequestDto,
   ScorecardResponseDto,
   ScorecardSectionBaseDto,
   ScorecardWithGroupResponseDto,
+  SearchScorecardQuery,
 } from 'src/dto/scorecard.dto';
 import { JwtUser } from 'src/shared/modules/global/jwt.service';
 import { PrismaService } from 'src/shared/modules/global/prisma.service';
@@ -153,7 +153,7 @@ export class ScoreCardService {
           throw new NotFoundException({ message: `Scorecard not found.` });
         }
         throw new InternalServerErrorException({
-          message: `Error: ${error.code}`,
+          message: `Invalid scorecard id - ${id}`,
         });
       });
     return data as ScorecardWithGroupResponseDto;
@@ -165,15 +165,15 @@ export class ScoreCardService {
    * @returns response dto
    */
   async getScoreCards(
-    query: ScorecardQueryDto,
+    query: SearchScorecardQuery,
   ): Promise<ScorecardPaginatedResponseDto> {
     const {
       page = 1,
       perPage = 10,
       challengeTrack,
       challengeType,
-      scorecardTypesArray,
-      statusArray,
+      scorecardType,
+      status,
       name,
     } = query;
     const skip = (page - 1) * perPage;
@@ -188,14 +188,14 @@ export class ScoreCardService {
           in: challengeType,
         },
       }),
-      ...(scorecardTypesArray?.length && {
+      ...(scorecardType?.length && {
         type: {
-          in: scorecardTypesArray,
+          in: scorecardType,
         },
       }),
-      ...(statusArray?.length && {
+      ...(status?.length && {
         status: {
-          in: statusArray,
+          in: status,
         },
       }),
       ...(name && { name: { contains: name, mode: 'insensitive' } }),

src/dto/scorecard.dto.ts

@@ -1,10 +1,11 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { $Enums } from '@prisma/client';
-import { Type } from 'class-transformer';
+import { Transform, Type } from 'class-transformer';
 import {
   IsArray,
   IsBoolean,
   IsEnum,
+  IsInt,
   IsNotEmpty,
   IsNumber,
   IsOptional,
@@ -288,6 +289,60 @@ export class ScorecardResponseDto extends ScorecardBaseDto {
   id: string;
 }
 
+function toArray<T = string>(value: unknown): T[] | undefined {
+  if (value === undefined || value === null || value === '') return undefined;
+  const asArray = Array.isArray(value) ? value : [value];
+  return asArray
+    .flatMap((v) => String(v).split(','))
+    .map((s) => s.trim())
+    .filter(Boolean) as T[];
+}
+
+export class SearchScorecardQuery {
+  @IsOptional()
+  @Transform(({ value }) => toArray<ChallengeTrack>(value))
+  @IsArray()
+  @IsEnum(ChallengeTrack, { each: true })
+  challengeTrack?: ChallengeTrack[];
+
+  @IsOptional()
+  @Transform(({ value }) => toArray<string>(value))
+  @IsArray()
+  @IsString({ each: true })
+  challengeType?: string[];
+
+  @IsOptional()
+  @Transform(({ value }) => toArray<$Enums.ScorecardStatus>(value))
+  @IsArray()
+  @IsEnum($Enums.ScorecardStatus, {
+    each: true,
+    message: (args) => `Invalid value "${args.value}" for "${args.property}".`,
+  })
+  status?: $Enums.ScorecardStatus[];
+
+  @IsOptional()
+  @Transform(({ value }) => toArray<$Enums.ScorecardType>(value))
+  @IsArray()
+  @IsEnum($Enums.ScorecardType, { each: true })
+  scorecardType?: $Enums.ScorecardType[];
+
+  @IsOptional()
+  @IsString()
+  name?: string;
+
+  @IsOptional()
+  @Type(() => Number)
+  @IsInt()
+  @Min(1)
+  page: number = 1;
+
+  @IsOptional()
+  @Type(() => Number)
+  @IsInt()
+  @Min(1)
+  perPage: number = 10;
+}
+
 export class ScorecardWithGroupResponseDto extends ScorecardBaseDto {
   @ApiProperty({ description: 'The ID of the scorecard', example: 'abc123' })
   id: string;
@@ -324,16 +379,6 @@ export class ScorecardPaginatedResponseDto {
   scoreCards: ScorecardResponseDto[];
 }
 
-export class ScorecardQueryDto {
-  challengeTrack?: ChallengeTrack[];
-  challengeType?: string[];
-  name?: string;
-  page?: number;
-  perPage?: number;
-  statusArray?: $Enums.ScorecardStatus[];
-  scorecardTypesArray?: $Enums.ScorecardType[];
-}
-
 export function mapScorecardRequestForCreate(request: ScorecardRequestDto) {
   const userFields = {
     ...(request.createdBy ? { createdBy: request.createdBy } : {}),

src/shared/decorators/user.decorator.ts

@@ -5,7 +5,7 @@ export const User = createParamDecorator(
   (data: string, ctx: ExecutionContext) => {
     const request = ctx.switchToHttp().getRequest();
     const user = request.user;
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
     return (data ? user?.[data] : user) as JwtUser;
   },
 );