appium-chromedriver 5.2.17 → 5.3.0

package/lib/types.ts

@@ -0,0 +1,101 @@
+export interface ChromedriverOpts {
+  host?: string;
+  port?: string;
+  useSystemExecutable?: boolean;
+  executable?: string;
+  executableDir?: string;
+  bundleId?: string;
+  mappingPath?: string;
+  cmdArgs?: string[];
+  adb?: AdbStub;
+  verbose?: boolean;
+  logPath?: string;
+  disableBuildCheck?: boolean;
+  /**
+   * Output of the `/json/version` CDP command
+   */
+  details?: {info?: {Browser: string}};
+  isAutodownloadEnabled?: boolean;
+}
+
+export type ChromedriverVersionMapping = Record<string, string | null>;
+
+export interface SyncOptions {
+  /**
+   * The list of chromedriver versions to sync. If empty (the default value)
+   * then all available chromedrivers are going to be downloaded and extracted
+   */
+  versions?: string[];
+  /**
+   * The minumum supported Chrome version that downloaded chromedrivers should
+   * support. Can match multiple drivers.
+   */
+  minBrowserVersion?: string | number;
+  /**
+   * System information used to filter out the list of the retrieved drivers. If
+   * not provided then the script will try to retrieve it.
+   */
+  osInfo?: OSInfo;
+}
+
+/**
+ * Information about the current operating system
+ */
+export interface OSInfo {
+  /**
+   * The architecture of the host OS.
+   * Can be either `32` or `64`
+   */
+  arch: string;
+  /**
+   *
+   * The name of the host OS.
+   * Can be either `mac`, `windows` or `linux`
+   */
+  name: string;
+}
+
+/**
+ * Info about a Chromedriver version
+ */
+export interface ChromedriverDetails {
+  /**
+   * Full url to corresponding driver in the remote storage
+   */
+  url: string;
+  /**
+   * CRC of driver archive
+   */
+  etag: string;
+  /**
+   * Chromedriver version
+   */
+  version: string;
+  minBrowserVersion: string | null;
+}
+
+/**
+ * The keys are unique driver identifiers (version/archive name). The corresponding values have {@linkcode ChromedriverDetails} containing chromedriver details
+ */
+export type ChromedriverDetailsMapping = Record<string, ChromedriverDetails>;
+
+export interface ChromedriverStorageClientOpts {
+  chromedriverDir?: string;
+  timeout?: number;
+}
+
+/**
+ * This is an instance of the `ADB` class from the `appium-adb` package.
+ * Remove this definition if/when `appium-adb` gets typed properly
+ * @see https://github.com/appium/appium-adb
+ */
+export type AdbStub = {
+  getApiLevel: () => Promise<number>;
+  adbPort?: number;
+  executable: {
+    defaultArgs: string[];
+  };
+  getForwardList: () => Promise<string[]>;
+  removePortForward: (systemPort: string) => Promise<void>;
+  getPackageInfo: (pkg: string) => Promise<{versionName: string}>;
+};

package/lib/utils.js

@@ -1,17 +1,18 @@
 import _ from 'lodash';
-import { system, fs, node } from '@appium/support';
-import { BaseDriver } from '@appium/base-driver';
+import {system, fs, node} from '@appium/support';
+import {BaseDriver} from '@appium/base-driver';
 import path from 'path';
-import { compareVersions } from 'compare-versions';
+import {compareVersions} from 'compare-versions';
 import axios from 'axios';
 
-const CD_CDN = process.env.npm_config_chromedriver_cdnurl
-  || process.env.CHROMEDRIVER_CDNURL
-  || 'https://chromedriver.storage.googleapis.com';
+const CD_CDN =
+  process.env.npm_config_chromedriver_cdnurl ||
+  process.env.CHROMEDRIVER_CDNURL ||
+  'https://chromedriver.storage.googleapis.com';
 const OS = {
   linux: 'linux',
   windows: 'win',
-  mac: 'mac'
+  mac: 'mac',
 };
 const X64 = '64';
 const X86 = '32';
@@ -25,7 +26,7 @@ const MODULE_NAME = 'appium-chromedriver';
  * @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 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`);
@@ -37,27 +38,44 @@ const getModuleRoot = _.memoize(function getModuleRoot () {
 const CHROMEDRIVER_CHROME_MAPPING = require(path.join(getModuleRoot(), 'config', 'mapping.json'));
 const CD_BASE_DIR = path.join(getModuleRoot(), 'chromedriver');
 
-function getMostRecentChromedriver (mapping = CHROMEDRIVER_CHROME_MAPPING) {
+/**
+ *
+ * @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 _.last(_.keys(mapping).sort(compareVersions));
+  return /** @type {string} */ (_.last(_.keys(mapping).sort(compareVersions)));
 }
 
-const CD_VER = process.env.npm_config_chromedriver_version
-  || process.env.CHROMEDRIVER_VERSION
-  || getMostRecentChromedriver();
+const CD_VER =
+  process.env.npm_config_chromedriver_version ||
+  process.env.CHROMEDRIVER_VERSION ||
+  getMostRecentChromedriver();
 
-async function getChromeVersion (adb, bundleId) {
+/**
+ *
+ * @param {import('./types').AdbStub} adb
+ * @param {string} bundleId
+ * @returns
+ */
+async function getChromeVersion(adb, bundleId) {
   const {versionName} = await adb.getPackageInfo(bundleId);
   return versionName;
 }
 
-function getChromedriverDir (osName = getOsName()) {
+function getChromedriverDir(osName = getOsName()) {
   return path.resolve(CD_BASE_DIR, osName);
 }
 
-async function getChromedriverBinaryPath (osName = getOsName()) {
+/**
+ *
+ * @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}`, {
@@ -69,23 +87,29 @@ async function getChromedriverBinaryPath (osName = getOsName()) {
   });
   return _.isEmpty(paths)
     ? path.resolve(rootDir, `${CD_EXECUTABLE_PREFIX}${pathSuffix}`)
-    : _.first(paths);
+    : /** @type {string} */ (_.first(paths));
 }
 
-async function retrieveData (url, headers, opts = {}) {
-  const {
-    timeout = 5000,
-    responseType = 'text',
-  } = opts;
-  return (await axios({
-    url,
-    headers,
-    timeout,
-    responseType,
-  })).data;
+/**
+ *
+ * @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;
 }
 
-const getOsName = _.memoize(function getOsName () {
+const getOsName = _.memoize(function getOsName() {
   if (system.isWindows()) {
     return OS.windows;
   }
@@ -95,29 +119,49 @@ const getOsName = _.memoize(function getOsName () {
   return OS.linux;
 });
 
-const getOsInfo = _.memoize(async function getOsInfo () {
-  return {
-    name: getOsName(),
-    arch: await system.arch(),
-  };
-});
+const getOsInfo = _.memoize(
+  /**
+   * @returns {Promise<import('./types').OSInfo>}
+   */
+  async function getOsInfo() {
+    return {
+      name: getOsName(),
+      arch: String(await system.arch()),
+    };
+  }
+);
 
 const getBaseDriverInstance = _.memoize(() => new BaseDriver({}, false));
 
 /**
  * Generates log prefix string
  *
- * @param {object} obj log owner instance
+ * @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);
+function generateLogPrefix(obj, sessionId = null) {
+  return getBaseDriverInstance().helpers.generateDriverLogPrefix(
+    obj,
+    sessionId ? sessionId : undefined
+  );
 }
 
-
 export {
-  getChromeVersion, getChromedriverDir, getChromedriverBinaryPath, getOsName,
-  CD_BASE_DIR, CD_CDN, CD_VER, CHROMEDRIVER_CHROME_MAPPING, getMostRecentChromedriver,
-  retrieveData, getOsInfo, OS, X64, X86, APPLE_ARM_SUFFIXES, generateLogPrefix,
+  getChromeVersion,
+  getChromedriverDir,
+  getChromedriverBinaryPath,
+  getOsName,
+  CD_BASE_DIR,
+  CD_CDN,
+  CD_VER,
+  CHROMEDRIVER_CHROME_MAPPING,
+  getMostRecentChromedriver,
+  retrieveData,
+  getOsInfo,
+  OS,
+  X64,
+  X86,
+  APPLE_ARM_SUFFIXES,
+  generateLogPrefix,
 };

package/package.json

@@ -6,7 +6,7 @@
     "chrome",
     "android"
   ],
-  "version": "5.2.17",
+  "version": "5.3.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -22,7 +22,8 @@
   },
   "lint-staged": {
     "*.js": [
-      "eslint --fix"
+      "eslint --fix",
+      "prettier --write"
     ]
   },
   "prettier": {
@@ -39,11 +40,14 @@
     "index.js",
     "install-npm.js",
     "lib",
-    "build/index.js",
-    "build/lib",
+    "build",
+    "!build/test",
+    "!build/tsconfig.tsbuildinfo",
     "config/mapping.json",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "tsconfig.json"
   ],
+  "types": "./build/index.d.ts",
   "dependencies": {
     "@appium/base-driver": "^9.1.0",
     "@appium/support": "^3.0.0",
@@ -60,48 +64,48 @@
     "teen_process": "^2.0.0",
     "xpath": "^0.x"
   },
-  "pre-commit": [
-    "precommit-msg",
-    "precommit-lint"
-  ],
   "scripts": {
-    "build": "rimraf build && babel --out-dir=build/lib lib && babel --out-dir=build index.js",
+    "build": "tsc -b",
+    "clean": "tsc -b --clean",
     "dev": "npm run build -- --watch",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
+    "lint-staged": "lint-staged",
     "postinstall": "node install-npm.js",
-    "precommit-msg": "echo 'Pre-commit checks...' && exit 0",
-    "precommit-lint": "lint-staged",
-    "prepare": "npm run build",
+    "prepare": "husky install && npm run build",
     "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\"",
     "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.js\""
   },
   "devDependencies": {
-    "@appium/eslint-config-appium": "^6.0.0",
+    "@appium/eslint-config-appium": "^8.0.0",
     "@appium/test-support": "^3.0.0",
-    "@babel/cli": "^7.18.10",
-    "@babel/core": "^7.18.10",
-    "@babel/eslint-parser": "^7.18.9",
-    "@babel/plugin-transform-runtime": "^7.18.10",
-    "@babel/preset-env": "^7.18.10",
-    "@babel/register": "^7.18.9",
+    "@appium/tsconfig": "^0.2.4",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "babel-plugin-source-map-support": "^2.2.0",
+    "@types/bluebird": "^3.5.38",
+    "@types/chai": "^4.3.4",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/lodash": "^4.14.191",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.13.0",
+    "@types/sinon": "^10.0.13",
+    "@types/teen_process": "^2.0.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "conventional-changelog-conventionalcommits": "^5.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-mocha": "^9.0.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "lint-staged": "^13.0.3",
+    "eslint": "^8.34.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-mocha": "^10.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.1.2",
     "mocha": "^10.0.0",
-    "pre-commit": "^1.1.3",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.4",
     "rimraf": "^4.0.4",
     "semantic-release": "^20.0.2",
-    "sinon": "^15.0.0"
+    "sinon": "^15.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
   }
 }

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@appium/tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "strict": true,
+    "types": ["node"],
+    "outDir": "build",
+    "checkJs": true,
+    "lib": ["es2020", "dom"]
+  },
+  "include": ["index.js", "lib"]
+}