fix(chromedriver): version fixes for update, status, and start (#380)

- Set the max versioning set in config.json. This will need to be updated on
every release of chromedriver. This will "fix" chrome and chromedriver
mismatches until Chrome 75 comes out. When it does there will have to be
an update for this again. Possible future work would allow a user
to set this via flag. Example --maxVersions.chrome "74."
- Create a generic way to get a valid version for Chromedriver. If
presented with 2.x, change this to 2.x.0. If presented with a 74.x.x.x,
chop off the last set of numbers and change this to 74.x.x
  - Fixes the status command during a semver check.
  - Fixes the update and start command when starting a specific version of
chromedriver

Author: cnishina

config.json

@@ -2,6 +2,7 @@
   "webdriverVersions": {
     "selenium": "2.53.1",
     "chromedriver": "2.27",
+    "maxChromedriver": "74",
     "geckodriver": "v0.13.0",
     "iedriver": "2.53.1",
     "androidsdk": "24.4.1",

lib/binaries/chrome_xml.ts

@@ -6,6 +6,8 @@ import {BinaryUrl} from './binary';
 import {XmlConfigSource} from './config_source';
 
 export class ChromeXml extends XmlConfigSource {
+  maxVersion = Config.binaryVersions().maxChrome;
+
   constructor() {
     super('chrome', Config.cdnUrls()['chrome']);
   }
@@ -66,44 +68,26 @@ export class ChromeXml extends XmlConfigSource {
       let latestVersion = '';
       for (let item of list) {
         // Get a semantic version
-        let version = item.split('/')[0];
+        const version = item.split('/')[0];
         if (semver.valid(version) == null) {
-          // This supports downloading 74.0.3729.6
-          try {
-            const newRegex = /(\d+.\d+.\d+).\d+/g;
-            const exec = newRegex.exec(version);
-            if (exec) {
-              version = exec[1];
-            }
-          } catch (_) {
-            // no-op: if this does not work, use the other regex pattern.
-          }
+          const iterVersion = getValidSemver(version);
 
-          // This supports downloading 2.46
-          try {
-            const oldRegex = /(\d+.\d+)/g;
-            const exec = oldRegex.exec(version);
-            if (exec) {
-              version = exec[1] + '.0';
-            }
-          } catch (_) {
-            // no-op: is this is not valid, do not throw here.
-          }
-
-          if (!semver.valid(version)) {
+          if (!semver.valid(iterVersion)) {
             throw new Error('invalid Chromedriver version');
           }
           // First time: use the version found.
           if (chromedriverVersion == null) {
-            chromedriverVersion = version;
+            chromedriverVersion = iterVersion;
             latest = item;
             latestVersion = item.split('/')[0];
-          } else if (semver.gt(version, chromedriverVersion)) {
+          } else if (
+              iterVersion.startsWith(this.maxVersion) &&
+              semver.gt(iterVersion, chromedriverVersion)) {
             // After the first time, make sure the semantic version is greater.
-            chromedriverVersion = version;
+            chromedriverVersion = iterVersion;
             latest = item;
             latestVersion = item.split('/')[0];
-          } else if (version === chromedriverVersion) {
+          } else if (iterVersion === chromedriverVersion) {
             // If the semantic version is the same, check os arch.
             // For 64-bit systems, prefer the 64-bit version.
             if (this.osarch === 'x64') {
@@ -123,17 +107,18 @@ export class ChromeXml extends XmlConfigSource {
    */
   private getSpecificChromeDriverVersion(inputVersion: string): Promise<BinaryUrl> {
     return this.getVersionList().then(list => {
-      let itemFound = '';
-      let specificVersion = semver.valid(inputVersion) ? inputVersion : inputVersion + '.0';
+      const specificVersion = getValidSemver(inputVersion);
 
+      let itemFound = '';
       for (let item of list) {
         // Get a semantic version.
         let version = item.split('/')[0];
         if (semver.valid(version) == null) {
-          version += '.0';
-          if (semver.valid(version)) {
+          const lookUpVersion = getValidSemver(version);
+
+          if (semver.valid(lookUpVersion)) {
             // Check to see if the specified version matches.
-            if (version === specificVersion) {
+            if (lookUpVersion === specificVersion) {
               // When item found is null, check the os arch
               // 64-bit version works OR not 64-bit version and the path does not have '64'
               if (itemFound == '') {
@@ -162,3 +147,40 @@ export class ChromeXml extends XmlConfigSource {
     });
   }
 }
+
+/**
+ * Chromedriver is the only binary that does not conform to semantic versioning
+ * and either has too little number of digits or too many. To get this to be in
+ * semver, we will either add a '.0' at the end or chop off the last set of
+ * digits. This is so we can compare to find the latest and greatest.
+ *
+ * Example:
+ *   2.46 -> 2.46.0
+ *   75.0.3770.8 -> 75.0.3770
+ *
+ * @param version
+ */
+export function getValidSemver(version: string): string {
+  let lookUpVersion = '';
+  // This supports downloading 2.46
+  try {
+    const oldRegex = /(\d+.\d+)/g;
+    const exec = oldRegex.exec(version);
+    if (exec) {
+      lookUpVersion = exec[1] + '.0';
+    }
+  } catch (_) {
+    // no-op: is this is not valid, do not throw here.
+  }
+  // This supports downloading 74.0.3729.6
+  try {
+    const newRegex = /(\d+.\d+.\d+).\d+/g;
+    const exec = newRegex.exec(version);
+    if (exec) {
+      lookUpVersion = exec[1];
+    }
+  } catch (_) {
+    // no-op: if this does not work, use the other regex pattern.
+  }
+  return lookUpVersion;
+}

lib/cmds/status.ts

@@ -4,6 +4,7 @@ import * as path from 'path';
 import * as semver from 'semver';
 
 import {AndroidSDK, Appium, ChromeDriver, GeckoDriver, IEDriver, Standalone} from '../binaries';
+import {getValidSemver} from '../binaries/chrome_xml';
 import {Logger, Options, Program} from '../cli';
 import {Config} from '../config';
 import {FileManager} from '../files';
@@ -88,8 +89,8 @@ function status(options: Options) {
     // - last: the last binary downloaded by webdriver-manager per the update-config.json
     downloaded.versions = downloaded.versions.sort((a: string, b: string): number => {
       if (!semver.valid(a)) {
-        a += '.0';
-        b += '.0';
+        a = getValidSemver(a);
+        b = getValidSemver(b);
       }
       if (semver.gt(a, b)) {
         return 1;

lib/config.ts

@@ -15,6 +15,7 @@ export interface ConfigFile {
   ie?: string;
   android?: string;
   appium?: string;
+  maxChrome?: string;
 }
 
 /**
@@ -94,6 +95,7 @@ export class Config {
     configVersions.ie = configFile.webdriverVersions.iedriver;
     configVersions.android = configFile.webdriverVersions.androidsdk;
     configVersions.appium = configFile.webdriverVersions.appium;
+    configVersions.maxChrome = configFile.webdriverVersions.maxChromedriver;
     return configVersions;
   }