@wdio/utils 8.20.0 → 8.21.0

package/build/envDetector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"envDetector.d.ts","sourceRoot":"","sources":["../src/envDetector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAQ/C;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,mBAAmB,WAwCpE;AA4JD;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,YAAY,EAAE,WAAW,CAAC,YAAY,EAAE,kBAAkB,EAAE,MAAM;;;;;;;;EAIjH;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,EAAE,YAAY,EAAE,qBAAqB,EAAE,EAC9E;IAAE,YAAY,EAAE,YAAY,CAAC,gBAAgB,CAAC;IAAC,qBAAqB,EAAE,YAAY,CAAC,gBAAgB,CAAA;CAAE;;;;;;;;;;EAexG;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,EAAE,WAAW,EAAE,EAAE,WAAW,CAAC,YAAY;;;;;;;;;;;EAapF;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,YAAY,EAAE,WAAW,CAAC,YAAY;;;;;;;;EAUlF"}
+{"version":3,"file":"envDetector.d.ts","sourceRoot":"","sources":["../src/envDetector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAQ/C;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,mBAAmB,WAwCpE;AAwKD;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,YAAY,EAAE,WAAW,CAAC,YAAY,EAAE,kBAAkB,EAAE,MAAM;;;;;;;;EAIjH;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,EAAE,YAAY,EAAE,qBAAqB,EAAE,EAC9E;IAAE,YAAY,EAAE,YAAY,CAAC,gBAAgB,CAAC;IAAC,qBAAqB,EAAE,YAAY,CAAC,gBAAgB,CAAA;CAAE;;;;;;;;;;EAexG;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,EAAE,WAAW,EAAE,EAAE,WAAW,CAAC,YAAY;;;;;;;;;;;EAapF;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,YAAY,EAAE,WAAW,CAAC,YAAY;;;;;;;;EAUlF"}

package/build/envDetector.js

@@ -76,6 +76,8 @@ function isFirefox(capabilities) {
  */
 function isMobile(capabilities) {
     const browserName = (capabilities.browserName || '').toLowerCase();
+    const bsOptions = capabilities['bstack:options'] || {};
+    const browserstackBrowserName = (bsOptions.browserName || '').toLowerCase();
     /**
      * we have mobile capabilities if
      */
@@ -86,6 +88,9 @@ function isMobile(capabilities) {
     capabilities.platformName && capabilities.platformName.match(/ios/i) ||
         capabilities.platformName && capabilities.platformName.match(/tvos/i) ||
         capabilities.platformName && capabilities.platformName.match(/android/i) ||
+        /ios/i.test(bsOptions.platformName || '') ||
+        /tvos/i.test(bsOptions.platformName || '') ||
+        /android/i.test(bsOptions.platformName || '') ||
         /**
          * capabilities contain mobile only specific capabilities
          */
@@ -94,10 +99,12 @@ function isMobile(capabilities) {
          * browserName is empty (and eventually app is defined)
          */
         capabilities.browserName === '' ||
+        bsOptions.browserName === '' ||
         /**
          * browserName is a mobile browser
          */
-        MOBILE_BROWSER_NAMES.includes(browserName));
+        MOBILE_BROWSER_NAMES.includes(browserName) ||
+        MOBILE_BROWSER_NAMES.includes(browserstackBrowserName));
 }
 /**
  * check if session is run on iOS device
@@ -105,11 +112,14 @@ function isMobile(capabilities) {
  * @return {Boolean}               true if run on iOS device
  */
 function isIOS(capabilities) {
+    const bsOptions = capabilities?.['bstack:options'] || {};
     if (!capabilities) {
         return false;
     }
     return Boolean((capabilities.platformName && capabilities.platformName.match(/iOS/i)) ||
-        (capabilities.deviceName && capabilities.deviceName.match(/(iPad|iPhone)/i)));
+        (capabilities.deviceName && capabilities.deviceName.match(/(iPad|iPhone)/i)) ||
+        (/iOS/i.test(bsOptions.platformName || '')) ||
+        (/(iPad|iPhone)/i.test(bsOptions.deviceName || '')));
 }
 /**
  * check if session is run on Android device
@@ -117,10 +127,13 @@ function isIOS(capabilities) {
  * @return {Boolean}               true if run on Android device
  */
 function isAndroid(capabilities) {
+    const bsOptions = capabilities?.['bstack:options'] || {};
     if (!capabilities) {
         return false;
     }
     return Boolean((capabilities.platformName && capabilities.platformName.match(/Android/i)) ||
+        (/Android/i.test(bsOptions.platformName || '')) ||
+        (/Android/i.test(bsOptions.browserName || '')) ||
         (capabilities.browserName && capabilities.browserName.match(/Android/i)));
 }
 /**

package/build/node/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/node/utils.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAK1C;;;;GAIG;AACH,eAAO,MAAM,SAAS,UAAW,MAAM,YAWtC,CAAA;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,oBAAoB,YAYvD;AAED,wBAAgB,sBAAsB,CAAC,UAAU,CAAC,EAAE,MAAM,sBAqBzD;AAED,wBAAsB,uBAAuB,CAAC,WAAW,CAAC,EAAE,MAAM,+BAiBjE;AAGD,eAAO,MAAM,wBAAwB,aAAc,MAAM,mBAAmB,MAAM,cAAc,MAAM,SAOrG,CAAA;AAoBD,wBAAsB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,YAAY;;;;;;GA6E3F;AAED,wBAAgB,gBAAgB,CAAE,IAAI,EAAE,WAAW,CAAC,YAAY,oGAS/D;AAED,wBAAgB,WAAW,CAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,YAAY,UAGxG;AAED,wBAAgB,yBAAyB,CAAC,WAAW,EAAC,MAAM,UAM3D;AAED,wBAAsB,iBAAiB,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM;;GAgDhF;AAED,wBAAgB,gBAAgB,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,mBAEzE;AAED,wBAAgB,eAAe,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,mBAExE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/node/utils.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAK1C;;;;GAIG;AACH,eAAO,MAAM,SAAS,UAAW,MAAM,YAWtC,CAAA;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,oBAAoB,YAYvD;AAED,wBAAgB,sBAAsB,CAAC,UAAU,CAAC,EAAE,MAAM,sBAqBzD;AAED,wBAAsB,uBAAuB,CAAC,WAAW,CAAC,EAAE,MAAM,+BAiBjE;AAGD,eAAO,MAAM,wBAAwB,aAAc,MAAM,mBAAmB,MAAM,cAAc,MAAM,SAOrG,CAAA;AAwBD,wBAAsB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,YAAY;;;;;;GA2G3F;AAED,wBAAgB,gBAAgB,CAAE,IAAI,EAAE,WAAW,CAAC,YAAY,oGAS/D;AAED,wBAAgB,WAAW,CAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,YAAY,UAGxG;AAED,wBAAgB,yBAAyB,CAAC,WAAW,EAAC,MAAM,UAM3D;AAED,wBAAsB,iBAAiB,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM;;GAgDhF;AAED,wBAAgB,gBAAgB,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,mBAEzE;AAED,wBAAgB,eAAe,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,mBAExE"}

package/build/node/utils.js

@@ -8,7 +8,7 @@ import logger from '@wdio/logger';
 import { install, canDownload, resolveBuildId, detectBrowserPlatform, Browser, ChromeReleaseChannel, computeExecutablePath } from '@puppeteer/browsers';
 import { download as downloadGeckodriver } from 'geckodriver';
 import { download as downloadEdgedriver } from 'edgedriver';
-import { locateChrome, locateFirefox } from 'locate-app';
+import { locateChrome, locateFirefox, locateApp } from 'locate-app';
 const log = logger('webdriver');
 const EXCLUDED_PARAMS = ['version', 'help'];
 /**
@@ -102,24 +102,39 @@ const _install = async (args) => {
     await install(args);
     log.progress('');
 };
+function locateChromeSafely() {
+    return locateChrome().catch(() => undefined);
+}
 export async function setupPuppeteerBrowser(cacheDir, caps) {
     caps.browserName = caps.browserName?.toLowerCase();
-    const browserName = caps.browserName === Browser.FIREFOX ? Browser.FIREFOX : Browser.CHROME;
+    const browserName = caps.browserName === Browser.FIREFOX
+        ? Browser.FIREFOX
+        : caps.browserName === Browser.CHROMIUM
+            ? Browser.CHROMIUM
+            : Browser.CHROME;
     const exist = await fsp.access(cacheDir).then(() => true, () => false);
+    const isChromeOrChromium = browserName === Browser.CHROME || caps.browserName === Browser.CHROMIUM;
     if (!exist) {
         await fsp.mkdir(cacheDir, { recursive: true });
     }
+    /**
+     * in case we run Chromium tests we have to switch back to browserName: 'chrome'
+     * as 'chromium' is not recognised as a valid browser name by Chromedriver
+     */
+    if (browserName === Browser.CHROMIUM) {
+        caps.browserName = Browser.CHROME;
+    }
     /**
      * don't set up Chrome/Firefox if a binary was defined in caps
      */
-    const browserOptions = (browserName === Browser.CHROME
+    const browserOptions = (isChromeOrChromium
         ? caps['goog:chromeOptions']
         : caps['moz:firefoxOptions']) || {};
     if (typeof browserOptions.binary === 'string') {
         return {
             executablePath: browserOptions.binary,
             browserVersion: (caps.browserVersion ||
-                (browserName === Browser.CHROME
+                (isChromeOrChromium
                     ? getBuildIdByChromePath(browserOptions.binary)
                     : await getBuildIdByFirefoxPath(browserOptions.binary)))
         };
@@ -130,9 +145,15 @@ export async function setupPuppeteerBrowser(cacheDir, caps) {
     }
     if (!caps.browserVersion) {
         const executablePath = browserName === Browser.CHROME
-            ? await locateChrome().catch(() => undefined)
-            : await locateFirefox().catch(() => undefined);
-        const tag = browserName === Browser.CHROME
+            ? await locateChromeSafely()
+            : browserName === Browser.CHROMIUM
+                ? await locateApp({
+                    appName: Browser.CHROMIUM,
+                    macOsName: Browser.CHROMIUM,
+                    linuxWhich: 'chromium-browser'
+                }).catch(() => undefined)
+                : await locateFirefox().catch(() => undefined);
+        const tag = isChromeOrChromium
             ? getBuildIdByChromePath(executablePath)
             : await getBuildIdByFirefoxPath(executablePath);
         /**
@@ -167,7 +188,16 @@ export async function setupPuppeteerBrowser(cacheDir, caps) {
     log.info(`Setting up ${browserName} v${buildId}`);
     await _install(installOptions);
     const executablePath = computeExecutablePath(installOptions);
-    return { executablePath, browserVersion: buildId };
+    /**
+     * for Chromium browser `resolveBuildId` returns with a useless build id
+     * which will not find a Chromedriver, therefor we need to resolve the
+     * id using Chrome as browser name
+     */
+    let browserVersion = buildId;
+    if (browserName === Browser.CHROMIUM) {
+        browserVersion = await resolveBuildId(Browser.CHROME, platform, tag);
+    }
+    return { executablePath, browserVersion };
 }
 export function getDriverOptions(caps) {
     return (caps['wdio:chromedriverOptions'] ||
@@ -193,7 +223,7 @@ export async function setupChromedriver(cacheDir, driverVersion) {
     if (!platform) {
         throw new Error('The current platform is not supported.');
     }
-    const version = driverVersion || getBuildIdByChromePath(await locateChrome()) || ChromeReleaseChannel.STABLE;
+    const version = driverVersion || getBuildIdByChromePath(await locateChromeSafely()) || ChromeReleaseChannel.STABLE;
     const buildId = await resolveBuildId(Browser.CHROMEDRIVER, platform, version);
     let executablePath = computeExecutablePath({
         browser: Browser.CHROMEDRIVER,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/utils",
-  "version": "8.20.0",
+  "version": "8.21.0",
   "description": "A WDIO helper utility to provide several utility functions used across the project.",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-utils",
@@ -39,7 +39,7 @@
   "dependencies": {
     "@puppeteer/browsers": "^1.6.0",
     "@wdio/logger": "8.16.17",
-    "@wdio/types": "8.20.0",
+    "@wdio/types": "8.21.0",
     "decamelize": "^6.0.0",
     "deepmerge-ts": "^5.1.0",
     "edgedriver": "^5.3.5",
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6aa9e33233a6abc832bb16d2e24aaaa382e206b6"
+  "gitHead": "92a7474463e872223ee26c99112e79ad7d8eb8d3"
 }