Merge pull request #14 from topcoder-platform/pm-1585

fic(PM-1585): Search scorecard modifications

Author: hentrymartin

.gitignore

@@ -42,6 +42,9 @@ lerna-debug.log*
 .env.production.local
 .env.local
 
+# Prisma score cards
+/prisma/Scorecards
+
 # temp directory
 .temp
 .tmp

src/api/api.module.ts

@@ -16,6 +16,7 @@ import { ChallengeApiService } from 'src/shared/modules/global/challenge.service
 import { WebhookController } from './webhook/webhook.controller';
 import { WebhookService } from './webhook/webhook.service';
 import { GiteaWebhookAuthGuard } from '../shared/guards/gitea-webhook-auth.guard';
+import { ScoreCardService } from './scorecard/scorecard.service';
 
 @Module({
   imports: [HttpModule, GlobalProvidersModule],
@@ -37,6 +38,7 @@ import { GiteaWebhookAuthGuard } from '../shared/guards/gitea-webhook-auth.guard
     ChallengeApiService,
     WebhookService,
     GiteaWebhookAuthGuard,
+    ScoreCardService,
   ],
 })
 export class ApiModule {}

src/api/scorecard/scorecard.controller.ts

@@ -7,8 +7,7 @@ import {
   Body,
   Param,
   Query,
-  NotFoundException,
-  InternalServerErrorException,
+  UseInterceptors,
 } from '@nestjs/common';
 import {
   ApiTags,
@@ -24,18 +23,20 @@ import { UserRole } from 'src/shared/enums/userRole.enum';
 import { Scopes } from 'src/shared/decorators/scopes.decorator';
 import { Scope } from 'src/shared/enums/scopes.enum';
 import {
+  ScorecardPaginatedResponseDto,
   ScorecardRequestDto,
   ScorecardResponseDto,
-  mapScorecardRequestToDto,
+  ScorecardWithGroupResponseDto,
 } from 'src/dto/scorecard.dto';
 import { ChallengeTrack } from 'src/shared/enums/challengeTrack.enum';
-import { PrismaService } from '../../shared/modules/global/prisma.service';
+import { ScoreCardService } from './scorecard.service';
+import { PaginationHeaderInterceptor } from 'src/interceptors/PaginationHeaderInterceptor';
 
 @ApiTags('Scorecard')
 @ApiBearerAuth()
 @Controller('/scorecards')
 export class ScorecardController {
-  constructor(private readonly prisma: PrismaService) {}
+  constructor(private readonly scorecardService: ScoreCardService) {}
 
   @Post()
   @Roles(UserRole.Admin)
@@ -48,27 +49,13 @@ export class ScorecardController {
   @ApiResponse({
     status: 201,
     description: 'Scorecard added successfully.',
-    type: ScorecardResponseDto,
+    type: ScorecardWithGroupResponseDto,
   })
   @ApiResponse({ status: 403, description: 'Forbidden.' })
   async addScorecard(
     @Body() body: ScorecardRequestDto,
-  ): Promise<ScorecardResponseDto> {
-    const data = await this.prisma.scorecard.create({
-      data: mapScorecardRequestToDto(body),
-      include: {
-        scorecardGroups: {
-          include: {
-            sections: {
-              include: {
-                questions: true,
-              },
-            },
-          },
-        },
-      },
-    });
-    return data as ScorecardResponseDto;
+  ): Promise<ScorecardWithGroupResponseDto> {
+    return await this.scorecardService.addScorecard(body);
   }
 
   @Put('/:id')
@@ -87,41 +74,15 @@ export class ScorecardController {
   @ApiResponse({
     status: 200,
     description: 'Scorecard updated successfully.',
-    type: ScorecardResponseDto,
+    type: ScorecardWithGroupResponseDto,
   })
   @ApiResponse({ status: 403, description: 'Forbidden.' })
   @ApiResponse({ status: 404, description: 'Scorecard not found.' })
   async editScorecard(
     @Param('id') id: string,
-    @Body() body: ScorecardRequestDto,
-  ): Promise<ScorecardResponseDto> {
-    console.log(JSON.stringify(body));
-
-    const data = await this.prisma.scorecard
-      .update({
-        where: { id },
-        data: mapScorecardRequestToDto(body),
-        include: {
-          scorecardGroups: {
-            include: {
-              sections: {
-                include: {
-                  questions: true,
-                },
-              },
-            },
-          },
-        },
-      })
-      .catch((error) => {
-        if (error.code !== 'P2025') {
-          throw new NotFoundException({ message: `Scorecard not found.` });
-        }
-        throw new InternalServerErrorException({
-          message: `Error: ${error.code}`,
-        });
-      });
-    return data as ScorecardResponseDto;
+    @Body() body: ScorecardWithGroupResponseDto,
+  ): Promise<ScorecardWithGroupResponseDto> {    
+    return await this.scorecardService.editScorecard(id, body);
   }
 
   @Delete(':id')
@@ -139,24 +100,12 @@ export class ScorecardController {
   @ApiResponse({
     status: 200,
     description: 'Scorecard deleted successfully.',
-    type: ScorecardResponseDto,
+    type: ScorecardWithGroupResponseDto,
   })
   @ApiResponse({ status: 403, description: 'Forbidden.' })
   @ApiResponse({ status: 404, description: 'Scorecard not found.' })
   async deleteScorecard(@Param('id') id: string) {
-    await this.prisma.scorecard
-      .delete({
-        where: { id },
-      })
-      .catch((error) => {
-        if (error.code !== 'P2025') {
-          throw new NotFoundException({ message: `Scorecard not found.` });
-        }
-        throw new InternalServerErrorException({
-          message: `Error: ${error.code}`,
-        });
-      });
-    return { message: `Scorecard ${id} deleted successfully.` };
+    return await this.scorecardService.deleteScorecard(id);
   }
 
   @Get('/:id')
@@ -173,38 +122,15 @@ export class ScorecardController {
   @ApiResponse({
     status: 200,
     description: 'Scorecard retrieved successfully.',
-    type: ScorecardResponseDto,
+    type: ScorecardWithGroupResponseDto,
   })
   @ApiResponse({ status: 404, description: 'Scorecard not found.' })
-  async viewScorecard(@Param('id') id: string): Promise<ScorecardResponseDto> {
-    const data = await this.prisma.scorecard
-      .findUniqueOrThrow({
-        where: { id },
-        include: {
-          scorecardGroups: {
-            include: {
-              sections: {
-                include: {
-                  questions: true,
-                },
-              },
-            },
-          },
-        },
-      })
-      .catch((error) => {
-        if (error.code !== 'P2025') {
-          throw new NotFoundException({ message: `Scorecard not found.` });
-        }
-        throw new InternalServerErrorException({
-          message: `Error: ${error.code}`,
-        });
-      });
-    return data as ScorecardResponseDto;
+  async viewScorecard(@Param('id') id: string): Promise<ScorecardWithGroupResponseDto> {
+    return await this.scorecardService.viewScorecard(id);
   }
 
   @Get()
-  @Roles(UserRole.Admin, UserRole.Copilot)
+  @Roles(UserRole.Admin)
   @Scopes(Scope.ReadScorecard)
   @ApiOperation({
     summary: 'Search scorecards',
@@ -249,34 +175,31 @@ export class ScorecardController {
     description: 'List of matching scorecards',
     type: [ScorecardResponseDto],
   })
+  @UseInterceptors(PaginationHeaderInterceptor)
   async searchScorecards(
-    @Query('challengeTrack') challengeTrack?: ChallengeTrack,
-    @Query('challengeType') challengeType?: string,
+    @Query('challengeTrack') challengeTrack?: ChallengeTrack | ChallengeTrack[],
+    @Query('challengeType') challengeType?: string | string[],
     @Query('name') name?: string,
     @Query('page') page: number = 1,
     @Query('perPage') perPage: number = 10,
-  ) {
-    const skip = (page - 1) * perPage;
-    const data = await this.prisma.scorecard.findMany({
-      where: {
-        ...(challengeTrack && { challengeTrack }),
-        ...(challengeType && { challengeType }),
-        ...(name && { name: { contains: name, mode: 'insensitive' } }),
-      },
-      include: {
-        scorecardGroups: {
-          include: {
-            sections: {
-              include: {
-                questions: true,
-              },
-            },
-          },
-        },
-      },
-      skip,
-      take: perPage,
+  ): Promise<ScorecardPaginatedResponseDto> {
+    const challengeTrackArray = Array.isArray(challengeTrack)
+    ? challengeTrack
+    : challengeTrack
+    ? [challengeTrack]
+    : [];
+    const challengeTypeArray = Array.isArray(challengeType)
+    ? challengeType
+    : challengeType
+    ? [challengeType]
+    : [];
+    const result = await this.scorecardService.getScoreCards({
+      challengeTrack: challengeTrackArray,
+      challengeType: challengeTypeArray,
+      name,
+      page,
+      perPage,
     });
-    return data as ScorecardResponseDto[];
+    return result;
   }
 }