feat: upgrade WebdriverIO to v9, drop JWP capabilities

web-padawan · web-padawan · commit 5fd629ec5843 · 2024-12-27T14:45:19.000+02:00
diff --git a/docs/docs/test-runner/browser-launchers/saucelabs.md b/docs/docs/test-runner/browser-launchers/saucelabs.md
@@ -68,12 +68,6 @@ export default {
       browserVersion: '11.0',
       platformName: 'Windows 7',
     }),
-
-    sauceLabsLauncher({
-      browserName: 'iphone',
-      platform: 'iPhone X Simulator',
-      version: '13.0',
-    }),
   ],
 };
 ```
@@ -141,24 +135,3 @@ export default {
   ],
 };
 ```
-
-### JWP Capabilities
-
-W3C webdriver capabilities are not yet fully implemented for Sauce Labs simulators. If you need to run the tests on iPhone Simulator, you need to use JWP capabilities.
-
-The following steps are required to use JWP capabilities with Sauce Labs launcher:
-
-- Use `version` instead of `browserVersion`,
-- Do not set a `sauce:options` property.
-
-```js
-export default {
-  browsers: [
-    sauceLabsLauncher({
-      browserName: 'iphone',
-      platform: 'iPhone X Simulator',
-      version: '13.0',
-    }),
-  ],
-};
-```
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/test-runner-commands/test/send-mouse/sendMousePlugin.test.ts b/packages/test-runner-commands/test/send-mouse/sendMousePlugin.test.ts
@@ -57,6 +57,8 @@ describe('sendMousePlugin', function test() {
         browsers: [
           webdriverLauncher({
             automationProtocol: 'webdriver',
+            hostname: 'localhost',
+            port: 4444,
             path: '/wd/hub/',
             capabilities: {
               browserName: 'chrome',
@@ -67,6 +69,8 @@ describe('sendMousePlugin', function test() {
           }),
           webdriverLauncher({
             automationProtocol: 'webdriver',
+            hostname: 'localhost',
+            port: 4444,
             path: '/wd/hub/',
             capabilities: {
               browserName: 'firefox',
diff --git a/packages/test-runner-saucelabs/package.json b/packages/test-runner-saucelabs/package.json
@@ -50,8 +50,8 @@
     "internal-ip": "^6.2.0",
     "nanoid": "^3.1.25",
     "saucelabs": "^7.2.0",
-    "webdriver": "^8.8.6",
-    "webdriverio": "^8.8.6"
+    "webdriver": "^9.0.0",
+    "webdriverio": "^9.0.0"
   },
   "devDependencies": {
     "@types/ip": "^1.1.0",
diff --git a/packages/test-runner-saucelabs/src/SauceLabsLauncher.ts b/packages/test-runner-saucelabs/src/SauceLabsLauncher.ts
@@ -1,5 +1,5 @@
 import { TestRunnerCoreConfig } from '@web/test-runner-core';
-import { RemoteOptions } from 'webdriverio';
+import { Capabilities } from '@wdio/types';
 import { WebdriverLauncher } from '@web/test-runner-webdriver';
 import internalIp from 'internal-ip';
 import { SauceLabsLauncherManager } from './SauceLabsLauncherManager.js';
@@ -13,7 +13,7 @@ export class SauceLabsLauncher extends WebdriverLauncher {
   constructor(
     private manager: SauceLabsLauncherManager,
     public name: string,
-    options: RemoteOptions,
+    options: Capabilities.WebdriverIOConfig,
   ) {
     super(options);
   }
diff --git a/packages/test-runner-saucelabs/src/createSauceLabsLauncher.ts b/packages/test-runner-saucelabs/src/createSauceLabsLauncher.ts
@@ -1,16 +1,13 @@
 import { BrowserLauncher } from '@web/test-runner-core';
 import { SauceLabsOptions, SauceConnectOptions } from 'saucelabs';
-import WebDriver from 'webdriver';
-import { RemoteOptions } from 'webdriverio';
-import { Options } from '@wdio/types';
+import { Capabilities, Options } from '@wdio/types';
 import { nanoid } from 'nanoid';
-
 import { SauceLabsLauncher } from './SauceLabsLauncher.js';
 import { SauceLabsLauncherManager } from './SauceLabsLauncherManager.js';
 
 export function createSauceLabsLauncher(
   saucelabsOptions: SauceLabsOptions,
-  saucelabsCapabilities?: WebDriver.DesiredCapabilities,
+  saucelabsCapabilities?: WebdriverIO.Capabilities,
   sauceConnectOptions?: SauceConnectOptions,
 ) {
   if (saucelabsOptions == null) {
@@ -36,51 +33,33 @@ export function createSauceLabsLauncher(
   }
   const manager = new SauceLabsLauncherManager(finalSauceLabsOptions, finalConnectOptions);
 
-  return function sauceLabsLauncher(capabilities: WebDriver.DesiredCapabilities): BrowserLauncher {
+  return function sauceLabsLauncher(capabilities: WebdriverIO.Capabilities): BrowserLauncher {
     if (capabilities == null) {
       throw new Error('Capabilities are required.');
     }
 
-    let finalCapabilities = { ...capabilities };
+    const finalCapabilities = { ...capabilities };
 
     const finalSauceCapabilities = {
       tunnelIdentifier: finalConnectOptions.tunnelIdentifier,
       ...saucelabsCapabilities,
     };
 
-    // W3C capabilities: only browserVersion is mandatory, platformName is optional.
-    // Note that setting 'sauce:options' forces Sauce Labs to use W3C capabilities.
-    if (capabilities.browserVersion) {
-      // version is not a valid W3C key.
-      delete finalCapabilities.version;
-
-      // platform is not a valid W3C key and will throw, use platformName instead.
-      if (capabilities.platform) {
-        finalCapabilities.platformName =
-          finalCapabilities.platformName || finalCapabilities.platform;
-        delete finalCapabilities.platform;
-      }
-
-      finalCapabilities['sauce:options'] = {
-        ...finalSauceCapabilities,
-        ...(finalCapabilities['sauce:options'] || {}),
-      };
-    } else {
-      // JWP capabilities for remote environments not yet supporting W3C.
-      // This enables running tests on iPhone Simulators in Sauce Labs.
-      finalCapabilities = { ...finalCapabilities, ...finalSauceCapabilities };
-    }
+    finalCapabilities['sauce:options'] = {
+      ...finalSauceCapabilities,
+      ...(finalCapabilities['sauce:options'] || {}),
+    };
 
     // Type cast to not fail on snake case syntax e.g. browser_version.
     const caps = finalCapabilities as Record<string, string>;
 
-    const browserName = caps.browserName ?? caps.browser ?? caps.device ?? 'unknown';
-    const browserVersion = caps.browserVersion ?? caps.version ?? caps.browser_version ?? '';
-    const platform = caps.platformName ?? caps.platform ?? '';
+    const browserName = caps.browserName ?? 'unknown';
+    const browserVersion = caps.browserVersion ?? '';
+    const platform = caps.platformName ?? '';
 
     const browserIdentifier = `${browserName}${browserVersion}${platform}`;
 
-    const options: RemoteOptions = {
+    const options: Capabilities.WebdriverIOConfig = {
       user: finalSauceLabsOptions.user,
       key: finalSauceLabsOptions.key,
       region: finalSauceLabsOptions.region as Options.SauceRegions,
diff --git a/packages/test-runner-webdriver/package.json b/packages/test-runner-webdriver/package.json
@@ -49,7 +49,7 @@
   ],
   "dependencies": {
     "@web/test-runner-core": "^0.13.0",
-    "webdriverio": "^8.8.6"
+    "webdriverio": "^9.0.0"
   },
   "devDependencies": {
     "@types/selenium-standalone": "^7.0.1",
diff --git a/packages/test-runner-webdriver/src/IFrameManager.ts b/packages/test-runner-webdriver/src/IFrameManager.ts
@@ -1,5 +1,5 @@
 import { TestRunnerCoreConfig } from '@web/test-runner-core';
-import { Browser, Element } from 'webdriverio';
+import { Browser } from 'webdriverio';
 import { validateBrowserResult } from './coverage.js';
 
 /**
@@ -169,9 +169,9 @@ export class IFrameManager {
 
     await this.driver.switchToFrame(frame);
 
-    const elementData = (await this.driver.execute(locator, [])) as Element;
+    const elementData = (await this.driver.execute(locator, [])) as WebdriverIO.Element;
 
-    const element = await this.driver.$(elementData);
+    const element = await this.driver.$(elementData).getElement();
 
     let base64 = '';
 
diff --git a/packages/test-runner-webdriver/src/SessionManager.ts b/packages/test-runner-webdriver/src/SessionManager.ts
@@ -1,5 +1,5 @@
 import { TestRunnerCoreConfig } from '@web/test-runner-core';
-import { Browser, Element } from 'webdriverio';
+import { Browser } from 'webdriverio';
 import { validateBrowserResult } from './coverage.js';
 
 /**
@@ -89,9 +89,9 @@ export class SessionManager {
   }
 
   async takeScreenshot(_: string, locator: string): Promise<Buffer> {
-    const elementData = (await this.driver.execute(locator, [])) as Element;
+    const elementData = (await this.driver.execute(locator, [])) as WebdriverIO.Element;
 
-    const element = await this.driver.$(elementData);
+    const element = await this.driver.$(elementData).getElement();
 
     let base64 = '';
 
diff --git a/packages/test-runner-webdriver/src/utils.ts b/packages/test-runner-webdriver/src/utils.ts
@@ -1,17 +1,15 @@
-import WebDriver from 'webdriver';
-
-function getPlatform(c: WebDriver.DesiredCapabilities): string | undefined {
-  return c.platformName || c.platform;
+function getPlatform(c: WebdriverIO.Capabilities): string | undefined {
+  return c.platformName;
 }
 
-export function getBrowserName(c: WebDriver.DesiredCapabilities): string | undefined {
+export function getBrowserName(c: WebdriverIO.Capabilities): string | undefined {
   return c.browserName;
 }
 
-function getBrowserVersion(c: WebDriver.DesiredCapabilities): string | undefined {
-  return c.browserVersion || c.version;
+function getBrowserVersion(c: WebdriverIO.Capabilities): string | undefined {
+  return c.browserVersion;
 }
 
-export function getBrowserLabel(c: WebDriver.DesiredCapabilities): string {
+export function getBrowserLabel(c: WebdriverIO.Capabilities): string {
   return [getPlatform(c), getBrowserName(c), getBrowserVersion(c)].filter(_ => _).join(' ');
 }
diff --git a/packages/test-runner-webdriver/src/webdriverLauncher.ts b/packages/test-runner-webdriver/src/webdriverLauncher.ts
@@ -1,5 +1,6 @@
 import { BrowserLauncher, TestRunnerCoreConfig } from '@web/test-runner-core';
-import { Browser, remote, RemoteOptions } from 'webdriverio';
+import { Browser, remote } from 'webdriverio';
+import { Capabilities } from '@wdio/types';
 import { IFrameManager } from './IFrameManager.js';
 import { SessionManager } from './SessionManager.js';
 import { getBrowserLabel } from './utils.js';
@@ -28,12 +29,12 @@ export class WebdriverLauncher implements BrowserLauncher {
   private isIE = false;
   private pendingHeartbeat?: ReturnType<typeof setInterval>;
 
-  constructor(private options: RemoteOptions) {}
+  constructor(private options: Capabilities.WebdriverIOConfig) {}
 
   async initialize(config: TestRunnerCoreConfig) {
     this.config = config;
 
-    const cap = this.options.capabilities as WebDriver.DesiredCapabilities;
+    const cap = this.options.capabilities as WebdriverIO.Capabilities;
     this.name = getBrowserLabel(cap);
     const browserName = cap.browserName?.toLowerCase().replace(/_/g, ' ') || '';
     this.isIE =
@@ -103,7 +104,7 @@ export class WebdriverLauncher implements BrowserLauncher {
 
   private async createDriverManager() {
     if (!this.config) throw new Error('Not initialized');
-    const options: RemoteOptions = { logLevel: 'error', ...this.options };
+    const options: Capabilities.WebdriverIOConfig = { logLevel: 'error', ...this.options };
 
     try {
       this.driver = (await remote(options)) as Browser;
@@ -237,7 +238,7 @@ export class WebdriverLauncher implements BrowserLauncher {
   }
 }
 
-export function webdriverLauncher(options: RemoteOptions) {
+export function webdriverLauncher(options: Capabilities.WebdriverIOConfig) {
   if (!options?.capabilities) {
     throw new Error(`Webdriver launcher requires a capabilities property.`);
   }
diff --git a/packages/test-runner-webdriver/test/webdriverLauncher.test.ts b/packages/test-runner-webdriver/test/webdriverLauncher.test.ts
@@ -53,6 +53,8 @@ describe('test-runner-webdriver', function testRunnerWebdriver() {
       browsers: [
         webdriverLauncher({
           automationProtocol: 'webdriver',
+          hostname: 'localhost',
+          port: 4444,
           path: '/wd/hub/',
           capabilities: {
             browserName: 'chrome',
@@ -63,6 +65,8 @@ describe('test-runner-webdriver', function testRunnerWebdriver() {
         }),
         webdriverLauncher({
           automationProtocol: 'webdriver',
+          hostname: 'localhost',
+          port: 4444,
           path: '/wd/hub/',
           capabilities: {
             browserName: 'firefox',

Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,15 @@`
`1`		`-import WebDriver from 'webdriver';`
`2`		`-`
`3`		`-function getPlatform(c: WebDriver.DesiredCapabilities): string \| undefined {`
`4`		`- return c.platformName \|\| c.platform;`
	`1`	`+function getPlatform(c: WebdriverIO.Capabilities): string \| undefined {`
	`2`	`+ return c.platformName;`
`5`	`3`	`}`
`6`	`4`
`7`		`-export function getBrowserName(c: WebDriver.DesiredCapabilities): string \| undefined {`
	`5`	`+export function getBrowserName(c: WebdriverIO.Capabilities): string \| undefined {`
`8`	`6`	`return c.browserName;`
`9`	`7`	`}`
`10`	`8`
`11`		`-function getBrowserVersion(c: WebDriver.DesiredCapabilities): string \| undefined {`
`12`		`- return c.browserVersion \|\| c.version;`
	`9`	`+function getBrowserVersion(c: WebdriverIO.Capabilities): string \| undefined {`
	`10`	`+ return c.browserVersion;`
`13`	`11`	`}`
`14`	`12`
`15`		`-export function getBrowserLabel(c: WebDriver.DesiredCapabilities): string {`
	`13`	`+export function getBrowserLabel(c: WebdriverIO.Capabilities): string {`
`16`	`14`	`return [getPlatform(c), getBrowserName(c), getBrowserVersion(c)].filter(_ => _).join(' ');`
`17`	`15`	`}`