chore: refactor afterScreenshot options

- implemented for saveWebScreen

Author: wswebcreation

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

@@ -89,20 +89,25 @@ vi.mock('../helpers/utils.js', () => ({
     canUseBidiScreenshot: vi.fn().mockReturnValue(false),
     getMethodOrWicOption: vi.fn().mockImplementation((method, wic, option) => method[option] ?? wic[option])
 }))
-vi.mock('../helpers/options.js', () => ({
-    createBeforeScreenshotOptions: vi.fn().mockReturnValue({
-        instanceData: { test: 'data' },
-        addressBarShadowPadding: 6,
-        toolBarShadowPadding: 6,
-        disableBlinkingCursor: false,
-        disableCSSAnimation: false,
-        enableLayoutTesting: false,
-        hideElements: [],
-        noScrollBars: true,
-        removeElements: [],
-        waitForFontsLoaded: false,
-    })
-}))
+vi.mock('../helpers/options.js', async (importOriginal) => {
+    const actual = await importOriginal() as any
+    return {
+        ...actual,
+        createBeforeScreenshotOptions: vi.fn().mockReturnValue({
+            instanceData: { test: 'data' },
+            addressBarShadowPadding: 6,
+            toolBarShadowPadding: 6,
+            disableBlinkingCursor: false,
+            disableCSSAnimation: false,
+            enableLayoutTesting: false,
+            hideElements: [],
+            noScrollBars: true,
+            removeElements: [],
+            waitForFontsLoaded: false,
+        }),
+        // Let buildAfterScreenshotOptions use the real implementation
+    }
+})
 
 describe('saveWebScreen', () => {
     let takeBase64BiDiScreenshotSpy: ReturnType<typeof vi.fn>

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

@@ -4,11 +4,11 @@ import beforeScreenshot from '../helpers/beforeScreenshot.js'
 import afterScreenshot from '../helpers/afterScreenshot.js'
 import { determineScreenRectangles } from '../methods/rectangles.js'
 import type { BeforeScreenshotResult } from '../helpers/beforeScreenshot.interfaces.js'
-import type { AfterScreenshotOptions, ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js'
+import type { ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js'
 import type { RectanglesOutput, ScreenRectanglesOptions } from '../methods/rectangles.interfaces.js'
 import type { InternalSaveScreenMethodOptions } from './save.interfaces.js'
 import { canUseBidiScreenshot, getMethodOrWicOption } from '../helpers/utils.js'
-import { createBeforeScreenshotOptions } from '../helpers/options.js'
+import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js'
 
 /**
  * Saves an image of the viewport of the screen
@@ -33,8 +33,6 @@ export default async function saveWebScreen(
     const beforeOptions = createBeforeScreenshotOptions(instanceData, saveScreenOptions.method, saveScreenOptions.wic)
     const enrichedInstanceData: BeforeScreenshotResult = await beforeScreenshot(browserInstance, beforeOptions)
     const {
-        browserName,
-        browserVersion,
         deviceName,
         dimensions: {
             window: {
@@ -43,22 +41,13 @@ export default async function saveWebScreen(
                 innerWidth,
                 isEmulated,
                 isLandscape,
-                outerHeight,
-                outerWidth,
-                screenHeight,
-                screenWidth,
             },
         },
         initialDevicePixelRatio,
         isAndroidChromeDriverScreenshot,
         isAndroidNativeWebScreenshot,
         isIOS,
         isMobile,
-        isTestInBrowser,
-        logName,
-        name,
-        platformName,
-        platformVersion,
     } = enrichedInstanceData
 
     // 3.  Take the screenshot
@@ -98,43 +87,16 @@ export default async function saveWebScreen(
     }
 
     // 5.  The after the screenshot methods
-    const afterOptions: AfterScreenshotOptions = {
-        actualFolder: folders.actualFolder,
+    const afterOptions = buildAfterScreenshotOptions({
         base64Image,
-        disableBlinkingCursor: beforeOptions.disableBlinkingCursor,
-        disableCSSAnimation: beforeOptions.disableCSSAnimation,
-        enableLayoutTesting: beforeOptions.enableLayoutTesting,
-        filePath: {
-            browserName,
-            deviceName,
-            isMobile,
-            savePerInstance,
-        },
-        fileName: {
-            browserName,
-            browserVersion,
-            deviceName,
-            devicePixelRatio: devicePixelRatio || NaN,
-            formatImageName,
-            isMobile,
-            isTestInBrowser,
-            logName,
-            name,
-            outerHeight: outerHeight || NaN,
-            outerWidth: outerWidth || NaN,
-            platformName,
-            platformVersion,
-            screenHeight: screenHeight || NaN,
-            screenWidth: screenWidth || NaN,
-            tag,
-        },
-        hideElements: beforeOptions.hideElements,
-        hideScrollBars: beforeOptions.noScrollBars,
-        isLandscape,
+        folders,
+        tag,
         isNativeContext,
-        platformName: instanceData.platformName,
-        removeElements: beforeOptions.removeElements,
-    }
+        instanceData,
+        enrichedInstanceData,
+        beforeOptions,
+        wicOptions: { formatImageName, savePerInstance }
+    })
 
     // 6.  Return the data
     return afterScreenshot(browserInstance, afterOptions)

packages/image-comparison-core/src/helpers/__snapshots__/options.test.ts.snap

@@ -1,5 +1,79 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`options > buildAfterScreenshotOptions > should build options for native commands (no enriched data) 1`] = `
+{
+  "actualFolder": "/test/actual",
+  "base64Image": "test-screenshot-data",
+  "fileName": {
+    "browserName": "chrome",
+    "browserVersion": "120.0.0",
+    "deviceName": "desktop",
+    "devicePixelRatio": 2,
+    "formatImageName": "{tag}-{browserName}-{width}x{height}",
+    "isMobile": false,
+    "isTestInBrowser": false,
+    "logName": "chrome",
+    "name": "chrome",
+    "outerHeight": NaN,
+    "outerWidth": NaN,
+    "platformName": "desktop",
+    "platformVersion": "120.0.0",
+    "screenHeight": 1080,
+    "screenWidth": 1920,
+    "tag": "test-element",
+  },
+  "filePath": {
+    "browserName": "chrome",
+    "deviceName": "desktop",
+    "isMobile": false,
+    "savePerInstance": false,
+  },
+  "isLandscape": false,
+  "isNativeContext": true,
+  "platformName": "desktop",
+}
+`;
+
+exports[`options > buildAfterScreenshotOptions > should build options for web commands with enriched data 1`] = `
+{
+  "actualFolder": "/test/actual",
+  "base64Image": "test-screenshot-data",
+  "disableBlinkingCursor": true,
+  "disableCSSAnimation": false,
+  "enableLayoutTesting": true,
+  "fileName": {
+    "browserName": "chrome",
+    "browserVersion": "120.0.0",
+    "deviceName": "desktop",
+    "devicePixelRatio": 3,
+    "formatImageName": "{tag}-{browserName}-{width}x{height}",
+    "isMobile": false,
+    "isTestInBrowser": true,
+    "logName": "chrome",
+    "name": "chrome",
+    "outerHeight": 1000,
+    "outerWidth": 1200,
+    "platformName": "desktop",
+    "platformVersion": "120.0.0",
+    "screenHeight": 1440,
+    "screenWidth": 2560,
+    "tag": "test-element",
+  },
+  "filePath": {
+    "browserName": "chrome",
+    "deviceName": "desktop",
+    "isMobile": false,
+    "savePerInstance": false,
+  },
+  "hideElements": [],
+  "hideScrollBars": true,
+  "isLandscape": true,
+  "isNativeContext": false,
+  "platformName": "desktop",
+  "removeElements": [],
+}
+`;
+
 exports[`options > defaultOptions > should return the default options when no options are provided 1`] = `
 {
   "addIOSBezelCorners": false,