Add possibility to intercept vrtTrack result from the test

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");
 
@@ -137,13 +135,24 @@ cy.vrtTrack("Whole page with additional options", {
   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

cypress/integration/error-callback.spec.js

@@ -0,0 +1,30 @@
+/* global cy */
+/// <reference types="cypress" />
+const vrtErrors=[];
+
+function vrtTrack(name){
+    cy.vrtTrack(name, null, (err) => {
+        vrtErrors.push(err);
+        return true;
+    });
+}
+
+before(() => {
+    cy.vrtStart();
+});
+
+after(() => {
+    cy.vrtStop();
+    expect(vrtErrors).to.have.length(2);
+});
+
+context("Error Callback", () => {
+    beforeEach(() => {
+        cy.visit("https://jestjs.io/");
+    });
+
+    it("should track several screenshots", () => {
+        vrtTrack("Page with UI change 1");
+        vrtTrack("Page with UI change 2");
+    });
+});

lib/commands.ts

@@ -44,11 +44,11 @@ export const addVrtTrackCommand = () =>
     {
       prevSubject: ["optional", "element", "window", "document"],
     },
-    (subject, name, options) => {
+    (subject, name, options, errorCallback) => {
       trackWithRetry(
         () => trackImage(subject, name, options),
         (result) => shouldStopRetry(result),
-        (result) => checkResult(result),
+        (result) => checkResult(result, errorCallback),
         options?.retryLimit
       );
     }

lib/index.ts

@@ -26,7 +26,8 @@ declare namespace Cypress {
           Timeoutable &
           ScreenshotOptions &
           TrackOptions & { keepScreenshot?: boolean }
-      >
+      >,
+      errorCallback?: (err:string) => boolean
     ): Chainable<null>;
 
     vrtTrackBuffer(

lib/utils.ts

@@ -61,8 +61,17 @@ export const trackWithRetry = (
   });
 };
 
-export const checkResult = (result: TestRunResponse) =>
-  cy.task("VRT_PROCESS_ERROR_RESULT", result, { log: false }).then(handleError);
+export const checkResult = (
+  result: TestRunResponse,
+  errorCallback?: (err:string) => boolean
+) => cy.task("VRT_PROCESS_ERROR_RESULT", result, { log: false }).then((err) => {
+  if(err && errorCallback){
+    if(errorCallback(err as string)){
+      return;
+    }
+  }
+  handleError(err);
+});
 
 export const shouldStopRetry = (result: TestRunResponse) =>
   result?.status !== TestStatus.unresolved;