Refactor code

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

@@ -17,10 +17,42 @@ vi.mock('../helpers/afterScreenshot.js', () => ({
         fileName: 'test-element.png'
     })
 }))
+vi.mock('../helpers/options.js', () => ({
+    buildAfterScreenshotOptions: vi.fn().mockReturnValue({
+        actualFolder: '/path/to/actual',
+        base64Image: 'base64-screenshot-data',
+        filePath: {
+            browserName: 'chrome',
+            deviceName: '',
+            isMobile: false,
+            savePerInstance: false
+        },
+        fileName: {
+            browserName: 'chrome',
+            browserVersion: 'latest',
+            deviceName: '',
+            devicePixelRatio: 1,
+            formatImageName: '{tag}',
+            isMobile: false,
+            isTestInBrowser: false,
+            logName: 'chrome',
+            name: '',
+            platformName: 'Windows',
+            platformVersion: 'latest',
+            screenHeight: 720,
+            screenWidth: 1366,
+            tag: 'test-element'
+        },
+        isNativeContext: true,
+        isLandscape: false,
+        platformName: 'Windows'
+    })
+}))
 
 describe('saveAppElement', () => {
     let takeBase64ElementScreenshotSpy: ReturnType<typeof vi.fn>
     let afterScreenshotSpy: ReturnType<typeof vi.fn>
+    let buildAfterScreenshotOptionsSpy: ReturnType<typeof vi.fn>
 
     const baseOptions: InternalSaveElementMethodOptions = {
         element: {
@@ -44,9 +76,11 @@ describe('saveAppElement', () => {
     beforeEach(async () => {
         const { takeBase64ElementScreenshot } = await import('../methods/images.js')
         const afterScreenshot = (await import('../helpers/afterScreenshot.js')).default
+        const { buildAfterScreenshotOptions } = await import('../helpers/options.js')
 
         takeBase64ElementScreenshotSpy = vi.mocked(takeBase64ElementScreenshot)
         afterScreenshotSpy = vi.mocked(afterScreenshot)
+        buildAfterScreenshotOptionsSpy = vi.mocked(buildAfterScreenshotOptions)
     })
 
     afterEach(() => {
@@ -58,7 +92,8 @@ describe('saveAppElement', () => {
 
         expect(result).toMatchSnapshot()
         expect(takeBase64ElementScreenshotSpy.mock.calls[0]).toMatchSnapshot()
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 
     it('should handle custom resize dimensions', async () => {
@@ -81,7 +116,8 @@ describe('saveAppElement', () => {
         await saveAppElement(options)
 
         expect(takeBase64ElementScreenshotSpy.mock.calls[0]).toMatchSnapshot()
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 
     it('should handle iOS device correctly', async () => {
@@ -105,7 +141,8 @@ describe('saveAppElement', () => {
         await saveAppElement(options)
 
         expect(takeBase64ElementScreenshotSpy.mock.calls[0]).toMatchSnapshot()
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 
     it('should handle Android device correctly', async () => {
@@ -129,7 +166,8 @@ describe('saveAppElement', () => {
         await saveAppElement(options)
 
         expect(takeBase64ElementScreenshotSpy.mock.calls[0]).toMatchSnapshot()
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 
     it('should handle non-native context correctly', async () => {
@@ -140,7 +178,8 @@ describe('saveAppElement', () => {
         await saveAppElement(options)
 
         expect(takeBase64ElementScreenshotSpy.mock.calls[0]).toMatchSnapshot()
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 
     it('should handle custom image naming', async () => {
@@ -150,7 +189,8 @@ describe('saveAppElement', () => {
 
         await saveAppElement(options)
 
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 
     it('should handle save per instance', async () => {
@@ -166,7 +206,8 @@ describe('saveAppElement', () => {
 
         await saveAppElement(options)
 
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 
     it('should handle custom screen sizes', async () => {
@@ -186,6 +227,7 @@ describe('saveAppElement', () => {
         await saveAppElement(options)
 
         expect(takeBase64ElementScreenshotSpy.mock.calls[0]).toMatchSnapshot()
-        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot()
     })
 })

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

@@ -1,6 +1,7 @@
-import type { AfterScreenshotOptions, ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js'
+import type { ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js'
 import afterScreenshot from '../helpers/afterScreenshot.js'
 import { DEFAULT_RESIZE_DIMENSIONS } from '../helpers/constants.js'
+import { buildAfterScreenshotOptions } from '../helpers/options.js'
 import type { ResizeDimensions } from '../methods/images.interfaces.js'
 import { takeBase64ElementScreenshot } from '../methods/images.js'
 import type { WicElement } from './element.interfaces.js'
@@ -21,22 +22,10 @@ export default async function saveAppElement(
     }: InternalSaveElementMethodOptions
 ): Promise<ScreenshotOutput> {
     // 1. Set some variables
-    const {
-        formatImageName,
-        savePerInstance,
-    } = saveElementOptions.wic
     const resizeDimensions: ResizeDimensions = saveElementOptions.method.resizeDimensions || DEFAULT_RESIZE_DIMENSIONS
     const {
-        browserName,
-        browserVersion,
-        deviceName,
         devicePixelRatio,
-        deviceRectangles:{ screenSize },
         isIOS,
-        isMobile,
-        logName,
-        platformName,
-        platformVersion,
     } = instanceData
 
     // 2. Take the screenshot
@@ -48,37 +37,17 @@ export default async function saveAppElement(
         resizeDimensions,
     })
 
-    // 3.  The after the screenshot methods
-    const afterOptions: AfterScreenshotOptions = {
-        actualFolder: folders.actualFolder,
+    // 3. The after the screenshot methods
+    const afterOptions = buildAfterScreenshotOptions({
         base64Image,
-        filePath: {
-            browserName,
-            deviceName,
-            isMobile,
-            savePerInstance,
-        },
-        fileName: {
-            browserName,
-            browserVersion,
-            deviceName,
-            devicePixelRatio: devicePixelRatio,
-            formatImageName,
-            isMobile,
-            isTestInBrowser: !isNativeContext,
-            logName,
-            name: '',
-            platformName,
-            platformVersion,
-            screenHeight: screenSize.height,
-            screenWidth: screenSize.width,
-            tag,
-        },
+        folders,
+        tag,
         isNativeContext,
-        isLandscape:false,
-        platformName,
-    }
+        instanceData: instanceData as any, // Use instanceData as enrichedInstanceData for app commands
+        enrichedInstanceData: instanceData as any,
+        wicOptions: saveElementOptions.wic
+    })
 
-    // 4.  Return the data
+    // 4. Return the data
     return afterScreenshot(browserInstance, afterOptions)
 }

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

@@ -1,5 +1,6 @@
 import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
 import saveAppScreen from './saveAppScreen.js'
+import { buildAfterScreenshotOptions } from '../helpers/options.js'
 import type { InternalSaveScreenMethodOptions } from './save.interfaces.js'
 import {
     BASE_CHECK_OPTIONS,
@@ -20,11 +21,45 @@ vi.mock('../helpers/afterScreenshot.js', () => ({
         fileName: 'test-screen.png'
     })
 }))
+vi.mock('../helpers/options.js', () => ({
+    buildAfterScreenshotOptions: vi.fn().mockReturnValue({
+        actualFolder: '/test/actual',
+        base64Image: 'base64-screenshot-data',
+        filePath: {
+            browserName: 'test-browser',
+            deviceName: 'test-device',
+            isMobile: true,
+            savePerInstance: false,
+        },
+        fileName: {
+            browserName: 'test-browser',
+            browserVersion: '17.0',
+            deviceName: 'test-device',
+            devicePixelRatio: 2,
+            formatImageName: '{tag}-{logName}-{width}x{height}-dpr-{dpr}',
+            isMobile: true,
+            isTestInBrowser: false,
+            logName: 'test-log',
+            name: 'test-device',
+            outerHeight: NaN,
+            outerWidth: NaN,
+            platformName: 'iOS',
+            platformVersion: '17.0',
+            screenHeight: 812,
+            screenWidth: 375,
+            tag: 'test-screen',
+        },
+        isNativeContext: true,
+        isLandscape: false,
+        platformName: 'iOS',
+    })
+}))
 
 describe('saveAppScreen', () => {
     let takeBase64ScreenshotSpy: ReturnType<typeof vi.fn>
     let makeCroppedBase64ImageSpy: ReturnType<typeof vi.fn>
     let afterScreenshotSpy: ReturnType<typeof vi.fn>
+    let buildAfterScreenshotOptionsSpy: ReturnType<typeof vi.fn>
 
     const baseOptions = {
         browserInstance: { isAndroid: false, isMobile: false } as any,
@@ -65,6 +100,7 @@ describe('saveAppScreen', () => {
         takeBase64ScreenshotSpy = vi.mocked(takeBase64Screenshot)
         makeCroppedBase64ImageSpy = vi.mocked(makeCroppedBase64Image)
         afterScreenshotSpy = vi.mocked(afterScreenshot)
+        buildAfterScreenshotOptionsSpy = vi.mocked(buildAfterScreenshotOptions)
     })
 
     afterEach(() => {
@@ -76,6 +112,7 @@ describe('saveAppScreen', () => {
 
         expect(result).toMatchSnapshot()
         expect(takeBase64ScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
         expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
         expect(makeCroppedBase64ImageSpy).not.toHaveBeenCalled()
     })
@@ -111,6 +148,7 @@ describe('saveAppScreen', () => {
         await saveAppScreen(options)
 
         expect(takeBase64ScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
         expect(makeCroppedBase64ImageSpy.mock.calls[0]).toMatchSnapshot()
         expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
     })
@@ -139,6 +177,7 @@ describe('saveAppScreen', () => {
         await saveAppScreen(options)
 
         expect(takeBase64ScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
         expect(makeCroppedBase64ImageSpy).not.toHaveBeenCalled()
         expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
     })
@@ -151,6 +190,7 @@ describe('saveAppScreen', () => {
         await saveAppScreen(options)
 
         expect(takeBase64ScreenshotSpy.mock.calls[0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
         expect(makeCroppedBase64ImageSpy).not.toHaveBeenCalled()
         expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
     })
@@ -168,6 +208,7 @@ describe('saveAppScreen', () => {
 
         await saveAppScreen(options)
 
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
         expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
     })
 
@@ -184,6 +225,7 @@ describe('saveAppScreen', () => {
 
         await saveAppScreen(options)
 
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
         expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
     })
 
@@ -204,6 +246,7 @@ describe('saveAppScreen', () => {
         await saveAppScreen(options)
 
         expect(takeBase64ScreenshotSpy.mock.calls[0][0]).toMatchSnapshot()
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot()
         expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot()
     })
 })