feat(#455): add protectedBranch project variable

Author: Przybylski Krzysztof

prisma/migrations/20250225101118_add_protected_branches/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Project" ADD COLUMN     "protectedBranch" TEXT;

prisma/schema.prisma

@@ -1,5 +1,5 @@
 generator client {
-  provider = "prisma-client-js"
+  provider      = "prisma-client-js"
   binaryTargets = ["native", "debian-openssl-3.0.x", "linux-arm64-openssl-3.0.x"]
 }
 
@@ -41,6 +41,7 @@ model Project {
   builds                Build[]
   TestRun               TestRun[]
   testVariations        TestVariation[]
+  protectedBranch       String?
 }
 
 model TestRun {

src/_data_/index.ts

@@ -13,6 +13,7 @@ export const TEST_PROJECT: Project = {
   autoApproveFeature: true,
   imageComparisonConfig: '{ "threshold": 0.1, "ignoreAntialiasing": true, "allowDiffDimensions": false }',
   imageComparison: ImageComparison.pixelmatch,
+  protectedBranch: 'release-[0-9]+'
 };
 
 export const TEST_BUILD: Build = {

src/projects/dto/project.dto.ts

@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsUUID, IsString, IsNumber, IsBoolean, IsEnum, IsJSON, IsDate } from 'class-validator';
+import { IsUUID, IsString, IsNumber, IsBoolean, IsEnum, IsJSON, IsDate, IsOptional } from 'class-validator';
 import { ImageComparison, Project } from '@prisma/client';
 import { Type } from 'class-transformer';
 
@@ -49,4 +49,9 @@ export class ProjectDto implements Project {
   @ApiProperty()
   @IsJSON()
   imageComparisonConfig: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsOptional()
+  protectedBranch: string;
 }

src/projects/projects.service.ts

@@ -48,6 +48,7 @@ export class ProjectsService {
         imageComparisonConfig: projectDto.imageComparisonConfig,
         maxBuildAllowed: projectDto.maxBuildAllowed,
         maxBranchLifetime: projectDto.maxBranchLifetime,
+        protectedBranch: projectDto.protectedBranch
       },
     });
   }
@@ -63,6 +64,7 @@ export class ProjectsService {
         maxBuildAllowed: projectDto.maxBuildAllowed,
         maxBranchLifetime: projectDto.maxBranchLifetime,
         imageComparisonConfig: projectDto.imageComparisonConfig,
+        protectedBranch: projectDto.protectedBranch
       },
     });
   }

src/shared/tasks/tasks.service.spec.ts

@@ -6,7 +6,7 @@ import { TestVariationsService } from '../../test-variations/test-variations.ser
 
 const initService = async ({
   projectFindManyMock = jest.fn(),
-  testVariationFindManyMock = jest.fn(),
+  findOldTestVariationsMock = jest.fn(),
   testVariationsDeleteMock = jest.fn(),
 }) => {
   const module: TestingModule = await Test.createTestingModule({
@@ -15,9 +15,6 @@ const initService = async ({
       {
         provide: PrismaService,
         useValue: {
-          testVariation: {
-            findMany: testVariationFindManyMock,
-          },
           project: {
             findMany: projectFindManyMock,
           },
@@ -27,6 +24,7 @@ const initService = async ({
         provide: TestVariationsService,
         useValue: {
           delete: testVariationsDeleteMock,
+          findOldTestVariations: findOldTestVariationsMock,
         },
       },
     ],
@@ -43,11 +41,11 @@ describe('cleanOldTestVariations', () => {
     const project = TEST_PROJECT;
     const testVariation = generateTestVariation();
     const projectFindManyMock = jest.fn().mockResolvedValueOnce([project]);
-    const testVariationFindManyMock = jest.fn().mockResolvedValueOnce([testVariation]);
+    const findOldTestVariationsMock = jest.fn().mockResolvedValueOnce([testVariation]);
     const testVariationsDeleteMock = jest.fn();
     service = await initService({
       projectFindManyMock: projectFindManyMock,
-      testVariationFindManyMock: testVariationFindManyMock,
+      findOldTestVariationsMock: findOldTestVariationsMock,
       testVariationsDeleteMock: testVariationsDeleteMock,
     });
     const dateNow = new Date('2022-10-23');
@@ -59,13 +57,7 @@ describe('cleanOldTestVariations', () => {
     await service.cleanOldTestVariations();
 
     // .Assert
-    expect(testVariationFindManyMock).toHaveBeenCalledWith({
-      where: {
-        updatedAt: { lte: dateRemoveAfter },
-        branchName: { not: project.mainBranchName },
-        projectId: project.id,
-      },
-    });
+    expect(findOldTestVariationsMock).toHaveBeenCalledWith(project, dateRemoveAfter);
     expect(testVariationsDeleteMock).toBeCalledWith(testVariation.id);
   });
 });

src/shared/tasks/tasks.service.ts

@@ -21,13 +21,8 @@ export class TasksService {
       const dateRemoveAfter: Date = new Date();
       dateRemoveAfter.setDate(dateRemoveAfter.getDate() - project.maxBranchLifetime);
 
-      const testVariations = await this.prismaService.testVariation.findMany({
-        where: {
-          projectId: project.id,
-          updatedAt: { lte: dateRemoveAfter },
-          branchName: { not: project.mainBranchName },
-        },
-      });
+      const testVariations = await this.testVariationService.findOldTestVariations(project, dateRemoveAfter);
+
       this.logger.debug(
         `Removing ${testVariations.length} TestVariations for ${project.name} later than ${dateRemoveAfter}`
       );

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

@@ -1,6 +1,6 @@
 import { Injectable, Inject, forwardRef, Logger } from '@nestjs/common';
 import { PrismaService } from '../prisma/prisma.service';
-import { TestVariation, Baseline, Build, TestRun, User } from '@prisma/client';
+import { TestVariation, Baseline, Build, TestRun, User, type Project } from '@prisma/client';
 import { StaticService } from '../static/static.service';
 import { BuildsService } from '../builds/builds.service';
 import { TestRunsService } from '../test-runs/test-runs.service';
@@ -246,4 +246,14 @@ export class TestVariationsService {
       where: { id: baseline.id },
     });
   }
+
+  async findOldTestVariations(project: Project, dateRemoveAfter: Date) {
+    return await this.prismaService.$queryRaw<Project[]>`
+      SELECT * from public."TestVariation"
+        WHERE "projectId" = ${project.id}
+        AND "updatedAt" <= ${dateRemoveAfter}
+        AND "branchName" NOT LIKE ${project.mainBranchName}
+        AND "branchName" NOT SIMILAR TO ${project.protectedBranch}
+      `;
+  }
 }

test/projects.e2e-spec.ts

@@ -20,6 +20,7 @@ const project: ProjectDto = {
   maxBuildAllowed: 0,
   maxBranchLifetime: 0,
   imageComparisonConfig: '{}',
+  protectedBranch: null
 };
 
 const projectServiceMock = {

test/test-variations.e2e-spec.ts

@@ -67,4 +67,52 @@ describe('TestVariations (e2e)', () => {
       expect((await testRunsService.findOne(testRun.id)).testVariationId).toBeNull();
     });
   });
+
+  describe('find old test variations', () => {
+    it('filters out test runs matching releaseBranch and mainBranchName', async () => {
+      const baselineBranchName = 'release-1';
+      const image_v1 = './test/image.png';
+      const image_v2 = './test/image_edited.png';
+
+      // Add variation to main branch
+      const { testRun: mainBranchTestRun } = await haveTestRunCreated(
+        buildsService,
+        testRunsService,
+        project.id,
+        project.mainBranchName,
+        image_v1
+      );
+      await testRunsService.approve(mainBranchTestRun.id);
+
+      // Add variation to release branch
+      const { testRun: releaseBranchTestRun } = await haveTestRunCreated(
+        buildsService,
+        testRunsService,
+        project.id,
+        baselineBranchName,
+        image_v1,
+        false,
+        baselineBranchName
+      );
+      await testRunsService.approve(releaseBranchTestRun.id);
+
+      // Add variation to feature branch
+      const { testRun: featureBranchTestRun } = await haveTestRunCreated(
+        buildsService,
+        testRunsService,
+        project.id,
+        'feature',
+        image_v2,
+        false,
+        project.mainBranchName
+      );
+      const featureBranchTestRunApproved = await testRunsService.approve(featureBranchTestRun.id);
+
+      const result = await testVariationsService.findOldTestVariations(project, new Date());
+      expect(result).toHaveLength(1);
+      expect(result).toEqual(
+        expect.arrayContaining([expect.objectContaining({ id: featureBranchTestRunApproved.testVariationId })])
+      );
+    });
+  });
 });