Add the username to the baseline history who has approved the new benchmark (#151)

pashidlos · web-flow · commit 9b04c17efbc8 · 2021-07-09T10:33:14.000+03:00
Visual-Regression-Tracker/Visual-Regression-Tracker#143
diff --git a/prisma/migrations/20210705154453-baseline-author/README.md b/prisma/migrations/20210705154453-baseline-author/README.md
@@ -0,0 +1,53 @@
+# Migration `20210705154453-baseline-author`
+
+This migration has been generated by Pavlo Strunkin <pashidlos@gmail.com> at 7/5/2021, 6:44:53 PM.
+You can check out the [state of the schema](./schema.prisma) after the migration.
+
+## Database Steps
+
+```sql
+ALTER TABLE "Baseline" ADD COLUMN     "userId" TEXT
+
+ALTER TABLE "Baseline" ADD FOREIGN KEY("userId")REFERENCES "User"("id") ON DELETE SET NULL ON UPDATE CASCADE
+```
+
+## Changes
+
+```diff
+diff --git schema.prisma schema.prisma
+migration 20210612140950-limit-build-number..20210705154453-baseline-author
+--- datamodel.dml
++++ datamodel.dml
+@@ -3,9 +3,9 @@
+ }
+ datasource db {
+   provider = "postgresql"
+-  url = "***"
++  url = "***"
+ }
+ model Build {
+   id         String    @id @default(uuid())
+@@ -102,9 +102,11 @@
+   testVariationId String
+   testVariation   TestVariation @relation(fields: [testVariationId], references: [id])
+   testRunId       String?
+   testRun         TestRun?      @relation(fields: [testRunId], references: [id])
+-  updatedAt       DateTime      @updatedAt
++  userId          String?
++  user            User?         @relation(fields: [userId], references: [id])
++  updatedAt       DateTime      @updatedAt 
+   createdAt       DateTime      @default(now())
+ }
+ model User {
+@@ -115,8 +117,9 @@
+   lastName  String?
+   apiKey    String   @unique
+   isActive  Boolean  @default(true)
+   builds    Build[]
++  baselines Baseline[]
+   updatedAt DateTime @updatedAt
+   createdAt DateTime @default(now())
+ }
+```
+
+
diff --git a/prisma/migrations/20210705154453-baseline-author/schema.prisma b/prisma/migrations/20210705154453-baseline-author/schema.prisma
@@ -0,0 +1,139 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgresql"
+  url = "***"
+}
+
+model Build {
+  id         String    @id @default(uuid())
+  ciBuildId  String?
+  number     Int?
+  branchName String?
+  status     String?
+  testRuns   TestRun[]
+  projectId  String
+  project    Project   @relation(fields: [projectId], references: [id])
+  updatedAt  DateTime  @updatedAt
+  createdAt  DateTime  @default(now())
+  user       User?     @relation(fields: [userId], references: [id])
+  userId     String?
+  isRunning  Boolean?
+
+  @@unique([projectId, ciBuildId])
+}
+
+model Project {
+  id                    String          @id @default(uuid())
+  name                  String
+  mainBranchName        String          @default("master")
+  builds                Build[]
+  buildsCounter         Int             @default(0)
+  maxBuildAllowed       Int             @default(100)
+  testVariations        TestVariation[]
+  updatedAt             DateTime        @updatedAt
+  createdAt             DateTime        @default(now())
+  // config
+  autoApproveFeature    Boolean         @default(false)
+  imageComparison       ImageComparison @default(pixelmatch)
+  imageComparisonConfig String          @default("{ \"threshold\": 0.1, \"ignoreAntialiasing\": true, \"allowDiffDimensions\": false }")
+
+  @@unique([name])
+}
+
+model TestRun {
+  id                    String         @id @default(uuid())
+  imageName             String
+  diffName              String?
+  diffPercent           Float?
+  diffTollerancePercent Float          @default(0)
+  pixelMisMatchCount    Int?
+  status                TestStatus
+  buildId               String
+  build                 Build          @relation(fields: [buildId], references: [id])
+  testVariationId       String?
+  testVariation         TestVariation? @relation(fields: [testVariationId], references: [id])
+  merge                 Boolean        @default(false)
+  updatedAt             DateTime       @updatedAt
+  createdAt             DateTime       @default(now())
+  // Test variation data
+  name                  String         @default("")
+  browser               String?
+  device                String?
+  os                    String?
+  viewport              String?
+  customTags            String?        @default("")
+  baselineName          String?
+  comment               String?
+  baseline              Baseline?
+  branchName            String         @default("master")
+  baselineBranchName    String?
+  ignoreAreas           String         @default("[]")
+  tempIgnoreAreas       String         @default("[]")
+}
+
+model TestVariation {
+  id           String     @id @default(uuid())
+  name         String
+  branchName   String     @default("master")
+  browser      String     @default("")
+  device       String     @default("")
+  os           String     @default("")
+  viewport     String     @default("")
+  customTags   String     @default("")
+  baselineName String?
+  ignoreAreas  String     @default("[]")
+  projectId    String
+  project      Project    @relation(fields: [projectId], references: [id])
+  testRuns     TestRun[]
+  baselines    Baseline[]
+  comment      String?
+  updatedAt    DateTime   @updatedAt
+  createdAt    DateTime   @default(now())
+
+  @@unique([projectId, name, browser, device, os, viewport, customTags, branchName])
+}
+
+model Baseline {
+  id              String        @id @default(uuid())
+  baselineName    String
+  testVariationId String
+  testVariation   TestVariation @relation(fields: [testVariationId], references: [id])
+  testRunId       String?
+  testRun         TestRun?      @relation(fields: [testRunId], references: [id])
+  userId          String?
+  user            User?         @relation(fields: [userId], references: [id])
+  updatedAt       DateTime      @updatedAt 
+  createdAt       DateTime      @default(now())
+}
+
+model User {
+  id        String   @id @default(uuid())
+  email     String   @unique
+  password  String
+  firstName String?
+  lastName  String?
+  apiKey    String   @unique
+  isActive  Boolean  @default(true)
+  builds    Build[]
+  baselines Baseline[]
+  updatedAt DateTime @updatedAt
+  createdAt DateTime @default(now())
+}
+
+enum TestStatus {
+  failed
+  new
+  ok
+  unresolved
+  approved
+  autoApproved
+}
+
+enum ImageComparison {
+  pixelmatch
+  lookSame
+  odiff
+}
diff --git a/prisma/migrations/20210705154453-baseline-author/steps.json b/prisma/migrations/20210705154453-baseline-author/steps.json
@@ -0,0 +1,65 @@
+{
+  "version": "0.3.14-fixed",
+  "steps": [
+    {
+      "tag": "CreateField",
+      "model": "User",
+      "field": "baselines",
+      "type": "Baseline",
+      "arity": "List"
+    },
+    {
+      "tag": "CreateField",
+      "model": "Baseline",
+      "field": "userId",
+      "type": "String",
+      "arity": "Optional"
+    },
+    {
+      "tag": "CreateField",
+      "model": "Baseline",
+      "field": "user",
+      "type": "User",
+      "arity": "Optional"
+    },
+    {
+      "tag": "CreateDirective",
+      "location": {
+        "path": {
+          "tag": "Field",
+          "model": "Baseline",
+          "field": "user"
+        },
+        "directive": "relation"
+      }
+    },
+    {
+      "tag": "CreateArgument",
+      "location": {
+        "tag": "Directive",
+        "path": {
+          "tag": "Field",
+          "model": "Baseline",
+          "field": "user"
+        },
+        "directive": "relation"
+      },
+      "argument": "fields",
+      "value": "[userId]"
+    },
+    {
+      "tag": "CreateArgument",
+      "location": {
+        "tag": "Directive",
+        "path": {
+          "tag": "Field",
+          "model": "Baseline",
+          "field": "user"
+        },
+        "directive": "relation"
+      },
+      "argument": "references",
+      "value": "[id]"
+    }
+  ]
+}
diff --git a/prisma/migrations/migrate.lock b/prisma/migrations/migrate.lock
@@ -19,4 +19,5 @@
 20210425191116-github_215_project_config
 20210517203552-add-custom-tags
 20210605124856-image-compare-config-as-json
-20210612140950-limit-build-number
+20210612140950-limit-build-number
+20210705154453-baseline-author
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -103,7 +103,9 @@ model Baseline {
   testVariation   TestVariation @relation(fields: [testVariationId], references: [id])
   testRunId       String?
   testRun         TestRun?      @relation(fields: [testRunId], references: [id])
-  updatedAt       DateTime      @updatedAt
+  userId          String?
+  user            User?         @relation(fields: [userId], references: [id])
+  updatedAt       DateTime      @updatedAt 
   createdAt       DateTime      @default(now())
 }
 
@@ -116,6 +118,7 @@ model User {
   apiKey    String   @unique
   isActive  Boolean  @default(true)
   builds    Build[]
+  baselines Baseline[]
   updatedAt DateTime @updatedAt
   createdAt DateTime @default(now())
 }
diff --git a/src/_data_/index.ts b/src/_data_/index.ts
@@ -33,6 +33,7 @@ export const generateBaseline = (baseline?: Partial<Baseline>): Baseline => {
     baselineName: 'baselineName',
     testVariationId: 'testVariationId',
     testRunId: 'testRunId',
+    userId: 'userId',
     updatedAt: new Date(),
     createdAt: new Date(),
     ...baseline,
diff --git a/src/test-runs/test-runs.controller.ts b/src/test-runs/test-runs.controller.ts
@@ -3,7 +3,6 @@ import {
   UseGuards,
   Param,
   ParseUUIDPipe,
-  Put,
   Body,
   Get,
   Query,
@@ -26,7 +25,7 @@ import {
   ApiBody,
 } from '@nestjs/swagger';
 import { JwtAuthGuard } from '../auth/guards/auth.guard';
-import { TestRun, TestStatus } from '@prisma/client';
+import { TestRun, TestStatus, User } from '@prisma/client';
 import { TestRunsService } from './test-runs.service';
 import { TestRunResultDto } from './dto/testRunResult.dto';
 import { ApiGuard } from '../auth/guards/api.guard';
@@ -37,13 +36,15 @@ import { CreateTestRequestMultipartDto } from './dto/create-test-request-multipa
 import { FileToBodyInterceptor } from '../shared/fite-to-body.interceptor';
 import { UpdateIgnoreAreasDto } from './dto/update-ignore-area.dto';
 import { UpdateTestRunDto } from './dto/update-test.dto';
+import { Reflector } from '@nestjs/core';
+import { CurrentUser } from '../shared/current-user.decorator';
 
 @ApiTags('test-runs')
 @Controller('test-runs')
 export class TestRunsController {
   private readonly logger: Logger = new Logger(TestRunsController.name);
 
-  constructor(private testRunsService: TestRunsService) {}
+  constructor(private testRunsService: TestRunsService, private reflector: Reflector) {}
 
   @Get()
   @ApiOkResponse({ type: [TestRunDto] })
@@ -57,10 +58,14 @@ export class TestRunsController {
   @ApiQuery({ name: 'merge', required: false })
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
-  async approveTestRun(@Body() ids: string[], @Query('merge', new ParseBoolPipe()) merge: boolean): Promise<void> {
+  async approveTestRun(
+    @CurrentUser() user: User,
+    @Body() ids: string[],
+    @Query('merge', new ParseBoolPipe()) merge: boolean
+  ): Promise<void> {
     this.logger.debug(`Going to approve TestRuns: ${ids}`);
     for (const id of ids) {
-      await this.testRunsService.approve(id, merge);
+      await this.testRunsService.approve(id, merge, false, user.id);
     }
   }
 
diff --git a/src/test-runs/test-runs.service.ts b/src/test-runs/test-runs.service.ts
@@ -95,13 +95,8 @@ export class TestRunsService {
 
   /**
    * Confirm difference for testRun
-   *
-   * @param id
-   * @param merge replaces main branch baseline with feature one
-   * @param autoApprove set auto approve status
-   * @returns
    */
-  async approve(id: string, merge = false, autoApprove = false): Promise<TestRun> {
+  async approve(id: string, merge = false, autoApprove = false, userId?: string): Promise<TestRun> {
     this.logger.log(`Approving testRun: ${id} merge: ${merge} autoApprove: ${autoApprove}`);
     const testRun = await this.findOne(id);
     let { testVariation } = testRun;
@@ -147,6 +142,7 @@ export class TestRunsService {
       // add baseline
       await this.testVariationService.addBaseline({
         id: testVariation.id,
+        userId,
         testRunId: testRun.id,
         baselineName,
       });
diff --git a/src/test-variations/test-variations.service.spec.ts b/src/test-variations/test-variations.service.spec.ts
@@ -97,6 +97,7 @@ describe('TestVariationsService', () => {
           baselines: {
             include: {
               testRun: true,
+              user: true,
             },
             orderBy: {
               createdAt: 'desc',
@@ -555,6 +556,7 @@ describe('TestVariationsService', () => {
           baselineName: 'image name 1',
           testVariationId: testVariationId,
           testRunId: 'test run id 1',
+          userId: 'userId',
           createdAt: new Date(),
           updatedAt: new Date(),
         },
@@ -588,6 +590,7 @@ describe('TestVariationsService', () => {
       baselineName: 'image name 1',
       testVariationId: 'test variation id',
       testRunId: 'test run id 1',
+      userId: 'userId',
       createdAt: new Date(),
       updatedAt: new Date(),
     };
diff --git a/src/test-variations/test-variations.service.ts b/src/test-variations/test-variations.service.ts
