@eyeo/get-browser-binary 0.19.0 → 0.20.1

package/.mocharc.json

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

package/RELEASE_NOTES.md

@@ -1,5 +1,15 @@
 # Unreleased
 
+# 0.20.1
+
+- test: Fixes enabling developer mode (!131)
+
+# 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)

package/package.json

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

package/src/browser.js

@@ -125,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,25 @@ import {Browser} from "./browser.js";
 import {download, getMajorVersion, checkVersion, checkPlatform, errMsg,
         snapshotsBaseDir, platformArch, checkExtensionPaths} from "./utils.js";
 
+async function enableDeveloperMode(driver) {
+  const currentHandle = await driver.getWindowHandle();
+
+  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();
+  });
+
+  await driver.close();
+  await driver.switchTo().window(currentHandle);
+}
+
 /**
  * Browser and webdriver functionality for Chromium.
  * @hideconstructor
@@ -211,8 +230,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");
@@ -227,11 +246,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,23 @@ import {download, killDriverProcess, wait, getMajorVersion, checkVersion,
         checkPlatform, errMsg, snapshotsBaseDir, checkExtensionPaths}
   from "./utils.js";
 
-let {By} = webdriver;
 let {platform} = process;
 
+async function enableDeveloperMode(driver) {
+  const currentHandle = await driver.getWindowHandle();
+  await driver.switchTo().newWindow("window");
+  await driver.navigate().to("edge://extensions/");
+
+  await driver.executeScript(() => {
+    const devModeToggle = document.getElementById("developer-mode");
+    if (!devModeToggle.checked)
+      devModeToggle.click();
+  });
+
+  await driver.close();
+  await driver.switchTo().window(currentHandle);
+}
+
 /**
  * Browser and webdriver functionality for Edge.
  * @hideconstructor
@@ -83,19 +97,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 +138,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);
@@ -143,16 +161,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,7 +180,7 @@ 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`);
     }
 
@@ -213,10 +229,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);
 
@@ -235,25 +251,46 @@ export class Edge extends Browser {
       }
     }, 30000, `${errMsg.driverStart}: msedgedriver`, 1000);
 
+    // From Edge 134 on, developer mode needs to be enabled
+    // for custom extensions to work properly
+    if (versionNumber >= 134)
+      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))
         continue;
 
       for (let button of await elem.findElements(By.css("button"))) {
-        text = await elem.getAttribute("innerHTML");
+        text = await button.getAttribute("outerHTML");
         if (!text.includes("Details"))
           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
@@ -221,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/test/browsers.js

@@ -224,6 +224,11 @@ for (let browser of Object.keys(BROWSERS)) {
 
         it("runs", async function() {
           driver = await BROWSERS[browser].getDriver(version);
+          const url = await driver.getCurrentUrl();
+          // check that default automation tab is in focus:
+          // data;, (chromium) and about:blank (firefox)
+          expect(url).toEqual(expect.stringMatching(/^(data:,|about:blank)$/));
+
           await basicUrlTest(driver, browser);
 
           let browserVersion =