@eyeo/get-browser-binary 0.11.0 → 0.12.0

package/README.md

@@ -35,7 +35,8 @@ the right side.
 - Edge >= 95
 
 Note: Installing Edge is not supported on Windows. It is assumed to be installed
-because it is the default browser on that platform.
+because it is the default browser on that platform. On macOS, only the latest
+Edge version is supported.
 
 ## Development
 

package/RELEASE_NOTES.md

@@ -1,3 +1,20 @@
+# 0.12.0
+
+- Adds a new field `customBrowserBinary` to `getDriver()` options parameter that
+accepts the path of a custom (pre-installed) browser binary. When used, that is
+the browser that will run (#56)
+- Fixes Edge install URLs for mac. Unfortunately, the new URLs provided by Edge
+offer a limited number of old versions only. For that reason `latest`
+becomes the only accepted value for Edge on mac (!64). Please see #56 as a
+possible workaround
+- Fixes an issue with Chromium 115 that prevented loading extensions in
+incognito mode (#52)
+- Logs URL info on previously uncaught http errors (!67)
+
+### Testing
+
+- Fixes recent failures when running Edge tests (#48)
+
 # 0.11.0
 
 - Fixes an issue on arm64 edgedriver links that prevented the driver to run on

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Install browser binaries and matching webdrivers",
   "repository": {
     "type": "git",

package/src/browsers.js

@@ -47,6 +47,7 @@ const DRIVER_START_ERROR = "Unable to start driver";
 const EXTENSION_NOT_FOUND_ERROR = "Extension not found";
 const BROWSER_DOWNLOAD_ERROR = "Browser download failed";
 const BROWSER_NOT_INSTALLED_ERROR = "Browser is not installed";
+const BROWSER_VERSION_CHECK_ERROR = "Checking the browser version failed";
 const ELEMENT_NOT_FOUND_ERROR = "HTML element not found";
 
 function getMajorVersion(versionNumber) {
@@ -104,16 +105,20 @@ class Browser {
    */
   static async getInstalledVersion(binary) {
     let stdout;
-    if (platform == "win32") {
-      ({stdout} = await promisify(exec)(
-        `(Get-ItemProperty ${binary}).VersionInfo.ProductVersion`,
-        {shell: "powershell.exe"})
-      );
-    }
-    else {
-      ({stdout} = await promisify(execFile)(binary, ["--version"]));
+    try {
+      if (platform == "win32") {
+        ({stdout} = await promisify(exec)(
+          `(Get-ItemProperty ${binary}).VersionInfo.ProductVersion`,
+          {shell: "powershell.exe"})
+        );
+      }
+      else {
+        ({stdout} = await promisify(execFile)(binary, ["--version"]));
+      }
+      return stdout.trim();
     }
-    return stdout.trim();
+    catch (e) {}
+    return "";
   }
 
   /**
@@ -135,6 +140,9 @@ class Browser {
    *   certificates, or not.
    * @property {Array.<string>} [extraArgs=[]] Additional arguments to start
    *   the browser with.
+   * @property {string} [customBrowserBinary] Path to the browser binary to be
+   *   used, instead of the browser installed by installBrowser(). This option
+   *   overrides the version parameter in getDriver().
    */
 
   /**
@@ -177,6 +185,7 @@ class Browser {
  */
 class Chromium extends Browser {
   static #CHANNELS = ["latest", "beta", "dev"];
+  static #MAX_VERSION_DECREMENTS = 200;
 
   static async #getVersionForChannel(channel) {
     if (!Chromium.#CHANNELS.includes(channel))
@@ -192,7 +201,14 @@ class Chromium extends Browser {
       "darwin-x64": "mac",
       "darwin-arm64": "mac_arm64"
     }[platformArch];
-    let data = await got(`https://omahaproxy.appspot.com/all.json?os=${os}`).json();
+    let url = `https://omahaproxy.appspot.com/all.json?os=${os}`;
+    let data;
+    try {
+      data = await got(url).json();
+    }
+    catch (err) {
+      throw new Error(`${BROWSER_VERSION_CHECK_ERROR}: ${url}\n${err}`);
+    }
     let release = data[0].versions.find(ver => ver.channel == channel);
     let {current_version: version} = release;
 
@@ -214,6 +230,27 @@ class Chromium extends Browser {
     }[platform];
   }
 
+  static async #getBase(chromiumVersion) {
+    let url = `https://omahaproxy.appspot.com/deps.json?version=${chromiumVersion}`;
+    let chromiumBase;
+    try {
+      ({chromium_base_position: chromiumBase} = await got(url).json());
+    }
+    catch (err) {
+      throw new Error(`${BROWSER_VERSION_CHECK_ERROR}: ${url}\n${err}`);
+    }
+    return parseInt(chromiumBase, 10);
+  }
+
+  static async #getInstalledBrowserInfo(binary) {
+    let installedVersion = await Chromium.getInstalledVersion(binary);
+    // Linux example: "Chromium 112.0.5615.49 built on Debian 11.6"
+    // Windows example: "114.0.5735.0"
+    let versionNumber = installedVersion.split(" ")[1] || installedVersion;
+    let base = await Chromium.#getBase(versionNumber);
+    return {binary, versionNumber, base};
+  }
+
   /**
    * Installs the browser. The Chromium executable gets extracted in the
    *   {@link snapshotsBaseDir} folder, ready to go.
@@ -227,32 +264,19 @@ class Chromium extends Browser {
    */
   static async installBrowser(version = "latest", downloadTimeout = 0) {
     const MIN_VERSION = 75;
-    const MAX_VERSION_DECREMENTS = 200;
 
     let binary;
     let versionNumber;
     let base;
 
-    async function getBase(chromiumVersion) {
-      let {chromium_base_position: chromiumBase} =
-        await got(`https://omahaproxy.appspot.com/deps.json?version=${chromiumVersion}`).json();
-      return parseInt(chromiumBase, 10);
-    }
-
     // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
-    if (platformArch == "linux-arm64") {
-      binary = "/usr/bin/chromium";
-      let installedVersion = await Chromium.getInstalledVersion(binary);
-      // installedVersion example: "Chromium 112.0.5615.49 built on Debian 11.6"
-      versionNumber = installedVersion.split(" ")[1];
-      base = await getBase(versionNumber);
-      return {binary, versionNumber, base};
-    }
+    if (platformArch == "linux-arm64")
+      return await Chromium.#getInstalledBrowserInfo("/usr/bin/chromium");
 
     checkVersion(version, MIN_VERSION, Chromium.#CHANNELS);
     versionNumber = await Chromium.#getVersionForChannel(version);
 
-    base = await getBase(versionNumber);
+    base = await Chromium.#getBase(versionNumber);
     let startBase = base;
     let [platformDir, fileName] = {
       "win32-ia32": ["Win", "chrome-win.zip"],
@@ -293,7 +317,7 @@ class Chromium extends Browser {
           // Chromium advises decrementing the branch_base_position when no
           // matching build was found. See https://www.chromium.org/getting-involved/download-chromium
           base--;
-          if (base <= startBase - MAX_VERSION_DECREMENTS)
+          if (base <= startBase - Chromium.#MAX_VERSION_DECREMENTS)
             throw new Error(`${BROWSER_DOWNLOAD_ERROR}: Chromium base ${startBase}`);
         }
         else {
@@ -306,7 +330,7 @@ class Chromium extends Browser {
     return {binary, versionNumber, base};
   }
 
-  static async #installDriver(base, versionNumber) {
+  static async #installDriver(startBase) {
     let [dir, zip, driverBinary] = {
       "win32-ia32": ["Win", "chromedriver_win32.zip", "chromedriver.exe"],
       "win32-x64": ["Win_x64", "chromedriver_win32.zip", "chromedriver.exe"],
@@ -317,27 +341,46 @@ class Chromium extends Browser {
     }[platformArch];
 
     let cacheDir = path.join(snapshotsBaseDir, "chromium", "cache",
-                             versionNumber);
-    let archive = path.join(cacheDir, `${base}-${zip}`);
-
+                             "chromedriver");
+    let archive = path.join(cacheDir, `${startBase}-${zip}`);
     try {
       await fs.promises.access(archive);
       await extractZip(archive, {dir: cacheDir});
     }
     catch (e) { // zip file is either not cached or corrupted
-      let url = `https://commondatastorage.googleapis.com/chromium-browser-snapshots/${dir}/${base}/${zip}`;
-      // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
-      // It is unclear how electron releases match Chromium versions. Once that
-      // is figured out, the link below will depend on the Chromium version.
-      // https://stackoverflow.com/questions/38732822/compile-chromedriver-on-arm
-      if (platformArch == "linux-arm64")
-        url = "https://github.com/electron/electron/releases/download/v24.1.2/chromedriver-v24.1.2-linux-arm64.zip";
-
-      try {
-        await download(url, archive);
+      if (platformArch == "linux-arm64") {
+        // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
+        // It's unclear how electron releases match Chromium versions. Once that
+        // is figured out, the link below will depend on the Chromium version.
+        // https://stackoverflow.com/questions/38732822/compile-chromedriver-on-arm
+        let url = "https://github.com/electron/electron/releases/download/v24.1.2/chromedriver-v24.1.2-linux-arm64.zip";
+        try {
+          await download(url, archive);
+        }
+        catch (err) {
+          throw new Error(`${DRIVER_DOWNLOAD_ERROR}: ${url}\n${err}`);
+        }
       }
-      catch (err) {
-        throw new Error(`${DRIVER_DOWNLOAD_ERROR}: ${url}\n${err}`);
+      else {
+        let base = startBase;
+        while (true) {
+          let url = `https://commondatastorage.googleapis.com/chromium-browser-snapshots/${dir}/${base}/${zip}`;
+          try {
+            await download(url, archive);
+            break;
+          }
+          catch (err) {
+            if (err.name == "HTTPError") {
+              base--;
+              archive = path.join(cacheDir, `${base}-${zip}`);
+              if (base <= startBase - Chromium.#MAX_VERSION_DECREMENTS)
+                throw new Error(`${DRIVER_DOWNLOAD_ERROR}: Chromium base ${startBase}`);
+            }
+            else {
+              throw new Error(`${DRIVER_DOWNLOAD_ERROR}: ${url}\n${err}`);
+            }
+          }
+        }
       }
       await extractZip(archive, {dir: cacheDir});
     }
@@ -355,11 +398,12 @@ class Chromium extends Browser {
   /** @see Browser.getDriver */
   static async getDriver(version = "latest", {
     headless = true, extensionPaths = [], incognito = false, insecure = false,
-    extraArgs = []
+    extraArgs = [], customBrowserBinary
   } = {}, downloadTimeout = 0) {
-    let {binary, versionNumber, base} =
+    let {binary, versionNumber, base} = customBrowserBinary ?
+      await Chromium.#getInstalledBrowserInfo(customBrowserBinary) :
       await Chromium.installBrowser(version, downloadTimeout);
-    let driverPath = await Chromium.#installDriver(base, versionNumber);
+    let driverPath = await Chromium.#installDriver(base);
     let serviceBuilder = new chrome.ServiceBuilder(driverPath);
     let options = new chrome.Options().addArguments("no-sandbox", ...extraArgs);
     if (extensionPaths.length > 0)
@@ -388,6 +432,15 @@ class Chromium extends Browser {
 
   /** @see Browser.enableExtensionInIncognito */
   static async enableExtensionInIncognito(driver, extensionTitle) {
+    let handle = await driver.getWindowHandle();
+
+    let version = getMajorVersion(
+      (await driver.getCapabilities()).getBrowserVersion());
+    if (version >= 115)
+      // On Chromium 115 opening chrome://extensions on the default tab causes
+      // WebDriverError: disconnected. Switching to a new window as a workaround
+      await driver.switchTo().newWindow("window");
+
     await driver.navigate().to("chrome://extensions");
     await driver.executeScript((...args) => {
       let enable = () => document.querySelector("extensions-manager").shadowRoot
@@ -415,6 +468,11 @@ class Chromium extends Browser {
         setTimeout(() => resolve(enable()), 100);
       });
     }, extensionTitle, EXTENSION_NOT_FOUND_ERROR);
+    if (version >= 115)
+      // Closing the previously opened new window
+      await driver.close();
+
+    await driver.switchTo().window(handle);
   }
 }
 
@@ -430,7 +488,14 @@ class Firefox extends Browser {
     if (!Firefox.#CHANNELS.includes(channel))
       return channel;
 
-    let data = await got("https://product-details.mozilla.org/1.0/firefox_versions.json").json();
+    let url = "https://product-details.mozilla.org/1.0/firefox_versions.json";
+    let data;
+    try {
+      data = await got(url).json();
+    }
+    catch (err) {
+      throw new Error(`${BROWSER_VERSION_CHECK_ERROR}: ${url}\n${err}`);
+    }
     return channel == "beta" ?
       data.LATEST_FIREFOX_DEVEL_VERSION : data.LATEST_FIREFOX_VERSION;
   }
@@ -514,9 +579,11 @@ class Firefox extends Browser {
   /** @see Browser.getDriver */
   static async getDriver(version = "latest", {
     headless = true, extensionPaths = [], incognito = false, insecure = false,
-    extraArgs = []
+    extraArgs = [], customBrowserBinary
   } = {}, downloadTimeout = 0) {
-    let {binary} = await Firefox.installBrowser(version, downloadTimeout);
+    let binary;
+    if (!customBrowserBinary)
+      ({binary} = await Firefox.installBrowser(version, downloadTimeout));
 
     let options = new firefox.Options();
     if (headless)
@@ -527,7 +594,7 @@ class Firefox extends Browser {
       options.set("acceptInsecureCerts", true);
     if (extraArgs.length > 0)
       options.addArguments(...extraArgs);
-    options.setBinary(binary);
+    options.setBinary(customBrowserBinary || binary);
 
     let driver;
     // The OS may be low on resources, that's why building the driver is retried
@@ -588,7 +655,14 @@ class Edge extends Browser {
     if (Edge.#CHANNELS.includes(version) && version != "latest")
       channel = version;
 
-    let {body} = await got(`https://packages.microsoft.com/repos/edge/pool/main/m/microsoft-edge-${channel}/`);
+    let url = `https://packages.microsoft.com/repos/edge/pool/main/m/microsoft-edge-${channel}/`;
+    let body;
+    try {
+      ({body} = await got(url));
+    }
+    catch (err) {
+      throw new Error(`${BROWSER_VERSION_CHECK_ERROR}: ${url}\n${err}`);
+    }
     let versionNumber;
     if (Edge.#CHANNELS.includes(version)) {
       let regex = /href="microsoft-edge-(stable|beta|dev)_(.*?)-1_/gm;
@@ -618,11 +692,7 @@ class Edge extends Browser {
     return {versionNumber, channel};
   }
 
-  static #getDarwinAppName(channel) {
-    let extra = channel == "stable" ?
-      "" : " " + channel.charAt(0).toUpperCase() + channel.slice(1);
-    return `Microsoft Edge${extra}`;
-  }
+  static #darwinApp = "Microsoft Edge";
 
   static #getBinaryPath(channel = "stable") {
     switch (platform) {
@@ -634,8 +704,7 @@ class Edge extends Browser {
         return channel == "stable" ?
           "microsoft-edge" : `microsoft-edge-${channel}`;
       case "darwin":
-        let appName = Edge.#getDarwinAppName(channel);
-        return `${process.env.HOME}/Applications/${appName}.app/Contents/MacOS/${appName}`;
+        return `${process.env.HOME}/Applications/${Edge.#darwinApp}.app/Contents/MacOS/${Edge.#darwinApp}`;
       default:
         checkPlatform();
     }
@@ -659,25 +728,17 @@ class Edge extends Browser {
       // https://support.microsoft.com/en-us/microsoft-edge/why-can-t-i-uninstall-microsoft-edge-ee150b3b-7d7a-9984-6d83-eb36683d526d
       throw new Error(`${UNSUPPORTED_PLATFORM_ERROR}: ${platform}`);
 
+    if (platform == "darwin" && version != "latest")
+      // Only latest Edge is supported on macOS
+      throw new Error(`${UNSUPPORTED_VERSION_ERROR}: ${version}. Only "latest" is supported`);
+
     const MIN_VERSION = 95;
     checkVersion(version, MIN_VERSION, Edge.#CHANNELS);
     let {versionNumber, channel} = await Edge.#getVersionForChannel(version);
 
-    let darwinName = {
-      stable: "MicrosoftEdge",
-      beta: "MicrosoftEdgeBeta",
-      dev: "MicrosoftEdgeDev"
-    }[channel];
     let filename = {
       linux: `microsoft-edge-${channel}_${versionNumber}-1_amd64.deb`,
-      darwin: `${darwinName}-${versionNumber}.pkg`
-    }[platform];
-    let darwinArch = process.arch == "arm64" ?
-      "03adf619-38c6-4249-95ff-4a01c0ffc962" :
-      "C1297A47-86C4-4C1F-97FA-950631F94777";
-    let url = {
-      linux: `https://packages.microsoft.com/repos/edge/pool/main/m/microsoft-edge-${channel}/${filename}`,
-      darwin: `https://officecdnmac.microsoft.com/pr/${darwinArch}/MacAutoupdate/${filename}`
+      darwin: `MicrosoftEdge-${versionNumber}.pkg`
     }[platform];
 
     let snapshotsDir = path.join(snapshotsBaseDir, "edge");
@@ -689,7 +750,20 @@ class Edge extends Browser {
     }
     catch (e) {}
 
+    let url = `https://packages.microsoft.com/repos/edge/pool/main/m/microsoft-edge-${channel}/${filename}`;
     try {
+      if (platform == "darwin") {
+        let caskUrl = "https://formulae.brew.sh/api/cask/microsoft-edge.json";
+        let caskJson;
+        try {
+          caskJson = await got(caskUrl).json();
+        }
+        catch (err) {
+          throw new Error(`${BROWSER_VERSION_CHECK_ERROR}: ${caskUrl}\n${err}`);
+        }
+        ({url} = process.arch == "arm64" ?
+          caskJson.variations.arm64_ventura : caskJson);
+      }
       await download(url, archive, downloadTimeout);
     }
     catch (err) {
@@ -700,8 +774,7 @@ class Edge extends Browser {
       await promisify(exec)(`dpkg -i ${archive}`);
     }
     else if (platform == "darwin") {
-      let appName = Edge.#getDarwinAppName(channel);
-      await fs.promises.rm(`${process.env.HOME}/Applications/${appName}.app`, {force: true, recursive: true});
+      await fs.promises.rm(`${process.env.HOME}/Applications/${Edge.#darwinApp}.app`, {force: true, recursive: true});
       await promisify(exec)(`installer -pkg ${archive} -target CurrentUserHomeDirectory`);
     }
 
@@ -715,17 +788,17 @@ class Edge extends Browser {
     return installedVersion.trim().replace(/.*\s/, "");
   }
 
-  static async #installDriver() {
+  static async #installDriver(binary) {
     async function extractEdgeZip(archive, cacheDir, driverPath) {
       await killDriverProcess("msedgedriver");
       await fs.promises.rm(driverPath, {force: true});
       await extractZip(archive, {dir: cacheDir});
     }
 
-    let binary = Edge.#getBinaryPath();
-    let versionNumber = await Edge.#getInstalledVersionNumber(binary);
+    let binaryPath = binary || Edge.#getBinaryPath();
+    let versionNumber = await Edge.#getInstalledVersionNumber(binaryPath);
     if (!versionNumber)
-      throw new Error(`${BROWSER_NOT_INSTALLED_ERROR}: Edge`);
+      throw new Error(`${BROWSER_NOT_INSTALLED_ERROR}. Binary path: ${binaryPath}`);
 
     let [zip, driverBinary] = {
       "win32-ia32": ["edgedriver_win32.zip", "msedgedriver.exe"],
@@ -768,12 +841,13 @@ class Edge extends Browser {
   /** @see Browser.getDriver */
   static async getDriver(version = "latest", {
     headless = true, extensionPaths = [], incognito = false, insecure = false,
-    extraArgs = []
+    extraArgs = [], customBrowserBinary
   } = {}, downloadTimeout = 0) {
-    if (platform == "linux" || platform == "darwin")
-      await Edge.installBrowser(version, downloadTimeout);
+    let binary;
+    if (!customBrowserBinary && (platform == "linux" || platform == "darwin"))
+      ({binary} = await Edge.installBrowser(version, downloadTimeout));
 
-    let driverPath = await Edge.#installDriver();
+    let driverPath = await Edge.#installDriver(customBrowserBinary || binary);
     let serviceBuilder = new edge.ServiceBuilder(driverPath);
 
     let options = new edge.Options().addArguments("no-sandbox", ...extraArgs);
@@ -782,7 +856,7 @@ class Edge extends Browser {
     if (extensionPaths.length > 0)
       options.addArguments(`load-extension=${extensionPaths.join(",")}`);
     if (incognito)
-      options.addArguments("incognito");
+      options.addArguments("inprivate");
     if (insecure)
       options.addArguments("ignore-certificate-errors");
 

package/test/browsers.js

@@ -28,7 +28,7 @@ import "geckodriver"; // Required to set the driver path on Windows
 const VERSIONS = {
   chromium: ["latest", "75.0.3770.0", "beta", "dev"],
   firefox: ["latest", "60.0", "beta"],
-  edge: ["latest", "95.0.1020.40", "beta", "dev"]
+  edge: ["dev", "latest", "beta", "95.0.1020.40"]
 };
 const TEST_URL = "https://abptestpages.org/en/exceptions/iframe_subdomains";
 const TEST_URL_LONG_PAGE = "https://abptestpages.org/";
@@ -121,9 +121,10 @@ async function getCachedTimes(browser) {
   }
 
   let driverCacheTime = null;
-  // Firefox install file includes the driver, that's why it's not tested here
+  // geckodriver is installed by npm, that's why Firefox is not tested here
   if (browser != "firefox" && !armLinuxChromium) {
-    let driverDir = cacheFiles.find(elem => !elem.endsWith(".zip"));
+    let driverDir = cacheFiles.find(
+      elem => !elem.endsWith(".zip") && !elem.endsWith(".pkg"));
     let driverFiles = await fs.promises.readdir(path.join(cacheDir, driverDir));
     let driverZip = driverFiles.find(elem => elem.endsWith(".zip"));
     let driverStat =
@@ -147,6 +148,7 @@ for (let browser of Object.keys(BROWSERS)) {
       describe(`Version: ${version}`, () => {
         let driver = null;
         let emptyCacheTimes = null;
+        let customBrowserBinary = null;
 
         async function quitDriver() {
           if (!driver)
@@ -168,7 +170,7 @@ for (let browser of Object.keys(BROWSERS)) {
             this.skip();
 
           let {binary, versionNumber} =
-            await BROWSERS[browser].installBrowser(version, 60000);
+            await BROWSERS[browser].installBrowser(version, this.timeout());
           let browserName = browser == "edge" ? /(edge|Edge)/ : browser;
           expect(binary).toEqual(expect.stringMatching(browserName));
 
@@ -179,6 +181,7 @@ for (let browser of Object.keys(BROWSERS)) {
 
           // Adding the version number to the test title for logging purposes
           this.test.title = `${this.test.title} [v${versionNumber}]`;
+          customBrowserBinary = binary;
         });
 
         it("runs", async() => {
@@ -212,13 +215,26 @@ for (let browser of Object.keys(BROWSERS)) {
           expect(existingCacheTimes).toEqual(emptyCacheTimes);
         });
 
-        it("supports extra args", async function() {
-          // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/48
-          // To be removed when Edge latest version > 112
-          if (browser == "edge" && version == "latest" &&
-              process.platform == "linux")
+        // This test depends on running the "installs" test
+        it("runs a custom browser binary", async function() {
+          if (!customBrowserBinary)
             this.skip();
 
+          let names = {
+            chromium: "chrome",
+            firefox: "firefox",
+            edge: /(MicrosoftEdge|msedge)/
+          };
+
+          driver =
+            await BROWSERS[browser].getDriver(version, {customBrowserBinary});
+          await driver.navigate().to(TEST_URL);
+
+          expect((await driver.getCapabilities()).getBrowserName())
+            .toEqual(expect.stringMatching(names[browser]));
+        });
+
+        it("supports extra args", async() => {
           let headless = false;
           let extraArgs = browser == "firefox" ?
             ["--devtools"] : ["auto-open-devtools-for-tabs"];