New Major Release

.github/workflows/tests.yml

@@ -176,7 +176,7 @@ jobs:
           LAMBDATEST_USERNAME: ${{ secrets.LAMBDATEST_USERNAME }}
           LAMBDATEST_ACCESS_KEY: ${{ secrets.LAMBDATEST_ACCESS_KEY }}
           BUILD_PREFIX: true
-        run: pnpm test.lambdatest.desktop --maxConcurrency=3
+        run: pnpm test.lambdatest.desktop --maxConcurrency=4
 
       - name: 📤 Upload artifacts
         uses: actions/upload-artifact@v4
@@ -239,7 +239,7 @@ jobs:
           LAMBDATEST_USERNAME: ${{ secrets.LAMBDATEST_USERNAME }}
           LAMBDATEST_ACCESS_KEY: ${{ secrets.LAMBDATEST_ACCESS_KEY }}
           BUILD_PREFIX: true
-        run: pnpm test.lambdatest.emu.web --maxConcurrency=4
+        run: pnpm test.lambdatest.emu.web --maxConcurrency=6
 
       - name: 📤 Upload artifacts
         uses: actions/upload-artifact@v4
@@ -302,7 +302,7 @@ jobs:
           LAMBDATEST_USERNAME: ${{ secrets.LAMBDATEST_USERNAME }}
           LAMBDATEST_ACCESS_KEY: ${{ secrets.LAMBDATEST_ACCESS_KEY }}
           BUILD_PREFIX: true
-        run: pnpm test.lambdatest.sims.web --maxConcurrency=4
+        run: pnpm test.lambdatest.sims.web --maxConcurrency=6
 
       - name: 📤 Upload artifacts
         uses: actions/upload-artifact@v4

package.json

@@ -12,7 +12,7 @@
   "scripts": {
     "build": "pnpm run -r build",
     "build:reporter": "node ./packages/visual-reporter/dist/cli.js --jsonOutput=.tmp/actual/output.json --reportFolder=.tmp/ --logLevel=debug",
-    "clean": "rimraf coverage dist .tmp '**/dist'",
+    "clean": "rimraf coverage dist .tmp **/dist",
     "release": "run-s build && changeset publish",
     "test": "run-s test:*",
     "test:lint": "rimraf .eslintcache && eslint packages tests",
@@ -57,42 +57,42 @@
   },
   "devDependencies": {
     "@changesets/cli": "^2.28.1",
-    "@tsconfig/node20": "^20.1.4",
+    "@tsconfig/node20": "^20.1.5",
     "@types/eslint": "^9.6.1",
     "@types/inquirer": "^9.0.7",
     "@types/jsdom": "~21.1.7",
     "@types/node": "^22",
     "@types/xml2js": "~0.4.14",
-    "@typescript-eslint/eslint-plugin": "^8.24.0",
-    "@typescript-eslint/parser": "^8.28.0",
-    "@typescript-eslint/utils": "^8.28.0",
-    "@vitest/coverage-v8": "^3.0.8",
-    "@vitest/ui": "^3.0.8",
-    "@wdio/appium-service": "^9.12.2",
-    "@wdio/cli": "^9.12.2",
-    "@wdio/globals": "^9.9.1",
-    "@wdio/local-runner": "^9.12.2",
-    "@wdio/mocha-framework": "^9.9.0",
-    "@wdio/sauce-service": "^9.12.2",
-    "@wdio/shared-store-service": "^9.12.2",
-    "@wdio/spec-reporter": "^9.12.2",
-    "@wdio/types": "^9.12.2",
+    "@typescript-eslint/eslint-plugin": "^8.29.0",
+    "@wdio/globals": "^9.12.4",
+    "@wdio/mocha-framework": "^9.12.3",
+    "@typescript-eslint/parser": "^8.29.0",
+    "@typescript-eslint/utils": "^8.29.0",
+    "@vitest/coverage-v8": "^3.1.1",
+    "@vitest/ui": "^3.1.1",
+    "@wdio/appium-service": "^9.12.4",
+    "@wdio/cli": "^9.12.4",
+    "@wdio/local-runner": "^9.12.4",
+    "@wdio/sauce-service": "^9.12.4",
+    "@wdio/shared-store-service": "^9.12.4",
+    "@wdio/spec-reporter": "^9.12.3",
+    "@wdio/types": "^9.12.3",
     "cross-env": "^7.0.3",
-    "eslint": "^9.23.0",
+    "eslint": "^9.24.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-unicorn": "^56.0.1",
     "eslint-plugin-wdio": "^9.9.1",
     "husky": "^9.1.7",
-    "jsdom": "^25.0.1",
+    "jsdom": "^26.0.0",
     "npm-run-all2": "^7.0.2",
-    "release-it": "^17.11.0",
+    "release-it": "^18.1.2",
     "rimraf": "^6.0.1",
-    "saucelabs": "^8.0.0",
+    "saucelabs": "^9.0.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.8",
-    "wdio-lambdatest-service": "^4.0.0",
-    "webdriverio": "^9.9.1"
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1",
+    "webdriverio": "^9.12.4",
+    "wdio-lambdatest-service": "^4.0.0"
   },
   "packageManager": "pnpm@9.15.9+sha256.cf86a7ad764406395d4286a6d09d730711720acc6d93e9dce9ac7ac4dc4a28a7"
 }

packages/ocr-service/package.json

@@ -28,11 +28,11 @@
     "watch": "pnpm run build:tsc -w"
   },
   "dependencies": {
-    "@wdio/globals": "^9.9.1",
+    "@wdio/globals": "^9.12.4",
     "@wdio/logger": "^9.4.4",
-    "@wdio/types": "^9.12.2",
+    "@wdio/types": "^9.12.3",
     "fuse.js": "^7.1.0",
-    "@inquirer/prompts": "7.3.2",
+    "@inquirer/prompts": "7.4.1",
     "jimp": "^1.6.0",
     "node-tesseract-ocr": "^2.2.1",
     "tesseract.js": "^5.1.1",
@@ -42,4 +42,4 @@
     "@types/inquirer": "~9.0.7",
     "@types/xml2js": "~0.4.14"
   }
-}
+}

packages/ocr-service/src/utils/getData.ts

@@ -1,7 +1,7 @@
 import logger from '@wdio/logger'
 import { getNodeOcrData, getSystemOcrData } from './tesseract.js'
 import type { GetOcrData, Line, GetData, GetDataOptions, RectReturn, Words } from '../types.js'
-import { adjustElementBbox, getScreenshotSize, isRectanglesObject } from './index.js'
+import { adjustElementBbox, getBase64ScreenshotSize, isRectanglesObject } from './index.js'
 import { drawHighlightedWords, processImage } from './imageProcessing.js'
 
 const log = logger('@wdio/ocr-service:getData')
@@ -22,7 +22,7 @@ export default async function getData(browser: WebdriverIO.Browser, options: Get
         if (!cliFile) {
             const screenSize = await browser.getWindowSize()
             screenshot = await browser.takeScreenshot()
-            const { width } = getScreenshotSize(screenshot)
+            const { width } = getBase64ScreenshotSize(screenshot)
             dpr = width / screenSize.width
         } else {
             screenshot = cliFile

packages/ocr-service/src/utils/index.ts

@@ -3,7 +3,7 @@ import { mkdirSync } from 'node:fs'
 import type { ChainablePromiseElement } from 'webdriverio'
 import type { ClickPoint, DetermineClickPointOptions, Rectangles, RectReturn, ScreenshotSize } from '../types.js'
 
-export function getScreenshotSize(screenshot: string): ScreenshotSize {
+export function getBase64ScreenshotSize(screenshot: string): ScreenshotSize {
     return {
         height: Math.round(Buffer.from(screenshot, 'base64').readUInt32BE(20)),
         width: Math.round(Buffer.from(screenshot, 'base64').readUInt32BE(16)),

packages/ocr-service/tests/utils/index.test.ts

@@ -1,6 +1,6 @@
 import { mkdirSync } from 'node:fs'
 import { describe, it, expect, vi } from 'vitest'
-import { adjustElementBbox, createOcrDir, determineClickPoint, getDprPositions, getScreenshotSize, isRectanglesObject } from '../../src/utils/index.js'
+import { adjustElementBbox, createOcrDir, determineClickPoint, getDprPositions, getBase64ScreenshotSize, isRectanglesObject } from '../../src/utils/index.js'
 import type { RectReturn } from '../../src/types.js'
 
 vi.mock('node:fs', () => ({
@@ -15,26 +15,26 @@ function createMockScreenshot(width: number, height: number): string {
     return buffer.toString('base64')
 }
 
-describe('getScreenshotSize', () => {
+describe('getBase64ScreenshotSize', () => {
     it('should correctly extract dimensions from a valid screenshot', () => {
         const width = 800
         const height = 600
         const base64 = createMockScreenshot(width, height)
-        const result = getScreenshotSize(base64)
+        const result = getBase64ScreenshotSize(base64)
 
         expect(result).toEqual({ width: width, height: height })
     })
 
     it('should handle invalid base64 strings gracefully', () => {
         const invalidBase64 = 'not-a-real-base64-string'
-        const action = () => getScreenshotSize(invalidBase64)
+        const action = () => getBase64ScreenshotSize(invalidBase64)
 
         expect(action).toThrowError()
     })
 
     it('should handle unexpected data layout', () => {
         const malformedBase64 = Buffer.from([1, 2, 3, 4, 5]).toString('base64')
-        const action = () => getScreenshotSize(malformedBase64)
+        const action = () => getBase64ScreenshotSize(malformedBase64)
 
         expect(action).toThrowError()
     })

packages/ocr-service/tests/utils/ocrGetData.test.ts

@@ -5,7 +5,7 @@ import { describe, it, expect, vi, beforeEach } from 'vitest'
 import getData from '../../src/utils/getData.js'
 import * as Tesseract from '../../src/utils/tesseract.js'
 import * as ImageProcessing from '../../src/utils/imageProcessing.js'
-import { adjustElementBbox, getScreenshotSize, isRectanglesObject } from '../../src/utils/index.js'
+import { adjustElementBbox, getBase64ScreenshotSize, isRectanglesObject } from '../../src/utils/index.js'
 
 const browser = wdioBrowser
 const log = logger('test')
@@ -15,7 +15,7 @@ vi.mock('../../src/utils/tesseract.js')
 vi.mock('../../src/utils/imageProcessing.js')
 vi.mock('../../src/utils/index.js')
 vi.mock('webdriver-image-comparison/dist/helpers/utils', () => ({
-    getScreenshotSize: vi.fn(() => ({ width: 1200 })),
+    getBase64ScreenshotSize: vi.fn(() => ({ width: 1200 })),
 }))
 vi.mock('../../src/utils/tesseract.js', () => ({
     getNodeOcrData: vi.fn().mockResolvedValue({
@@ -42,7 +42,7 @@ vi.mock('@wdio/globals', () => ({
         isAndroid: false,
         isIOS: false,
         getElementRect:vi.fn().mockResolvedValue({ x: 10, y: 20, width: 300, height: 400 }),
-        getScreenshotSize:vi.fn().mockReturnValue({ width: 1200 }),
+        getBase64ScreenshotSize:vi.fn().mockReturnValue({ width: 1200 }),
         getWindowSize: vi.fn().mockResolvedValue({ width: 1200, height: 800 }),
         takeScreenshot:vi.fn().mockResolvedValue('screenshotData'),
     }
@@ -61,13 +61,13 @@ describe('getData', () => {
             language: 'ENG',
             ocrImagesPath: '/fake/ocr/path'
         }
-        vi.mocked(getScreenshotSize).mockReturnValue({ height: 1200, width: 1200 })
+        vi.mocked(getBase64ScreenshotSize).mockReturnValue({ height: 1200, width: 1200 })
 
         const result = await getData(browser, options)
 
         expect(browser.getWindowSize).toHaveBeenCalled()
         expect(browser.takeScreenshot).toHaveBeenCalled()
-        expect(getScreenshotSize).toHaveBeenCalledWith('screenshotData')
+        expect(getBase64ScreenshotSize).toHaveBeenCalledWith('screenshotData')
         expect(isRectanglesObject).not.toHaveBeenCalled()
         expect(ImageProcessing.processImage).toHaveBeenCalledTimes(1)
         expect(Tesseract.getSystemOcrData).toHaveBeenCalledWith({
@@ -87,13 +87,13 @@ describe('getData', () => {
             language: 'ENG',
             ocrImagesPath: '/fake/ocr/path'
         }
-        vi.mocked(getScreenshotSize).mockReturnValue({ height: 1200, width: 1200 })
+        vi.mocked(getBase64ScreenshotSize).mockReturnValue({ height: 1200, width: 1200 })
 
         const result = await getData(browser, options)
 
         expect(browser.getWindowSize).toHaveBeenCalled()
         expect(browser.takeScreenshot).toHaveBeenCalled()
-        expect(getScreenshotSize).toHaveBeenCalledWith('screenshotData')
+        expect(getBase64ScreenshotSize).toHaveBeenCalledWith('screenshotData')
         expect(isRectanglesObject).not.toHaveBeenCalled()
         expect(ImageProcessing.processImage).toHaveBeenCalledTimes(1)
         expect(Tesseract.getNodeOcrData).toHaveBeenCalledWith({
@@ -114,13 +114,13 @@ describe('getData', () => {
             language: 'ENG',
             ocrImagesPath: '/fake/ocr/path'
         }
-        vi.mocked(getScreenshotSize).mockReturnValue({ height: 1200, width: 1200 })
+        vi.mocked(getBase64ScreenshotSize).mockReturnValue({ height: 1200, width: 1200 })
 
         const result = await getData(browser, options)
 
         expect(browser.getWindowSize).toHaveBeenCalled()
         expect(browser.takeScreenshot).toHaveBeenCalled()
-        expect(getScreenshotSize).toHaveBeenCalledWith('screenshotData')
+        expect(getBase64ScreenshotSize).toHaveBeenCalledWith('screenshotData')
         expect(isRectanglesObject).toHaveBeenCalledTimes(1)
         expect(ImageProcessing.processImage).toHaveBeenCalledTimes(2)
         expect(Tesseract.getSystemOcrData).toHaveBeenCalledWith({

packages/visual-reporter/package.json

@@ -29,39 +29,39 @@
     "watch:scripts": "npm run build:scripts --watch"
   },
   "dependencies": {
-    "@inquirer/prompts": "^7.3.2",
+    "@inquirer/prompts": "^7.4.1",
     "ora": "^8.2.0",
-    "sirv-cli": "^3.0.0",
-    "sharp": "^0.33.5"
+    "sirv-cli": "^3.0.1",
+    "sharp": "^0.34.0"
   },
   "devDependencies": {
-    "@remix-run/node": "^2.16.3",
-    "@remix-run/react": "^2.16.3",
-    "@remix-run/serve": "^2.16.3",
-    "@remix-run/dev": "^2.15.3",
-    "@types/react": "^18.3.18",
-    "@types/react-dom": "^18.3.5",
-    "@typescript-eslint/eslint-plugin": "^8.24.0",
-    "@typescript-eslint/parser": "^8.28.0",
+    "@remix-run/node": "^2.16.4",
+    "@remix-run/react": "^2.16.4",
+    "@remix-run/serve": "^2.16.4",
+    "@remix-run/dev": "^2.16.4",
+    "@types/react": "^18.3.20",
+    "@types/react-dom": "^18.3.6",
+    "@typescript-eslint/eslint-plugin": "^8.29.0",
+    "@typescript-eslint/parser": "^8.29.0",
     "autoprefixer": "^10.4.21",
-    "eslint": "^9.23.0",
-    "eslint-import-resolver-typescript": "^3.8.0",
+    "eslint": "^9.24.0",
+    "eslint-import-resolver-typescript": "^3.10.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-react": "^7.37.4",
+    "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
     "isbot": "^5.1.25",
     "postcss": "^8.5.3",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-icons": "^5.5.0",
-    "react-select": "^5.10.0",
+    "react-select": "^5.10.1",
     "tailwindcss": "^3.4.17",
-    "typescript": "^5.7.3",
-    "vite": "^5.4.15",
+    "typescript": "^5.8.3",
+    "vite": "^5.4.17",
     "vite-tsconfig-paths": "^5.1.4"
   },
   "engines": {
     "node": ">=20.0.0"
   }
-}
+}

packages/visual-service/package.json

@@ -26,9 +26,9 @@
     "watch": "pnpm run build:tsc -w"
   },
   "dependencies": {
-    "@wdio/globals": "^9.9.1",
+    "@wdio/globals": "^9.12.4",
     "@wdio/logger": "^9.4.4",
-    "@wdio/types": "^9.12.2",
+    "@wdio/types": "^9.12.3",
     "expect-webdriverio": "^5.1.0",
     "webdriver-image-comparison": "workspace:*"
   }

packages/visual-service/src/service.ts

@@ -172,12 +172,16 @@ export default class WdioImageComparisonService extends BaseClass {
      * Add commands to the "normal" browser object
      */
     async #addCommandsToBrowser(currentBrowser: WebdriverIO.Browser) {
-        const instanceData = await getInstanceData(currentBrowser)
         const isNativeContext = getNativeContext(
             this.#browser as WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser,
             currentBrowser,
             this._isNativeContext as NativeContextType
         )
+        const instanceData = await getInstanceData({
+            currentBrowser,
+            initialDeviceRectangles: this.deviceRectangles,
+            isNativeContext,
+        })
 
         for (const [commandName, command] of Object.entries(elementCommands)) {
             this.#addElementCommand(currentBrowser, commandName, command, instanceData, isNativeContext)
@@ -309,7 +313,11 @@ export default class WdioImageComparisonService extends BaseClass {
                         browserInstance,
                         self._isNativeContext as NativeContextType
                     )
-                    const instanceData = await getInstanceData(browserInstance)
+                    const instanceData = await getInstanceData({
+                        currentBrowser: browserInstance,
+                        initialDeviceRectangles: self.deviceRectangles,
+                        isNativeContext
+                    })
 
                     returnData[browserName] = await command(
                         {
@@ -369,7 +377,11 @@ export default class WdioImageComparisonService extends BaseClass {
                         browserInstance,
                         self._isNativeContext as NativeContextType
                         )
-                        const instanceData = await getInstanceData(browserInstance)
+                        const instanceData = await getInstanceData({
+                            currentBrowser: browserInstance,
+                            initialDeviceRectangles: self.deviceRectangles,
+                            isNativeContext
+                        })
 
                         returnData[browserName] = await command(
                             {