plop

Author: P-Courteille

packages/ocr-service/src/service.ts

@@ -62,7 +62,7 @@ export default class WdioOcrService {
         const self = this
         log.info(`Adding commands to Multi Browser: ${browserNames.join(', ')}`)
         /**
-         * Add all OCR commands to the global browser object that will execute
+         * Add all commands to the global browser object that will execute on each browser in the Multi Remote.
          */
         for (const commandName of Object.keys(ocrCommands)) {
             browser.addCommand(commandName, async function (...args: unknown[]) {
@@ -92,7 +92,7 @@ export default class WdioOcrService {
             })
         }
         /**
-         * Add all OCR commands to each instance (but Single Remote version)
+         * Add all commands to each instance (but Single Remote version)
          */
         for (const browserName of browserNames) {
             const multiremoteBrowser = browser as WebdriverIO.MultiRemoteBrowser

packages/visual-reporter/package.json

@@ -17,7 +17,7 @@
     "build": "run-s clean build:*",
     "build:report": "remix vite:build",
     "build:scripts": "tsc -p tsconfig.scripts.json",
-    "clean": "rimraf coverage build *.tsbuildinfo",
+    "clean": "rimraf coverage build --glob *.tsbuildinfo",
     "dev": "cross-env VISUAL_REPORT_LOCAL_DEV=true run-s build:scripts script:prepare.report && run-p watch:scripts dev:remix",
     "dev:remix": "remix vite:dev",
     "script:prepare.report": "node ./dist/prepareReportAssets.js",

packages/visual-service/src/service.ts

@@ -2,6 +2,7 @@ import logger from '@wdio/logger'
 import { expect } from '@wdio/globals'
 import { dirname, normalize, resolve } from 'node:path'
 import type { Capabilities, Frameworks } from '@wdio/types'
+import type { TransformElement } from 'webdriverio'
 import {
     BaseClass,
     checkElement,
@@ -142,7 +143,14 @@ export default class WdioImageComparisonService extends BaseClass {
         const browserNames = Object.keys(capabilities)
 
         /**
-         * Add all the commands to each browser in the Multi Remote
+         * Add all commands to the global browser object that will execute on each browser in the Multi Remote.
+         */
+        for (const [commandName, command] of Object.entries(pageCommands)) {
+            this.#addMultiremoteCommand(browser, browserNames, commandName, command)
+        }
+
+        /**
+         * Add all commands to each instance (but Single Remote version)
          */
         for (const browserName of browserNames) {
             log.info(`Adding commands to Multi Browser: ${browserName}`)
@@ -155,15 +163,6 @@ export default class WdioImageComparisonService extends BaseClass {
             await this.#addCommandsToBrowser(browserInstance)
         }
 
-        /**
-         * Add all the commands to the global browser object that will execute
-         * on each browser in the Multi Remote
-         * Start with the page commands
-         */
-        for (const [commandName, command] of Object.entries(pageCommands)) {
-            this.#addMultiremoteCommand(browser, browserNames, commandName, command)
-        }
-
         /**
          * Add all the element commands to the global browser object that will execute
          * on each browser in the Multi Remote
@@ -234,7 +233,7 @@ export default class WdioImageComparisonService extends BaseClass {
                             methods: {
                                 bidiScreenshot: isBiDiScreenshotSupported(browser) ? this.browsingContextCaptureScreenshot.bind(browser) : undefined,
                                 executor: <ReturnValue, InnerArguments extends unknown[]>(
-                                    fn: string | ((...args: InnerArguments) => ReturnValue),
+                                    fn: string | ((...innerArgs: TransformElement<InnerArguments>) => ReturnValue),
                                     ...args: InnerArguments
                                 ): Promise<ReturnValue> => {
                                     return this.execute(fn, ...args) as Promise<ReturnValue>
@@ -311,7 +310,7 @@ export default class WdioImageComparisonService extends BaseClass {
                             methods: {
                                 bidiScreenshot: isBiDiScreenshotSupported(browser) ? this.browsingContextCaptureScreenshot.bind(browser) : undefined,
                                 executor: <ReturnValue, InnerArguments extends unknown[]>(
-                                    fn: string | ((...args: InnerArguments) => ReturnValue),
+                                    fn: string | ((...innerArgs: TransformElement<InnerArguments>) => ReturnValue),
                                     ...args: InnerArguments
                                 ): Promise<ReturnValue> => {
                                     return this.execute(fn, ...args) as Promise<ReturnValue>
@@ -387,7 +386,7 @@ export default class WdioImageComparisonService extends BaseClass {
                                 methods: {
                                     bidiScreenshot: isBiDiScreenshotSupported(browserInstance) ? browserInstance.browsingContextCaptureScreenshot.bind(browserInstance) : undefined,
                                     executor: <ReturnValue, InnerArguments extends unknown[]>(
-                                        fn: string | ((...args: InnerArguments) => ReturnValue),
+                                        fn: string | ((...innerArgs: TransformElement<InnerArguments>) => ReturnValue),
                                         ...args: InnerArguments
                                     ): Promise<ReturnValue> => {
                                         return browserInstance.execute(fn, ...args) as Promise<ReturnValue>
@@ -480,7 +479,7 @@ export default class WdioImageComparisonService extends BaseClass {
                                 methods: {
                                     bidiScreenshot: isBiDiScreenshotSupported(browserInstance) ? browserInstance.browsingContextCaptureScreenshot.bind(browserInstance) : undefined,
                                     executor: <ReturnValue, InnerArguments extends unknown[]>(
-                                        fn: string | ((...args: InnerArguments) => ReturnValue),
+                                        fn: string | ((...innerArgs: TransformElement<InnerArguments>) => ReturnValue),
                                         ...args: InnerArguments
                                     ): Promise<ReturnValue> => {
                                         return browserInstance.execute(fn, ...args) as Promise<ReturnValue>

packages/visual-service/src/utils.ts

@@ -2,6 +2,7 @@ import type { Capabilities } from '@wdio/types'
 import type { AppiumCapabilities } from 'node_modules/@wdio/types/build/Capabilities.js'
 import { getMobileScreenSize, getMobileViewPortPosition, IOS_OFFSETS, NOT_KNOWN } from 'webdriver-image-comparison'
 import type { Folders, InstanceData, TestContext } from 'webdriver-image-comparison'
+import type { TransformElement, TransformReturn } from 'webdriverio'
 import type {
     EnrichTestContextOptions,
     getFolderMethodOptions,
@@ -70,8 +71,8 @@ async function getMobileInstanceData({
 
     if (isMobile) {
         const executor = <ReturnValue, InnerArguments extends unknown[]>(
-            fn: string | ((...args: InnerArguments) => ReturnValue),
-            ...args: InnerArguments) => currentBrowser.execute(fn, ...args) as Promise<ReturnValue>
+            fn: string | ((...innerArgs: TransformElement<InnerArguments>) => ReturnValue),
+            ...args: InnerArguments) => currentBrowser.execute(fn, ...args) as Promise<TransformReturn<ReturnValue>>
         const getUrl = () => currentBrowser.getUrl()
         const url = (arg:string) => currentBrowser.url(arg)
         const currentDriverCapabilities = currentBrowser.capabilities

packages/webdriver-image-comparison/src/methods/methods.interfaces.ts

@@ -1,15 +1,15 @@
 import type { RectanglesOutput } from './rectangles.interfaces.js'
-
+import type { TransformReturn, TransformElement } from 'webdriverio'
 // There a multiple ways to call the executor method, for mobile and web
-type ExecuteScript = <ReturnValue, Args extends unknown[]>(
-    fn: (...args: Args) => ReturnValue,
-    ...args: Args
-  ) => Promise<ReturnValue>;
+type ExecuteScript = <ReturnValue, InnerArguments extends unknown[]>(
+    fn: (...innerArgs: TransformElement<InnerArguments>) => ReturnValue,
+    ...args: InnerArguments
+  ) => Promise<TransformReturn<ReturnValue>>;
 
 type ExecuteMobile = <ReturnValue>(
     fn: string,
     args?: Record<string, any>
-) => Promise<ReturnValue>;
+) => Promise<TransformReturn<ReturnValue>>;
 interface BrowsingContextCaptureScreenshotParameters {
     context: string;
     origin?: 'viewport' | 'document';