@eyeo/get-browser-binary 0.17.0 → 0.19.0

package/.gitlab-ci.yml

@@ -52,8 +52,10 @@ test:browsers:linux:dev:
     - choco install -y microsoft-edge
     - npm install
   tags:
-    - saas-windows-medium-amd64
+    - eyeo-windows
   cache: {}
+  # Retrying to mitigate Edge install issues
+  retry: 1
 
 test:browsers:windows:
   extends: .windows

package/README.md

@@ -32,7 +32,7 @@ the right side.
 
 - Chromium >= 77 (Chromium ARM >= 92)
 - Firefox >= 68
-- Edge >= 95 (Windows Edge >= 79)
+- Edge >= 114
 
 Note: Installing Edge is not supported on Windows. It is assumed to be installed
 because it is the default browser on that platform. On macOS, only the latest

package/RELEASE_NOTES.md

@@ -1,4 +1,26 @@
-# Unreleased 
+# Unreleased
+
+# 0.19.0
+
+- Fixes an issue starting with Firefox version 135 which prevented the binary to be downloaded (#82)
+- `getInstalledVersion` now returns only the version number (#81)
+
+## Testing
+
+- Test extensions internal pages can now load normally. The development version of Chromium 133 got the `driver.getAllWindowHandles()` issue fixed, therefore the workaround is no longer needed. (!121)
+
+# 0.18.0
+
+- Adds support for Firefox dev channel (!116)
+- Drops support for old Edge versions (#79)
+- Fixes `enableExtensionInIncognito()` to keep working with Chromium +131 (!117)
+
+## Testing
+
+- Changes the way test extensions load internal pages. With Chromium +133,
+`driver.getAllWindowHandles()` can't see tabs opened by an extension if the url
+option opens an extension page. Please check the example provided by !119 in
+order to workaround that issue.
 
 # 0.17.0
 

package/package.json

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

package/src/browser.js

@@ -48,7 +48,8 @@ export class Browser {
   }
 
   /**
-   * Gets the installed version returned by the browser binary.
+   * Gets the installed version returned by the browser binary. Subclasses add
+   *   specific parsing to this function.
    * @param {string} binary The path to the browser binary.
    * @return {string} Installed browser version.
    * @throws {Error} Browser is not installed.

package/src/chromium.js

@@ -110,11 +110,18 @@ export class Chromium extends Browser {
     return parseInt(chromiumBase, 10);
   }
 
-  static async #getInstalledBrowserInfo(binary) {
-    let installedVersion = await Chromium.getInstalledVersion(binary);
+  /** @see Browser.getInstalledVersion */
+  static async getInstalledVersion(binary) {
+    const installedVersion = await super.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;
+    return installedVersion.split(" ")[1] || installedVersion;
+  }
+
+  static async #getInstalledBrowserInfo(binary) {
+    const versionNumber = await Chromium.getInstalledVersion(binary);
+
     return {binary, versionNumber};
   }
 
@@ -229,47 +236,59 @@ export class Chromium extends Browser {
 
   /** @see Browser.enableExtensionInIncognito */
   static async enableExtensionInIncognito(driver, extensionTitle) {
-    let handle = await driver.getWindowHandle();
+    const currentHandle = await driver.getWindowHandle();
 
-    let version = getMajorVersion(
-      (await driver.getCapabilities()).getBrowserVersion());
-    if (version >= 115)
+    const browserVersion =
+      getMajorVersion((await driver.getCapabilities()).getBrowserVersion());
+    if (browserVersion >= 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
+
+    await driver.executeScript((title, errorMsg) => {
+      const enableIncognitoMode = () => document
+        .querySelector("extensions-manager").shadowRoot
         .querySelector("extensions-detail-view").shadowRoot
         .getElementById("allow-incognito").shadowRoot
         .getElementById("crToggle").click();
 
-      let extensions = document.querySelector("extensions-manager").shadowRoot
-        .getElementById("items-list").shadowRoot
-        .querySelectorAll("extensions-item");
+      const getExtensionDetailsButton = () => {
+        const extensions = document
+          .querySelector("extensions-manager").shadowRoot
+          .getElementById("items-list").shadowRoot
+          .querySelectorAll("extensions-item");
 
-      return new Promise((resolve, reject) => {
-        let extensionDetails;
+        let detailsButton;
         for (let {shadowRoot} of extensions) {
-          if (shadowRoot.getElementById("name").innerHTML != args[0])
+          const extensionName = shadowRoot.getElementById("name").innerHTML;
+          if (!extensionName.includes(title))
             continue;
 
-          extensionDetails = shadowRoot.getElementById("detailsButton");
+          detailsButton = shadowRoot.getElementById("detailsButton");
           break;
         }
-        if (!extensionDetails)
-          reject(`${args[1]}: ${args[0]}`);
 
-        extensionDetails.click();
-        setTimeout(() => resolve(enable()), 100);
+        return detailsButton;
+      };
+
+      return new Promise((resolve, reject) => {
+        const detailsButton = getExtensionDetailsButton();
+
+        if (!detailsButton)
+          reject(`${errorMsg}: ${title}`);
+
+        detailsButton.click();
+        setTimeout(() => resolve(enableIncognitoMode()), 100);
       });
     }, extensionTitle, errMsg.extensionNotFound);
-    if (version >= 115 && process.platform == "win32")
+
+    if (browserVersion >= 115 && process.platform == "win32")
       // Closing the previously opened new window. Needed on Windows to avoid a
       // further `WebDriverError: disconnected` error
       await driver.close();
 
-    await driver.switchTo().window(handle);
+    await driver.switchTo().window(currentHandle);
   }
 }

package/src/edge.js

@@ -23,7 +23,6 @@ import fs from "fs";
 import got from "got";
 import webdriver from "selenium-webdriver";
 import edge from "selenium-webdriver/edge.js";
-import extractZip from "extract-zip";
 
 import {Browser} from "./browser.js";
 import {download, killDriverProcess, wait, getMajorVersion, checkVersion,
@@ -40,6 +39,7 @@ let {platform} = process;
  */
 export class Edge extends Browser {
   static #CHANNELS = ["latest", "beta", "dev"];
+  static #MIN_VERSION = 114;
 
   static async #getVersionForChannel(version) {
     let channel = "stable";
@@ -106,7 +106,7 @@ export class Edge extends Browser {
    *   which requires root permissions. On MacOS, Edge is installed as a user
    *   app (not as a system app). Installing Edge on Windows is not supported.
    * @param {string} [version=latest] Either "latest", "beta", "dev" or a full
-   *   version number (i.e. "95.0.1020.40").
+   *   version number (i.e. "114.0.1823.82").
    * @param {number} [downloadTimeout=0] Allowed time in ms for the download of
    *   install files to complete. When set to 0 there is no time limit.
    * @return {BrowserBinary}
@@ -123,8 +123,7 @@ export class Edge extends Browser {
       // Only latest Edge is supported on macOS
       throw new Error(`${errMsg.unsupportedVersion}: ${version}. Only "latest" is supported`);
 
-    const MIN_VERSION = 95;
-    checkVersion(version, MIN_VERSION, Edge.#CHANNELS);
+    checkVersion(version, Edge.#MIN_VERSION, Edge.#CHANNELS);
     let {versionNumber, channel} = await Edge.#getVersionForChannel(version);
 
     let filename = {
@@ -136,7 +135,7 @@ export class Edge extends Browser {
     let archive = path.join(snapshotsDir, "cache", filename);
     let binary = Edge.#getBinaryPath(channel);
     try {
-      if (await Edge.#getInstalledVersionNumber(binary) == versionNumber)
+      if (await Edge.getInstalledVersion(binary) == versionNumber)
         return {binary, versionNumber};
     }
     catch (e) {}
@@ -172,60 +171,21 @@ export class Edge extends Browser {
     return {binary, versionNumber};
   }
 
-  static async #getInstalledVersionNumber(binary) {
-    let installedVersion = await Edge.getInstalledVersion(binary);
+  /** @see Browser.getInstalledVersion */
+  static async getInstalledVersion(binary) {
+    let installedVersion = await super.getInstalledVersion(binary);
     for (let word of ["beta", "dev", "Beta", "Dev"])
       installedVersion = installedVersion.replace(word, "");
     return installedVersion.trim().replace(/.*\s/, "");
   }
 
-  static async #installOldWindowsDriver(binary) {
-    async function extractEdgeZip(archive, cacheDir, driverPath) {
-      await killDriverProcess("msedgedriver");
-      await fs.promises.rm(driverPath, {force: true});
-      await extractZip(archive, {dir: cacheDir});
-    }
-
-    let binaryPath = binary || Edge.#getBinaryPath();
-    let versionNumber = await Edge.#getInstalledVersionNumber(binaryPath);
-    let cacheDir = path.join(snapshotsBaseDir, "edge", "cache",
-                             `edgedriver-${versionNumber}`);
-    let zip = process.arch == "ia32" ?
-      "edgedriver_win32.zip" : "edgedriver_win64.zip";
-    let archive = path.join(cacheDir, `${versionNumber}-${zip}`);
-    let driverPath = path.join(cacheDir, "msedgedriver.exe");
-
-    try {
-      await fs.promises.access(archive);
-      await extractEdgeZip(archive, cacheDir, driverPath);
-    }
-    catch (e) { // zip file is either not cached or corrupted
-      let vSplit = versionNumber.split(".");
-      let lastNum = parseInt(vSplit[3], 10);
-      while (lastNum >= 0) {
-        try {
-          let attempt = `${vSplit[0]}.${vSplit[1]}.${vSplit[2]}.${lastNum}`;
-          await download(`https://msedgedriver.azureedge.net/${attempt}/${zip}`,
-                         archive);
-          break;
-        }
-        catch (e2) {
-          lastNum--;
-        }
-      }
-      if (lastNum < 0)
-        throw new Error(`${errMsg.driverDownload}: Edge ${versionNumber}`);
-
-      await extractEdgeZip(archive, cacheDir, driverPath);
-    }
-    return driverPath;
-  }
-
   /** @see Browser.getDriver */
   static async getDriver(version = "latest", {
     headless = true, extensionPaths = [], incognito = false, insecure = false,
     extraArgs = [], customBrowserBinary
   } = {}, downloadTimeout = 0) {
+    checkVersion(version, Edge.#MIN_VERSION, Edge.#CHANNELS);
+
     let binary;
     let versionNumber;
     if (!customBrowserBinary && (platform == "linux" || platform == "darwin")) {
@@ -235,7 +195,7 @@ export class Edge extends Browser {
     else {
       binary = customBrowserBinary || Edge.#getBinaryPath();
       versionNumber =
-        await Edge.#getInstalledVersionNumber(binary);
+        await Edge.getInstalledVersion(binary);
     }
 
     let options = new edge.Options().addArguments("no-sandbox", ...extraArgs);
@@ -260,15 +220,6 @@ export class Edge extends Browser {
     builder.forBrowser("MicrosoftEdge");
     builder.setEdgeOptions(options);
 
-    if (getMajorVersion(versionNumber) < 95) {
-      // Selenium's automated driver download doesn't work on old Edge versions.
-      // Support to installing old drivers is only needed by Windows CI jobs.
-      // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/2#note_1189235804
-      let driverPath = await Edge.#installOldWindowsDriver(binary);
-      let serviceBuilder = new edge.ServiceBuilder(driverPath);
-      builder.setEdgeService(serviceBuilder);
-    }
-
     let driver;
     // On Windows CI, occasionally a SessionNotCreatedError is thrown, likely
     // due to low OS resources, that's why building the driver is retried

package/src/firefox.js

@@ -38,12 +38,13 @@ let {until, By} = webdriver;
  * @extends Browser
  */
 export class Firefox extends Browser {
-  static #CHANNELS = ["latest", "beta"];
+  static #CHANNELS = ["latest", "beta", "dev"];
 
   static async #getVersionForChannel(channel) {
     if (!Firefox.#CHANNELS.includes(channel))
       return channel;
 
+    // https://wiki.mozilla.org/Release_Management/Product_details#firefox_versions.json
     let url = "https://product-details.mozilla.org/1.0/firefox_versions.json";
     let data;
     try {
@@ -52,17 +53,44 @@ export class Firefox extends Browser {
     catch (err) {
       throw new Error(`${errMsg.browserVersionCheck}: ${url}\n${err}`);
     }
-    return channel == "beta" ?
-      data.LATEST_FIREFOX_DEVEL_VERSION : data.LATEST_FIREFOX_VERSION;
+
+    if (channel === "beta") {
+      // The validated latest Firefox Beta built, exposed for downloading
+      return data.LATEST_FIREFOX_RELEASED_DEVEL_VERSION;
+    }
+    else if (channel === "dev") {
+      // Firefox Developer Edition
+      return data.FIREFOX_DEVEDITION;
+    }
+
+    // The Firefox Version shipped on the release channel
+    return data.LATEST_FIREFOX_VERSION;
+  }
+
+  static #getAppDir(dir) {
+    const appDirRegexes = {
+      win32: /^core$/,
+      linux: /^firefox$/,
+      darwin: /^Firefox.*\.app$/
+    };
+
+    const contents = fs.readdirSync(dir);
+    const appDir = contents.find(candidateDir =>
+      appDirRegexes[process.platform].test(candidateDir));
+
+    return path.join(dir, appDir);
   }
 
   static #getBinaryPath(dir) {
     checkPlatform();
-    return {
-      win32: path.join(dir, "core", "firefox.exe"),
-      linux: path.join(dir, "firefox", "firefox"),
-      darwin: path.join(dir, "Firefox.app", "Contents", "MacOS", "firefox")
-    }[process.platform];
+
+    const defaultBinaries = {
+      win32: path.join(Firefox.#getAppDir(dir), "firefox.exe"),
+      linux: path.join(Firefox.#getAppDir(dir), "firefox"),
+      darwin: path.join(Firefox.#getAppDir(dir), "Contents", "MacOS", "firefox")
+    };
+
+    return defaultBinaries[process.platform];
   }
 
   static #extractFirefoxArchive(archive, dir) {
@@ -78,11 +106,12 @@ export class Firefox extends Browser {
     }
   }
 
-  static async #getInstalledBrowserInfo(binary) {
-    let installedVersion = await Firefox.getInstalledVersion(binary);
+  /** @see Browser.getInstalledVersion */
+  static async getInstalledVersion(binary) {
+    const installedVersion = await super.getInstalledVersion(binary);
+
     // Linux example: "Mozilla Firefox 102.15.0esr"
-    let versionNumber = installedVersion.split(" ")[2] || installedVersion;
-    return {binary, versionNumber};
+    return installedVersion.split(" ")[2] || installedVersion;
   }
 
   /**
@@ -102,10 +131,15 @@ export class Firefox extends Browser {
     checkVersion(version, MIN_VERSION, Firefox.#CHANNELS);
     let versionNumber = await Firefox.#getVersionForChannel(version);
 
+    const majorVersion = getMajorVersion(versionNumber);
+    // Starting from Firefox 135 on Linux, the binary file extension
+    // was changed from .bz2 to .xz
+    const linuxExtension = majorVersion <= 134 ? "tar.bz2" : "tar.xz";
+
     let [buildPlatform, fileName] = {
       "win32-ia32": ["win32", `Firefox Setup ${versionNumber}.exe`],
       "win32-x64": ["win64", `Firefox Setup ${versionNumber}.exe`],
-      "linux-x64": ["linux-x86_64", `firefox-${versionNumber}.tar.bz2`],
+      "linux-x64": ["linux-x86_64", `firefox-${versionNumber}.${linuxExtension}`],
       "darwin-x64": ["mac", `Firefox ${versionNumber}.dmg`],
       "darwin-arm64": ["mac", `Firefox ${versionNumber}.dmg`]
     }[platformArch];
@@ -113,12 +147,16 @@ export class Firefox extends Browser {
     let snapshotsDir = path.join(snapshotsBaseDir, "firefox");
     let browserDir = path.join(snapshotsDir,
                                `firefox-${platformArch}-${versionNumber}`);
-    let binary = Firefox.#getBinaryPath(browserDir);
+
+    let binary;
     try {
       await fs.promises.access(browserDir);
+      binary = Firefox.#getBinaryPath(browserDir);
       return {binary, versionNumber};
     }
-    catch (e) {}
+    catch (e) {
+      // The binary was not already downloaded
+    }
 
     let archive = path.join(snapshotsDir, "cache", fileName);
     await fs.promises.mkdir(path.dirname(browserDir), {recursive: true});
@@ -126,7 +164,9 @@ export class Firefox extends Browser {
       await fs.promises.access(archive);
     }
     catch (e) {
-      let url = `https://archive.mozilla.org/pub/firefox/releases/${versionNumber}/${buildPlatform}/en-US/${fileName}`;
+      const baseUrl = "https://archive.mozilla.org/pub";
+      const channel = version === "dev" ? "devedition" : "firefox";
+      let url = `${baseUrl}/${channel}/releases/${versionNumber}/${buildPlatform}/en-US/${fileName}`;
       try {
         await download(url, archive, downloadTimeout);
       }
@@ -135,6 +175,7 @@ export class Firefox extends Browser {
       }
     }
     await Firefox.#extractFirefoxArchive(archive, browserDir);
+    binary = Firefox.#getBinaryPath(browserDir);
 
     return {binary, versionNumber};
   }

package/src/utils.js

@@ -91,7 +91,15 @@ export async function download(url, destFile, timeout = 0) {
 
 export async function extractTar(archive, dir) {
   await fs.promises.mkdir(dir);
-  await promisify(exec)(`tar -jxf ${archive} -C ${dir}`);
+
+  let command;
+
+  if (archive.endsWith(".xz"))
+    command = `tar -xf ${archive} -C ${dir}`;
+  else
+    command = `tar -jxf ${archive} -C ${dir}`;
+
+  await promisify(exec)(command);
 }
 
 export async function extractDmg(archive, dir) {

package/test/browsers.js

@@ -27,8 +27,8 @@ import {TEST_SERVER_URL} from "./test-server.js";
 
 const VERSIONS = {
   chromium: ["latest", "77.0.3865.0", "beta", "dev"],
-  firefox: ["latest", "68.0", "beta"],
-  edge: ["latest", "95.0.1020.40", "beta", "dev"]
+  firefox: ["latest", "68.0", "beta", "dev"],
+  edge: ["latest", "114.0.1823.82", "beta", "dev"]
 };
 const TEST_URL_BASIC = `${TEST_SERVER_URL}/basic.html`;
 const PROXY_URL_BASIC = "http://testpages.adblockplus.org/basic.html";
@@ -111,7 +111,7 @@ async function getInstallFileCTime(browser) {
                             process.platform == "darwin"))
     return null;
 
-  const installTypes = [".zip", ".dmg", ".bz2", ".deb", ".exe"];
+  const installTypes = [".zip", ".dmg", ".bz2", ".xz", ".deb", ".exe"];
 
   let cacheDir = path.join(snapshotsBaseDir, browser, "cache");
   let cacheFiles = await fs.promises.readdir(cacheDir);
@@ -355,21 +355,24 @@ for (let browser of Object.keys(BROWSERS)) {
       });
     }
 
-    it("does not install unsupported versions", async function() {
-      if (browser == "edge" && process.platform == "win32")
-        this.skip();
 
-      for (let unsupported of ["0.0", "invalid"]) {
-        await expect(BROWSERS[browser].installBrowser(unsupported))
-          .rejects.toThrow(`Unsupported browser version: ${unsupported}`);
-      }
-    });
+    describe("Any version", async() => {
+      it("does not install unsupported versions", async function() {
+        if (browser == "edge" && process.platform == "win32")
+          this.skip();
 
-    it("does not load an invalid extension", async() => {
-      let extensionPaths = [process.cwd()];
+        for (let unsupported of ["0.0", "invalid"]) {
+          await expect(BROWSERS[browser].installBrowser(unsupported))
+            .rejects.toThrow(`Unsupported browser version: ${unsupported}`);
+        }
+      });
 
-      await expect(BROWSERS[browser].getDriver("latest", {extensionPaths}))
-        .rejects.toThrow(`Extension manifest file not found: ${extensionPaths[0]}`);
+      it("does not load an invalid extension", async() => {
+        let extensionPaths = [process.cwd()];
+
+        await expect(BROWSERS[browser].getDriver("latest", {extensionPaths}))
+          .rejects.toThrow(`Extension manifest file not found: ${extensionPaths[0]}`);
+      });
     });
   });
 }