feat: baselineBranchName param added

wsbaser · web-flow · commit 40faea056018 · 2023-01-23T17:46:36.000+02:00
diff --git a/lib/helpers/config.helper.spec.ts b/lib/helpers/config.helper.spec.ts
@@ -28,6 +28,7 @@ describe("config.helper", () => {
     const updatedConfig: Config = {
       apiUrl: "apiUrlUpdated",
       branchName: "branchNameUpdated",
+      baselineBranchName: "baselineBranchNameUpdated",
       project: "projectUpdated",
       apiKey: "apiKeyUpdated",
       enableSoftAssert: false,
@@ -79,6 +80,7 @@ describe("config.helper", () => {
         VRT_APIURL: "apiUrlTest",
         VRT_CIBUILDID: "ciBuildIdTest",
         VRT_BRANCHNAME: "branchNameTest",
+        VRT_BASELINEBRANCHNAME: "baselineBranchNameTest",
         VRT_PROJECT: "projectTest",
         VRT_APIKEY: "apiKeyTest",
         VRT_ENABLESOFTASSERT: "false",
@@ -90,6 +92,7 @@ describe("config.helper", () => {
         apiUrl: "apiUrlTest",
         ciBuildId: "ciBuildIdTest",
         branchName: "branchNameTest",
+        baselineBranchName: "baselineBranchNameTest",
         project: "projectTest",
         apiKey: "apiKeyTest",
         enableSoftAssert: false,
@@ -101,6 +104,7 @@ describe("config.helper", () => {
         VRT_APIURL: undefined,
         VRT_CIBUILDID: undefined,
         VRT_BRANCHNAME: undefined,
+        VRT_BASELINEBRANCHNAME: undefined,
         VRT_PROJECT: undefined,
         VRT_APIKEY: undefined,
         VRT_ENABLESOFTASSERT: undefined,
diff --git a/lib/helpers/config.helper.ts b/lib/helpers/config.helper.ts
@@ -12,6 +12,9 @@ const readConfigFromFile = (config: Config): Config => {
     if (fileConfig.branchName) {
       config.branchName = fileConfig.branchName;
     }
+    if (fileConfig.baselineBranchName) {
+      config.baselineBranchName = fileConfig.baselineBranchName;
+    }
     if (fileConfig.project) {
       config.project = fileConfig.project;
     }
@@ -35,6 +38,9 @@ const readConfigFromEnv = (config: Config): Config => {
   if (process.env["VRT_BRANCHNAME"]) {
     config.branchName = process.env["VRT_BRANCHNAME"];
   }
+  if (process.env["VRT_BASELINEBRANCHNAME"]) {
+    config.baselineBranchName = process.env["VRT_BASELINEBRANCHNAME"];
+  }
   if (process.env["VRT_PROJECT"]) {
     config.project = process.env["VRT_PROJECT"];
   }
diff --git a/lib/helpers/dto.helper.ts b/lib/helpers/dto.helper.ts
@@ -7,6 +7,7 @@ export const multipartDtoToFormData = (dto: TestRunMultipartDto): FormData => {
   data.append("buildId", dto.buildId);
   data.append("projectId", dto.projectId);
   data.append("branchName", dto.branchName);
+  dto.baselineBranchName && data.append("baselineBranchName", dto.baselineBranchName);
   data.append("name", dto.name);
   data.append("image", fs.createReadStream(dto.imagePath), {
     knownLength: fs.statSync(dto.imagePath).size,
@@ -30,6 +31,7 @@ export const bufferDtoToFormData = (dto: TestRunBufferDto): FormData => {
   data.append("buildId", dto.buildId);
   data.append("projectId", dto.projectId);
   data.append("branchName", dto.branchName);
+  dto.baselineBranchName && data.append("baselineBranchName", dto.baselineBranchName);
   data.append("name", dto.name);
   data.append("image", dto.imageBuffer, { filename: "image.png" });
   dto.os && data.append("os", dto.os);
diff --git a/lib/helpers/track.helper.spec.ts b/lib/helpers/track.helper.spec.ts
@@ -1,5 +1,9 @@
 import { TestRunResponse, TestStatus } from "../types";
-import { processTestRun, shouldStopRetry } from "./track.helper";
+import {
+  processTestRun,
+  shouldStopRetry,
+  trackWithRetry,
+} from "./track.helper";
 import {
   testRunOkResponse,
   testRunUnresolvedResponse,
@@ -43,6 +47,57 @@ describe.each<[TestStatus.new | TestStatus.unresolved, string]>([
   });
 });
 
+const unresolvedResponce: TestRunResponse = {
+  id: "someId",
+  imageName: "imageName",
+  diffName: "diffName",
+  baselineName: "baselineName",
+  diffPercent: 1.11,
+  diffTollerancePercent: 2.22,
+  pixelMisMatchCount: 3,
+  status: TestStatus.unresolved,
+  url: "url",
+  merge: true,
+};
+
+const okResponce: TestRunResponse = {
+  ...unresolvedResponce,
+  status: TestStatus.ok,
+};
+
+it("should stop when diff not found", async () => {
+  // .Arrange
+  const trackMock = jest.fn().mockReturnValue(okResponce);
+
+  // .Act
+  await trackWithRetry(trackMock, 5);
+
+  // .Assert
+  expect(trackMock).toBeCalledTimes(1);
+});
+
+it("should stop on default retry limit", async () => {
+  // .Arrange
+  const trackMock = jest.fn().mockReturnValue(unresolvedResponce);
+
+  // .Act
+  await trackWithRetry(trackMock, undefined as unknown as number, true);
+
+  // .Assert
+  expect(trackMock).toBeCalledTimes(3);
+});
+
+it("should stop on custom retry limit", async () => {
+  // .Arrange
+  const trackMock = jest.fn().mockReturnValue(unresolvedResponce);
+
+  // .Act
+  await trackWithRetry(trackMock, 5, true);
+
+  // .Assert
+  expect(trackMock).toBeCalledTimes(6);
+});
+
 it.each<[TestRunResponse, boolean]>([
   [testRunOkResponse, true],
   [testRunUnresolvedResponse, false],
diff --git a/lib/helpers/track.helper.ts b/lib/helpers/track.helper.ts
@@ -34,7 +34,7 @@ export const shouldStopRetry = (result: TestRunResponse) =>
 
 export const trackWithRetry = async (
   trackFn: () => Promise<TestRunResponse>,
-  retryLimit: number,
+  retryLimit: number = 2,
   enableSoftAssert?: boolean
 ): Promise<TestRunResponse> => {
   const result = await trackFn();
diff --git a/lib/helpers/type.helper.ts b/lib/helpers/type.helper.ts
@@ -1,9 +1,13 @@
-import { TestRunBase64, TestRunBuffer } from "../types";
+import { TestRunBase64, TestRunBuffer, TestRunMultipart } from "../types";
 
 export function instanceOfTestRunBase64(object: any): object is TestRunBase64 {
   return "imageBase64" in object;
 }
 
 export function instanceOfTestRunBuffer(object: any): object is TestRunBuffer {
   return "imageBuffer" in object;
+}
+
+export function instanceOfTestRunMultipart(object: any): object is TestRunMultipart {
+  return "imagePath" in object;
 }
diff --git a/lib/types/config.ts b/lib/types/config.ts
@@ -1,6 +1,7 @@
 export interface Config extends Record<string, any> {
   apiUrl: string;
   branchName: string;
+  baselineBranchName?: string;
   project: string;
   apiKey: string;
   enableSoftAssert?: boolean;
diff --git a/lib/types/request/testRun.dto.ts b/lib/types/request/testRun.dto.ts
@@ -15,6 +15,8 @@ export interface TestRunDto {
 
   branchName: string;
 
+  baselineBranchName?: string
+
   buildId: string;
 
   projectId: string;
diff --git a/lib/visualRegressionTracker.spec.ts b/lib/visualRegressionTracker.spec.ts
@@ -102,6 +102,7 @@ const axiosErrorEmptyResponse: AxiosError = {
 const config: Config = {
   apiUrl: "http://localhost:4200",
   branchName: "develop",
+  baselineBranchName: "next-release",
   project: "Default project",
   apiKey: "CPKVK4JNK24NVNPNGVFQ853HXXEG",
   enableSoftAssert: false,
@@ -176,6 +177,7 @@ describe("VisualRegressionTracker", () => {
     const fileConfig: Config = {
       apiUrl: "apiUrlFile",
       branchName: "branchNameFile",
+      baselineBranchName: "baselineBranchNameFile",
       project: "projectFile",
       apiKey: "apiKeyFile",
       enableSoftAssert: false,
@@ -184,6 +186,7 @@ describe("VisualRegressionTracker", () => {
     const envConfig: Config = {
       apiUrl: "apiUrlEnv",
       branchName: "branchNameEnv",
+      baselineBranchName: "baselineBranchNameEnv",
       project: "projectEnv",
       apiKey: "apiKeyEnv",
       enableSoftAssert: false,
@@ -282,6 +285,7 @@ describe("VisualRegressionTracker", () => {
         buildId,
         projectId,
         branchName: config.branchName,
+        baselineBranchName: config.baselineBranchName,
         ...testRunMultipart,
       });
       expect(vrt["submitTestRunMultipart"]).toHaveBeenCalledTimes(1);
@@ -310,6 +314,7 @@ describe("VisualRegressionTracker", () => {
         buildId,
         projectId,
         branchName: config.branchName,
+        baselineBranchName: config.baselineBranchName,
         ...testRunMultipart,
       });
       expect(vrt["submitTestRunMultipart"]).toHaveBeenCalledTimes(4);
@@ -333,6 +338,7 @@ describe("VisualRegressionTracker", () => {
         buildId,
         projectId,
         branchName: config.branchName,
+        baselineBranchName: config.baselineBranchName,
         ...testRunBuffer,
       });
       expect(vrt["submitTestRunMultipart"]).toHaveBeenCalledWith(data);
@@ -359,6 +365,7 @@ describe("VisualRegressionTracker", () => {
         `${config.apiUrl}/builds`,
         {
           branchName: config.branchName,
+          baselineBranchName: config.baselineBranchName,
           project: config.project,
           ciBuildId: config.ciBuildId,
         },
@@ -460,6 +467,7 @@ describe("VisualRegressionTracker", () => {
           buildId: buildId,
           projectId: projectId,
           branchName: config.branchName,
+          baselineBranchName: config.baselineBranchName,
           name: testRunBase64.name,
           imageBase64: testRunBase64.imageBase64,
           os: testRunBase64.os,
diff --git a/lib/visualRegressionTracker.ts b/lib/visualRegressionTracker.ts
@@ -20,6 +20,7 @@ import {
   instanceOfTestRunBuffer,
   bufferDtoToFormData,
   trackWithRetry,
+  instanceOfTestRunMultipart,
 } from "./helpers";
 
 export class VisualRegressionTracker {
@@ -56,6 +57,7 @@ export class VisualRegressionTracker {
   async start(): Promise<BuildResponse> {
     const data = {
       branchName: this.config.branchName,
+      baselineBranchName: this.config.baselineBranchName,
       project: this.config.project,
       ciBuildId: this.config.ciBuildId,
     };
@@ -93,6 +95,7 @@ export class VisualRegressionTracker {
       buildId: this.buildId,
       projectId: this.projectId,
       branchName: this.config.branchName,
+      baselineBranchName: this.config.baselineBranchName,
       ...test,
     };
 
@@ -138,6 +141,29 @@ export class VisualRegressionTracker {
     }
   }
 
+  private getFormData(
+    test: TestRunBase64 | TestRunMultipart | TestRunBuffer
+  ): FormData {
+    if (instanceOfTestRunBuffer(test)) {
+      return bufferDtoToFormData({
+        buildId: this.buildId,
+        projectId: this.projectId,
+        branchName: this.config.branchName,
+        baselineBranchName: this.config.baselineBranchName,
+        ...test,
+      });
+    } else if (instanceOfTestRunMultipart(test)) {
+      return multipartDtoToFormData({
+        buildId: this.buildId,
+        projectId: this.projectId,
+        branchName: this.config.branchName,
+        baselineBranchName: this.config.baselineBranchName,
+        ...test,
+      });
+    }
+    throw new Error("Invalid test run data");
+  }
+
   /**
    * Submit test data to external VRT service
    *
@@ -161,25 +187,8 @@ export class VisualRegressionTracker {
         this.config.enableSoftAssert
       );
     } else {
-      let formData: FormData;
-      if (instanceOfTestRunBuffer(test)) {
-        formData = bufferDtoToFormData({
-          buildId: this.buildId,
-          projectId: this.projectId,
-          branchName: this.config.branchName,
-          ...test,
-        });
-      } else {
-        formData = multipartDtoToFormData({
-          buildId: this.buildId,
-          projectId: this.projectId,
-          branchName: this.config.branchName,
-          ...test,
-        });
-      }
-
       testRunResponse = await trackWithRetry(
-        () => this.submitTestRunMultipart(formData),
+        () => this.submitTestRunMultipart(this.getFormData(test)),
         retryCount,
         this.config.enableSoftAssert
       );
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@visual-regression-tracker/sdk-js",
-  "version": "5.0.0",
+  "version": "5.5.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@ const readConfigFromFile = (config: Config): Config => {`
`12`	`12`	`if (fileConfig.branchName) {`
`13`	`13`	`config.branchName = fileConfig.branchName;`
`14`	`14`	`}`
	`15`	`+ if (fileConfig.baselineBranchName) {`
	`16`	`+ config.baselineBranchName = fileConfig.baselineBranchName;`
	`17`	`+ }`
`15`	`18`	`if (fileConfig.project) {`
`16`	`19`	`config.project = fileConfig.project;`
`17`	`20`	`}`
`@@ -35,6 +38,9 @@ const readConfigFromEnv = (config: Config): Config => {`
`35`	`38`	`if (process.env["VRT_BRANCHNAME"]) {`
`36`	`39`	`config.branchName = process.env["VRT_BRANCHNAME"];`
`37`	`40`	`}`
	`41`	`+ if (process.env["VRT_BASELINEBRANCHNAME"]) {`
	`42`	`+ config.baselineBranchName = process.env["VRT_BASELINEBRANCHNAME"];`
	`43`	`+ }`
`38`	`44`	`if (process.env["VRT_PROJECT"]) {`
`39`	`45`	`config.project = process.env["VRT_PROJECT"];`
`40`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,13 @@`
`1`		`-import { TestRunBase64, TestRunBuffer } from "../types";`
	`1`	`+import { TestRunBase64, TestRunBuffer, TestRunMultipart } from "../types";`
`2`	`2`
`3`	`3`	`export function instanceOfTestRunBase64(object: any): object is TestRunBase64 {`
`4`	`4`	`return "imageBase64" in object;`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`export function instanceOfTestRunBuffer(object: any): object is TestRunBuffer {`
`8`	`8`	`return "imageBuffer" in object;`
	`9`	`+}`
	`10`	`+`
	`11`	`+export function instanceOfTestRunMultipart(object: any): object is TestRunMultipart {`
	`12`	`+ return "imagePath" in object;`
`9`	`13`	`}`