@visual-regression-tracker/sdk-js 5.2.0 → 5.5.0

package/README.md

@@ -151,5 +151,9 @@ await vrt.track({
       height: 400;
     }
   ]
+
+  // Allow additional details
+  // Optional
+  comment: 'Ignoring region because of animation'
 });
 ```

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/dto.helper.js

@@ -24,6 +24,7 @@ const multipartDtoToFormData = (dto) => {
         data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
     dto.diffTollerancePercent &&
         data.append("diffTollerancePercent", dto.diffTollerancePercent);
+    dto.comment && data.append("comment", dto.comment);
     return data;
 };
 exports.multipartDtoToFormData = multipartDtoToFormData;
@@ -43,6 +44,7 @@ const bufferDtoToFormData = (dto) => {
         data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
     dto.diffTollerancePercent &&
         data.append("diffTollerancePercent", dto.diffTollerancePercent);
+    dto.comment && data.append("comment", dto.comment);
     return data;
 };
 exports.bufferDtoToFormData = bufferDtoToFormData;

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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -13,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, 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/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/types/request/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -12,4 +12,5 @@ export interface TestRunDto {
     diffTollerancePercent?: number;
     merge?: boolean;
     ignoreAreas?: IgnoreArea[];
+    comment?: string;
 }

package/dist/types/testRun.d.ts

@@ -9,6 +9,7 @@ interface TestRun {
     customTags?: string;
     diffTollerancePercent?: number;
     ignoreAreas?: IgnoreArea[];
+    comment?: string;
 }
 export interface TestRunBase64 extends TestRun {
     imageBase64: string;

package/dist/visualRegressionTracker.d.ts

@@ -13,6 +13,12 @@ export declare class VisualRegressionTracker {
     private submitTestRunMultipart;
     private handleResponse;
     private handleException;
-    track(test: TestRunBase64 | TestRunMultipart | TestRunBuffer): Promise<TestRunResult>;
-    private processTestRun;
+    /**
+     * 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 {
@@ -38,6 +37,7 @@ class VisualRegressionTracker {
         this.axiosConfig = {
             headers: {
                 apiKey: this.config.apiKey,
+                project: this.config.project,
             },
         };
     }
@@ -86,7 +86,7 @@ class VisualRegressionTracker {
         return __awaiter(this, void 0, void 0, function* () {
             return axios_1.default
                 .post(`${this.config.apiUrl}/test-runs/multipart`, data, {
-                headers: Object.assign(Object.assign({}, data.getHeaders()), { "Content-Length": data.getLengthSync(), apiKey: this.config.apiKey }),
+                headers: Object.assign(Object.assign(Object.assign({}, data.getHeaders()), { "Content-Length": data.getLengthSync() }), this.axiosConfig.headers),
             })
                 .then(this.handleResponse)
                 .catch(this.handleException);
@@ -115,14 +115,21 @@ class VisualRegressionTracker {
             }
         });
     }
-    track(test) {
+    /**
+     * 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;
@@ -132,33 +139,10 @@ class VisualRegressionTracker {
                 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(formData), 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.2.0",
+  "version": "5.5.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,16 +20,16 @@
   },
   "homepage": "https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker",
   "dependencies": {
-    "axios": "^0.21.0",
+    "axios": "^0.26.1",
     "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
-    "@types/node": "^15.14.9",
-    "jest": "^26.6.3",
-    "semantic-release": "^17.4.7",
-    "ts-jest": "^26.5.6",
-    "typescript": "^4.4.2"
+    "@types/jest": "^27.4.1",
+    "@types/node": "^17.0.23",
+    "jest": "^27.5.1",
+    "semantic-release": "^19.0.2",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3"
   },
   "publishConfig": {
     "access": "public"