@eyeo/get-browser-binary 0.18.0 → 0.20.0

package/.mocharc.json

@@ -1,3 +1,3 @@
 {
-  "timeout": 80000
+  "timeout": 90000
 }

package/RELEASE_NOTES.md

@@ -1,4 +1,19 @@
-# Unreleased 
+# Unreleased
+
+# 0.20.0
+
+- Enable developer mode for incognito tests (!126)
+- Adds support to beta and dev channels for Edge in macOS (!127)
+- Enable developer mode for latest versions of chromium browsers (!128)
+
+# 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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.18.0",
+  "version": "0.20.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.
@@ -124,7 +125,6 @@ export class Browser {
    * enables the extension when loaded in incognito.
    * @param {webdriver} driver The driver controlling the browser.
    * @param {string} extensionTitle Title of the extension to be enabled.
-   * @return {webdriver}
    * @throws {Error} Unsupported browser version, Extension not found, HTML
    *   element not found.
    */

package/src/chromium.js

@@ -19,7 +19,7 @@ import path from "path";
 import fs from "fs";
 
 import got from "got";
-import webdriver from "selenium-webdriver";
+import {Builder} from "selenium-webdriver";
 import chrome from "selenium-webdriver/chrome.js";
 import extractZip from "extract-zip";
 
@@ -27,6 +27,20 @@ import {Browser} from "./browser.js";
 import {download, getMajorVersion, checkVersion, checkPlatform, errMsg,
         snapshotsBaseDir, platformArch, checkExtensionPaths} from "./utils.js";
 
+async function enableDeveloperMode(driver) {
+  await driver.switchTo().newWindow("window");
+  await driver.navigate().to("chrome://extensions");
+  await driver.executeScript(() => {
+    const devModeToggle = document
+      .querySelector("extensions-manager").shadowRoot
+      .getElementById("toolbar").shadowRoot
+      .querySelector("#toolbar #devMode");
+
+    if (!devModeToggle.checked)
+      devModeToggle.click();
+  });
+}
+
 /**
  * Browser and webdriver functionality for Chromium.
  * @hideconstructor
@@ -110,11 +124,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};
   }
 
@@ -204,8 +225,8 @@ export class Chromium extends Browser {
       await checkExtensionPaths(extensionPaths);
       options.addArguments(`load-extension=${extensionPaths.join(",")}`);
     }
+    let majorVersion = getMajorVersion(versionNumber);
     if (headless) {
-      let majorVersion = getMajorVersion(versionNumber);
       // https://www.selenium.dev/blog/2023/headless-is-going-away/
       if (majorVersion >= 109)
         options.addArguments("headless=new");
@@ -220,11 +241,18 @@ export class Chromium extends Browser {
       options.addArguments("incognito");
     options.setChromeBinaryPath(binary);
 
-    let builder = new webdriver.Builder();
+    let builder = new Builder();
     builder.forBrowser("chrome");
     builder.setChromeOptions(options);
 
-    return builder.build();
+    const driver = builder.build();
+
+    // From Chromium 134 on, developer mode needs to be enabled
+    // for custom extensions to work properly
+    if (majorVersion >= 134)
+      await enableDeveloperMode(driver);
+
+    return driver;
   }
 
   /** @see Browser.enableExtensionInIncognito */

package/src/edge.js

@@ -21,7 +21,7 @@ import {promisify} from "util";
 import fs from "fs";
 
 import got from "got";
-import webdriver from "selenium-webdriver";
+import {until, By, Builder} from "selenium-webdriver";
 import edge from "selenium-webdriver/edge.js";
 
 import {Browser} from "./browser.js";
@@ -29,9 +29,16 @@ import {download, killDriverProcess, wait, getMajorVersion, checkVersion,
         checkPlatform, errMsg, snapshotsBaseDir, checkExtensionPaths}
   from "./utils.js";
 
-let {By} = webdriver;
 let {platform} = process;
 
+async function enableDeveloperMode(driver) {
+  await driver.navigate().to("edge://extensions/");
+  const devModeToggle = driver.findElement(By.id("developer-mode"));
+
+  if (!devModeToggle.checked)
+    devModeToggle.click();
+}
+
 /**
  * Browser and webdriver functionality for Edge.
  * @hideconstructor
@@ -83,19 +90,24 @@ export class Edge extends Browser {
     return {versionNumber, channel};
   }
 
-  static #darwinApp = "Microsoft Edge";
+  static #getDarwinApp(channel = "stable") {
+    const firstUppercase =
+      String(channel).charAt(0).toUpperCase() + String(channel).slice(1);
+    return channel === "stable" ? "Microsoft Edge" : `Microsoft Edge ${firstUppercase}`;
+  }
 
   static #getBinaryPath(channel = "stable") {
     switch (platform) {
       case "win32":
-        let programFiles = process.env["ProgramFiles(x86)"] ?
+        const programFiles = process.env["ProgramFiles(x86)"] ?
           "${Env:ProgramFiles(x86)}" : "${Env:ProgramFiles}";
         return `${programFiles}\\Microsoft\\Edge\\Application\\msedge.exe`;
       case "linux":
         return channel == "stable" ?
           "/usr/bin/microsoft-edge" : `/usr/bin/microsoft-edge-${channel}`;
       case "darwin":
-        return `${process.env.HOME}/Applications/${Edge.#darwinApp}.app/Contents/MacOS/${Edge.#darwinApp}`;
+        const darwinApp = Edge.#getDarwinApp(channel);
+        return `${process.env.HOME}/Applications/${darwinApp}.app/Contents/MacOS/${darwinApp}`;
       default:
         checkPlatform();
     }
@@ -119,9 +131,8 @@ export 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(`${errMsg.unsupportedPlatform}: ${platform}`);
 
-    if (platform == "darwin" && version != "latest")
-      // Only latest Edge is supported on macOS
-      throw new Error(`${errMsg.unsupportedVersion}: ${version}. Only "latest" is supported`);
+    if (platform == "darwin" && !/latest|beta|dev/.test(version))
+      throw new Error(`${errMsg.unsupportedVersion}: ${version}. Only "latest", "beta" or "dev" are supported`);
 
     checkVersion(version, Edge.#MIN_VERSION, Edge.#CHANNELS);
     let {versionNumber, channel} = await Edge.#getVersionForChannel(version);
@@ -135,7 +146,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) {}
@@ -143,16 +154,14 @@ export class Edge extends Browser {
     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;
+        const caskFile = channel === "stable" ? "microsoft-edge.json" : `microsoft-edge@${channel}.json`;
+        const caskUrl = `https://formulae.brew.sh/api/cask/${caskFile}`;
         try {
-          caskJson = await got(caskUrl).json();
+          ({url} = await got(caskUrl).json());
         }
         catch (err) {
           throw new Error(`${errMsg.browserVersionCheck}: ${caskUrl}\n${err}`);
         }
-        ({url} = process.arch == "arm64" ?
-          caskJson.variations.arm64_ventura : caskJson);
       }
       await download(url, archive, downloadTimeout);
     }
@@ -164,15 +173,16 @@ export class Edge extends Browser {
       await promisify(exec)(`dpkg -i ${archive}`);
     }
     else if (platform == "darwin") {
-      await fs.promises.rm(`${process.env.HOME}/Applications/${Edge.#darwinApp}.app`, {force: true, recursive: true});
+      await fs.promises.rm(`${process.env.HOME}/Applications/${Edge.#getDarwinApp(channel)}.app`, {force: true, recursive: true});
       await promisify(exec)(`installer -pkg ${archive} -target CurrentUserHomeDirectory`);
     }
 
     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/, "");
@@ -194,7 +204,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);
@@ -212,10 +222,10 @@ export class Edge extends Browser {
       options.addArguments("inprivate");
     if (insecure)
       options.addArguments("ignore-certificate-errors");
-    if (platform == "linux")
+    if (platform === "linux" || platform === "darwin")
       options.setEdgeChromiumBinaryPath(binary);
 
-    let builder = new webdriver.Builder();
+    let builder = new Builder();
     builder.forBrowser("MicrosoftEdge");
     builder.setEdgeOptions(options);
 
@@ -234,12 +244,17 @@ export class Edge extends Browser {
       }
     }, 30000, `${errMsg.driverStart}: msedgedriver`, 1000);
 
+    // Developer mode needs to be enabled
+    // for custom extensions to work properly
+    await enableDeveloperMode(driver);
+
     return driver;
   }
 
   /** @see Browser.enableExtensionInIncognito */
   static async enableExtensionInIncognito(driver, extensionTitle) {
     await driver.navigate().to("edge://extensions/");
+
     for (let elem of await driver.findElements(By.css("[role=listitem]"))) {
       let text = await elem.getAttribute("innerHTML");
       if (!text.includes(extensionTitle))
@@ -251,8 +266,23 @@ export class Edge extends Browser {
           continue;
 
         await button.click();
-        return await driver.findElement(By.id("itemAllowIncognito")).click();
+        await driver.findElement(By.id("itemAllowIncognito")).click();
+
+        // On Edge 134, extension gets turned off when incognito mode is enabled
+        // We need to turn it back on by clicking the toggle
+        try {
+          await driver.wait(until.elementLocated(
+            By.css('[aria-label="Extension on"]:not(:checked)')), 3000).click();
+        }
+        catch (err) {
+          // ignoring timeout errors, as the element is not expected
+          // to be present for all Edge versions
+          if (err.name !== "TimeoutError")
+            throw err;
+        }
+        return;
       }
+
       throw new Error(`${errMsg.elemNotFound}: Details button`);
     }
     throw new Error(`${errMsg.extensionNotFound}: ${extensionTitle}`);

package/src/firefox.js

@@ -21,7 +21,7 @@ import {promisify} from "util";
 import fs from "fs";
 
 import got from "got";
-import webdriver from "selenium-webdriver";
+import {until, By, Builder} from "selenium-webdriver";
 import firefox from "selenium-webdriver/firefox.js";
 import {Command} from "selenium-webdriver/lib/command.js";
 
@@ -30,8 +30,6 @@ import {download, extractTar, extractDmg, killDriverProcess, wait,
         getMajorVersion, checkVersion, checkPlatform, errMsg, snapshotsBaseDir,
         platformArch, checkExtensionPaths} from "./utils.js";
 
-let {until, By} = webdriver;
-
 /**
  * Browser and webdriver functionality for Firefox.
  * @hideconstructor
@@ -106,11 +104,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;
   }
 
   /**
@@ -130,10 +129,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];
@@ -215,7 +219,7 @@ export class Firefox extends Browser {
     // https://github.com/mozilla/geckodriver/issues/1560
     await wait(async() => {
       try {
-        driver = await new webdriver.Builder()
+        driver = await new Builder()
           .forBrowser("firefox")
           .setFirefoxOptions(options)
           .build();

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

@@ -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);

package/test/extension/mv3/background.js

@@ -1,16 +1,3 @@
 "use strict";
 
-// There's an issue with Chrome +133 and selenium webdriver where
-// getAllWindowHandles() can't see tabs opened by an extension if the url option
-// opens an extension page. Example: chrome.tabs.create({url: "index.html"});
-//
-// Workaround: Create the tab with empty options, which allows
-// getAllWindowHandles() to see it, and afterwards update the tab with the
-// intended url.
-
-// This timeout must be higher than driver.geAllWindowHandles() polling interval
-const timeout = 1000;
-
-chrome.tabs.create({}, ({tabId}) => {
-  setTimeout(() => chrome.tabs.update(tabId, {url: "index.html"}), timeout);
-});
+chrome.tabs.create({url: "index.html"});