build-updated-fix

pashidlos · pashidlos · commit 582600664b7d · 2021-01-31T11:05:22.000+02:00
Visual-Regression-Tracker/Visual-Regression-Tracker#192
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,11 +31,13 @@
     "@nestjs/swagger": "^4.5.12",
     "@nestjs/websockets": "^7.4.2",
     "@prisma/client": "2.12.1",
+    "@types/lodash.debounce": "^4.0.6",
     "bcryptjs": "^2.4.3",
     "cache-manager": "^3.4.0",
     "class-transformer": "^0.3.1",
     "class-validator": "^0.12.2",
     "fs-extra": "^9.0.1",
+    "lodash.debounce": "^4.0.8",
     "passport": "^0.4.1",
     "passport-jwt": "^4.0.0",
     "passport-local": "^1.0.0",
diff --git a/src/builds/builds.service.spec.ts b/src/builds/builds.service.spec.ts
@@ -304,14 +304,13 @@ describe('BuildsService', () => {
   });
 
   it('approve', async () => {
-    const eventsBuildUpdatedMock = jest.fn();
     const buildFindUniqueMock = jest.fn().mockResolvedValueOnce(build);
     const testRunApproveMock = jest.fn().mockResolvedValueOnce({
       ...build.testRuns[0],
       status: TestStatus.approved,
     });
     mocked(BuildDto).mockReturnValueOnce(buildDto);
-    service = await initService({ eventsBuildUpdatedMock, buildFindUniqueMock, testRunApproveMock });
+    service = await initService({ buildFindUniqueMock, testRunApproveMock });
 
     await service.approve('someId', true);
 
@@ -337,6 +336,16 @@ describe('BuildsService', () => {
         },
       ],
     });
+  });
+
+  it('emitUpdateBuildEvent', async () => {
+    const eventsBuildUpdatedMock = jest.fn();
+    service = await initService({ eventsBuildUpdatedMock });
+    service.findOne = jest.fn().mockResolvedValueOnce(buildDto);
+
+    await service.emitUpdateBuildEvent('someId');
+
+    expect(service.findOne).toHaveBeenCalledWith('someId');
     expect(eventsBuildUpdatedMock).toHaveBeenCalledWith(buildDto);
   });
 });
diff --git a/src/builds/builds.service.ts b/src/builds/builds.service.ts
@@ -148,7 +148,11 @@ export class BuildsService {
     );
 
     const buildDto = new BuildDto(build);
-    this.eventsGateway.buildUpdated(buildDto);
     return buildDto;
   }
+
+  async emitUpdateBuildEvent(buildId: string) {
+    const build = await this.findOne(buildId);
+    this.eventsGateway.buildUpdated(build);
+  }
 }
diff --git a/src/shared/events/events.gateway.ts b/src/shared/events/events.gateway.ts
@@ -2,12 +2,15 @@ import { WebSocketGateway, WebSocketServer } from '@nestjs/websockets';
 import { Server } from 'socket.io';
 import { TestRun } from '@prisma/client';
 import { BuildDto } from '../../builds/dto/build.dto';
+import debounce from 'lodash.debounce';
 
 @WebSocketGateway()
 export class EventsGateway {
   @WebSocketServer()
   server: Server;
 
+  private testRuns: TestRun[] = [];
+
   buildCreated(build: BuildDto): void {
     this.server.emit('build_created', build);
   }
@@ -21,7 +24,18 @@ export class EventsGateway {
   }
 
   testRunCreated(testRun: TestRun): void {
-    this.server.emit('testRun_created', testRun);
+    this.testRuns.push(testRun);
+    debounce(
+      () =>
+        this.emitEvent('testRun_created', this.testRuns, () => {
+          this.testRuns = [];
+        }),
+      3000,
+      {
+        maxWait: 5000,
+      }
+    )();
+    // this.server.emit('testRun_created', testRun);
   }
 
   testRunUpdated(testRun: TestRun): void {
@@ -31,4 +45,10 @@ export class EventsGateway {
   testRunDeleted(testRun: TestRun): void {
     this.server.emit('testRun_deleted', testRun);
   }
+
+  private emitEvent(event: string, object: object, callbackfn: () => void) {
+    console.log(object)
+    this.server.emit(event, object);
+    callbackfn();
+  }
 }
diff --git a/src/test-runs/test-runs.module.ts b/src/test-runs/test-runs.module.ts
@@ -4,9 +4,10 @@ import { SharedModule } from '../shared/shared.module';
 import { PrismaService } from '../prisma/prisma.service';
 import { TestRunsController } from './test-runs.controller';
 import { TestVariationsModule } from '../test-variations/test-variations.module';
+import { BuildsModule } from '../builds/builds.module';
 
 @Module({
-  imports: [SharedModule, forwardRef(() => TestVariationsModule)],
+  imports: [SharedModule, forwardRef(() => TestVariationsModule), forwardRef(() => BuildsModule)],
   providers: [TestRunsService, PrismaService],
   controllers: [TestRunsController],
   exports: [TestRunsService],
diff --git a/src/test-runs/test-runs.service.spec.ts b/src/test-runs/test-runs.service.spec.ts
@@ -15,6 +15,7 @@ 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';
+import { BuildsService } from '../builds/builds.service';
 
 jest.mock('pixelmatch');
 jest.mock('./dto/testRunResult.dto');
@@ -32,13 +33,13 @@ const initService = async ({
   eventTestRunUpdatedMock = jest.fn(),
   eventTestRunCreatedMock = jest.fn(),
   eventTestRunDeletedMock = jest.fn(),
-  eventBuildUpdatedMock = jest.fn(),
   eventBuildCreatedMock = jest.fn(),
   testVariationCreateMock = jest.fn(),
   testVariationFindManyMock = jest.fn(),
   baselineCreateMock = jest.fn(),
   testVariationFindOrCreateMock = jest.fn(),
   projectFindOneMock = jest.fn(),
+  buildEmitUpdateBuildEventMock = jest.fn(),
 }) => {
   const module: TestingModule = await Test.createTestingModule({
     providers: [
@@ -80,7 +81,6 @@ const initService = async ({
           testRunUpdated: eventTestRunUpdatedMock,
           testRunCreated: eventTestRunCreatedMock,
           testRunDeleted: eventTestRunDeletedMock,
-          buildUpdated: eventBuildUpdatedMock,
           buildCreated: eventBuildCreatedMock,
         },
       },
@@ -90,6 +90,12 @@ const initService = async ({
           findOrCreate: testVariationFindOrCreateMock,
         },
       },
+      {
+        provide: BuildsService,
+        useValue: {
+          emitUpdateBuildEvent: buildEmitUpdateBuildEventMock,
+        },
+      },
     ],
   }).compile();
 
@@ -130,9 +136,11 @@ describe('TestRunsService', () => {
     };
     const testRunUpdateMock = jest.fn().mockResolvedValueOnce(testRun);
     const eventTestRunUpdatedMock = jest.fn();
+    const buildEmitUpdateBuildEventMock = jest.fn();
     service = await initService({
       testRunUpdateMock,
       eventTestRunUpdatedMock,
+      buildEmitUpdateBuildEventMock,
     });
 
     await service.reject(testRun.id);
@@ -144,6 +152,7 @@ describe('TestRunsService', () => {
       },
     });
     expect(eventTestRunUpdatedMock).toBeCalledWith(testRun);
+    expect(buildEmitUpdateBuildEventMock).toBeCalledWith(testRun.buildId);
   });
 
   describe('approve', () => {
@@ -178,6 +187,7 @@ describe('TestRunsService', () => {
         status: TestStatus.approved,
       });
       const eventTestRunUpdatedMock = jest.fn();
+      const buildEmitUpdateBuildEventMock = jest.fn();
       const testRunFindOneMock = jest.fn().mockResolvedValueOnce(testRun);
       const baselineName = 'some baseline name';
       const saveImageMock = jest.fn().mockReturnValueOnce(baselineName);
@@ -192,6 +202,7 @@ describe('TestRunsService', () => {
         saveImageMock,
         getImageMock,
         eventTestRunUpdatedMock,
+        buildEmitUpdateBuildEventMock,
       });
       service.findOne = testRunFindOneMock;
 
@@ -225,6 +236,7 @@ describe('TestRunsService', () => {
         ...testRun,
         status: TestStatus.approved,
       });
+      expect(buildEmitUpdateBuildEventMock).toHaveBeenCalledWith(testRun.buildId);
     });
 
     it('should approve merge', async () => {
@@ -258,6 +270,7 @@ describe('TestRunsService', () => {
         status: TestStatus.approved,
       });
       const eventTestRunUpdatedMock = jest.fn();
+      const buildEmitUpdateBuildEventMock = jest.fn();
       const testRunFindOneMock = jest.fn().mockResolvedValueOnce(testRun);
       const baselineName = 'some baseline name';
       const saveImageMock = jest.fn().mockReturnValueOnce(baselineName);
@@ -272,6 +285,7 @@ describe('TestRunsService', () => {
         saveImageMock,
         getImageMock,
         eventTestRunUpdatedMock,
+        buildEmitUpdateBuildEventMock,
       });
       service.findOne = testRunFindOneMock;
 
@@ -305,6 +319,7 @@ describe('TestRunsService', () => {
         ...testRun,
         status: TestStatus.approved,
       });
+      expect(buildEmitUpdateBuildEventMock).toBeCalledWith(testRun.buildId);
     });
 
     it('should approve different branch', async () => {
@@ -370,6 +385,7 @@ describe('TestRunsService', () => {
         status: TestStatus.approved,
       });
       const eventTestRunUpdatedMock = jest.fn();
+      const buildEmitUpdateBuildEventMock = jest.fn();
       const testRunFindOneMock = jest.fn().mockResolvedValueOnce(testRun);
       const baselineName = 'some baseline name';
       const saveImageMock = jest.fn().mockReturnValueOnce(baselineName);
@@ -388,6 +404,7 @@ describe('TestRunsService', () => {
         testVariationCreateMock,
         baselineCreateMock,
         eventTestRunUpdatedMock,
+        buildEmitUpdateBuildEventMock,
       });
       service.findOne = testRunFindOneMock;
 
@@ -436,6 +453,7 @@ describe('TestRunsService', () => {
         ...testRun,
         status: TestStatus.approved,
       });
+      expect(buildEmitUpdateBuildEventMock).toBeCalledWith(testRun.buildId);
     });
   });
 
@@ -463,6 +481,7 @@ describe('TestRunsService', () => {
     };
     const testRunWithResult = {
       id: 'id',
+      buildId: 'buildId',
       imageName: 'imageName',
       baselineName: 'baselineName',
       diffTollerancePercent: 1,
@@ -502,7 +521,14 @@ describe('TestRunsService', () => {
     const baseline = 'baseline';
     const getImageMock = jest.fn().mockReturnValueOnce(baseline).mockReturnValueOnce(image);
     const eventTestRunCreatedMock = jest.fn();
-    service = await initService({ testRunCreateMock, saveImageMock, getImageMock, eventTestRunCreatedMock });
+    const buildEmitUpdateBuildEventMock = jest.fn();
+    service = await initService({
+      testRunCreateMock,
+      saveImageMock,
+      getImageMock,
+      eventTestRunCreatedMock,
+      buildEmitUpdateBuildEventMock,
+    });
     const diffResult: DiffResult = {
       status: TestStatus.unresolved,
       diffName: 'diff image name',
@@ -581,6 +607,7 @@ describe('TestRunsService', () => {
       },
     ]);
     expect(eventTestRunCreatedMock).toHaveBeenCalledWith(testRunWithResult);
+    expect(buildEmitUpdateBuildEventMock).toHaveBeenCalledWith(testRunWithResult.buildId);
     expect(result).toBe(testRunWithResult);
   });
 
@@ -718,6 +745,7 @@ describe('TestRunsService', () => {
     const testRunFindOneMock = jest.fn().mockResolvedValueOnce(testRun);
     const testRunUpdateMock = jest.fn();
     const eventTestRunUpdatedMock = jest.fn();
+    const buildEmitUpdateBuildEventMock = jest.fn();
     const baselineMock = 'baseline image';
     const imageeMock = 'image';
     const getImageMock = jest.fn().mockReturnValueOnce(baselineMock).mockReturnValueOnce(imageeMock);
@@ -731,6 +759,7 @@ describe('TestRunsService', () => {
       eventTestRunUpdatedMock,
       getImageMock,
       deleteImageMock,
+      buildEmitUpdateBuildEventMock,
     });
     service.findOne = testRunFindOneMock;
     service.getDiff = getDiffMock;
@@ -748,6 +777,7 @@ describe('TestRunsService', () => {
       JSON.parse(testRun.ignoreAreas)
     );
     expect(eventTestRunUpdatedMock).toBeCalledWith(testRun);
+    expect(buildEmitUpdateBuildEventMock).toBeCalledWith(testRun.buildId);
   });
 
   describe('saveDiffResult', () => {
@@ -854,17 +884,20 @@ describe('TestRunsService', () => {
   it('delete', async () => {
     const id = 'some id';
     const testRun = {
+      buildId: 'buildId',
       diffName: 'diffName',
       imageName: 'imageName',
     };
     const findOneMock = jest.fn().mockResolvedValueOnce(testRun);
     const deleteImageMock = jest.fn();
     const testRunDeleteMock = jest.fn();
     const eventTestRunDeletedMock = jest.fn();
+    const buildEmitUpdateBuildEventMock = jest.fn();
     service = await initService({
       deleteImageMock,
       testRunDeleteMock,
       eventTestRunDeletedMock,
+      buildEmitUpdateBuildEventMock,
     });
     service.findOne = findOneMock;
 
@@ -877,6 +910,7 @@ describe('TestRunsService', () => {
       where: { id },
     });
     expect(eventTestRunDeletedMock).toHaveBeenCalledWith(testRun);
+    expect(buildEmitUpdateBuildEventMock).toHaveBeenCalledWith(testRun.buildId);
   });
 
   it('updateIgnoreAreas', async () => {
diff --git a/src/test-runs/test-runs.service.ts b/src/test-runs/test-runs.service.ts

Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,11 @@ export class BuildsService {`
`148`	`148`	`);`
`149`	`149`
`150`	`150`	`const buildDto = new BuildDto(build);`
`151`		`- this.eventsGateway.buildUpdated(buildDto);`
`152`	`151`	`return buildDto;`
`153`	`152`	`}`
	`153`	`+`
	`154`	`+ async emitUpdateBuildEvent(buildId: string) {`
	`155`	`+ const build = await this.findOne(buildId);`
	`156`	`+ this.eventsGateway.buildUpdated(build);`
	`157`	`+ }`
`154`	`158`	`}`