Fix: autoSaveBaseline collides with the new alwaysSaveActualImage flag (#1096)

* chore: update deps

* fix: fix issue 1085

- added tests

* chore: add changeset

Author: wswebcreation

.changeset/swift-terms-jump.md

@@ -0,0 +1,16 @@
+---
+"@wdio/image-comparison-core": patch
+"@wdio/visual-reporter": patch
+"@wdio/visual-service": patch
+"@wdio/ocr-service": patch
+---
+
+# 🐛 Bugfixes
+
+## #1085 autoSaveBaseline collides with the new alwaysSaveActualImage flag
+
+When `autoSaveBaseline` is `true` and `alwaysSaveActualImage` is `false`, actual images were still saved. This patch should fix that
+
+# Committers: 1
+
+-   Wim Selles ([@wswebcreation](https://github.com/wswebcreation))

package.json

@@ -52,43 +52,43 @@
     "watch": "pnpm run -r --parallel watch"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.29.7",
+    "@changesets/cli": "^2.29.8",
     "@tsconfig/node20": "^20.1.8",
     "@types/eslint": "^9.6.1",
     "@types/inquirer": "^9.0.9",
     "@types/jsdom": "~21.1.7",
     "@types/node": "^24",
     "@types/xml2js": "~0.4.14",
-    "@typescript-eslint/eslint-plugin": "^8.47.0",
-    "@wdio/globals": "^9.17.0",
-    "@wdio/mocha-framework": "^9.20.1",
-    "@typescript-eslint/parser": "^8.47.0",
-    "@typescript-eslint/utils": "^8.47.0",
+    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@wdio/globals": "^9.23.0",
+    "@wdio/mocha-framework": "^9.23.0",
+    "@typescript-eslint/parser": "^8.53.0",
+    "@typescript-eslint/utils": "^8.53.0",
     "@vitest/coverage-v8": "^3.2.4",
     "@vitest/ui": "^3.2.4",
-    "@wdio/appium-service": "^9.20.1",
-    "@wdio/browserstack-service": "^9.20.1",
-    "@wdio/cli": "^9.20.1",
-    "@wdio/local-runner": "^9.20.1",
-    "@wdio/sauce-service": "^9.20.1",
-    "@wdio/shared-store-service": "^9.20.1",
+    "@wdio/appium-service": "^9.23.0",
+    "@wdio/browserstack-service": "^9.23.0",
+    "@wdio/cli": "^9.23.0",
+    "@wdio/local-runner": "^9.23.0",
+    "@wdio/sauce-service": "^9.23.0",
+    "@wdio/shared-store-service": "^9.23.0",
     "@wdio/spec-reporter": "^9.20.0",
     "@wdio/types": "^9.20.0",
     "cross-env": "^7.0.3",
-    "eslint": "^9.39.1",
+    "eslint": "^9.39.2",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-unicorn": "^56.0.1",
-    "eslint-plugin-wdio": "^9.16.2",
+    "eslint-plugin-wdio": "^9.23.0",
     "husky": "^9.1.7",
     "jsdom": "^26.1.0",
     "npm-run-all2": "^8.0.4",
-    "release-it": "^19.0.6",
+    "release-it": "^19.2.3",
     "rimraf": "^6.1.2",
     "saucelabs": "^9.0.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
     "vitest": "^3.2.4",
-    "webdriverio": "^9.20.1",
+    "webdriverio": "^9.23.0",
     "wdio-lambdatest-service": "^4.0.1"
   },
   "packageManager": "pnpm@9.15.9+sha256.cf86a7ad764406395d4286a6d09d730711720acc6d93e9dce9ac7ac4dc4a28a7"

packages/image-comparison-core/package.json

@@ -39,7 +39,7 @@
     "@wdio/types": "^9.20.0"
   },
   "devDependencies": {
-    "webdriverio": "^9.20.1"
+    "webdriverio": "^9.23.0"
   },
   "publishConfig": {
     "access": "public"

packages/image-comparison-core/src/methods/images.executeImageCompare.test.ts

@@ -665,6 +665,14 @@ describe('executeImageCompare', () => {
                 autoSaveBaseline: true,
             }
         }
+
+        vi.mocked(fsPromises.access).mockImplementation(async (path: any) => {
+            if (path === '/mock/baseline/test.png') {
+                throw new Error('File not found')
+            }
+            return undefined
+        })
+
         vi.mocked(compareImages.default).mockResolvedValue({
             rawMisMatchPercentage: 0,
             misMatchPercentage: 0,
@@ -1043,4 +1051,44 @@ describe('executeImageCompare', () => {
         expect(images.saveBase64Image).not.toHaveBeenCalled()
         expect(log.warn).not.toHaveBeenCalled()
     })
+
+    it('should not save actual image when autoSaveBaseline is true, alwaysSaveActualImage is false, baseline exists, and comparison passes', async () => {
+        // This test covers issue #1085: autoSaveBaseline collides with alwaysSaveActualImage
+        // When baseline exists and comparison passes, actual image should NOT be saved
+        const base64Image = Buffer.from('base64-image').toString('base64')
+        const optionsWithAutoSave = {
+            ...mockOptions,
+            folderOptions: {
+                ...mockOptions.folderOptions,
+                alwaysSaveActualImage: false,
+                autoSaveBaseline: true,
+            }
+        }
+
+        vi.mocked(fsPromises.access).mockResolvedValue(undefined)
+
+        vi.mocked(images.checkBaselineImageExists).mockImplementation(async () => {
+            return Promise.resolve()
+        })
+
+        vi.mocked(compareImages.default).mockResolvedValue({
+            rawMisMatchPercentage: 0,
+            misMatchPercentage: 0,
+            getBuffer: vi.fn().mockResolvedValue(Buffer.from('diff-image-data')),
+            diffBounds: { left: 0, top: 0, right: 0, bottom: 0 },
+            analysisTime: 10,
+            diffPixels: []
+        })
+
+        await executeImageCompare({
+            isViewPortScreenshot: true,
+            isNativeContext: false,
+            options: optionsWithAutoSave,
+            testContext: mockTestContext,
+            actualBase64Image: base64Image,
+        })
+
+        expect(images.saveBase64Image).not.toHaveBeenCalled()
+        expect(fsPromises.writeFile).not.toHaveBeenCalledWith('/mock/actual/test.png', expect.anything())
+    })
 })

packages/image-comparison-core/src/methods/images.ts

@@ -384,8 +384,8 @@ export async function executeImageCompare(
     if (useBase64Image) {
         // Convert base64 to buffer for comparison
         actualImageBuffer = Buffer.from(actualBase64Image, 'base64')
-        // Only save if autoSaveBaseline is true (needed to copy to baseline)
-        if (autoSaveBaseline) {
+        // Only save actual image if baseline doesn't exist and autoSaveBaseline is true
+        if (autoSaveBaseline && !(await checkIfImageExists(baselineFilePath))) {
             await saveBase64Image(actualBase64Image, actualFilePath)
         }
     } else {

packages/ocr-service/package.json

@@ -28,7 +28,7 @@
     "watch": "pnpm run build:tsc -w"
   },
   "dependencies": {
-    "@wdio/globals": "^9.17.0",
+    "@wdio/globals": "^9.23.0",
     "@wdio/logger": "^9.18.0",
     "@wdio/types": "^9.20.0",
     "fuse.js": "^7.1.0",

packages/visual-reporter/package.json

@@ -35,16 +35,16 @@
     "sharp": "^0.34.5"
   },
   "devDependencies": {
-    "@remix-run/node": "^2.17.2",
-    "@remix-run/react": "^2.17.2",
-    "@remix-run/serve": "^2.17.2",
-    "@remix-run/dev": "^2.17.2",
+    "@remix-run/node": "^2.17.4",
+    "@remix-run/react": "^2.17.4",
+    "@remix-run/serve": "^2.17.4",
+    "@remix-run/dev": "^2.17.4",
     "@types/react": "^18.3.27",
     "@types/react-dom": "^18.3.7",
-    "@typescript-eslint/eslint-plugin": "^8.47.0",
-    "@typescript-eslint/parser": "^8.47.0",
-    "autoprefixer": "^10.4.22",
-    "eslint": "^9.39.1",
+    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/parser": "^8.53.0",
+    "autoprefixer": "^10.4.23",
+    "eslint": "^9.39.2",
     "eslint-import-resolver-typescript": "^3.10.1",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
@@ -56,7 +56,7 @@
     "react-dom": "^18.3.1",
     "react-icons": "^5.5.0",
     "react-select": "^5.10.2",
-    "tailwindcss": "^3.4.18",
+    "tailwindcss": "^3.4.19",
     "typescript": "^5.9.3",
     "vite": "^5.4.21",
     "vite-tsconfig-paths": "^5.1.4"

packages/visual-service/package.json

@@ -26,10 +26,10 @@
     "watch": "pnpm run build:tsc -w"
   },
   "dependencies": {
-    "@wdio/globals": "^9.17.0",
+    "@wdio/globals": "^9.23.0",
     "@wdio/logger": "^9.18.0",
     "@wdio/types": "^9.20.0",
-    "expect-webdriverio": "^5.5.0",
+    "expect-webdriverio": "^5.6.1",
     "@wdio/image-comparison-core": "workspace:*"
   }
 }