appium-chromedriver 8.1.0 → 8.2.0

package/lib/{constants.js → constants.ts}

@@ -12,13 +12,14 @@ export const OS = {
   LINUX: 'linux',
   WINDOWS: 'win',
   MAC: 'mac',
-};
+} as const;
 export const ARCH = {
   X64: '64',
   X86: '32',
-};
+} as const;
 export const CPU = {
   INTEL: 'intel',
   ARM: 'arm',
-};
-export const APPLE_ARM_SUFFIXES = ['64_m1', '_arm64'];
+} as const;
+export const APPLE_ARM_SUFFIXES = ['64_m1', '_arm64'] as const;
+

package/lib/protocol-helpers.ts

@@ -0,0 +1,44 @@
+import _ from 'lodash';
+import {isStandardCap} from '@appium/base-driver';
+
+const W3C_PREFIX = 'goog:';
+
+/**
+ * Converts a capability name to W3C format by adding the 'goog:' prefix if needed.
+ * @param capName - The capability name to convert.
+ * @returns The W3C-formatted capability name.
+ */
+export function toW3cCapName(capName: string): string {
+  return (_.isString(capName) && !capName.includes(':') && !isStandardCap(capName))
+    ? `${W3C_PREFIX}${capName}`
+    : capName;
+}
+
+/**
+ * Gets a capability value from a capabilities object, handling both standard and W3C format names.
+ * @param allCaps - The capabilities object to search in.
+ * @param rawCapName - The capability name to look for (can be in either format).
+ * @param defaultValue - Optional default value to return if the capability is not found.
+ * @returns The capability value or the default value.
+ */
+export function getCapValue(allCaps: Record<string, any> = {}, rawCapName: string, defaultValue?: any): any {
+  for (const [capName, capValue] of _.toPairs(allCaps)) {
+    if (toW3cCapName(capName) === toW3cCapName(rawCapName)) {
+      return capValue;
+    }
+  }
+  return defaultValue;
+}
+
+/**
+ * Converts all capability names in an object to W3C format.
+ * @param originalCaps - The original capabilities object.
+ * @returns A new object with W3C-formatted capability names.
+ */
+export function toW3cCapNames(originalCaps: Record<string, any> = {}): Record<string, any> {
+  return _.reduce(originalCaps, (acc, value, key) => {
+    acc[toW3cCapName(key)] = value;
+    return acc;
+  }, {} as Record<string, any>);
+}
+

package/lib/utils.ts

@@ -0,0 +1,185 @@
+import _ from 'lodash';
+import {system, fs, node} from '@appium/support';
+import {BaseDriver} from '@appium/base-driver';
+import path from 'path';
+import {compareVersions} from 'compare-versions';
+import axios from 'axios';
+import os from 'os';
+import {OS, CPU} from './constants';
+import type {ADB} from 'appium-adb';
+import type {ChromedriverVersionMapping, OSInfo} from './types';
+
+const CD_EXECUTABLE_PREFIX = 'chromedriver';
+const MODULE_NAME = 'appium-chromedriver';
+
+/**
+ * Calculates the path to the current module's root folder
+ * @returns The full path to module root
+ * @throws {Error} If the current module root folder cannot be determined
+ */
+const getModuleRoot = _.memoize(function getModuleRoot(): string {
+  const root = node.getModuleRootSync(MODULE_NAME, __filename);
+  if (!root) {
+    throw new Error(`Cannot find the root folder of the ${MODULE_NAME} Node.js module`);
+  }
+  return root;
+});
+
+// Chromedriver version: minimum Chrome version
+export const CHROMEDRIVER_CHROME_MAPPING: ChromedriverVersionMapping = require(path.join(
+  getModuleRoot(),
+  'config',
+  'mapping.json'
+));
+export const CD_BASE_DIR = path.join(getModuleRoot(), 'chromedriver');
+
+/**
+ * Gets the most recent Chromedriver version from the mapping.
+ * @param mapping - The Chromedriver version mapping (defaults to the static mapping).
+ * @returns The most recent version string.
+ * @throws {Error} If the mapping is empty.
+ */
+export function getMostRecentChromedriver(mapping: ChromedriverVersionMapping = CHROMEDRIVER_CHROME_MAPPING): string {
+  if (_.isEmpty(mapping)) {
+    throw new Error('Unable to get most recent Chromedriver version from empty mapping');
+  }
+  return _.last(_.keys(mapping).sort(compareVersions)) as string;
+}
+
+export const CD_VER: string =
+  process.env.npm_config_chromedriver_version ||
+  process.env.CHROMEDRIVER_VERSION ||
+  getMostRecentChromedriver();
+
+/**
+ * Gets the Chrome version for a given bundle ID using ADB.
+ * @param adb - The ADB instance to use.
+ * @param bundleId - The bundle ID of the Chrome/WebView app.
+ * @returns The version name string, or undefined if not found.
+ */
+export async function getChromeVersion(adb: ADB, bundleId: string): Promise<string | undefined> {
+  const {versionName} = await adb.getPackageInfo(bundleId);
+  return versionName;
+}
+
+/**
+ * Gets the directory path for Chromedriver executables for a given OS.
+ * @param osName - The OS name (defaults to the current OS).
+ * @returns The full path to the Chromedriver directory.
+ */
+export function getChromedriverDir(osName: string = getOsName()): string {
+  return path.resolve(CD_BASE_DIR, osName);
+}
+
+/**
+ * Gets the path to the Chromedriver binary for a given OS.
+ * @param osName - The OS name (defaults to the current OS).
+ * @returns The full path to the Chromedriver binary.
+ */
+export async function getChromedriverBinaryPath(osName: string = getOsName()): Promise<string> {
+  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,
+  });
+  return _.isEmpty(paths)
+    ? path.resolve(rootDir, `${CD_EXECUTABLE_PREFIX}${pathSuffix}`)
+    : (_.first(paths) as string);
+}
+
+/**
+ * Retrieves data from a URL using axios.
+ * @param url - The URL to fetch from.
+ * @param headers - Optional HTTP headers.
+ * @param opts - Optional configuration (timeout, responseType).
+ * @returns The response data.
+ */
+export async function retrieveData(
+  url: string,
+  headers?: import('axios').AxiosRequestConfig['headers'],
+  opts: Pick<import('axios').AxiosRequestConfig, 'timeout' | 'responseType'> = {}
+): Promise<any> {
+  const {timeout = 5000, responseType = 'text'} = opts;
+  return (
+    await axios({
+      url,
+      headers,
+      timeout,
+      responseType,
+    })
+  ).data;
+}
+
+/**
+ * Gets the OS name for the current system.
+ * @returns The OS name ('win', 'mac', or 'linux').
+ */
+export const getOsName = _.memoize(function getOsName(): typeof OS[keyof typeof OS] {
+  if (system.isWindows()) {
+    return OS.WINDOWS;
+  }
+  if (system.isMac()) {
+    return OS.MAC;
+  }
+  return OS.LINUX;
+});
+
+/**
+ * Gets the CPU type for the current system.
+ * @returns The CPU type ('intel' or 'arm').
+ */
+export const getCpuType = _.memoize(function getCpuType(): typeof CPU[keyof typeof CPU] {
+  return _.includes(_.toLower(os.cpus()[0].model), 'apple') ? CPU.ARM : CPU.INTEL;
+});
+
+/**
+ * Gets OS information including name, architecture, and CPU type.
+ * @returns A promise that resolves to OS information.
+ */
+export const getOsInfo = _.memoize(async function getOsInfo(): Promise<OSInfo> {
+  return {
+    name: getOsName(),
+    arch: String(await system.arch()),
+    cpu: getCpuType(),
+  };
+});
+
+// @ts-expect-error to avoid error
+// TS2345: Argument of type '{}' is not assignable to parameter of type 'DriverOpts<Readonly<Record<string, Constraint>>>'
+// Type '{}' is missing the following properties from type 'ServerArgs': address, allowCors, allowInsecure, basePath, and 26 more.
+const getBaseDriverInstance = _.memoize(() => new BaseDriver({}, false));
+
+/**
+ * Generates log prefix string.
+ * @param obj - Log owner instance.
+ * @param sessionId - Optional session identifier.
+ * @returns The generated log prefix string.
+ */
+export function generateLogPrefix(obj: any, sessionId: string | null = null): string {
+  return getBaseDriverInstance().helpers.generateDriverLogPrefix(
+    obj,
+    sessionId ? sessionId : undefined
+  );
+}
+
+/**
+ * Converts the given object to an integer number if possible.
+ * @param value - The value to be converted.
+ * @returns The integer value or null if conversion is not possible.
+ */
+export function convertToInt(value: any): number | null {
+  switch (typeof value) {
+    case 'number':
+      return Number.isNaN(value) ? null : value;
+    case 'string': {
+      const parsedAsInt = parseInt(value, 10);
+      return Number.isNaN(parsedAsInt) ? null : parsedAsInt;
+    }
+    default:
+      return null;
+  }
+}
+

package/package.json

@@ -6,7 +6,7 @@
     "chrome",
     "android"
   ],
-  "version": "8.1.0",
+  "version": "8.2.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -73,6 +73,7 @@
     "@types/bluebird": "^3.5.38",
     "@types/chai": "^5.2.3",
     "@types/chai-as-promised": "^8.0.2",
+    "@types/express": "^5.0.6",
     "@types/lodash": "^4.14.191",
     "@types/mocha": "^10.0.1",
     "@types/node": "^25.0.0",

package/lib/protocol-helpers.js

@@ -1,44 +0,0 @@
-import _ from 'lodash';
-import { isStandardCap } from '@appium/base-driver';
-
-const W3C_PREFIX = 'goog:';
-
-/**
- *
- * @param {string} capName
- */
-export function toW3cCapName (capName) {
-  return (_.isString(capName) && !capName.includes(':') && !isStandardCap(capName))
-    ? `${W3C_PREFIX}${capName}`
-    : capName;
-}
-
-/**
- *
- * @param {Record<string,any>} allCaps
- * @param {string} rawCapName
- * @param {any} [defaultValue]
- * @returns {any}
- */
-function getCapValue (allCaps = {}, rawCapName, defaultValue) {
-  for (const [capName, capValue] of _.toPairs(allCaps)) {
-    if (toW3cCapName(capName) === toW3cCapName(rawCapName)) {
-      return capValue;
-    }
-  }
-  return defaultValue;
-}
-
-/**
- *
- * @param {any} originalCaps
- * @returns {Record<string,any>}
- */
-function toW3cCapNames (originalCaps = {}) {
-  return _.reduce(originalCaps, (acc, value, key) => {
-    acc[toW3cCapName(key)] = value;
-    return acc;
-  }, /** @type {Record<string,any>} */({}));
-}
-
-export { toW3cCapNames, getCapValue };

package/lib/utils.js

@@ -1,189 +0,0 @@
-import _ from 'lodash';
-import {system, fs, node} from '@appium/support';
-import {BaseDriver} from '@appium/base-driver';
-import path from 'path';
-import {compareVersions} from 'compare-versions';
-import axios from 'axios';
-import os from 'os';
-import {OS, CPU} from './constants';
-
-const CD_EXECUTABLE_PREFIX = 'chromedriver';
-const MODULE_NAME = 'appium-chromedriver';
-
-/**
- * Calculates the path to the current module's root folder
- *
- * @returns {string} The full path to module root
- * @throws {Error} If the current module root folder cannot be determined
- */
-const getModuleRoot = _.memoize(function getModuleRoot() {
-  const root = node.getModuleRootSync(MODULE_NAME, __filename);
-  if (!root) {
-    throw new Error(`Cannot find the root folder of the ${MODULE_NAME} Node.js module`);
-  }
-  return root;
-});
-
-// Chromedriver version: minimum Chrome version
-const CHROMEDRIVER_CHROME_MAPPING = require(path.join(getModuleRoot(), 'config', 'mapping.json'));
-const CD_BASE_DIR = path.join(getModuleRoot(), 'chromedriver');
-
-/**
- *
- * @param {import('./types').ChromedriverVersionMapping} mapping
- * @returns {string}
- */
-function getMostRecentChromedriver(mapping = CHROMEDRIVER_CHROME_MAPPING) {
-  if (_.isEmpty(mapping)) {
-    throw new Error('Unable to get most recent Chromedriver version from empty mapping');
-  }
-  return /** @type {string} */ (_.last(_.keys(mapping).sort(compareVersions)));
-}
-
-const CD_VER =
-  process.env.npm_config_chromedriver_version ||
-  process.env.CHROMEDRIVER_VERSION ||
-  getMostRecentChromedriver();
-
-/**
- *
- * @param {import('appium-adb').ADB} adb
- * @param {string} bundleId
- * @returns
- */
-async function getChromeVersion(adb, bundleId) {
-  const {versionName} = await adb.getPackageInfo(bundleId);
-  return versionName;
-}
-
-function getChromedriverDir(osName = getOsName()) {
-  return path.resolve(CD_BASE_DIR, osName);
-}
-
-/**
- *
- * @param {string} osName
- * @returns {Promise<string>}
- */
-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,
-  });
-  return _.isEmpty(paths)
-    ? path.resolve(rootDir, `${CD_EXECUTABLE_PREFIX}${pathSuffix}`)
-    : /** @type {string} */ (_.first(paths));
-}
-
-/**
- *
- * @param {string} url
- * @param {import('axios').AxiosRequestConfig['headers']} headers
- * @param {Pick<import('axios').AxiosRequestConfig, 'timeout'|'responseType'>} opts
- * @returns
- */
-async function retrieveData(url, headers, opts = {}) {
-  const {timeout = 5000, responseType = 'text'} = opts;
-  return (
-    await axios({
-      url,
-      headers,
-      timeout,
-      responseType,
-    })
-  ).data;
-}
-
-/**
- * @returns {keyof OS}
- */
-const getOsName = _.memoize(function getOsName() {
-  if (system.isWindows()) {
-    return OS.WINDOWS;
-  }
-  if (system.isMac()) {
-    return OS.MAC;
-  }
-  return OS.LINUX;
-});
-
-const getCpuType = _.memoize(
-  /**
-   * @returns {string}
-   */
-  function getCpuType() {
-    return _.includes(_.toLower(os.cpus()[0].model), 'apple') ? CPU.ARM : CPU.INTEL;
-  }
-);
-
-const getOsInfo = _.memoize(
-  /**
-   * @returns {Promise<import('./types').OSInfo>}
-   */
-  async function getOsInfo() {
-    return {
-      name: getOsName(),
-      arch: String(await system.arch()),
-      cpu: getCpuType(),
-    };
-  }
-);
-
-// @ts-expect-error to avoid error
-// TS2345: Argument of type '{}' is not assignable to parameter of type 'DriverOpts<Readonly<Record<string, Constraint>>>'
-// Type '{}' is missing the following properties from type 'ServerArgs': address, allowCors, allowInsecure, basePath, and 26 more.
-const getBaseDriverInstance = _.memoize(() => new BaseDriver({}, false));
-
-/**
- * Generates log prefix string
- *
- * @param {any} obj log owner instance
- * @param {string?} sessionId Optional session identifier
- * @returns {string}
- */
-function generateLogPrefix(obj, sessionId = null) {
-  return getBaseDriverInstance().helpers.generateDriverLogPrefix(
-    obj,
-    sessionId ? sessionId : undefined
-  );
-}
-
-/**
- * Converts the given object to an integer number if possible
- *
- * @param {any} value to be converted
- * @returns {number | null}
- */
-function convertToInt(value) {
-  switch (typeof value) {
-    case 'number':
-      return Number.isNaN(value) ? null : value;
-    case 'string': {
-      const parsedAsInt = parseInt(value, 10);
-      return Number.isNaN(parsedAsInt) ? null : parsedAsInt;
-    }
-    default:
-      return null;
-  }
-}
-
-export {
-  getChromeVersion,
-  getChromedriverDir,
-  getChromedriverBinaryPath,
-  getOsName,
-  CD_BASE_DIR,
-  CD_VER,
-  CHROMEDRIVER_CHROME_MAPPING,
-  getMostRecentChromedriver,
-  retrieveData,
-  getOsInfo,
-  getCpuType,
-  OS,
-  generateLogPrefix,
-  convertToInt,
-};