appium-chromedriver 4.26.2 → 4.27.1

package/lib/storage-client.js

@@ -1,4 +1,7 @@
-import { getChromedriverDir, CD_CDN, retrieveData } from './utils';
+import {
+  getChromedriverDir, CD_CDN, retrieveData, getOsInfo,
+  OS, X64, X86, M1_ARCH_SUFFIX,
+} from './utils';
 import _ from 'lodash';
 import xpath from 'xpath';
 import { DOMParser } from 'xmldom';
@@ -13,19 +16,6 @@ const MAX_PARALLEL_DOWNLOADS = 5;
 const log = logger.getLogger('ChromedriverStorageClient');
 
 
-async function getOsInfo () {
-  let name = 'linux';
-  if (system.isWindows()) {
-    name = 'win';
-  } else if (system.isMac()) {
-    name = 'mac';
-  }
-  return {
-    name,
-    arch: await system.arch(),
-  };
-}
-
 async function isCrcOk (src, checksum) {
   const md5 = await fs.hash(src, 'md5');
   return _.toLower(md5) === _.toLower(checksum);
@@ -154,7 +144,6 @@ class ChromedriverStorageClient {
         continue;
       }
 
-      log.debug(`Processing chromedriver entry '${key}'`);
       const etag = extractNodeText(findChildNode(driverNode, 'ETag'));
       if (!etag) {
         log.debug(`The entry '${key}' does not contain the checksum. Skipping it`);
@@ -254,6 +243,8 @@ class ChromedriverStorageClient {
    * Can be either `mac`, `windows` or `linux`
    * @property {string} arch - The architecture of the host OD.
    * Can be either `32` or `64`
+   * @property {?string} hardwareName - The output of `uname -m` command
+   * on linux and mac systems. `null` on Windows
    */
 
   /**
@@ -261,7 +252,7 @@ class ChromedriverStorageClient {
    * chromedriver entries by operating system information
    * and/or additional synchronization options (if provided)
    *
-   * @param {OSInfo} osInfo
+   * @param {?OSInfo} osInfo
    * @param {?SyncOptions} opts
    * @returns {Array<String>} The list of filtered chromedriver
    * entry names (version/archive name)
@@ -312,13 +303,19 @@ class ChromedriverStorageClient {
 
     if (!_.isEmpty(osInfo)) {
       // Filter out drivers for unsupported system architectures
-      let {name, arch} = osInfo;
-      if (arch === '64' && !driversToSync.some((cdName) => cdName.includes(`_${name}64`))) {
+      let {name, arch, hardwareName} = osInfo;
+      if (arch === X64 && !driversToSync.some((cdName) => cdName.includes(`_${name}${X64}`))) {
         // Fall back to x86 build if x64 one is not available for the given OS
-        arch = '32';
+        arch = X86;
+      }
+      if (name === OS.mac && _.includes(hardwareName, 'arm')
+          && driversToSync.some((cdName) => cdName.includes(M1_ARCH_SUFFIX))) {
+        // prefer executable for M1 arch if present
+        arch += M1_ARCH_SUFFIX;
       }
       log.debug(`Selecting chromedrivers whose platform matches to ${name}${arch}`);
-      driversToSync = driversToSync.filter((cdName) => cdName.includes(`_${name}${arch}`));
+      const platformRe = new RegExp(`(\\b|_)${name}${arch}\\b`);
+      driversToSync = driversToSync.filter((cdName) => platformRe.test(cdName));
       log.debug(`Got ${util.pluralize('item', driversToSync.length, true)}`);
     }
 
@@ -390,6 +387,9 @@ class ChromedriverStorageClient {
    * @property {string|number} minBrowserVersion - The minumum supported
    * Chrome version that downloaded chromedrivers should support. Can match
    * multiple drivers.
+   * @property {?OSInfo} osInfo - System information used to filter out
+   * the list of the retrieved drivers. If not provided then the script
+   * will try to retrieve it.
    */
 
   /**
@@ -409,7 +409,7 @@ class ChromedriverStorageClient {
       throw new Error('Cannot retrieve chromedrivers mapping from Google storage');
     }
 
-    const driversToSync = this.selectMatchingDrivers(await getOsInfo(), opts);
+    const driversToSync = this.selectMatchingDrivers(opts.osInfo ?? await getOsInfo(), opts);
     if (_.isEmpty(driversToSync)) {
       log.debug(`There are no drivers to sync. Exiting`);
       return [];

package/lib/utils.js

@@ -1,9 +1,9 @@
 import _ from 'lodash';
-import { system } from 'appium-support';
+import { system, fs } from 'appium-support';
 import path from 'path';
-import semver from 'semver';
 import compareVersions from 'compare-versions';
 import axios from 'axios';
+import { exec } from 'teen_process';
 
 
 const rootDir = path.basename(__dirname) === 'lib'
@@ -19,9 +19,15 @@ const CD_BASE_DIR = path.resolve(__dirname, '..', '..', 'chromedriver');
 const CD_CDN = process.env.npm_config_chromedriver_cdnurl
   || process.env.CHROMEDRIVER_CDNURL
   || 'https://chromedriver.storage.googleapis.com';
-
-const MAC_32_ONLY = '2.23.0';
-const LINUX_32_ONLY = '2.34.0';
+const OS = {
+  linux: 'linux',
+  windows: 'win',
+  mac: 'mac'
+};
+const X64 = '64';
+const X86 = '32';
+const M1_ARCH_SUFFIX = '_m1';
+const CD_EXECUTABLE_PREFIX = 'chromedriver';
 
 
 function getMostRecentChromedriver (mapping = CHROMEDRIVER_CHROME_MAPPING) {
@@ -36,39 +42,23 @@ async function getChromeVersion (adb, bundleId) {
   return versionName;
 }
 
-function getChromedriverDir (platform = getCurPlatform()) {
-  return path.resolve(CD_BASE_DIR, platform);
+function getChromedriverDir (osName = getOsName()) {
+  return path.resolve(CD_BASE_DIR, osName);
 }
 
-async function getChromedriverBinaryPath (platform = getCurPlatform(), arch = null) {
-  const baseDir = getChromedriverDir(platform);
-  let ext = '';
-  if (platform === 'win') {
-    ext = '.exe';
-  } else if (platform === 'linux') {
-    ext = `_${arch || await system.arch()}`;
-  }
-
-  return path.resolve(baseDir, `chromedriver${ext}`);
-}
-
-function getCurPlatform () {
-  return system.isWindows() ? 'win' : (system.isMac() ? 'mac' : 'linux');
-}
-
-function getPlatforms () {
-  let plats = [
-    ['win', '32'],
-    ['linux', '64'],
-  ];
-  const cdVer = semver.coerce(CD_VER);
-  // before 2.23 Mac version was 32 bit. After it is 64.
-  plats.push(semver.lt(cdVer, MAC_32_ONLY) ? ['mac', '32'] : ['mac', '64']);
-  // 2.34 and above linux is only supporting 64 bit
-  if (semver.lt(cdVer, LINUX_32_ONLY)) {
-    plats.push(['linux', '32']);
-  }
-  return plats;
+async function getChromedriverBinaryPath (osName = getOsName()) {
+  const rootDir = getChromedriverDir(osName);
+  const pathSuffix = osName === OS.windows ? '.exe' : '';
+  const paths = await fs.glob(`${CD_EXECUTABLE_PREFIX}*${pathSuffix}`, {
+    cwd: rootDir,
+    absolute: true,
+    nocase: true,
+    nodir: true,
+    strict: false,
+  });
+  return _.isEmpty(paths)
+    ? path.resolve(rootDir, `${CD_EXECUTABLE_PREFIX}${pathSuffix}`)
+    : _.first(paths);
 }
 
 async function retrieveData (url, headers, opts = {}) {
@@ -84,10 +74,27 @@ async function retrieveData (url, headers, opts = {}) {
   })).data;
 }
 
+const getOsName = _.memoize(function getOsName () {
+  if (system.isWindows()) {
+    return OS.windows;
+  }
+  if (system.isMac()) {
+    return OS.mac;
+  }
+  return OS.linux;
+});
+
+const getOsInfo = _.memoize(async function getOsInfo () {
+  return {
+    name: getOsName(),
+    arch: await system.arch(),
+    hardwareName: system.isWindows() ? null : _.trim(await exec('uname', ['-m'])),
+  };
+});
+
 
 export {
-  getChromeVersion, getChromedriverDir, getChromedriverBinaryPath,
-  getCurPlatform, getPlatforms, CD_BASE_DIR, MAC_32_ONLY, LINUX_32_ONLY,
-  CD_CDN, CD_VER, CHROMEDRIVER_CHROME_MAPPING, getMostRecentChromedriver,
-  retrieveData,
+  getChromeVersion, getChromedriverDir, getChromedriverBinaryPath, getOsName,
+  CD_BASE_DIR, CD_CDN, CD_VER, CHROMEDRIVER_CHROME_MAPPING, getMostRecentChromedriver,
+  retrieveData, getOsInfo, OS, X64, X86, M1_ARCH_SUFFIX,
 };

package/package.json

@@ -6,7 +6,7 @@
     "chrome",
     "android"
   ],
-  "version": "4.26.2",
+  "version": "4.27.1",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -39,16 +39,16 @@
     "appium-base-driver": "^7.1.0",
     "appium-support": "^2.46.0",
     "asyncbox": "^2.0.2",
-    "axios": "^0.21.0",
+    "axios": "^0.x",
     "bluebird": "^3.5.1",
     "compare-versions": "^3.4.0",
     "fancy-log": "^1.3.2",
     "lodash": "^4.17.4",
     "semver": "^7.0.0",
-    "source-map-support": "^0.5.5",
+    "source-map-support": "^0.x",
     "teen_process": "^1.15.0",
-    "xmldom": "^0.4.0",
-    "xpath": "^0.0.32"
+    "xmldom": "^0.x",
+    "xpath": "^0.x"
   },
   "pre-commit": [
     "precommit-msg",
@@ -78,6 +78,6 @@
     "gulp": "^4.0.0",
     "mocha": "^8.0.1",
     "pre-commit": "^1.1.3",
-    "sinon": "^9.0.0"
+    "sinon": "^10.0.0"
   }
 }