Test Run pagination added (#93)

* Test Run pagination added

Visual-Regression-Tracker/Visual-Regression-Tracker#180

Author: pashidlos

.env

@@ -1,7 +1,7 @@
 JWT_SECRET='jwtPrivateKey'
 JWT_LIFE_TIME=1d
 
-BODY_PARSER_JSON_LIMIT="1mb"
+BODY_PARSER_JSON_LIMIT="5mb"
 
 APP_PORT=4200
 APP_FRONTEND_URL=http://localhost:8080

src/test-runs/dto/testRun-paginated.dto.ts

@@ -0,0 +1,8 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Pagination } from '../../shared/dto/pagination.dto';
+import { TestRunDto } from './testRun.dto';
+
+export class PaginatedTestRunDto extends Pagination {
+  @ApiProperty({ type: [TestRunDto] })
+  data: TestRunDto[];
+}

src/test-runs/dto/testRun.dto.ts

@@ -0,0 +1,68 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { TestRun, TestStatus } from '@prisma/client';
+
+export class TestRunDto {
+  @ApiProperty()
+  id: string;
+  @ApiProperty()
+  buildId: string;
+  @ApiProperty()
+  imageName: string;
+  @ApiProperty()
+  diffName: string;
+  @ApiProperty()
+  diffPercent: number;
+  @ApiProperty()
+  diffTollerancePercent: number;
+  @ApiProperty()
+  status: TestStatus;
+  @ApiProperty()
+  testVariationId: string;
+  @ApiProperty()
+  name: string;
+  @ApiProperty()
+  baselineName: string;
+  @ApiProperty()
+  os: string;
+  @ApiProperty()
+  browser: string;
+  @ApiProperty()
+  viewport: string;
+  @ApiProperty()
+  device: string;
+  @ApiProperty()
+  ignoreAreas: string;
+  @ApiProperty()
+  tempIgnoreAreas: string;
+  @ApiProperty()
+  comment?: string;
+  @ApiProperty()
+  branchName: string;
+  @ApiProperty()
+  baselineBranchName: string;
+  @ApiProperty()
+  merge: boolean;
+
+  constructor(testRun: TestRun) {
+    this.id = testRun.id;
+    this.buildId = testRun.buildId;
+    this.imageName = testRun.imageName;
+    this.diffName = testRun.diffName;
+    this.diffPercent = testRun.diffPercent;
+    this.diffTollerancePercent = testRun.diffTollerancePercent;
+    this.status = testRun.status;
+    this.testVariationId = testRun.testVariationId;
+    this.name = testRun.name;
+    this.baselineName = testRun.baselineName;
+    this.os = testRun.os;
+    this.browser = testRun.browser;
+    this.viewport = testRun.viewport;
+    this.device = testRun.device;
+    this.ignoreAreas = testRun.ignoreAreas;
+    this.tempIgnoreAreas = testRun.tempIgnoreAreas;
+    this.comment = testRun.comment;
+    this.branchName = testRun.branchName;
+    this.baselineBranchName = testRun.baselineBranchName;
+    this.merge = testRun.merge;
+  }
+}

src/test-runs/dto/testRunResult.dto.ts

@@ -1,38 +1,19 @@
-import { TestRun, TestStatus, TestVariation } from '@prisma/client';
+import { TestRun, TestVariation } from '@prisma/client';
 import { ApiProperty } from '@nestjs/swagger';
+import { TestRunDto } from './testRun.dto';
 
-export class TestRunResultDto {
-  @ApiProperty()
-  id: string;
-  @ApiProperty()
-  imageName: string;
-  @ApiProperty()
-  diffName?: string;
-  @ApiProperty()
-  baselineName?: string;
-  @ApiProperty()
-  diffPercent: number;
-  @ApiProperty()
-  diffTollerancePercent?: number;
+export class TestRunResultDto extends TestRunDto {
   @ApiProperty()
   pixelMisMatchCount?: number;
   @ApiProperty()
-  status: TestStatus;
-  @ApiProperty()
   url: string;
   @ApiProperty()
-  merge: boolean;
+  baselineName: string;
 
   constructor(testRun: TestRun, testVariation: TestVariation) {
-    this.id = testRun.id;
-    this.imageName = testRun.imageName;
-    this.diffName = testRun.diffName;
+    super(testRun);
     this.baselineName = testVariation.baselineName;
-    this.diffPercent = testRun.diffPercent;
-    this.diffTollerancePercent = testRun.diffTollerancePercent;
     this.pixelMisMatchCount = testRun.pixelMisMatchCount;
-    this.status = testRun.status;
-    this.merge = testRun.merge;
     this.url = `${process.env.APP_FRONTEND_URL}/${testVariation.projectId}?buildId=${testRun.buildId}&testId=${testRun.id}`;
   }
 }

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

@@ -10,6 +10,7 @@ import {
   Query,
   Post,
   ParseBoolPipe,
+  ParseIntPipe,
 } from '@nestjs/common';
 import { ApiTags, ApiParam, ApiBearerAuth, ApiQuery, ApiSecurity, ApiOkResponse } from '@nestjs/swagger';
 import { JwtAuthGuard } from '../auth/guards/auth.guard';
@@ -20,18 +21,23 @@ import { CommentDto } from '../shared/dto/comment.dto';
 import { TestRunResultDto } from './dto/testRunResult.dto';
 import { ApiGuard } from '../auth/guards/api.guard';
 import { CreateTestRequestDto } from './dto/create-test-request.dto';
+import { PaginatedTestRunDto } from './dto/testRun-paginated.dto';
 
 @ApiTags('test-runs')
 @Controller('test-runs')
 export class TestRunsController {
   constructor(private testRunsService: TestRunsService) {}
 
   @Get()
-  @ApiQuery({ name: 'buildId', required: true })
+  @ApiOkResponse({ type: PaginatedTestRunDto })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
-  get(@Query('buildId', new ParseUUIDPipe()) buildId: string): Promise<TestRun[]> {
-    return this.testRunsService.findMany(buildId);
+  get(
+    @Query('buildId', new ParseUUIDPipe()) buildId: string,
+    @Query('take', new ParseIntPipe()) take: number,
+    @Query('skip', new ParseIntPipe()) skip: number
+  ): Promise<PaginatedTestRunDto> {
+    return this.testRunsService.findMany(buildId, take, skip);
   }
 
   @Get('recalculateDiff/:id')

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

@@ -14,6 +14,7 @@ import { EventsGateway } from '../shared/events/events.gateway';
 import { CommentDto } from '../shared/dto/comment.dto';
 import { TestVariationsService } from '../test-variations/test-variations.service';
 import { convertBaselineDataToQuery } from '../shared/dto/baseline-data.dto';
+import { TestRunDto } from './dto/testRun.dto';
 
 jest.mock('pixelmatch');
 jest.mock('./dto/testRunResult.dto');
@@ -24,6 +25,7 @@ const initService = async ({
   testRunFindUniqueMock = jest.fn(),
   testRunFindManyMock = jest.fn(),
   testRunCreateMock = jest.fn(),
+  testRunCountMock = jest.fn(),
   getImageMock = jest.fn(),
   saveImageMock = jest.fn(),
   deleteImageMock = jest.fn(),
@@ -50,6 +52,7 @@ const initService = async ({
             findUnique: testRunFindUniqueMock,
             create: testRunCreateMock,
             update: testRunUpdateMock,
+            count: testRunCountMock,
           },
           testVariation: {
             create: testVariationCreateMock,
@@ -782,15 +785,53 @@ describe('TestRunsService', () => {
 
   it('findMany', async () => {
     const buildId = 'some id';
-    const testRunFindManyMock = jest.fn();
+    const testRun: TestRun = {
+      id: '10fb5e02-64e0-4cf5-9f17-c00ab3c96658',
+      imageName: '1592423768112.screenshot.png',
+      diffName: 'diffName',
+      diffPercent: 12,
+      diffTollerancePercent: 1,
+      pixelMisMatchCount: 123,
+      status: 'new',
+      buildId: buildId,
+      testVariationId: '3bc4a5bc-006e-4d43-8e4e-eaa132627fca',
+      updatedAt: new Date(),
+      createdAt: new Date(),
+      name: 'ss2f77',
+      browser: 'chromium',
+      device: null,
+      os: null,
+      viewport: '1800x1600',
+      baselineName: null,
+      ignoreAreas: '[]',
+      tempIgnoreAreas: '[]',
+      comment: 'some comment',
+      baselineBranchName: 'master',
+      branchName: 'develop',
+      merge: false,
+    };
+    const testRunFindManyMock = jest.fn().mockResolvedValueOnce([testRun]);
+    const testRunCountMock = jest.fn().mockResolvedValueOnce(30);
     service = await initService({
       testRunFindManyMock,
+      testRunCountMock,
     });
 
-    await service.findMany(buildId);
+    const result = await service.findMany(buildId, 10, 1);
 
     expect(testRunFindManyMock).toHaveBeenCalledWith({
       where: { buildId },
+      take: 10,
+      skip: 1,
+    });
+    expect(testRunCountMock).toHaveBeenCalledWith({
+      where: { buildId },
+    });
+    expect(result).toEqual({
+      data: [new TestRunDto(testRun)],
+      take: 10,
+      skip: 1,
+      total: 30,
     });
   });
 

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

@@ -12,6 +12,8 @@ import { CommentDto } from '../shared/dto/comment.dto';
 import { TestRunResultDto } from '../test-runs/dto/testRunResult.dto';
 import { TestVariationsService } from '../test-variations/test-variations.service';
 import { convertBaselineDataToQuery } from '../shared/dto/baseline-data.dto';
+import { TestRunDto } from './dto/testRun.dto';
+import { PaginatedTestRunDto } from './dto/testRun-paginated.dto';
 
 @Injectable()
 export class TestRunsService {
@@ -23,10 +25,21 @@ export class TestRunsService {
     private eventsGateway: EventsGateway
   ) {}
 
-  async findMany(buildId: string): Promise<TestRun[]> {
-    return this.prismaService.testRun.findMany({
-      where: { buildId },
-    });
+  async findMany(buildId: string, take: number, skip: number): Promise<PaginatedTestRunDto> {
+    const [total, list] = await Promise.all([
+      this.prismaService.testRun.count({ where: { buildId } }),
+      this.prismaService.testRun.findMany({
+        where: { buildId },
+        take,
+        skip,
+      }),
+    ]);
+    return {
+      data: list.map((item) => new TestRunDto(item)),
+      total,
+      take,
+      skip,
+    };
   }
 
   async findOne(