appium-chromedriver 5.6.78 → 6.0.1

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [6.0.1](https://github.com/appium/appium-chromedriver/compare/v6.0.0...v6.0.1) (2024-09-16)
+
+### Bug Fixes
+
+* Import proper eslint config ([#409](https://github.com/appium/appium-chromedriver/issues/409)) ([044a5ac](https://github.com/appium/appium-chromedriver/commit/044a5ac5132e6f8506d2846d67106ad1c14bf44b))
+
+## [6.0.0](https://github.com/appium/appium-chromedriver/compare/v5.6.78...v6.0.0) (2024-09-16)
+
+### ⚠ BREAKING CHANGES
+
+* Latest chromedriver binary does not get downloaded automatically anymore upon module installation
+
+### Features
+
+* Remove automatic download of the latest chromedriver upon install ([#430](https://github.com/appium/appium-chromedriver/issues/430)) ([ee7940d](https://github.com/appium/appium-chromedriver/commit/ee7940d30ef23cd825584b76b8fcfb8c42b38cc8))
+
 ## [5.6.78](https://github.com/appium/appium-chromedriver/compare/v5.6.77...v5.6.78) (2024-09-14)
 
 ### Miscellaneous Chores

package/README.md

@@ -24,7 +24,12 @@ more details on it.
 > This package can work with Microsoft Edge WebDriver as well, but the support is limited.
 > For example, automatic downloads do not work for Microsoft Edge WebDriver.
 
-## Skipping binary installation
+## Automatic Chromedriver download on module install
+
+Since version 6.0.0 of this module automatic download of the latest known chromedriver
+does not happen anymore. The below information is only relevant for older module versions:
+
+### Skipping binary installation
 
 By default, upon installation the package downloads the most recent known Chromedriver version from
 Chromedriver CDN server: http://chromedriver.storage.googleapis.com.
@@ -35,7 +40,7 @@ binary set the `APPIUM_SKIP_CHROMEDRIVER_INSTALL` environment variable:
 APPIUM_SKIP_CHROMEDRIVER_INSTALL=1 npm install appium-chromedriver
 ```
 
-## Custom Chromedriver version
+### Custom Chromedriver version
 
 By default, the package uses the most recent known Chromedriver version.
 The full list of known Chromedriver versions and their corresponding supported
@@ -51,19 +56,8 @@ CHROMEDRIVER_VERSION=107.0.5304.62 npm install appium-chromedriver
 ## Custom binaries url
 
 If you want Chromedriver to be downloaded from another CDN, which differs from the
-default one https://chromedriver.storage.googleapis.com, then either set the npm config property `chromedriver_cdnurl`:
-
-```bash
-npm install appium-chromedriver --chromedriver_cdnurl=http://npm.taobao.org/mirrors/chromedriver
-```
-
-The property could also be added into your [`.npmrc`](https://docs.npmjs.com/files/npmrc) file.
-
-```bash
-chromedriver_cdnurl=http://npm.taobao.org/mirrors/chromedriver
-```
-
-Or set the new URL to `CHROMEDRIVER_CDNURL` environment variable:
+default one https://chromedriver.storage.googleapis.com, then set the new URL to
+the `CHROMEDRIVER_CDNURL` environment variable:
 
 ```bash
 CHROMEDRIVER_CDNURL=http://npm.taobao.org/mirrors/chromedriver npm install appium-chromedriver
@@ -77,7 +71,7 @@ the server returns a proper list of stored drivers in response to requests havin
 Since version 5.6 the second environment variable has been added: `CHROMELABS_URL`. By default, it points
 to https://googlechromelabs.github.io, and is expected to contain the actual prefix of
 [Chrome for Testing availability](https://github.com/GoogleChromeLabs/chrome-for-testing#json-api-endpoints)
-JSON API. This API allows retrieval of chromedrivers whose versions are greater than 114.
+JSON API. This API allows retrieval of chromedrivers whose major versions are greater than `114`.
 
 Similarly to the above it could be also defined in the .npmrc file:
 

package/package.json

@@ -6,7 +6,7 @@
     "chrome",
     "android"
   ],
-  "version": "5.6.78",
+  "version": "6.0.1",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -31,7 +31,6 @@
   },
   "files": [
     "config",
-    "install-npm.js",
     "lib",
     "build",
     "!build/test",
@@ -62,14 +61,13 @@
     "dev": "npm run build -- --watch",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
-    "postinstall": "node install-npm.js",
     "prepare": "npm run build",
     "format": "prettier -w ./lib",
     "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\"",
     "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.js\""
   },
   "devDependencies": {
-    "@appium/eslint-config-appium": "^8.0.0",
+    "@appium/eslint-config-appium-ts": "^0.x",
     "@appium/test-support": "^3.0.0",
     "@appium/tsconfig": "^0.x",
     "@semantic-release/changelog": "^6.0.1",

package/build/lib/install.d.ts

@@ -1,3 +0,0 @@
-export function install(): Promise<void>;
-export function doInstall(): Promise<void>;
-//# sourceMappingURL=install.d.ts.map

package/build/lib/install.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../lib/install.js"],"names":[],"mappings":"AAmDA,yCASC;AAED,2CAEC"}

package/build/lib/install.js

@@ -1,64 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.install = install;
-exports.doInstall = doInstall;
-const lodash_1 = __importDefault(require("lodash"));
-const support_1 = require("@appium/support");
-const storage_client_1 = __importDefault(require("./storage-client/storage-client"));
-const chromelabs_1 = require("./storage-client/chromelabs");
-const utils_1 = require("./utils");
-const constants_1 = require("./constants");
-const LATEST_VERSION = 'LATEST';
-/**
- *
- * @param {string} ver
- * @returns {Promise<string>}
- */
-async function formatCdVersion(ver) {
-    if (lodash_1.default.toUpper(ver) !== LATEST_VERSION) {
-        return ver;
-    }
-    let jsonStr;
-    const url = `${constants_1.CHROMELABS_URL}/chrome-for-testing/last-known-good-versions.json`;
-    try {
-        jsonStr = await (0, utils_1.retrieveData)(url, {
-            'user-agent': constants_1.USER_AGENT,
-            accept: `application/json, */*`,
-        }, { timeout: constants_1.STORAGE_REQ_TIMEOUT_MS });
-    }
-    catch (e) {
-        const err = /** @type {Error} */ (e);
-        throw new Error(`Cannot fetch the latest Chromedriver version. ` +
-            `Make sure you can access ${url} from your machine or provide a mirror by setting ` +
-            `a custom value to CHROMELABS_URL enironment variable. Original error: ${err.message}`);
-    }
-    return (0, chromelabs_1.parseLatestKnownGoodVersionsJson)(jsonStr);
-}
-/**
- *
- * @param {string} platformName
- */
-async function prepareChromedriverDir(platformName) {
-    const chromedriverDir = (0, utils_1.getChromedriverDir)(platformName);
-    if (!await support_1.fs.exists(chromedriverDir)) {
-        await (0, support_1.mkdirp)(chromedriverDir);
-    }
-    return chromedriverDir;
-}
-async function install() {
-    const osInfo = await (0, utils_1.getOsInfo)();
-    const client = new storage_client_1.default({
-        chromedriverDir: await prepareChromedriverDir(osInfo.name),
-    });
-    await client.syncDrivers({
-        osInfo,
-        versions: [await formatCdVersion(utils_1.CD_VER)],
-    });
-}
-async function doInstall() {
-    await install();
-}
-//# sourceMappingURL=install.js.map

package/build/lib/install.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"install.js","sourceRoot":"","sources":["../../lib/install.js"],"names":[],"mappings":";;;;;AAkES,0BAAO;AAAE,8BAAS;AAlE3B,oDAAuB;AACvB,6CAA6C;AAC7C,qFAAwE;AACxE,4DAA6E;AAC7E,mCAEiB;AACjB,2CAAiF;AAEjF,MAAM,cAAc,GAAG,QAAQ,CAAC;AAEhC;;;;GAIG;AACH,KAAK,UAAU,eAAe,CAAE,GAAG;IACjC,IAAI,gBAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,cAAc,EAAE,CAAC;QACtC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,IAAI,OAAO,CAAC;IACZ,MAAM,GAAG,GAAG,GAAG,0BAAc,mDAAmD,CAAC;IACjF,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,IAAA,oBAAY,EAC1B,GAAG,EAAE;YACH,YAAY,EAAE,sBAAU;YACxB,MAAM,EAAE,uBAAuB;SAChC,EAAE,EAAC,OAAO,EAAE,kCAAsB,EAAC,CACrC,CAAC;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,gDAAgD;YAC9D,4BAA4B,GAAG,oDAAoD;YACnF,yEAAyE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,OAAO,IAAA,6CAAgC,EAAC,OAAO,CAAC,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,sBAAsB,CAAE,YAAY;IACjD,MAAM,eAAe,GAAG,IAAA,0BAAkB,EAAC,YAAY,CAAC,CAAC;IACzD,IAAI,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;QACtC,MAAM,IAAA,gBAAM,EAAC,eAAe,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,KAAK,UAAU,OAAO;IACpB,MAAM,MAAM,GAAG,MAAM,IAAA,iBAAS,GAAE,CAAC;IACjC,MAAM,MAAM,GAAG,IAAI,wBAAyB,CAAC;QAC3C,eAAe,EAAE,MAAM,sBAAsB,CAAC,MAAM,CAAC,IAAI,CAAC;KAC3D,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,WAAW,CAAC;QACvB,MAAM;QACN,QAAQ,EAAE,CAAC,MAAM,eAAe,CAAC,cAAM,CAAC,CAAC;KAC1C,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,SAAS;IACtB,MAAM,OAAO,EAAE,CAAC;AAClB,CAAC"}

package/install-npm.js

@@ -1,80 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * This is the `postinstall` script which:
- * 1. Builds the project if it isn't yet built (only happens in a dev environment), and
- * 2. Downloads Chromedriver (which can be disabled);
- *
- * Because `prepare` is run _after_ `postinstall`, we cannot just use `prepare` to build the project
- * because this script depends on the project being built!
- */
-
-const B = require('bluebird');
-const util = require('util');
-
-// this is here because we're using async/await, and this must be set _before_ we use async/await,
-// given that bluebird is used elsewhere via `doInstall()`.
-B.config({
-  cancellation: true,
-});
-
-const fs = require('fs/promises');
-const path = require('path');
-const _ = require('lodash');
-const {exec} = require('teen_process');
-const {logger} = require('@appium/support');
-
-const log = logger.getLogger('CDInstaller');
-const BUILD_PATH = path.join(__dirname, 'build', 'lib', 'install.js');
-
-async function main() {
-  // always build if not yet built.
-  // this should only happen in a working copy / dev environment.
-  try {
-    await fs.stat(BUILD_PATH);
-  } catch {
-    log.info(
-      `The Chromedriver install script cannot be found at '${BUILD_PATH}'. ` +
-        `Building appium-chromedriver package`
-    );
-    const isWindows = process.platform === 'win32';
-    const npmCommand = `npm${isWindows ? '.cmd' : ''}`;
-    try {
-      await exec(npmCommand, ['run', 'build'], {
-        logger: log,
-        cwd: __dirname,
-        shell: isWindows,
-      });
-    } catch (e) {
-      throw new Error(`appium-chromedriver package cannot be built: ${util.inspect(e)}`);
-    }
-  }
-
-  // check if we should skip install
-  if (
-    !_.isEmpty(process.env.APPIUM_SKIP_CHROMEDRIVER_INSTALL) ||
-    !_.isEmpty(process.env.npm_config_chromedriver_skip_install)
-  ) {
-    log.warn(
-      `'APPIUM_SKIP_CHROMEDRIVER_INSTALL' environment variable is set; skipping Chromedriver installation.`
-    );
-    log.warn(`Android web/hybrid testing will not be possible without Chromedriver.`);
-    return;
-  }
-
-  try {
-    await require(BUILD_PATH).doInstall();
-  } catch (err) {
-    log.error(`Error installing Chromedriver: ${err.message}`);
-    log.error(err.stack ? err.stack : err);
-    log.error(
-      `Downloading Chromedriver can be skipped by setting the` +
-        `'APPIUM_SKIP_CHROMEDRIVER_INSTALL' environment variable.`
-    );
-    process.exit(1);
-  }
-}
-
-if (require.main === module) {
-  main();
-}

package/lib/install.js

@@ -1,67 +0,0 @@
-import _ from 'lodash';
-import { fs, mkdirp } from '@appium/support';
-import ChromedriverStorageClient from './storage-client/storage-client';
-import {parseLatestKnownGoodVersionsJson} from './storage-client/chromelabs';
-import {
-  CD_VER, retrieveData, getOsInfo, getChromedriverDir,
-} from './utils';
-import { USER_AGENT, STORAGE_REQ_TIMEOUT_MS, CHROMELABS_URL } from './constants';
-
-const LATEST_VERSION = 'LATEST';
-
-/**
- *
- * @param {string} ver
- * @returns {Promise<string>}
- */
-async function formatCdVersion (ver) {
-  if (_.toUpper(ver) !== LATEST_VERSION) {
-    return ver;
-  }
-
-  let jsonStr;
-  const url = `${CHROMELABS_URL}/chrome-for-testing/last-known-good-versions.json`;
-  try {
-    jsonStr = await retrieveData(
-      url, {
-        'user-agent': USER_AGENT,
-        accept: `application/json, */*`,
-      }, {timeout: STORAGE_REQ_TIMEOUT_MS}
-    );
-  } catch (e) {
-    const err = /** @type {Error} */ (e);
-    throw new Error(`Cannot fetch the latest Chromedriver version. ` +
-      `Make sure you can access ${url} from your machine or provide a mirror by setting ` +
-      `a custom value to CHROMELABS_URL enironment variable. Original error: ${err.message}`);
-  }
-  return parseLatestKnownGoodVersionsJson(jsonStr);
-}
-
-/**
- *
- * @param {string} platformName
- */
-async function prepareChromedriverDir (platformName) {
-  const chromedriverDir = getChromedriverDir(platformName);
-  if (!await fs.exists(chromedriverDir)) {
-    await mkdirp(chromedriverDir);
-  }
-  return chromedriverDir;
-}
-
-async function install () {
-  const osInfo = await getOsInfo();
-  const client = new ChromedriverStorageClient({
-    chromedriverDir: await prepareChromedriverDir(osInfo.name),
-  });
-  await client.syncDrivers({
-    osInfo,
-    versions: [await formatCdVersion(CD_VER)],
-  });
-}
-
-async function doInstall () {
-  await install();
-}
-
-export { install, doInstall };