feat: add optional keepScreenshot option to vrtTrack (#189)

* feat: add optional keepScreenshot option to vrtTrack

* refactor: add keepScreenshot option to test

Author: dimitriharding

README.md

@@ -136,6 +136,7 @@ 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
 });
 ```
 

cypress/integration/example.spec.js

@@ -34,6 +34,7 @@ context("Visual Regression Tracker", () => {
       device: "Cloud agent",
       customTags: "Cloud, DarkTheme, Auth",
       diffTollerancePercent: 0,
+      keepScreenshot: true,
       ignoreAreas: [
         {
           x: 0,

lib/index.ts

@@ -15,13 +15,17 @@ 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
+        Loggable &
+          Timeoutable &
+          ScreenshotOptions &
+          TrackOptions & { keepScreenshot?: boolean }
       >
     ): Chainable<null>;
 

lib/plugin.js

@@ -40,7 +40,9 @@ export function addVisualRegressionTrackerPlugin(on, config) {
 
       const result = await vrt["submitTestRunMultipart"](data);
 
-      unlinkSync(props.imagePath);
+      if (!props.keepScreenshot) {
+        unlinkSync(props.imagePath);
+      }
       return result;
     },
     ["VRT_TRACK_BUFFER_MULTIPART"]: async (props) => {

lib/utils.ts

@@ -41,6 +41,7 @@ export const toTestRunDto = ({
   customTags: options?.customTags,
   diffTollerancePercent: options?.diffTollerancePercent,
   ignoreAreas: options?.ignoreAreas,
+  keepScreenshot: options?.keepScreenshot,
 });
 
 export const trackWithRetry = (