Swagger docs updated (#234)

pashidlos · web-flow · commit 2a98d163923f · 2023-08-20T00:16:35.000+03:00
* Swagger docs updated

* fix

* Update test-variations.service.ts

* Update test-runs.e2e-spec.ts

* Update create-test-request-multipart.dto.ts
diff --git a/src/builds/builds.controller.ts b/src/builds/builds.controller.ts
@@ -58,6 +58,7 @@ export class BuildsController {
   }
 
   @Delete(':id')
+  @ApiOkResponse({ type: BuildDto })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
diff --git a/src/builds/dto/build-paginated.dto.ts b/src/builds/dto/build-paginated.dto.ts
@@ -3,6 +3,6 @@ import { Pagination } from '../../shared/dto/pagination.dto';
 import { BuildDto } from './build.dto';
 
 export class PaginatedBuildDto extends Pagination {
-  @ApiProperty({ type: [BuildDto] })
+  @ApiProperty({ type: BuildDto, isArray: true })
   data: BuildDto[];
 }
diff --git a/src/health/health.controller.ts b/src/health/health.controller.ts
@@ -1,7 +1,9 @@
 import { Controller, Get } from '@nestjs/common';
 import { HealthCheckService, HealthCheck } from '@nestjs/terminus';
 import { PrismaService } from '../prisma/prisma.service';
+import { ApiOkResponse, ApiTags } from '@nestjs/swagger';
 
+@ApiTags('health')
 @Controller('health')
 export class HealthController {
   constructor(
@@ -10,6 +12,7 @@ export class HealthController {
   ) {}
 
   @Get()
+  @ApiOkResponse({type: Object})
   @HealthCheck()
   check() {
     return this.health.check([() => this.prismaService.$queryRaw`SELECT 1`]);
diff --git a/src/projects/dto/project.dto.ts b/src/projects/dto/project.dto.ts
@@ -1,6 +1,7 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsUUID, IsString, IsNumber, IsBoolean, IsEnum, IsJSON } from 'class-validator';
+import { IsUUID, IsString, IsNumber, IsBoolean, IsEnum, IsJSON, IsDate } from 'class-validator';
 import { ImageComparison, Project } from '@prisma/client';
+import { Type } from 'class-transformer';
 
 export class ProjectDto implements Project {
   @ApiProperty()
@@ -20,9 +21,13 @@ export class ProjectDto implements Project {
   readonly mainBranchName: string;
 
   @ApiProperty()
+  @IsDate()
+  @Type(() => Date)
   readonly createdAt: Date;
 
   @ApiProperty()
+  @IsDate()
+  @Type(() => Date)
   readonly updatedAt: Date;
 
   @ApiProperty()
diff --git a/src/projects/projects.controller.ts b/src/projects/projects.controller.ts
@@ -17,7 +17,7 @@ export class ProjectsController {
   @Get()
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
-  @ApiOkResponse({ type: [ProjectDto] })
+  @ApiOkResponse({ type: ProjectDto, isArray: true })
   getAll(): Promise<Project[]> {
     return this.projectsService.findAll();
   }
diff --git a/src/shared/dto/baseline.dto.ts b/src/shared/dto/baseline.dto.ts
@@ -0,0 +1,26 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { TestRunDto } from '../../test-runs/dto/testRun.dto';
+import { UserDto } from '../../users/dto/user.dto';
+
+export class BaselineDto {
+  @ApiProperty()
+  id: string;
+
+  @ApiProperty()
+  baselineName: string;
+
+  @ApiProperty()
+  testVariationId: string;
+
+  @ApiProperty()
+  createdAt: Date;
+
+  @ApiProperty()
+  updatedAt: Date;
+
+  @ApiProperty()
+  testRun: TestRunDto;
+
+  @ApiProperty()
+  user: UserDto;
+}
diff --git a/src/test-runs/dto/create-test-request-multipart.dto.ts b/src/test-runs/dto/create-test-request-multipart.dto.ts
@@ -1,7 +1,33 @@
+import { ApiPropertyOptional, OmitType } from '@nestjs/swagger';
 import { ApiFile } from '../../shared/api-file.decorator';
 import { CreateTestRequestDto } from './create-test-request.dto';
+import { Transform, Type } from 'class-transformer';
+import { IgnoreAreaDto } from './ignore-area.dto';
+import { IsBoolean, IsNumber, IsOptional } from 'class-validator';
 
-export class CreateTestRequestMultipartDto extends CreateTestRequestDto {
+export class CreateTestRequestMultipartDto extends OmitType(CreateTestRequestDto, [
+  'ignoreAreas',
+  'merge',
+  'diffTollerancePercent',
+]) {
   @ApiFile()
   image: Express.Multer.File;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsNumber()
+  @Transform(({ value }) => parseFloat(value) || 0)
+  diffTollerancePercent?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsBoolean()
+  @Transform(({ value }) => value == 'true')
+  merge?: boolean;
+
+  @ApiPropertyOptional({ type: String })
+  @IsOptional()
+  @Type(() => String)
+  @Transform(({ value }) => (value ? JSON.parse(value) : []))
+  ignoreAreas?: IgnoreAreaDto[];
 }
diff --git a/src/test-runs/dto/create-test-request.dto.ts b/src/test-runs/dto/create-test-request.dto.ts
@@ -1,7 +1,6 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { Transform } from 'class-transformer';
-import { IsOptional, IsUUID, IsNumber, IsBoolean, IsString } from 'class-validator';
-import { isArray } from 'lodash';
+import { Type } from 'class-transformer';
+import { IsOptional, IsUUID, IsNumber, IsBoolean, IsString, IsArray, ValidateNested } from 'class-validator';
 import { BaselineDataDto } from '../../shared/dto/baseline-data.dto';
 import { IgnoreAreaDto } from './ignore-area.dto';
 
@@ -17,32 +16,18 @@ export class CreateTestRequestDto extends BaselineDataDto {
   @ApiPropertyOptional()
   @IsOptional()
   @IsNumber()
-  @Transform(({ value }) => parseFloat(value))
   diffTollerancePercent?: number;
 
   @ApiPropertyOptional()
   @IsBoolean()
   @IsOptional()
-  @Transform(({ value }) => {
-    switch (value) {
-      case 'true':
-        return true;
-      case 'false':
-        return false;
-      default:
-        return value;
-    }
-  })
   merge?: boolean;
 
-  @ApiPropertyOptional({ type: [IgnoreAreaDto] })
+  @ApiPropertyOptional({ type: IgnoreAreaDto, isArray: true })
   @IsOptional()
-  @Transform(({ value }) => {
-    if (isArray(value)) {
-      return value;
-    }
-    return JSON.parse(value);
-  })
+  @IsArray()
+  @Type(() => IgnoreAreaDto)
+  @ValidateNested({ each: true })
   ignoreAreas?: IgnoreAreaDto[];
 
   @ApiPropertyOptional()
diff --git a/src/test-runs/dto/testRun-paginated.dto.ts b/src/test-runs/dto/testRun-paginated.dto.ts
@@ -3,6 +3,6 @@ import { Pagination } from '../../shared/dto/pagination.dto';
 import { TestRunDto } from './testRun.dto';
 
 export class PaginatedTestRunDto extends Pagination {
-  @ApiProperty({ type: [TestRunDto] })
+  @ApiProperty({ type: TestRunDto, isArray: true })
   data: TestRunDto[];
 }
diff --git a/src/test-runs/dto/testRun.dto.ts b/src/test-runs/dto/testRun.dto.ts
@@ -1,4 +1,4 @@
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import { TestRun, TestStatus } from '@prisma/client';
 
 export class TestRunDto {
@@ -36,7 +36,7 @@ export class TestRunDto {
   ignoreAreas: string;
   @ApiProperty()
   tempIgnoreAreas: string;
-  @ApiProperty()
+  @ApiPropertyOptional()
   comment?: string;
   @ApiProperty()
   branchName: string;
diff --git a/src/test-runs/dto/testRunResult.dto.ts b/src/test-runs/dto/testRunResult.dto.ts
@@ -1,9 +1,9 @@
 import { TestRun, TestVariation } from '@prisma/client';
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import { TestRunDto } from './testRun.dto';
 
 export class TestRunResultDto extends TestRunDto {
-  @ApiProperty()
+  @ApiPropertyOptional()
   pixelMisMatchCount?: number;
   @ApiProperty()
   url: string;
diff --git a/src/test-runs/dto/update-ignore-area.dto.ts b/src/test-runs/dto/update-ignore-area.dto.ts
@@ -1,10 +1,14 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { IgnoreAreaDto } from './ignore-area.dto';
+import { Type } from 'class-transformer';
+import { ValidateNested } from 'class-validator';
 
 export class UpdateIgnoreAreasDto {
-  @ApiProperty()
+  @ApiProperty({ isArray: true })
   readonly ids: string[];
 
-  @ApiProperty({ type: [IgnoreAreaDto] })
+  @ApiProperty({ type: IgnoreAreaDto, isArray: true })
+  @Type(() => IgnoreAreaDto)
+  @ValidateNested({ each: true })
   readonly ignoreAreas: IgnoreAreaDto[];
 }
diff --git a/src/test-runs/test-runs.controller.ts b/src/test-runs/test-runs.controller.ts
@@ -48,7 +48,7 @@ export class TestRunsController {
   constructor(private testRunsService: TestRunsService) {}
 
   @Get()
-  @ApiOkResponse({ type: [TestRunDto] })
+  @ApiOkResponse({ type: TestRunDto, isArray: true })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   get(@Query('buildId', new ParseUUIDPipe()) buildId: string): Promise<TestRunDto[]> {
@@ -65,6 +65,7 @@ export class TestRunsController {
 
   @Post('approve')
   @ApiQuery({ name: 'merge', required: false })
+  @ApiOkResponse({ type: undefined })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
@@ -80,6 +81,7 @@ export class TestRunsController {
   }
 
   @Post('reject')
+  @ApiOkResponse({ type: undefined })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
@@ -91,6 +93,7 @@ export class TestRunsController {
   }
 
   @Post('delete')
+  @ApiOkResponse({ type: undefined })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
@@ -102,6 +105,7 @@ export class TestRunsController {
   }
 
   @Post('ignoreAreas/update')
+  @ApiOkResponse({ type: undefined })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
@@ -113,6 +117,7 @@ export class TestRunsController {
   }
 
   @Post('ignoreAreas/add')
+  @ApiOkResponse({ type: undefined })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
@@ -125,6 +130,7 @@ export class TestRunsController {
 
   @Patch('update/:testRunId')
   @ApiParam({ name: 'testRunId', required: true })
+  @ApiOkResponse({ type: TestRunDto })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
@@ -154,7 +160,7 @@ export class TestRunsController {
   @UseGuards(ApiGuard, RoleGuard)
   @Roles(Role.admin, Role.editor)
   @UseInterceptors(FileInterceptor('image'), FileToBodyInterceptor)
-  @UsePipes(new ValidationPipe({ transform: true }))
+  @UsePipes(new ValidationPipe({ transform: true, forbidUnknownValues: true }))
   postTestRunMultipart(@Body() createTestRequestDto: CreateTestRequestMultipartDto): Promise<TestRunResultDto> {
     const imageBuffer = createTestRequestDto.image.buffer;
     return this.testRunsService.postTestRun({ createTestRequestDto, imageBuffer });
diff --git a/src/test-variations/dto/base-test-variation.dto.ts b/src/test-variations/dto/base-test-variation.dto.ts
@@ -0,0 +1,39 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+
+export class BaseTestVariationDto {
+  @ApiProperty()
+  id: string;
+
+  @ApiProperty()
+  name: string;
+
+  @ApiPropertyOptional()
+  baselineName?: string;
+
+  @ApiProperty()
+  branchName: string;
+
+  @ApiProperty()
+  os: string;
+
+  @ApiProperty()
+  browser: string;
+
+  @ApiProperty()
+  viewport: string;
+
+  @ApiProperty()
+  device: string;
+
+  @ApiProperty()
+  customTags: string;
+
+  @ApiPropertyOptional()
+  ignoreAreas?: string;
+
+  @ApiProperty()
+  projectId: string;
+
+  @ApiPropertyOptional()
+  comment?: string;
+}
diff --git a/src/test-variations/dto/test-variation-update.dto.ts b/src/test-variations/dto/test-variation-update.dto.ts
@@ -1,5 +1,8 @@
-export class TestVariationUpdateDto {
-  baselineName?: string;
-  ignoreAreas?: string;
-  comment?: string;
-}
+import { PickType } from '@nestjs/swagger';
+import { BaseTestVariationDto } from './base-test-variation.dto';
+
+export class TestVariationUpdateDto extends PickType(BaseTestVariationDto, [
+  'baselineName',
+  'ignoreAreas',
+  'comment',
+] as const) {}
diff --git a/src/test-variations/dto/test-variation.dto.ts b/src/test-variations/dto/test-variation.dto.ts
@@ -0,0 +1,8 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { BaseTestVariationDto } from './base-test-variation.dto';
+import { BaselineDto } from '../../shared/dto/baseline.dto';
+
+export class TestVariationDto extends BaseTestVariationDto {
+  @ApiProperty({ type: BaselineDto, isArray: true })
+  baselines: BaselineDto[];
+}
diff --git a/src/test-variations/test-variations.controller.ts b/src/test-variations/test-variations.controller.ts
diff --git a/src/test-variations/test-variations.service.ts b/src/test-variations/test-variations.service.ts
diff --git a/src/users/users.controller.ts b/src/users/users.controller.ts
diff --git a/test/test-runs.e2e-spec.ts b/test/test-runs.e2e-spec.ts

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ export class BuildsController {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`@Delete(':id')`
	`61`	`+ @ApiOkResponse({ type: BuildDto })`
`61`	`62`	`@ApiBearerAuth()`
`62`	`63`	`@UseGuards(JwtAuthGuard, RoleGuard)`
`63`	`64`	`@Roles(Role.admin, Role.editor)`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@ import { Pagination } from '../../shared/dto/pagination.dto';`
`3`	`3`	`import { BuildDto } from './build.dto';`
`4`	`4`
`5`	`5`	`export class PaginatedBuildDto extends Pagination {`
`6`		`- @ApiProperty({ type: [BuildDto] })`
	`6`	`+ @ApiProperty({ type: BuildDto, isArray: true })`
`7`	`7`	`data: BuildDto[];`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ export class ProjectsController {`
`17`	`17`	`@Get()`
`18`	`18`	`@ApiBearerAuth()`
`19`	`19`	`@UseGuards(JwtAuthGuard)`
`20`		`- @ApiOkResponse({ type: [ProjectDto] })`
	`20`	`+ @ApiOkResponse({ type: ProjectDto, isArray: true })`
`21`	`21`	`getAll(): Promise<Project[]> {`
`22`	`22`	`return this.projectsService.findAll();`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@ import { Pagination } from '../../shared/dto/pagination.dto';`
`3`	`3`	`import { TestRunDto } from './testRun.dto';`
`4`	`4`
`5`	`5`	`export class PaginatedTestRunDto extends Pagination {`
`6`		`- @ApiProperty({ type: [TestRunDto] })`
	`6`	`+ @ApiProperty({ type: TestRunDto, isArray: true })`
`7`	`7`	`data: TestRunDto[];`
`8`	`8`	`}`