feat: Remove automatic download of the latest chromedriver upon insta…

…ll (#430)

BREAKING CHANGE: Latest chromedriver binary does not get downloaded automatically anymore upon module installation

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.json

@@ -31,7 +31,6 @@
   },
   "files": [
     "config",
-    "install-npm.js",
     "lib",
     "build",
     "!build/test",
@@ -62,7 +61,6 @@
     "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\"",

test/functional/chromedriver-e2e-specs.js

@@ -1,7 +1,7 @@
 // transpile:mocha
 
 import {Chromedriver} from '../../lib/chromedriver';
-import {install} from '../../lib/install';
+import {install} from '../helpers/install';
 import B from 'bluebird';
 import {exec} from 'teen_process';
 import _ from 'lodash';

lib/install.js → test/helpers/install.js

@@ -1,11 +1,11 @@
 import _ from 'lodash';
 import { fs, mkdirp } from '@appium/support';
-import ChromedriverStorageClient from './storage-client/storage-client';
-import {parseLatestKnownGoodVersionsJson} from './storage-client/chromelabs';
+import ChromedriverStorageClient from '../../lib/storage-client/storage-client';
+import {parseLatestKnownGoodVersionsJson} from '../../lib/storage-client/chromelabs';
 import {
   CD_VER, retrieveData, getOsInfo, getChromedriverDir,
-} from './utils';
-import { USER_AGENT, STORAGE_REQ_TIMEOUT_MS, CHROMELABS_URL } from './constants';
+} from '../../lib/utils';
+import { USER_AGENT, STORAGE_REQ_TIMEOUT_MS, CHROMELABS_URL } from '../../lib/constants';
 
 const LATEST_VERSION = 'LATEST';
 
@@ -49,7 +49,7 @@ async function prepareChromedriverDir (platformName) {
   return chromedriverDir;
 }
 
-async function install () {
+export async function install () {
   const osInfo = await getOsInfo();
   const client = new ChromedriverStorageClient({
     chromedriverDir: await prepareChromedriverDir(osInfo.name),
@@ -59,9 +59,3 @@ async function install () {
     versions: [await formatCdVersion(CD_VER)],
   });
 }
-
-async function doInstall () {
-  await install();
-}
-
-export { install, doInstall };