@wdio/ocr-service 2.2.10 → 2.3.1

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # @wdio/ocr-service
 
+## 2.3.1
+
+### Patch Changes
+
+- 525a75a: chore: accept the WebdriverIO 10 releases instead of the 10.0.0 prereleases
+
+  The `@wdio/globals`, `@wdio/logger` and `@wdio/types` ranges change from `^9.29.1 || ^10.0.0-0` to `^9.29.1 || ^10.0.0`. WebdriverIO 10.0.0 is released, so the alpha versions are no longer accepted. WebdriverIO v9 (9.29.1 and later) is still supported.
+
+## 2.3.0
+
+### Minor Changes
+
+- c1a5b84: feat: support WebdriverIO v10 (keep WebdriverIO v9 support)
+
+  `@wdio/visual-service` and `@wdio/ocr-service` now run with WebdriverIO v10. WebdriverIO v9 (9.29.1 and later) is still supported. WebdriverIO v10 needs Node.js 22.19 or later.
+
+  **What changed**
+
+  - The `@wdio/globals`, `@wdio/logger` and `@wdio/types` dependencies accept v9 and v10.
+  - `expect-webdriverio` is no longer a dependency of `@wdio/visual-service`. The service uses only its `ExpectWebdriverIO` types, which your `@wdio/globals` gives. This removes a second `expect-webdriverio` copy and peer dependency warnings (for example with pnpm).
+  - Multiremote: the services read `isMultiRemote` (v10) and `isMultiremote` (v9). Before, a multiremote session on v10 did not get the visual and OCR commands.
+  - Multiremote mobile emulation is set on each instance with `instances` and `getInstance()`, which are available in v9 and v10.
+  - Multiremote: the commands of each instance (for example `browser.getInstance('chrome').checkScreen()`) use the context of that instance. Before, all instances used the context of the last instance, so with a web instance and a native app instance, the web check ran as a native app check and saved a `...-NaNxNaN.png` file.
+  - Chrome and Edge `mobileEmulation.deviceName` in a WebDriver BiDi session: in v10, `emulate('device')` can fail (for example `emulation.setTextLayoutModeOverride` is not supported by Chrome 154), and the service setup then stopped, so the visual matchers were missing. The service now sets the viewport and the device pixel ratio of the device that the browser emulates, so the screenshots keep the resolution of the device. In v9 nothing changes.
+  - Storybook: the loader uses `execute()` with an `async` function, because v10 removed `executeAsync()`. The clip selector uses `$(selector, { strict: false })`, because `$` is strict in v10.
+  - Element screenshots: the service gets the browser of an element whose parent is a v10 browsing context.
+  - Appium `mobile:` commands use `executeScript()`. In a WebDriver BiDi session (Appium 3, required by v10), `execute()` runs the script as page JavaScript.
+  - Jasmine: the visual matchers (`toMatchScreenSnapshot` and the others) now work with `framework: 'jasmine'`, in WebdriverIO v9 and v10. Before, they were never added, because the Jasmine `expect` has no `extend()`. The service now adds them as Jasmine async matchers.
+  - When the matchers cannot be added, the warning now gives the reason. Before, it always said "Expect package not found".
+  - When the service cannot add its commands (for example when a WebDriver command of its setup fails), the visual matchers are still added, the service logs the reason, and a matcher fails with `The visual service did not add the "checkScreen" command to this session`. Before, the only error was `expect(...).toMatchScreenSnapshot is not a function`.
+  - When an ignored element was not found, the error now shows the selector and the reason, for example `element "~button-LOGIN" could not be found: StrictSelectorError: ...`. Before, it showed the element as JSON.
+  - `ignore` elements: before the comparison, each element is found again in its own scope (the element or browsing context it was found from) and at its own index. Before, the service searched the whole page with the selector and took the elements in order, so an element of a filtered `$$().filter()` list, of a chained `$('form').$$('input')` query or of a frame could be replaced by another element with the same selector.
+
+  **Known limits**
+
+  - In a WebDriver BiDi session, an element screenshot of an element in a frame is not supported: with WebdriverIO v9 `switchFrame()` the image is moved by the position of the frame, and with v10 `context.frame()` the command fails. With WebDriver Classic (`'wdio:enforceWebDriverClassic': true`), it works with v9 and v10. See #1228.
+
+  **Upgrading to WebdriverIO v10**
+
+  - In WebdriverIO v10, `$()` throws a `StrictSelectorError` when the selector finds more than one element. This applies to elements in `ignore` and to `checkElement()` / `toMatchElementSnapshot()`. Use `$$()`, `$(selector, { strict: false })` or a more specific selector. `hideElements` and `removeElements` are not affected.
+
+  ### Committers: 1
+
+  - David Prevost ([@dprevost-LMI](https://github.com/dprevost-LMI))
+
 ## 2.2.10
 
 ### Patch Changes

package/dist/service.js

@@ -1,7 +1,7 @@
 import logger from '@wdio/logger';
 import { isSystemTesseractAvailable } from './utils/tesseract.js';
 import { CONTRAST, DEFAULT_IMAGES_FOLDER, SUPPORTED_LANGUAGES } from './utils/constants.js';
-import { createOcrDir } from './utils/index.js';
+import { createOcrDir, isMultiRemoteBrowser } from './utils/index.js';
 import ocrGetText from './commands/ocrGetText.js';
 import ocrGetElementPositionByText from './commands/ocrGetElementPositionByText.js';
 import ocrWaitForTextDisplayed from './commands/ocrWaitForTextDisplayed.js';
@@ -36,9 +36,9 @@ export default class WdioOcrService {
     }
     async before(capabilities, _specs, browser) {
         this._browser = browser;
-        if (!this._browser.isMultiremote) {
+        if (!isMultiRemoteBrowser(browser)) {
             log.info('Adding commands to global browser');
-            await this.#addCommandsToBrowser(this._browser);
+            await this.#addCommandsToBrowser(browser);
         }
         else {
             await this.#extendMultiremoteBrowser(capabilities);

package/dist/utils/index.d.ts

@@ -12,4 +12,8 @@ export declare function determineClickPoint(options: DetermineClickPointOptions)
 export declare function adjustElementBbox(bbox: Rectangles, elementRect: RectReturn): Rectangles;
 export declare function createOcrDir(imagesPath: string): string;
 export declare function isRectanglesObject(obj: WebdriverIO.Element | ChainablePromiseElement | RectReturn): boolean;
+/**
+ * WebdriverIO v10 renamed `isMultiremote` to `isMultiRemote`, check both so v9 and v10 are supported
+ */
+export declare function isMultiRemoteBrowser(browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser): browser is WebdriverIO.MultiRemoteBrowser;
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,0BAA0B,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,CAK1E;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAO3E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,0BAA0B,GAAG,UAAU,CAMnF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,UAAU,CAOvF;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAKvD;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,OAAO,GAAG,uBAAuB,GAAG,UAAU,GAAG,OAAO,CAM3G"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,0BAA0B,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,CAK1E;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAO3E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,0BAA0B,GAAG,UAAU,CAMnF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,UAAU,CAOvF;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAKvD;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,OAAO,GAAG,uBAAuB,GAAG,UAAU,GAAG,OAAO,CAM3G;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAChC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,GAC9D,OAAO,IAAI,WAAW,CAAC,kBAAkB,CAG3C"}

package/dist/utils/index.js

@@ -44,3 +44,10 @@ export function isRectanglesObject(obj) {
         typeof obj === 'object' &&
         properties.every(prop => typeof obj[prop] === 'number' && !isNaN(obj[prop]) && obj[prop] >= 0);
 }
+/**
+ * WebdriverIO v10 renamed `isMultiremote` to `isMultiRemote`, check both so v9 and v10 are supported
+ */
+export function isMultiRemoteBrowser(browser) {
+    const { isMultiRemote, isMultiremote } = browser;
+    return Boolean(isMultiRemote ?? isMultiremote);
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wdio/ocr-service",
   "author": "Wim Selles - wswebcreation",
   "description": "A WebdriverIO service that is using Tesseract OCR for Desktop/Mobile Web and Mobile Native App tests.",
-  "version": "2.2.10",
+  "version": "2.3.1",
   "license": "MIT",
   "homepage": "https://webdriver.io/docs/visual-testing",
   "repository": {
@@ -22,9 +22,9 @@
   "type": "module",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@wdio/globals": "^9.29.1",
-    "@wdio/logger": "^9.29.1",
-    "@wdio/types": "^9.29.1",
+    "@wdio/globals": "^9.29.1 || ^10.0.0",
+    "@wdio/logger": "^9.29.1 || ^10.0.0",
+    "@wdio/types": "^9.29.1 || ^10.0.0",
     "fuse.js": "^7.4.2",
     "@inquirer/prompts": "7.10.1",
     "jimp": "^1.6.1",