fix: proper fix

Author: wswebcreation

.changeset/fix-save-methods-always-save.md

@@ -10,10 +10,16 @@ Previously, when `alwaysSaveActualImage: false` was set in the configuration, `s
 The `alwaysSaveActualImage` option is intended to control whether actual images are saved during `check*` methods (comparison operations), not `save*` methods. Since `save*` methods are explicitly designed to save screenshots, they should always save files regardless of this setting.
 
 This fix ensures:
-- `save*` methods always save files to disk, even when `alwaysSaveActualImage: false` is set
+- `save*` methods always save files to disk, even when `alwaysSaveActualImage: false` is set in the config
 - `alwaysSaveActualImage: false` continues to work correctly for `check*` methods (as intended for issue #1115)
 - The behavior is now consistent: `save*` = always save, `check*` = respect `alwaysSaveActualImage` setting
 
+**Implementation details:**
+- The visual service overrides `alwaysSaveActualImage: true` when calling `save*` methods directly from the browser API
+- `save*` methods respect whatever `alwaysSaveActualImage` value is passed to them (no special logic needed)
+- `check*` methods pass through the config value (which may be `false`), so `save*` methods respect it when called internally
+- This clean separation ensures `save*` methods work correctly when called directly while still respecting `alwaysSaveActualImage` for `check*` methods
+
 # Committers: 1
 
 -   Wim Selles ([@wswebcreation](https://github.com/wswebcreation))

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

@@ -41,9 +41,7 @@ export default async function saveAppElement(
         tag,
         isNativeContext,
         instanceData: instanceData,
-        // save* methods should always save files, regardless of alwaysSaveActualImage setting
-        // (alwaysSaveActualImage only applies to check* methods)
-        wicOptions: { ...saveElementOptions.wic, alwaysSaveActualImage: true }
+        wicOptions: saveElementOptions.wic
     })
 
     return afterScreenshot(browserInstance, afterOptions)

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

@@ -52,9 +52,7 @@ export default async function saveAppScreen(
         tag,
         isNativeContext,
         instanceData,
-        // save* methods should always save files, regardless of alwaysSaveActualImage setting
-        // (alwaysSaveActualImage only applies to check* methods)
-        wicOptions: { ...saveScreenOptions.wic, alwaysSaveActualImage: true }
+        wicOptions: saveScreenOptions.wic
     })
 
     return afterScreenshot(browserInstance, afterOptions)

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

@@ -28,7 +28,6 @@ export default async function saveFullPageScreen(
     }
 
     // 2. Set some variables
-    const { formatImageName, savePerInstance } = saveFullPageOptions.wic
     const enableLegacyScreenshotMethod = getMethodOrWicOption(saveFullPageOptions.method, saveFullPageOptions.wic, 'enableLegacyScreenshotMethod')
     const fullPageScrollTimeout = getMethodOrWicOption(saveFullPageOptions.method, saveFullPageOptions.wic, 'fullPageScrollTimeout')
     const hideAfterFirstScroll: HTMLElement[] = saveFullPageOptions.method.hideAfterFirstScroll || []
@@ -88,11 +87,8 @@ export default async function saveFullPageScreen(
         instanceData,
         enrichedInstanceData,
         beforeOptions,
-        // save* methods should always save files, regardless of alwaysSaveActualImage setting
-        // (alwaysSaveActualImage only applies to check* methods)
-        wicOptions: { formatImageName, savePerInstance, alwaysSaveActualImage: true }
+        wicOptions: saveFullPageOptions.wic
     })
 
     return afterScreenshot(browserInstance, afterOptions!)
 }
-

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

@@ -24,7 +24,7 @@ export default async function saveWebElement(
     }: InternalSaveElementMethodOptions
 ): Promise<ScreenshotOutput> {
     // 1. Set some variables
-    const { addressBarShadowPadding, autoElementScroll, formatImageName, savePerInstance } = saveElementOptions.wic
+    const { addressBarShadowPadding, autoElementScroll } = saveElementOptions.wic
     const enableLegacyScreenshotMethod = getMethodOrWicOption(saveElementOptions.method, saveElementOptions.wic, 'enableLegacyScreenshotMethod')
     const resizeDimensions: ResizeDimensions | number = saveElementOptions.method.resizeDimensions || DEFAULT_RESIZE_DIMENSIONS
 
@@ -81,9 +81,7 @@ export default async function saveWebElement(
         instanceData,
         enrichedInstanceData,
         beforeOptions,
-        // save* methods should always save files, regardless of alwaysSaveActualImage setting
-        // (alwaysSaveActualImage only applies to check* methods)
-        wicOptions: { formatImageName, savePerInstance, alwaysSaveActualImage: true }
+        wicOptions: saveElementOptions.wic
     })
 
     return afterScreenshot(browserInstance, afterOptions)

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

@@ -22,7 +22,7 @@ export default async function saveWebScreen(
     }: InternalSaveScreenMethodOptions
 ): Promise<ScreenshotOutput> {
     // 1. Set some variables
-    const { addIOSBezelCorners, formatImageName, savePerInstance } = saveScreenOptions.wic
+    const { addIOSBezelCorners } = saveScreenOptions.wic
     const enableLegacyScreenshotMethod = getMethodOrWicOption(saveScreenOptions.method, saveScreenOptions.wic, 'enableLegacyScreenshotMethod')
 
     // 2.  Prepare the screenshot
@@ -76,9 +76,7 @@ export default async function saveWebScreen(
         instanceData,
         enrichedInstanceData,
         beforeOptions,
-        // save* methods should always save files, regardless of alwaysSaveActualImage setting
-        // (alwaysSaveActualImage only applies to check* methods)
-        wicOptions: { formatImageName, savePerInstance, alwaysSaveActualImage: true }
+        wicOptions: saveScreenOptions.wic
     })
 
     return afterScreenshot(browserInstance, afterOptions)

packages/visual-service/src/service.ts

@@ -229,6 +229,12 @@ export default class WdioImageComparisonService extends BaseClass {
                         }
                         const isCurrentContextNative = self.contextManager.isNativeContext
 
+                        // save* methods should always save files, regardless of alwaysSaveActualImage config
+                        const isSaveCommand = commandName === 'saveElement'
+                        const wicOptions = isSaveCommand
+                            ? { ...self.defaultOptions, alwaysSaveActualImage: true }
+                            : self.defaultOptions
+
                         return [{
                             browserInstance,
                             element,
@@ -237,7 +243,7 @@ export default class WdioImageComparisonService extends BaseClass {
                             isNativeContext: isCurrentContextNative,
                             tag,
                             [elementOptionsKey]: {
-                                wic: self.defaultOptions,
+                                wic: wicOptions,
                                 method: elementOptions,
                             },
                             testContext: enrichTestContext({
@@ -294,14 +300,20 @@ export default class WdioImageComparisonService extends BaseClass {
                         }
                         const isCurrentContextNative = self.contextManager.isNativeContext
 
+                        // save* methods should always save files, regardless of alwaysSaveActualImage config
+                        const isSaveCommand = commandName === 'saveScreen' || commandName === 'saveFullPageScreen' || commandName === 'saveTabbablePage'
+                        const wicOptions = isSaveCommand
+                            ? { ...self.defaultOptions, alwaysSaveActualImage: true }
+                            : self.defaultOptions
+
                         return [{
                             browserInstance,
                             folders: getFolders(pageOptions, self.folders, self.#getBaselineFolder()),
                             instanceData: updatedInstanceData,
                             isNativeContext: isCurrentContextNative,
                             tag,
                             [pageOptionsKey]: {
-                                wic: self.defaultOptions,
+                                wic: wicOptions,
                                 method: pageOptions,
                             },
                             testContext: enrichTestContext({