@visual-regression-tracker/agent-cypress 5.2.0 → 5.5.0

package/.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@v1.4.4
+        uses: actions/setup-node@v2
 
       - name: Install dependencies
         run: npm ci

package/README.md

@@ -121,8 +121,6 @@ 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");
 
@@ -136,13 +134,25 @@ cy.vrtTrack("Whole page with additional options", {
   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,8 @@ 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.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, errorCallback); }, options === null || options === void 0 ? void 0 : options.retryLimit);
     });
 };
 exports.addVrtTrackCommand = addVrtTrackCommand;

package/dist/index.d.ts

@@ -17,10 +17,13 @@ declare namespace Cypress {
          *       ignoreAreas: [
          *         {x: 1, y: 2, width: 100, height: 200}
          *       ],
-         *       retryLimit: 5
+         *       retryLimit: 5,
+         *       keepScreenshot: false,
          *    })
          */
-        vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions>): Chainable<null>;
+        vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions & {
+            keepScreenshot?: boolean;
+        }>, 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

@@ -106,7 +106,9 @@ function addVisualRegressionTrackerPlugin(on, config) {
                         return [4 /*yield*/, vrt["submitTestRunMultipart"](data)];
                     case 1:
                         result = _a.sent();
-                        (0, fs_1.unlinkSync)(props.imagePath);
+                        if (!props.keepScreenshot) {
+                            (0, fs_1.unlinkSync)(props.imagePath);
+                        }
                         return [2 /*return*/, result];
                 }
             });

package/dist/utils.d.ts

@@ -16,9 +16,10 @@ export declare const toTestRunDto: ({ name, pixelRatio, options, }: {
     customTags: any;
     diffTollerancePercent: any;
     ignoreAreas: any;
+    keepScreenshot: any;
 };
-export declare const trackWithRetry: (trackFn: () => Cypress.Chainable<TestRunResponse>, shouldStopFn: (result: TestRunResponse) => boolean, onStopFn: (result: TestRunResponse) => Cypress.Chainable<unknown>, retryLimit?: number) => Cypress.Chainable<unknown>;
-export declare const checkResult: (result: TestRunResponse) => Cypress.Chainable<unknown>;
+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, errorCallback?: ((err: string) => boolean) | undefined) => Cypress.Chainable<unknown>;
 export declare const shouldStopRetry: (result: TestRunResponse) => boolean;
 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>;

package/dist/utils.js

@@ -34,12 +34,13 @@ var toTestRunDto = function (_a) {
     return ({
         name: name,
         browser: Cypress.browser.name,
-        viewport: (_b = options === null || options === void 0 ? void 0 : options.viewport) !== null && _b !== void 0 ? _b : Cypress.config("viewportWidth") * pixelRatio + "x" + Cypress.config("viewportHeight") * pixelRatio,
+        viewport: (_b = options === null || options === void 0 ? void 0 : options.viewport) !== null && _b !== void 0 ? _b : "".concat(Cypress.config("viewportWidth") * pixelRatio, "x").concat(Cypress.config("viewportHeight") * pixelRatio),
         os: options === null || options === void 0 ? void 0 : options.os,
         device: options === null || options === void 0 ? void 0 : options.device,
         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,
+        keepScreenshot: options === null || options === void 0 ? void 0 : options.keepScreenshot,
     });
 };
 exports.toTestRunDto = toTestRunDto;
@@ -50,14 +51,19 @@ var trackWithRetry = function (trackFn, shouldStopFn, onStopFn, retryLimit) {
             onStopFn(result);
             return;
         }
-        (0, exports.log)("Diff found... Remaining retry attempts **" + retryLimit + "**");
+        (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);
-};
+var checkResult = function (result, errorCallback) { return cy.task("VRT_PROCESS_ERROR_RESULT", result, { log: false }).then(function (err) {
+    if (err && errorCallback) {
+        if (errorCallback(err)) {
+            return;
+        }
+    }
+    (0, exports.handleError)(err);
+}); };
 exports.checkResult = checkResult;
 var shouldStopRetry = function (result) {
     return (result === null || result === void 0 ? void 0 : result.status) !== sdk_js_1.TestStatus.unresolved;
@@ -73,19 +79,19 @@ var trackImage = function (subject, name, options) {
             pixelRatio = props.pixelRatio;
             return options === null || options === void 0 ? void 0 : options.onAfterScreenshot;
         } }))
-        .then(function () { return (0, exports.log)("tracking " + name); })
+        .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 });
     });
 };
 exports.trackImage = trackImage;
 var trackBuffer = function (name, imageBuffer, options) {
-    (0, exports.log)("tracking " + name);
+    (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 });
 };
 exports.trackBuffer = trackBuffer;
 var trackBase64 = function (name, imageBase64, options) {
-    (0, exports.log)("tracking " + name);
+    (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 });
 };
 exports.trackBase64 = trackBase64;

package/package.json

@@ -1,7 +1,9 @@
 {
   "name": "@visual-regression-tracker/agent-cypress",
-  "version": "5.2.0",
+  "version": "5.5.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",
@@ -23,16 +25,16 @@
   },
   "homepage": "https://github.com/Visual-Regression-Tracker/agent-cypress#readme",
   "dependencies": {
-    "@visual-regression-tracker/sdk-js": "5.2.0"
+    "@visual-regression-tracker/sdk-js": "5.3.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
-    "@types/node": "^16.7.7",
-    "cypress": "^8.3.1",
-    "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",
+    "cypress": "^9.5.2",
+    "jest": "^27.5.1",
+    "semantic-release": "^19.0.2",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3"
   },
   "publishConfig": {
     "access": "public"