chore: refactor to use buildFolderOptions

- adjust methods
- add and adjust UTs

Author: wswebcreation

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

@@ -32,7 +32,17 @@ vi.mock('../helpers/utils.js', () => ({
         autoSaveBaseline: false,
         savePerInstance: false,
         isHybridApp: false,
-    })
+    }),
+    buildFolderOptions: vi.fn().mockReturnValue({
+        autoSaveBaseline: false,
+        actualFolder: '/mock/actual',
+        baselineFolder: '/mock/baseline',
+        diffFolder: '/mock/diff',
+        browserName: 'chrome',
+        deviceName: 'Desktop',
+        isMobile: false,
+        savePerInstance: false,
+    }),
 }))
 
 vi.mock('../methods/images.js', () => ({

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

@@ -3,7 +3,7 @@ import saveFullPageScreen from './saveFullPageScreen.js'
 import type { ImageCompareResult } from '../methods/images.interfaces.js'
 import type { SaveFullPageOptions } from './fullPage.interfaces.js'
 import { methodCompareOptions } from '../helpers/options.js'
-import { extractCommonCheckVariables } from '../helpers/utils.js'
+import { extractCommonCheckVariables, buildFolderOptions } from '../helpers/utils.js'
 import type { InternalCheckFullPageMethodOptions } from './check.interfaces.js'
 
 /**
@@ -21,22 +21,15 @@ export default async function checkFullPageScreen(
     }: InternalCheckFullPageMethodOptions
 ): Promise<ImageCompareResult | number> {
     // 1. Extract common variables
+    const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkFullPageOptions.wic })
     const {
-        browserName,
-        deviceName,
         deviceRectangles,
         isAndroid,
         isIOS,
-        isMobile,
         isAndroidNativeWebScreenshot,
         platformName,
-        autoSaveBaseline,
-        isHybridApp,
-        savePerInstance,
-        actualFolder,
-        baselineFolder,
-        diffFolder
-    } = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkFullPageOptions.wic })
+        isHybridApp
+    } = commonCheckVariables
     const {
         disableBlinkingCursor,
         disableCSSAnimation,
@@ -90,16 +83,7 @@ export default async function checkFullPageScreen(
         devicePixelRatio,
         deviceRectangles,
         fileName,
-        folderOptions: {
-            autoSaveBaseline,
-            actualFolder,
-            baselineFolder,
-            diffFolder,
-            browserName,
-            deviceName,
-            isMobile,
-            savePerInstance,
-        },
+        folderOptions: buildFolderOptions({ commonCheckVariables }),
         isAndroid,
         isAndroidNativeWebScreenshot,
         isIOS,

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

@@ -45,7 +45,17 @@ vi.mock('../helpers/utils.js', () => ({
         platformName: 'Windows',
         autoSaveBaseline: false,
         savePerInstance: false,
-    })
+    }),
+    buildFolderOptions: vi.fn().mockReturnValue({
+        autoSaveBaseline: false,
+        actualFolder: '/mock/actual',
+        baselineFolder: '/mock/baseline',
+        diffFolder: '/mock/diff',
+        browserName: 'chrome',
+        deviceName: 'Desktop',
+        isMobile: false,
+        savePerInstance: false,
+    }),
 }))
 
 describe('checkWebElement', () => {

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

@@ -3,7 +3,7 @@ import saveWebElement from './saveWebElement.js'
 import type { ImageCompareResult } from '../methods/images.interfaces.js'
 import type { SaveElementOptions } from './element.interfaces.js'
 import { methodCompareOptions } from '../helpers/options.js'
-import { extractCommonCheckVariables } from '../helpers/utils.js'
+import { extractCommonCheckVariables, buildFolderOptions } from '../helpers/utils.js'
 import type { InternalCheckElementMethodOptions } from './check.interfaces.js'
 
 /**
@@ -22,20 +22,13 @@ export default async function checkWebElement(
     }: InternalCheckElementMethodOptions
 ): Promise<ImageCompareResult | number> {
     // 1. Extract common variables
+    const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkElementOptions.wic })
     const {
-        browserName,
-        deviceName,
         deviceRectangles,
         isAndroid,
-        isMobile,
         isAndroidNativeWebScreenshot,
-        platformName,
-        autoSaveBaseline,
-        savePerInstance,
-        actualFolder,
-        baselineFolder,
-        diffFolder
-    } = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkElementOptions.wic })
+        platformName
+    } = commonCheckVariables
     const {
         disableBlinkingCursor,
         disableCSSAnimation,
@@ -88,16 +81,7 @@ export default async function checkWebElement(
         devicePixelRatio,
         deviceRectangles,
         fileName,
-        folderOptions: {
-            autoSaveBaseline,
-            actualFolder,
-            baselineFolder,
-            diffFolder,
-            browserName,
-            deviceName,
-            isMobile,
-            savePerInstance,
-        },
+        folderOptions: buildFolderOptions({ commonCheckVariables }),
         isAndroid,
         isAndroidNativeWebScreenshot,
         platformName,

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

@@ -44,7 +44,17 @@ vi.mock('../helpers/utils.js', () => ({
         isAndroidNativeWebScreenshot: false,
         autoSaveBaseline: false,
         savePerInstance: false,
-    })
+    }),
+    buildFolderOptions: vi.fn().mockReturnValue({
+        autoSaveBaseline: false,
+        actualFolder: '/mock/actual',
+        baselineFolder: '/mock/baseline',
+        diffFolder: '/mock/diff',
+        browserName: 'chrome',
+        deviceName: 'Desktop',
+        isMobile: false,
+        savePerInstance: false,
+    }),
 }))
 
 describe('checkWebScreen', () => {

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

@@ -3,7 +3,7 @@ import { executeImageCompare } from '../methods/images.js'
 import type { ImageCompareOptions, ImageCompareResult } from '../methods/images.interfaces.js'
 import type { SaveScreenOptions } from './screen.interfaces.js'
 import { screenMethodCompareOptions } from '../helpers/options.js'
-import { extractCommonCheckVariables } from '../helpers/utils.js'
+import { extractCommonCheckVariables, buildFolderOptions } from '../helpers/utils.js'
 import type { InternalCheckScreenMethodOptions } from './check.interfaces.js'
 
 /**
@@ -21,19 +21,12 @@ export default async function checkWebScreen(
     }: InternalCheckScreenMethodOptions
 ): Promise<ImageCompareResult | number> {
     // 1. Extract common variables
+    const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkScreenOptions.wic })
     const {
-        browserName,
-        deviceName,
         deviceRectangles,
         isAndroid,
-        isMobile,
-        isAndroidNativeWebScreenshot,
-        autoSaveBaseline,
-        savePerInstance,
-        actualFolder,
-        baselineFolder,
-        diffFolder
-    } = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkScreenOptions.wic })
+        isAndroidNativeWebScreenshot
+    } = commonCheckVariables
     const {
         disableBlinkingCursor,
         disableCSSAnimation,
@@ -78,16 +71,7 @@ export default async function checkWebScreen(
         devicePixelRatio,
         deviceRectangles,
         fileName,
-        folderOptions: {
-            autoSaveBaseline,
-            actualFolder,
-            baselineFolder,
-            diffFolder,
-            browserName,
-            deviceName,
-            isMobile,
-            savePerInstance,
-        },
+        folderOptions: buildFolderOptions({ commonCheckVariables }),
         isAndroid,
         isAndroidNativeWebScreenshot,
     }

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

@@ -1,5 +1,31 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`utils > buildFolderOptions > should build folder options from common check variables 1`] = `
+{
+  "actualFolder": "/path/to/actual",
+  "autoSaveBaseline": true,
+  "baselineFolder": "/path/to/baseline",
+  "browserName": "chrome",
+  "deviceName": "iPhone 12",
+  "diffFolder": "/path/to/diff",
+  "isMobile": true,
+  "savePerInstance": false,
+}
+`;
+
+exports[`utils > buildFolderOptions > should handle all properties correctly 1`] = `
+{
+  "actualFolder": "/test/actual",
+  "autoSaveBaseline": false,
+  "baselineFolder": "/test/baseline",
+  "browserName": "firefox",
+  "deviceName": "Desktop",
+  "diffFolder": "/test/diff",
+  "isMobile": false,
+  "savePerInstance": true,
+}
+`;
+
 exports[`utils > calculateDprData > should multiply all number values by the dpr value 1`] = `
 {
   "1": 6,

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

@@ -181,10 +181,34 @@ export interface CommonCheckVariables {
 }
 
 export interface ExtractCommonCheckVariablesOptions {
-    /** The folder paths for storing screenshots */
+    /** The folders object */
     folders: Folders;
-    /** Instance data containing device and browser information */
+    /** The instance data object */
     instanceData: any;
-    /** WIC options containing settings and compare options */
+    /** The wic options object */
     wicOptions: any;
 }
+
+export interface FolderOptions {
+    /** Whether to auto-save baseline images */
+    autoSaveBaseline: boolean;
+    /** The actual folder path */
+    actualFolder: string;
+    /** The baseline folder path */
+    baselineFolder: string;
+    /** The diff folder path */
+    diffFolder: string;
+    /** The browser name */
+    browserName: string;
+    /** The device name */
+    deviceName: string;
+    /** Whether this is a mobile device */
+    isMobile: boolean;
+    /** Whether to save per instance */
+    savePerInstance: boolean;
+}
+
+export interface BuildFolderOptionsOptions {
+    /** Common check variables that include all the needed folder options properties */
+    commonCheckVariables: CommonCheckVariables;
+}

packages/image-comparison-core/src/helpers/utils.test.ts

@@ -12,6 +12,7 @@ vi.mock('node:fs', async () => {
 })
 import logger from '@wdio/logger'
 import {
+    buildFolderOptions,
     calculateDprData,
     canUseBidiScreenshot,
     checkAndroidChromeDriverScreenshot,
@@ -925,4 +926,49 @@ describe('utils', () => {
             expect(result.deviceName).toBe('Pixel 4')
         })
     })
+
+    describe('buildFolderOptions', () => {
+        it('should build folder options from common check variables', () => {
+            const commonCheckVariables = {
+                actualFolder: '/path/to/actual',
+                baselineFolder: '/path/to/baseline',
+                diffFolder: '/path/to/diff',
+                browserName: 'chrome',
+                deviceName: 'iPhone 12',
+                deviceRectangles: { screenSize: { width: 390, height: 844 } },
+                isAndroid: false,
+                isMobile: true,
+                isAndroidNativeWebScreenshot: true,
+                autoSaveBaseline: true,
+                savePerInstance: false,
+            }
+
+            const result = buildFolderOptions({ commonCheckVariables })
+
+            expect(result).toMatchSnapshot()
+        })
+
+        it('should handle all properties correctly', () => {
+            const commonCheckVariables = {
+                actualFolder: '/test/actual',
+                baselineFolder: '/test/baseline',
+                diffFolder: '/test/diff',
+                browserName: 'firefox',
+                deviceName: 'Desktop',
+                deviceRectangles: { screenSize: { width: 1920, height: 1080 } },
+                isAndroid: true,
+                isMobile: false,
+                isAndroidNativeWebScreenshot: false,
+                autoSaveBaseline: false,
+                savePerInstance: true,
+                platformName: 'Android',
+                isIOS: false,
+                isHybridApp: true,
+            }
+
+            const result = buildFolderOptions({ commonCheckVariables })
+
+            expect(result).toMatchSnapshot()
+        })
+    })
 })

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

@@ -3,9 +3,11 @@ import { join } from 'node:path'
 import { DESKTOP, NOT_KNOWN } from './constants.js'
 import { mkdirSync } from 'node:fs'
 import type {
+    BuildFolderOptionsOptions,
     CommonCheckVariables,
     ExecuteNativeClickOptions,
     ExtractCommonCheckVariablesOptions,
+    FolderOptions,
     FormatFileDefaults,
     FormatFileNameOptions,
     GetAddressBarShadowPaddingOptions,
@@ -613,3 +615,23 @@ export function extractCommonCheckVariables(
         ...(wicOptions.isHybridApp !== undefined && { isHybridApp: wicOptions.isHybridApp }),
     }
 }
+
+/**
+ * Builds folder options object used across all check methods to reduce duplication
+ */
+export function buildFolderOptions(
+    options: BuildFolderOptionsOptions
+): FolderOptions {
+    const { commonCheckVariables } = options
+
+    return {
+        autoSaveBaseline: commonCheckVariables.autoSaveBaseline,
+        actualFolder: commonCheckVariables.actualFolder,
+        baselineFolder: commonCheckVariables.baselineFolder,
+        diffFolder: commonCheckVariables.diffFolder,
+        browserName: commonCheckVariables.browserName,
+        deviceName: commonCheckVariables.deviceName,
+        isMobile: commonCheckVariables.isMobile,
+        savePerInstance: commonCheckVariables.savePerInstance,
+    }
+}