@visual-regression-tracker/agent-cypress 5.4.0 → 5.6.0

package/.github/workflows/ci.yml

@@ -19,6 +19,3 @@ jobs:
 
       - name: Build
         run: npm run build
-
-      - name: Unit tests
-        run: npm run test

package/.github/workflows/release.yml

@@ -22,9 +22,6 @@ jobs:
       - name: Build
         run: npm run build
 
-      - name: Unit tests
-        run: npm run test
-
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/README.md

@@ -70,6 +70,10 @@ module.exports = (on, config) => {
       // Required
       "branchName": "develop",
 
+      // Branch with baseline
+      // Optional - when not set, main branch from project settings is used
+      "baselineBranchName": "release",
+
       // Log errors instead of throwing exceptions
       // Optional - default false
       "enableSoftAssert": true,
@@ -108,6 +112,7 @@ VRT_PROJECT="Default project"
 VRT_APIKEY="tXZVHX0EA4YQM1MGDD"
 VRT_CIBUILDID="commit_sha"
 VRT_BRANCHNAME="develop"
+VRT_BASELINEBRANCHNAME="release"
 VRT_ENABLESOFTASSERT=true
 ```
 
@@ -121,29 +126,44 @@ cy.vrtStart();
 
 ### Assert
 
-All `options` from `screenshot` command are also supported [more details](https://docs.cypress.io/api/commands/screenshot.html#Arguments)
-
 ```js
 cy.vrtTrack("Whole page with default params");
 
 cy.get("#navbar").vrtTrack("Separate element with default params");
 
-cy.vrtTrack("Whole page with additional options", {
-  viewport: "1920x1080",
-  os: "MacOS",
-  device: "Cloud agent",
-  customTags: "Cloud, DarkTheme, Auth",
-  diffTollerancePercent: 1,
-  ignoreAreas: [{ x: 1, y: 2, width: 100, height: 200 }],
-  retryLimit: 2,
-  keepScreenshot: false, // Keep screenshot local copy, false by default
-});
+cy.vrtTrack(
+  "Whole page with additional options",
+  {
+    viewport: "1920x1080",
+    os: "MacOS",
+    device: "Cloud agent",
+    customTags: "Cloud, DarkTheme, Auth",
+    diffTollerancePercent: 1,
+    ignoreAreas: [{ x: 1, y: 2, width: 100, height: 200 }],
+    retryLimit: 2,
+    keepScreenshot: false, // Keep screenshot local copy, false by default
+  },
+  (err) => {
+    console.log("Screenshot has diff with baseline", err);
+    return true; // Skip failing test
+  }
+);
 ```
 
+##### options (optional)
+
+Allows to set options for taking screenshot. All `options` from `screenshot` command are also supported [more details](https://docs.cypress.io/api/commands/screenshot.html#Arguments)
+
 Viewport is taken from `Cypress.config()`, if option is not set
 
 Browser is taken from `Cypress.browser.name`
 
+##### errorCallbak (optional)
+
+Allows you to define a callback that receives the error for custom side-effects.
+
+Also allows to override assertion policy. When callback returns `true` this acts similar to `enableSoftAssertions` option in config, but allows to enable soft assertion only for one specific screenshot.
+
 ### Teadown
 
 ```js

package/dist/commands.js

@@ -26,8 +26,10 @@ exports.addVrtStopCommand = addVrtStopCommand;
 var addVrtTrackCommand = function () {
     return Cypress.Commands.add("vrtTrack", {
         prevSubject: ["optional", "element", "window", "document"],
-    }, function (subject, name, options) {
-        (0, utils_1.trackWithRetry)(function () { return (0, utils_1.trackImage)(subject, name, options); }, function (result) { return (0, utils_1.shouldStopRetry)(result); }, function (result) { return (0, utils_1.checkResult)(result); }, options === null || options === void 0 ? void 0 : options.retryLimit);
+    }, function (subject, name, options, errorCallback) {
+        (0, utils_1.trackImage)(subject, name, options).then(function (result) {
+            return (0, utils_1.checkResult)(result, errorCallback);
+        });
     });
 };
 exports.addVrtTrackCommand = addVrtTrackCommand;

package/dist/index.d.ts

@@ -23,7 +23,7 @@ declare namespace Cypress {
          */
         vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions & {
             keepScreenshot?: boolean;
-        }>): Chainable<null>;
+        }>, errorCallback?: (err: string) => boolean): Chainable<null>;
         vrtTrackBuffer(name: string, imageBuffer: Buffer, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions>): Chainable<null>;
         vrtTrackBase64(name: string, imageBase64: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions>): Chainable<null>;
         vrtStart(): null;

package/dist/plugin.js

@@ -1,15 +1,4 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 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) {
@@ -97,56 +86,25 @@ function addVisualRegressionTrackerPlugin(on, config) {
                 }
             });
         }); },
-        _a["VRT_TRACK_IMAGE_MULTIPART"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
-            var data, result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+        _a["VRT_TRACK"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
+            var err_3;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        data = (0, sdk_js_1.multipartDtoToFormData)(__assign(__assign({}, props), { buildId: vrt.buildId, projectId: vrt.projectId, branchName: vrt.config.branchName }));
-                        return [4 /*yield*/, vrt["submitTestRunMultipart"](data)];
-                    case 1:
-                        result = _a.sent();
-                        if (!props.keepScreenshot) {
+                        _b.trys.push([0, 2, 3, 4]);
+                        return [4 /*yield*/, vrt.track(props, props === null || props === void 0 ? void 0 : props.retryLimit)];
+                    case 1: return [2 /*return*/, _b.sent()];
+                    case 2:
+                        err_3 = _b.sent();
+                        return [2 /*return*/, (_a = err_3.message) !== null && _a !== void 0 ? _a : err_3];
+                    case 3:
+                        if (!props.keepScreenshot && props.imagePath) {
                             (0, fs_1.unlinkSync)(props.imagePath);
                         }
-                        return [2 /*return*/, result];
-                }
-            });
-        }); },
-        _a["VRT_TRACK_BUFFER_MULTIPART"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
-            var data, result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        data = (0, sdk_js_1.bufferDtoToFormData)(__assign(__assign({}, props), { buildId: vrt.buildId, projectId: vrt.projectId, branchName: vrt.config.branchName }));
-                        return [4 /*yield*/, vrt["submitTestRunMultipart"](data)];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, result];
-                }
-            });
-        }); },
-        _a["VRT_TRACK_IMAGE_BASE64"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, vrt["submitTestRunBase64"](props)];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, result];
-                }
-            });
-        }); },
-        _a["VRT_PROCESS_ERROR_RESULT"] = function (testRunResult) { return __awaiter(_this, void 0, void 0, function () {
-            var _a;
-            return __generator(this, function (_b) {
-                try {
-                    vrt["processTestRun"](testRunResult);
-                }
-                catch (err) {
-                    return [2 /*return*/, (_a = err.message) !== null && _a !== void 0 ? _a : err];
+                        return [7 /*endfinally*/];
+                    case 4: return [2 /*return*/];
                 }
-                return [2 /*return*/, null];
             });
         }); },
         _a));

package/dist/utils.d.ts

@@ -17,10 +17,9 @@ export declare const toTestRunDto: ({ name, pixelRatio, options, }: {
     diffTollerancePercent: any;
     ignoreAreas: any;
     keepScreenshot: any;
+    retryLimit: any;
 };
-export declare const trackWithRetry: (trackFn: () => Cypress.Chainable<TestRunResponse>, shouldStopFn: (result: TestRunResponse) => boolean, onStopFn: (result: TestRunResponse) => Cypress.Chainable<unknown>, retryLimit?: number) => unknown;
-export declare const checkResult: (result: TestRunResponse) => Cypress.Chainable<unknown>;
-export declare const shouldStopRetry: (result: TestRunResponse) => boolean;
+export declare const checkResult: (result: TestRunResponse | string, errorCallback?: ((err: string) => boolean) | undefined) => void;
 export declare const trackImage: (subject: any, name: string, options: any) => Cypress.Chainable<TestRunResponse>;
 export declare const trackBuffer: (name: string, imageBuffer: Buffer, options: any) => Cypress.Chainable<TestRunResponse>;
 export declare const trackBase64: (name: string, imageBase64: string, options: any) => Cypress.Chainable<TestRunResponse>;

package/dist/utils.js

@@ -12,8 +12,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackBase64 = exports.trackBuffer = exports.trackImage = exports.shouldStopRetry = exports.checkResult = exports.trackWithRetry = exports.toTestRunDto = exports.handleError = exports.log = void 0;
-var sdk_js_1 = require("@visual-regression-tracker/sdk-js");
+exports.trackBase64 = exports.trackBuffer = exports.trackImage = exports.checkResult = exports.toTestRunDto = exports.handleError = exports.log = void 0;
 var log = function (message) {
     return Cypress.log({
         name: "Visual Regression Tracker",
@@ -40,30 +39,24 @@ var toTestRunDto = function (_a) {
         customTags: options === null || options === void 0 ? void 0 : options.customTags,
         diffTollerancePercent: options === null || options === void 0 ? void 0 : options.diffTollerancePercent,
         ignoreAreas: options === null || options === void 0 ? void 0 : options.ignoreAreas,
+        // next two properties actually do not belong to TestRunDto and ideally should be removed from this object
         keepScreenshot: options === null || options === void 0 ? void 0 : options.keepScreenshot,
+        retryLimit: options === null || options === void 0 ? void 0 : options.retryLimit,
     });
 };
 exports.toTestRunDto = toTestRunDto;
-var trackWithRetry = function (trackFn, shouldStopFn, onStopFn, retryLimit) {
-    if (retryLimit === void 0) { retryLimit = 2; }
-    return trackFn().then(function (result) {
-        if (retryLimit <= 0 || shouldStopFn(result)) {
-            onStopFn(result);
-            return;
+var checkResult = function (result, errorCallback) {
+    if (typeof result === "string") {
+        // . this is an error message
+        if (errorCallback) {
+            if (errorCallback(result)) {
+                return;
+            }
         }
-        (0, exports.log)("Diff found... Remaining retry attempts **".concat(retryLimit, "**"));
-        return (0, exports.trackWithRetry)(trackFn, shouldStopFn, onStopFn, retryLimit - 1);
-    });
-};
-exports.trackWithRetry = trackWithRetry;
-var checkResult = function (result) {
-    return cy.task("VRT_PROCESS_ERROR_RESULT", result, { log: false }).then(exports.handleError);
+        (0, exports.handleError)(result);
+    }
 };
 exports.checkResult = checkResult;
-var shouldStopRetry = function (result) {
-    return (result === null || result === void 0 ? void 0 : result.status) !== sdk_js_1.TestStatus.unresolved;
-};
-exports.shouldStopRetry = shouldStopRetry;
 var trackImage = function (subject, name, options) {
     var imagePath;
     var pixelRatio;
@@ -76,17 +69,17 @@ var trackImage = function (subject, name, options) {
         } }))
         .then(function () { return (0, exports.log)("tracking ".concat(name)); })
         .then(function () {
-        return cy.task("VRT_TRACK_IMAGE_MULTIPART", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, pixelRatio: pixelRatio, options: options })), { imagePath: imagePath }), { log: false });
+        return cy.task("VRT_TRACK", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, pixelRatio: pixelRatio, options: options })), { imagePath: imagePath }), { log: false });
     });
 };
 exports.trackImage = trackImage;
 var trackBuffer = function (name, imageBuffer, options) {
     (0, exports.log)("tracking ".concat(name));
-    return cy.task("VRT_TRACK_BUFFER_MULTIPART", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBuffer: imageBuffer }), { log: false });
+    return cy.task("VRT_TRACK", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBuffer: imageBuffer }), { log: false });
 };
 exports.trackBuffer = trackBuffer;
 var trackBase64 = function (name, imageBase64, options) {
     (0, exports.log)("tracking ".concat(name));
-    return cy.task("VRT_TRACK_IMAGE_BASE64", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBase64: imageBase64 }), { log: false });
+    return cy.task("VRT_TRACK", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBase64: imageBase64 }), { log: false });
 };
 exports.trackBase64 = trackBase64;

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@visual-regression-tracker/agent-cypress",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "description": "Visual Regression Tracker integration plugin",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "cypress run --spec 'cypress/integration/regression.spec.ts'",
     "build": "tsc",
     "semantic-release": "semantic-release"
   },
@@ -25,7 +24,7 @@
   },
   "homepage": "https://github.com/Visual-Regression-Tracker/agent-cypress#readme",
   "dependencies": {
-    "@visual-regression-tracker/sdk-js": "5.3.0"
+    "@visual-regression-tracker/sdk-js": "5.6.0"
   },
   "devDependencies": {
     "@types/jest": "^27.4.1",