@visual-regression-tracker/sdk-js 5.4.0 → 5.6.0

package/dist/__data__/index.d.ts

@@ -0,0 +1,5 @@
+import { TestRunResponse } from "../types";
+export declare const testRunUnresolvedResponse: TestRunResponse;
+export declare const testRunOkResponse: TestRunResponse;
+export declare const testRunNewResponse: TestRunResponse;
+export declare const testRunAutoApprovedResponse: TestRunResponse;

package/dist/__data__/index.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testRunAutoApprovedResponse = exports.testRunNewResponse = exports.testRunOkResponse = exports.testRunUnresolvedResponse = void 0;
+const types_1 = require("../types");
+exports.testRunUnresolvedResponse = {
+    url: "url",
+    status: types_1.TestStatus.unresolved,
+    pixelMisMatchCount: 12,
+    diffPercent: 0.12,
+    diffTollerancePercent: 0,
+    id: "some id",
+    imageName: "imageName",
+    merge: false,
+};
+exports.testRunOkResponse = {
+    url: "url",
+    status: types_1.TestStatus.ok,
+    diffPercent: 0,
+    diffTollerancePercent: 0,
+    id: "some id",
+    imageName: "imageName",
+    merge: false,
+};
+exports.testRunNewResponse = {
+    url: "url",
+    status: types_1.TestStatus.new,
+    pixelMisMatchCount: 0,
+    diffPercent: 0,
+    diffTollerancePercent: 0,
+    id: "some id",
+    imageName: "imageName",
+    merge: false,
+};
+exports.testRunAutoApprovedResponse = {
+    url: "url",
+    status: types_1.TestStatus.autoApproved,
+    pixelMisMatchCount: 0,
+    diffPercent: 0,
+    diffTollerancePercent: 0,
+    id: "some id",
+    imageName: "imageName",
+    merge: false,
+};

package/dist/helpers/config.helper.js

@@ -12,6 +12,9 @@ const readConfigFromFile = (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) => {
     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"];
     }

package/dist/helpers/dto.helper.js

@@ -11,6 +11,7 @@ const multipartDtoToFormData = (dto) => {
     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_1.default.createReadStream(dto.imagePath), {
         knownLength: fs_1.default.statSync(dto.imagePath).size,
@@ -33,6 +34,7 @@ const bufferDtoToFormData = (dto) => {
     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);

package/dist/helpers/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./config.helper";
 export * from "./type.helper";
 export * from "./dto.helper";
+export * from "./track.helper";

package/dist/helpers/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./config.helper"), exports);
 __exportStar(require("./type.helper"), exports);
 __exportStar(require("./dto.helper"), exports);
+__exportStar(require("./track.helper"), exports);

package/dist/helpers/track.helper.d.ts

@@ -0,0 +1,4 @@
+import { TestRunResponse } from "../types";
+export declare const processTestRun: (testRunResponse: TestRunResponse, enableSoftAssert?: boolean | undefined) => void;
+export declare const shouldStopRetry: (result: TestRunResponse) => boolean;
+export declare const trackWithRetry: (trackFn: () => Promise<TestRunResponse>, retryLimit?: number, enableSoftAssert?: boolean | undefined) => Promise<TestRunResponse>;

package/dist/helpers/track.helper.js

@@ -0,0 +1,49 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trackWithRetry = exports.shouldStopRetry = exports.processTestRun = void 0;
+const types_1 = require("../types");
+const getErrorMessage = (testRunResponse) => {
+    switch (testRunResponse.status) {
+        case types_1.TestStatus.new: {
+            return `No baseline: ${testRunResponse.url}`;
+        }
+        case types_1.TestStatus.unresolved: {
+            return `Difference found: ${testRunResponse.url}`;
+        }
+    }
+};
+const processTestRun = (testRunResponse, enableSoftAssert) => {
+    const errorMessage = getErrorMessage(testRunResponse);
+    if (errorMessage) {
+        if (enableSoftAssert) {
+            // eslint-disable-next-line no-console
+            console.error(errorMessage);
+        }
+        else {
+            throw new Error(errorMessage);
+        }
+    }
+};
+exports.processTestRun = processTestRun;
+const shouldStopRetry = (result) => result.status !== types_1.TestStatus.unresolved;
+exports.shouldStopRetry = shouldStopRetry;
+const trackWithRetry = (trackFn, retryLimit = 2, enableSoftAssert) => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield trackFn();
+    if (retryLimit <= 0 || (0, exports.shouldStopRetry)(result)) {
+        (0, exports.processTestRun)(result, enableSoftAssert);
+        return result;
+    }
+    // eslint-disable-next-line no-console
+    console.info(`Diff found... Remaining retry attempts **${retryLimit}**`);
+    return (0, exports.trackWithRetry)(trackFn, retryLimit - 1, enableSoftAssert);
+});
+exports.trackWithRetry = trackWithRetry;

package/dist/helpers/type.helper.d.ts

@@ -1,3 +1,4 @@
-import { TestRunBase64, TestRunBuffer } from "../types";
+import { TestRunBase64, TestRunBuffer, TestRunMultipart } from "../types";
 export declare function instanceOfTestRunBase64(object: any): object is TestRunBase64;
 export declare function instanceOfTestRunBuffer(object: any): object is TestRunBuffer;
+export declare function instanceOfTestRunMultipart(object: any): object is TestRunMultipart;

package/dist/helpers/type.helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfTestRunBuffer = exports.instanceOfTestRunBase64 = void 0;
+exports.instanceOfTestRunMultipart = exports.instanceOfTestRunBuffer = exports.instanceOfTestRunBase64 = void 0;
 function instanceOfTestRunBase64(object) {
     return "imageBase64" in object;
 }
@@ -9,3 +9,7 @@ function instanceOfTestRunBuffer(object) {
     return "imageBuffer" in object;
 }
 exports.instanceOfTestRunBuffer = instanceOfTestRunBuffer;
+function instanceOfTestRunMultipart(object) {
+    return "imagePath" in object;
+}
+exports.instanceOfTestRunMultipart = instanceOfTestRunMultipart;

package/dist/types/config.d.ts

@@ -1,6 +1,7 @@
 export interface Config extends Record<string, any> {
     apiUrl: string;
     branchName: string;
+    baselineBranchName?: string;
     project: string;
     apiKey: string;
     enableSoftAssert?: boolean;

package/dist/types/request/testRun.dto.d.ts

@@ -7,6 +7,7 @@ export interface TestRunDto {
     device?: string;
     customTags?: string;
     branchName: string;
+    baselineBranchName?: string;
     buildId: string;
     projectId: string;
     diffTollerancePercent?: number;

package/dist/visualRegressionTracker.d.ts

@@ -13,6 +13,13 @@ export declare class VisualRegressionTracker {
     private submitTestRunMultipart;
     private handleResponse;
     private handleException;
-    track(test: TestRunBase64 | TestRunMultipart | TestRunBuffer): Promise<TestRunResult>;
-    private processTestRun;
+    private getFormData;
+    /**
+     * Submit test data to external VRT service
+     *
+     * @param test Test data to track
+     * @param retryCount Retry count, default is 2
+     * @returns
+     */
+    track(test: TestRunBase64 | TestRunMultipart | TestRunBuffer, retryCount?: number): Promise<TestRunResult>;
 }

package/dist/visualRegressionTracker.js

@@ -14,7 +14,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VisualRegressionTracker = void 0;
 const axios_1 = __importDefault(require("axios"));
-const types_1 = require("./types");
 const testRunResult_1 = __importDefault(require("./testRunResult"));
 const helpers_1 = require("./helpers");
 class VisualRegressionTracker {
@@ -49,6 +48,7 @@ class VisualRegressionTracker {
         return __awaiter(this, void 0, void 0, function* () {
             const data = {
                 branchName: this.config.branchName,
+                baselineBranchName: this.config.baselineBranchName,
                 project: this.config.project,
                 ciBuildId: this.config.ciBuildId,
             };
@@ -76,7 +76,7 @@ class VisualRegressionTracker {
     }
     submitTestRunBase64(test) {
         return __awaiter(this, void 0, void 0, function* () {
-            const data = Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName }, test);
+            const data = Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName, baselineBranchName: this.config.baselineBranchName }, test);
             return axios_1.default
                 .post(`${this.config.apiUrl}/test-runs`, data, this.axiosConfig)
                 .then(this.handleResponse)
@@ -116,50 +116,36 @@ class VisualRegressionTracker {
             }
         });
     }
-    track(test) {
+    getFormData(test) {
+        if ((0, helpers_1.instanceOfTestRunBuffer)(test)) {
+            return (0, helpers_1.bufferDtoToFormData)(Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName, baselineBranchName: this.config.baselineBranchName }, test));
+        }
+        else if ((0, helpers_1.instanceOfTestRunMultipart)(test)) {
+            return (0, helpers_1.multipartDtoToFormData)(Object.assign({ 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
+     *
+     * @param test Test data to track
+     * @param retryCount Retry count, default is 2
+     * @returns
+     */
+    track(test, retryCount = 2) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.isStarted()) {
                 throw new Error("Visual Regression Tracker has not been started");
             }
             let testRunResponse;
             if ((0, helpers_1.instanceOfTestRunBase64)(test)) {
-                testRunResponse = yield this.submitTestRunBase64(test);
+                testRunResponse = yield (0, helpers_1.trackWithRetry)(() => this.submitTestRunBase64(test), retryCount, this.config.enableSoftAssert);
             }
             else {
-                let formData;
-                if ((0, helpers_1.instanceOfTestRunBuffer)(test)) {
-                    formData = (0, helpers_1.bufferDtoToFormData)(Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName }, test));
-                }
-                else {
-                    formData = (0, helpers_1.multipartDtoToFormData)(Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName }, test));
-                }
-                testRunResponse = yield this.submitTestRunMultipart(formData);
+                testRunResponse = yield (0, helpers_1.trackWithRetry)(() => this.submitTestRunMultipart(this.getFormData(test)), retryCount, this.config.enableSoftAssert);
             }
-            this.processTestRun(testRunResponse);
             return new testRunResult_1.default(testRunResponse, this.config.apiUrl);
         });
     }
-    processTestRun(testRunResponse) {
-        let errorMessage;
-        switch (testRunResponse.status) {
-            case types_1.TestStatus.new: {
-                errorMessage = `No baseline: ${testRunResponse.url}`;
-                break;
-            }
-            case types_1.TestStatus.unresolved: {
-                errorMessage = `Difference found: ${testRunResponse.url}`;
-                break;
-            }
-        }
-        if (errorMessage) {
-            if (this.config.enableSoftAssert) {
-                // eslint-disable-next-line no-console
-                console.error(errorMessage);
-            }
-            else {
-                throw new Error(errorMessage);
-            }
-        }
-    }
 }
 exports.VisualRegressionTracker = VisualRegressionTracker;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visual-regression-tracker/sdk-js",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",