webdriver-installer 1.0.0 → 1.1.2

package/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+### [1.1.2](https://github.com/joeyparrish/webdriver-installer/compare/v1.1.1...v1.1.2) (2022-02-03)
+
+
+### Bug Fixes
+
+* Fix CLI installation ([2f6b649](https://github.com/joeyparrish/webdriver-installer/commit/2f6b649033312f778795b1372abfc0a175d70e61))
+
+### [1.1.1](https://github.com/joeyparrish/webdriver-installer/compare/v1.1.0...v1.1.1) (2022-02-03)
+
+
+### Bug Fixes
+
+* Make Windows browser version queries more robust ([85f3b27](https://github.com/joeyparrish/webdriver-installer/commit/85f3b2796e06e1a0f2171b46beef73f6a0407ecb))
+
+## [1.1.0](https://github.com/joeyparrish/webdriver-installer/compare/v1.0.1...v1.1.0) (2022-02-03)
+
+
+### Features
+
+* Add MS Edge support on Linux and Mac ([59505f4](https://github.com/joeyparrish/webdriver-installer/commit/59505f49b94030c63377d72e2b4639093915ab3d))
+
+
+### Bug Fixes
+
+* Fix GitHub API rate limit issues getting geckodriver release ([074beb7](https://github.com/joeyparrish/webdriver-installer/commit/074beb79adf7d9807ab57b67c9edd26d9451270e))
+
+## [1.0.1](https://github.com/joeyparrish/webdriver-installer/compare/v1.0.0...v1.0.1) (2022-02-02)
+
+
+### Bug Fixes
+
+* Fix execution in node v12 ([9b06017](https://github.com/joeyparrish/webdriver-installer/commit/9b06017b7c83ebfea1e600d7f667b2810ab05b5f))
+* Fix failure to query registry for Firefox ([ce12f34](https://github.com/joeyparrish/webdriver-installer/commit/ce12f347f96406cc1f0a219c4c44cd2a9b827254))
+* Improved error logging for CLI ([b588638](https://github.com/joeyparrish/webdriver-installer/commit/b588638774526d621983e0b497aa85ab217fcc46))
+
+
+## [1.0.0](https://github.com/joeyparrish/webdriver-installer/commits/v1.0.0) (2022-01-27)
+
+
+### Features
+
+* Support for Chrome, Chrome-android, Firefox, and Edge ([5f4cc57](https://github.com/joeyparrish/webdriver-installer/commit/5f4cc578a8b911d5a6da26e46e9bf0fb95580606))
+* Make logging optional, export main ([1d7bb17](https://github.com/joeyparrish/webdriver-installer/commit/1d7bb1755725a50b9c5a423c55402f6a84503919))

package/chrome.js

@@ -36,9 +36,7 @@ class ChromeWebDriverInstaller extends WebDriverInstallerBase {
     } else if (os.platform() == 'darwin') {
       return await InstallerUtils.getMacAppVersion('Google Chrome');
     } else if (os.platform() == 'win32') {
-      return await InstallerUtils.getWindowsRegistryVersion(
-          'HKEY_CURRENT_USER\\Software\\Google\\Chrome\\BLBeacon',
-          'version');
+      return await InstallerUtils.getWindowsExeVersion('chrome.exe');
     } else {
       throw new Error(`Unrecognized platform: ${os.platform()}`);
     }

package/edge.js

@@ -28,8 +28,18 @@ class EdgeWebDriverInstaller extends WebDriverInstallerBase {
 
   /** @return {!Promise<?string>} */
   async getInstalledBrowserVersion() {
-    return await InstallerUtils.getWindowsExeVersion(
-        'C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe');
+    if (os.platform() == 'linux') {
+      const output = await InstallerUtils.getCommandOutputOrNullIfMissing(
+          ['microsoft-edge', '--version']);
+      // Output is a string like "Microsoft Edge 97.0.1072.76\n"
+      return output ? output.trim().split(' ')[2] : null;
+    } else if (os.platform() == 'darwin') {
+      return await InstallerUtils.getMacAppVersion('Microsoft Edge');
+    } else if (os.platform() == 'win32') {
+      return await InstallerUtils.getWindowsExeVersion('msedge.exe');
+    } else {
+      throw new Error(`Unrecognized platform: ${os.platform()}`);
+    }
   }
 
   /**
@@ -65,9 +75,30 @@ class EdgeWebDriverInstaller extends WebDriverInstallerBase {
    * @return {!Promise}
    */
   async install(driverVersion, outputDirectory) {
-    const archiveUrl = `${CDN_URL}/${driverVersion}/edgedriver_win64.zip`;
-    const binaryName = 'msedgedriver.exe';
-    const outputName = this.getDriverName() + '.exe';
+    let platform;
+
+    if (os.platform() == 'linux') {
+      platform = 'linux64';
+    } else if (os.platform() == 'darwin') {
+      platform = 'mac64';
+    } else if (os.platform() == 'win32') {
+      platform = 'win64';
+    } else {
+      throw new Error(`Unrecognized platform: ${os.platform()}`);
+    }
+
+    const archiveUrl = `${CDN_URL}/${driverVersion}/edgedriver_${platform}.zip`;
+
+    let binaryName = 'msedgedriver';
+    if (os.platform() == 'win32') {
+      binaryName += '.exe';
+    }
+
+    let outputName = this.getDriverName();
+    if (os.platform() == 'win32') {
+      outputName += '.exe';
+    }
+
     return await InstallerUtils.installBinary(
         archiveUrl, binaryName, outputName,
         outputDirectory, /* isZip= */ true);

package/firefox.js

@@ -34,9 +34,7 @@ class FirefoxWebDriverInstaller extends WebDriverInstallerBase {
     } else if (os.platform() == 'darwin') {
       return await InstallerUtils.getMacAppVersion('Firefox');
     } else if (os.platform() == 'win32') {
-      return await InstallerUtils.getWindowsRegistryVersion(
-          'HKLM\\SOFTWARE\\Mozilla\\Mozilla Firefox',
-          'CurrentVersion')
+      return await InstallerUtils.getWindowsExeVersion('firefox.exe');
     } else {
       throw new Error(`Unrecognized platform: ${os.platform()}`);
     }

package/main.js

@@ -73,7 +73,15 @@ if (require.main == module) {
     process.exit(1);
   }
 
-  main(args[0]);
+  (async () => {
+    try {
+      await main(args[0]);
+      process.exit(0);
+    } catch (error) {
+      console.error(error);
+      process.exit(1);
+    }
+  })();
 } else {
   module.exports = {installWebDrivers: main};
 }

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "webdriver-installer",
-  "version": "1.0.0",
+  "version": "1.1.2",
   "description": "Install the right WebDriver version for your local browsers, automatically.",
   "main": "main.js",
+  "bin": {
+    "webdriver-installer": "main.js"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/joeyparrish/webdriver-installer"
@@ -16,6 +19,7 @@
   "author": "Joey Parrish <joeyparrish@google.com>",
   "dependencies": {
     "node-fetch": "^2.6.7",
+    "regedit": "^5.0.0",
     "tar-stream": "^2.2.0",
     "yauzl": "^2.10.0"
   },

package/utils.js

@@ -7,19 +7,24 @@
 const childProcess = require('child_process');
 const fetch = require('node-fetch');
 const fs = require('fs');
-const fsPromises = require('fs/promises');
+const fsPromises = require('fs').promises;
 const os = require('os');
 const path = require('path');
+const regedit = require('regedit');
 const stream = require('stream');
 const tar = require('tar-stream');
 const util = require('util');
 const yauzl = require('yauzl');
 const zlib = require('zlib');
 
+const regQuery = util.promisify(regedit.list);
 const execFile = util.promisify(childProcess.execFile);
 const pipeline = util.promisify(stream.pipeline);
 const zipFromBuffer = util.promisify(yauzl.fromBuffer);
 
+const WINDOWS_REGISTRY_APP_PATHS =
+    'HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\App\ Paths\\';
+
 /**
  * A static utility class for driver installers to use for common operations.
  */
@@ -88,26 +93,17 @@ class InstallerUtils {
       return null;
     }
 
-    const result = await InstallerUtils.runCommand([
-      'reg', 'query', path, '/v', key,
-    ]);
-
-    // Find the line with the key in it.  For "version", it would look something
-    // like this:
-    //     version    REG_SZ    94.0.4606.61
-    for (const line of result.stdout.split('\n')) {
-      if (line[0] == ' ' && line.includes(key)) {
-        // Find the section that starts with a number.
-        for (const section of line.split(' ')) {
-          if (section[0] >= '0' && section[0] <= '9') {
-            return section;
-          }
-        }
-      }
+    // Try the 64-bit registry first, then fall back to the 32-bit registry.
+    // Necessary values could be in either location.
+    let result = await regQuery(path, '64');
+    if (!result[path].exists || !result[path].values[key]) {
+      result = await regQuery(path, '32');
+    }
+    if (!result[path].exists || !result[path].values[key]) {
+      return null;
     }
 
-    // Not found.
-    return null;
+    return result[path].values[key].value;
   }
 
   /**
@@ -137,9 +133,16 @@ class InstallerUtils {
     }
 
     if (!(await InstallerUtils.fileExists(path))) {
-      // No such file.  Avoid the need to parse "not found" errors from
-      // powershell output.
-      return null;
+      // No such file.
+      // If it's a relative path, ask the registry for a full one.
+      if (!path.includes('/') && !path.includes('\\')) {
+        path = await InstallerUtils.getWindowsRegistryVersion(
+            WINDOWS_REGISTRY_APP_PATHS + path,
+            '');
+        if (!path || !(await InstallerUtils.fileExists(path))) {
+          return null;
+        }
+      }
     }
 
     const result = await InstallerUtils.runCommand([
@@ -239,10 +242,13 @@ class InstallerUtils {
    * @return {?string}
    */
   static async fetchLatestGitHubTag(repo) {
-    const url = `https://api.github.com/repos/${repo}/releases/latest`;
-    const response = await InstallerUtils.fetchUrl(url);
-    const releaseMetadata = await response.json();
-    return releaseMetadata['tag_name'];
+    // The GitHub API has rate limits, but this is public.  It will redirect to
+    // a URL specific to the tag.
+    const url = `https://github.com/${repo}/releases/latest`;
+    const response = await fetch(url, {method: 'HEAD'});
+    // The redirected URL will be something like:
+    //   "https://github.com/mozilla/geckodriver/releases/tag/v0.30.0"
+    return response.url.split('/').pop();
   }
 
   /**