feat: implement the code changes

Author: wswebcreation

packages/image-comparison-core/src/commands/checkAppElement.ts

@@ -25,7 +25,7 @@ export default async function checkAppElement(
     const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkElementOptions.wic })
 
     // 2. Save the element and return the data
-    const { devicePixelRatio, fileName } = await saveAppElement({
+    const { devicePixelRatio, fileName, base64Image } = await saveAppElement({
         browserInstance,
         element: element as WicElement,
         folders,
@@ -58,5 +58,6 @@ export default async function checkAppElement(
         testContext,
         isViewPortScreenshot: false,
         isNativeContext,
+        actualBase64Image: base64Image,
     })
 }

packages/image-comparison-core/src/commands/checkAppScreen.ts

@@ -43,7 +43,7 @@ export default async function checkAppScreen(
     }
 
     // 2. Take the actual screenshot and retrieve the needed data
-    const { devicePixelRatio, fileName } = await saveAppScreen({
+    const { devicePixelRatio, fileName, base64Image } = await saveAppScreen({
         browserInstance,
         folders,
         instanceData,
@@ -88,5 +88,6 @@ export default async function checkAppScreen(
         isNativeContext,
         options: executeCompareOptions,
         testContext,
+        actualBase64Image: base64Image,
     })
 }

packages/image-comparison-core/src/commands/checkFullPageScreen.ts

@@ -56,7 +56,7 @@ export default async function checkFullPageScreen(
             waitForFontsLoaded,
         },
     }
-    const { devicePixelRatio, fileName } = await saveFullPageScreen({
+    const { devicePixelRatio, fileName, base64Image } = await saveFullPageScreen({
         browserInstance,
         folders,
         instanceData,
@@ -81,5 +81,6 @@ export default async function checkFullPageScreen(
         isNativeContext,
         options: executeCompareOptions,
         testContext,
+        actualBase64Image: base64Image,
     })
 }

packages/image-comparison-core/src/commands/checkWebElement.ts

@@ -50,7 +50,7 @@ export default async function checkWebElement(
             waitForFontsLoaded,
         },
     }
-    const { devicePixelRatio, fileName } = await saveWebElement({
+    const { devicePixelRatio, fileName, base64Image } = await saveWebElement({
         browserInstance,
         instanceData,
         folders,
@@ -76,5 +76,6 @@ export default async function checkWebElement(
         isNativeContext,
         options: executeCompareOptions,
         testContext,
+        actualBase64Image: base64Image,
     })
 }

packages/image-comparison-core/src/commands/checkWebScreen.ts

@@ -47,7 +47,7 @@ export default async function checkWebScreen(
             waitForFontsLoaded,
         },
     }
-    const { devicePixelRatio, fileName } = await saveWebScreen({
+    const { devicePixelRatio, fileName, base64Image } = await saveWebScreen({
         browserInstance,
         instanceData,
         folders,
@@ -72,5 +72,6 @@ export default async function checkWebScreen(
         isNativeContext,
         options: executeCompareOptions,
         testContext,
+        actualBase64Image: base64Image,
     })
 }

packages/image-comparison-core/src/commands/saveFullPageScreen.ts

@@ -88,7 +88,7 @@ export default async function saveFullPageScreen(
         instanceData,
         enrichedInstanceData,
         beforeOptions,
-        wicOptions: { formatImageName, savePerInstance }
+        wicOptions: { formatImageName, savePerInstance, alwaysSaveActualImage: saveFullPageOptions.wic.alwaysSaveActualImage }
     })
 
     return afterScreenshot(browserInstance, afterOptions!)

packages/image-comparison-core/src/commands/saveWebElement.ts

@@ -81,7 +81,7 @@ export default async function saveWebElement(
         instanceData,
         enrichedInstanceData,
         beforeOptions,
-        wicOptions: { formatImageName, savePerInstance }
+        wicOptions: { formatImageName, savePerInstance, alwaysSaveActualImage: saveElementOptions.wic.alwaysSaveActualImage }
     })
 
     return afterScreenshot(browserInstance, afterOptions)

packages/image-comparison-core/src/commands/saveWebScreen.ts

@@ -76,7 +76,7 @@ export default async function saveWebScreen(
         instanceData,
         enrichedInstanceData,
         beforeOptions,
-        wicOptions: { formatImageName, savePerInstance }
+        wicOptions: { formatImageName, savePerInstance, alwaysSaveActualImage: saveScreenOptions.wic.alwaysSaveActualImage }
     })
 
     return afterScreenshot(browserInstance, afterOptions)

packages/image-comparison-core/src/helpers/afterScreenshot.interfaces.ts

@@ -7,6 +7,8 @@ export interface ScreenshotOutput {
     isLandscape: boolean;
     // The path where the file can be found
     path: string;
+    // The base64 image (only present when alwaysSaveActualImage is false and image wasn't saved)
+    base64Image?: string;
 }
 
 export interface AfterScreenshotOptions {
@@ -36,6 +38,8 @@ export interface AfterScreenshotOptions {
     platformName: string;
     // Elements that need to be removed (display: none) before saving a screenshot
     removeElements?: (HTMLElement | HTMLElement[])[];
+    // Always save the actual image to disk
+    alwaysSaveActualImage?: boolean;
 }
 
 export interface ScreenshotFilePathOptions {

packages/image-comparison-core/src/helpers/afterScreenshot.ts

@@ -29,19 +29,23 @@ export default async function afterScreenshot(browserInstance: WebdriverIO.Brows
         isLandscape,
         isNativeContext,
         removeElements,
+        alwaysSaveActualImage,
     } = options
     const path = getAndCreatePath(actualFolder, filePath)
     const fileName = formatFileName(fileNameOptions)
-
-    await saveBase64Image(base64Image, join(path, fileName))
-
-    const result = {
+    const result: ScreenshotOutput = {
         devicePixelRatio: fileNameOptions.devicePixelRatio,
         fileName,
         isLandscape,
         path,
     }
 
+    if (alwaysSaveActualImage) {
+        await saveBase64Image(base64Image, join(path, fileName))
+    } else {
+        result.base64Image = base64Image
+    }
+
     if (isNativeContext) {
         return result
     }