Detect chromedriver version that corresponds to the version of Chrome installed

Author: ksathyanm

README.md

@@ -241,6 +241,31 @@ You can also force a different version of chromedriver by replacing `LATEST` wit
 CHROMEDRIVER_VERSION=75.0.3770.140 npm install chromedriver
 ```
 
+## Detect ChromeDriver Version
+
+The NPM package version may not be always compatible to your Chrome version.
+To get the chromedriver that corresponds to the version of Chrome installed,
+you can use the npm config property `detect_chromedriver_version`.
+
+```shell
+npm install chromedriver --detect_chromedriver_version
+```
+
+Or add property into your [`.npmrc`](https://docs.npmjs.com/files/npmrc) file.
+
+```
+detect_chromedriver_version=true
+```
+
+Another option is to use environment variable `DETECT_CHROMEDRIVER_VERSION`.
+
+```shell
+DETECT_CHROMEDRIVER_VERSION=true npm install chromedriver
+```
+
+**Note:** When the property `detect_chromedriver_version` is provided,
+`chromedriver_version` and `chromedriver_filepath` properties are ignored.
+
 ## A Note on chromedriver
 
 Chromedriver is not a library for NodeJS.

install.js

@@ -9,6 +9,7 @@ const path = require('path');
 const del = require('del');
 const child_process = require('child_process');
 const os = require('os');
+const { getChromeVersion } = require('@testim/chrome-version');
 
 const skipDownload = process.env.npm_config_chromedriver_skip_download || process.env.CHROMEDRIVER_SKIP_DOWNLOAD;
 if (skipDownload === 'true') {
@@ -24,6 +25,7 @@ const configuredfilePath = process.env.npm_config_chromedriver_filepath || proce
 cdnUrl = cdnUrl.replace(/\/+$/, '');
 let platform = process.platform;
 
+const detect_chromedriver_version = process.env.npm_config_detect_chromedriver_version || process.env.DETECT_CHROMEDRIVER_VERSION;
 let chromedriver_version = process.env.npm_config_chromedriver_version || process.env.CHROMEDRIVER_VERSION || helper.version;
 if (platform === 'linux') {
   if (process.arch === 'arm64' || process.arch === 'x64') {
@@ -50,13 +52,23 @@ let chromedriverBinaryFilePath;
 let downloadedFile = '';
 
 Promise.resolve().then(function () {
+  if (detect_chromedriver_version === 'true') {
+    // Refer http://chromedriver.chromium.org/downloads/version-selection
+    return getChromeVersion().then(function (chromeVersion) {
+      console.log("Your Chrome version is " + chromeVersion);
+      const chromeVersionWithoutPatch = /^(.*?)\.\d+$/.exec(chromeVersion)[1];
+      return getChromeDriverVersion(getRequestOptions(cdnUrl + '/LATEST_RELEASE_' + chromeVersionWithoutPatch));
+    }).then(function () {
+      console.log("Compatible ChromeDriver version is " + chromedriver_version);
+    });
+  }
   if (chromedriver_version === 'LATEST') {
-    return getLatestVersion(getRequestOptions(`${cdnUrl}/LATEST_RELEASE`));
+    return getChromeDriverVersion(getRequestOptions(`${cdnUrl}/LATEST_RELEASE`));
   } else {
     const latestReleaseForVersionMatch = chromedriver_version.match(/LATEST_(\d+)/);
     if (latestReleaseForVersionMatch) {
       const majorVersion = latestReleaseForVersionMatch[1];
-      return getLatestVersion(getRequestOptions(`${cdnUrl}/LATEST_RELEASE_${majorVersion}`));
+      return getChromeDriverVersion(getRequestOptions(`${cdnUrl}/LATEST_RELEASE_${majorVersion}`));
     }
   }
 })
@@ -79,7 +91,7 @@ Promise.resolve().then(function () {
 });
 
 function downloadFile() {
-  if (configuredfilePath) {
+  if (detect_chromedriver_version !== 'true' && configuredfilePath) {
     downloadedFile = configuredfilePath;
     console.log('Using file: ', downloadedFile);
     return Promise.resolve();
@@ -220,7 +232,7 @@ function getRequestOptions(downloadPath) {
   return options;
 }
 
-function getLatestVersion(requestOptions) {
+function getChromeDriverVersion(requestOptions) {
   const deferred = new Deferred();
   request(requestOptions, function (err, response, data) {
     if (err) {

package-lock.json

@@ -26,6 +26,7 @@
     "update-chromedriver": "node update.js"
   },
   "dependencies": {
+    "@testim/chrome-version": "^1.0.3",
     "del": "^4.1.1",
     "extract-zip": "^1.6.7",
     "mkdirp": "^0.5.1",