CommentDto added

Author: pashidlos

src/shared/dto/comment.dto.ts

@@ -0,0 +1,8 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+
+export class CommentDto {
+  @ApiProperty()
+  @IsString()
+  comment: string;
+}

src/test-runs/test-runs.controller.ts

@@ -4,6 +4,7 @@ import { JwtAuthGuard } from '../auth/guards/auth.guard';
 import { TestRun } from '@prisma/client';
 import { TestRunsService } from './test-runs.service';
 import { IgnoreAreaDto } from '../test/dto/ignore-area.dto';
+import { CommentDto } from '../shared/dto/comment.dto';
 
 @ApiTags('test-runs')
 @Controller('test-runs')
@@ -65,7 +66,7 @@ export class TestRunsController {
   @ApiParam({ name: 'testRunId', required: true })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
-  updateComment(@Param('testRunId', new ParseUUIDPipe()) testRunId: string, @Body() comment: string): Promise<TestRun> {
-    return this.testRunsService.updateComment(testRunId, comment);
+  updateComment(@Param('testRunId', new ParseUUIDPipe()) id: string, @Body() body: CommentDto): Promise<TestRun> {
+    return this.testRunsService.updateComment(id, body);
   }
 }

src/test-runs/test-runs.service.spec.ts

@@ -10,6 +10,7 @@ import { CreateTestRequestDto } from '../test/dto/create-test-request.dto';
 import { DiffResult } from './diffResult';
 import { IgnoreAreaDto } from '../test/dto/ignore-area.dto';
 import { EventsGateway } from '../events/events.gateway';
+import { CommentDto } from '../shared/dto/comment.dto';
 
 jest.mock('pixelmatch');
 
@@ -538,18 +539,20 @@ describe('TestRunsService', () => {
 
   it('updateComment', async () => {
     const id = 'some id';
-    const comment = 'random comment';
+    const commentDto: CommentDto = {
+      comment: 'random comment',
+    };
     const testRunUpdateMock = jest.fn();
     service = await initService({
       testRunUpdateMock,
     });
 
-    await service.updateComment(id, comment);
+    await service.updateComment(id, commentDto);
 
     expect(testRunUpdateMock).toHaveBeenCalledWith({
       where: { id },
       data: {
-        comment,
+        comment: commentDto.comment,
       },
     });
   });

src/test-runs/test-runs.service.ts

@@ -8,6 +8,7 @@ import { PrismaService } from '../prisma/prisma.service';
 import { TestRun, TestStatus, TestVariation } from '@prisma/client';
 import { DiffResult } from './diffResult';
 import { EventsGateway } from '../events/events.gateway';
+import { CommentDto } from 'src/shared/dto/comment.dto';
 
 @Injectable()
 export class TestRunsService {
@@ -160,11 +161,11 @@ export class TestRunsService {
     });
   }
 
-  async updateComment(id: string, comment: string): Promise<TestRun> {
+  async updateComment(id: string, commentDto: CommentDto): Promise<TestRun> {
     return this.prismaService.testRun.update({
       where: { id },
       data: {
-        comment,
+        comment: commentDto.comment,
       },
     });
   }

src/test-variations/test-variations.controller.ts

@@ -5,6 +5,7 @@ import { TestVariation, Baseline } from '@prisma/client';
 import { JwtAuthGuard } from '../auth/guards/auth.guard';
 import { PrismaService } from '../prisma/prisma.service';
 import { IgnoreAreaDto } from '../test/dto/ignore-area.dto';
+import { CommentDto } from '../shared/dto/comment.dto';
 
 @ApiTags('test-variations')
 @Controller('test-variations')
@@ -40,14 +41,11 @@ export class TestVariationsController {
     return this.testVariations.updateIgnoreAreas(variationId, ignoreAreas);
   }
 
-  @Put('comment/:testRunId')
-  @ApiParam({ name: 'testRunId', required: true })
+  @Put('comment/:id')
+  @ApiParam({ name: 'id', required: true })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
-  updateComment(
-    @Param('testRunId', new ParseUUIDPipe()) testRunId: string,
-    @Body() comment: string
-  ): Promise<TestVariation> {
-    return this.testVariations.updateComment(testRunId, comment);
+  updateComment(@Param('id', new ParseUUIDPipe()) id: string, @Body() body: CommentDto): Promise<TestVariation> {
+    return this.testVariations.updateComment(id, body);
   }
 }

src/test-variations/test-variations.service.spec.ts

@@ -5,6 +5,7 @@ import { CreateTestRequestDto } from '../test/dto/create-test-request.dto';
 import { StaticService } from '../shared/static/static.service';
 import { IgnoreAreaDto } from 'src/test/dto/ignore-area.dto';
 import { TestVariation, Baseline } from '@prisma/client';
+import { CommentDto } from '../shared/dto/comment.dto';
 
 const initModule = async ({
   imageDeleteMock = jest.fn(),
@@ -237,18 +238,20 @@ describe('TestVariationsService', () => {
 
   it('updateComment', async () => {
     const id = 'some id';
-    const comment = 'random comment';
+    const commentDto: CommentDto = {
+      comment: 'random comment',
+    };
     const variationUpdateMock = jest.fn();
     service = await initModule({
       variationUpdateMock,
     });
 
-    await service.updateComment(id, comment);
+    await service.updateComment(id, commentDto);
 
     expect(variationUpdateMock).toHaveBeenCalledWith({
       where: { id },
       data: {
-        comment,
+        comment: commentDto.comment,
       },
     });
   });

src/test-variations/test-variations.service.ts

@@ -4,6 +4,7 @@ import { IgnoreAreaDto } from '../test/dto/ignore-area.dto';
 import { PrismaService } from '../prisma/prisma.service';
 import { TestVariation, Baseline } from '@prisma/client';
 import { StaticService } from '../shared/static/static.service';
+import { CommentDto } from '../shared/dto/comment.dto';
 
 @Injectable()
 export class TestVariationsService {
@@ -61,11 +62,11 @@ export class TestVariationsService {
     });
   }
 
-  async updateComment(id: string, comment: string): Promise<TestVariation> {
+  async updateComment(id: string, commentDto: CommentDto): Promise<TestVariation> {
     return this.prismaService.testVariation.update({
       where: { id },
       data: {
-        comment,
+        comment: commentDto.comment,
       },
     });
   }