@eyeo/get-browser-binary 0.20.1 → 0.21.0

package/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 default:
-  image: registry.gitlab.com/eyeo/docker/get-browser-binary:node18
+  image: registry.gitlab.com/eyeo/docker/get-browser-binary:node22
   interruptible: true
 
 stages:
@@ -49,29 +49,26 @@ test:browsers:linux:dev:
 .windows:
   stage: test
   before_script:
-    - choco install -y microsoft-edge
     - npm install
   tags:
     - eyeo-windows
   cache: {}
-  # Retrying to mitigate Edge install issues
-  retry: 1
 
 test:browsers:windows:
   extends: .windows
   script:
     # Running Edge tests only on the preinstalled version
     # https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/29
-    - npm test -- --grep "edge.*latest"
-    - npm test -- --grep "^.*chromium((?!Version:.dev).)*$"
+    - npm test "--" --grep "edge.*latest"
+    - npm test "--" --grep "^.*chromium((?!Version:.dev).)*$"
     # Running only a subset of Firefox tests to avoid low OS resources error
     # https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/2
-    - npm test -- --grep "firefox.*installs"
+    - npm test "--" --grep "firefox.*installs"
 
 test:browsers:windows:dev:
   extends: .windows
   script:
-    - npm test -- --grep "chromium.*Version:.dev"
+    - npm test "--" --grep "chromium.*Version:.dev"
   allow_failure: true
 
 docs:

package/.nvmrc

@@ -0,0 +1 @@
+22.14.0

package/RELEASE_NOTES.md

@@ -1,8 +1,21 @@
 # Unreleased
 
+# 0.21.0
+
+- Fixes an issue on Chromedriver (>=136) which stopped returning webdriver
+  handles for extension pages (!139)
+- Fixes an issue on Firefox (>=138) when getting the installed version through
+  the binary file (#86)
+- Updates the minimum supported version of Node to 22. Node 22 is the current
+  LTS version of Node (EXT-778)
+
+# 0.20.2
+
+- Fixes getting majorVersion on Edge (!133)
+
 # 0.20.1
 
-- test: Fixes enabling developer mode (!131)
+- Fixes enabling developer mode (!131)
 
 # 0.20.0
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.20.1",
+  "version": "0.21.0",
   "description": "Install browser binaries and matching webdrivers",
   "repository": {
     "type": "git",
@@ -9,8 +9,8 @@
   "author": "eyeo GmbH",
   "license": "GPL-3.0",
   "engines": {
-    "node": ">=18",
-    "npm": ">=9"
+    "node": ">=22",
+    "npm": ">=10"
   },
   "type": "module",
   "main": "index.js",

package/src/browser.js

@@ -55,6 +55,12 @@ export class Browser {
    * @throws {Error} Browser is not installed.
    */
   static async getInstalledVersion(binary) {
+    // Since Firefox v138, calling `[firefox binary] --version` produces an
+    // EPERM error on the CI, even though the browser version is returned
+    // correctly. Ignoring that error as a workaround.
+    const ignoredError =
+      "Sandbox: CanCreateUserNamespace() clone() failure: EPERM";
+
     try {
       let stdout;
       let stderr;
@@ -67,8 +73,8 @@ export class Browser {
       else {
         ({stdout, stderr} = await promisify(execFile)(binary, ["--version"]));
       }
-      if (stderr)
-        throw new Error(stderr);
+      if (stderr && !stderr.includes(ignoredError))
+        throw new Error(JSON.stringify({stdout, stderr}, null, 2));
 
       return stdout.trim();
     }

package/src/chromium.js

@@ -42,6 +42,17 @@ async function enableDeveloperMode(driver) {
       devModeToggle.click();
   });
 
+  await driver.wait(async() => {
+    const checked = await driver.executeScript(() => {
+      const devModeToggle = document
+      .querySelector("extensions-manager").shadowRoot
+      .getElementById("toolbar").shadowRoot
+      .querySelector("#toolbar #devMode");
+      return devModeToggle.checked;
+    });
+    return checked;
+  }, 500);
+
   await driver.close();
   await driver.switchTo().window(currentHandle);
 }
@@ -225,12 +236,18 @@ export class Chromium extends Browser {
       await Chromium.#getInstalledBrowserInfo(customBrowserBinary) :
       await Chromium.installBrowser(version, downloadTimeout);
 
-    let options = new chrome.Options().addArguments("no-sandbox", ...extraArgs);
+    const majorVersion = getMajorVersion(versionNumber);
+    const chromeOptions = {};
+    // https://issues.chromium.org/issues/409441960
+    if (majorVersion >= 136)
+      chromeOptions.enableExtensionTargets = true;
+
+    const options = new chrome.Options({"goog:chromeOptions": chromeOptions})
+      .addArguments("no-sandbox", ...extraArgs);
     if (extensionPaths.length > 0) {
       await checkExtensionPaths(extensionPaths);
       options.addArguments(`load-extension=${extensionPaths.join(",")}`);
     }
-    let majorVersion = getMajorVersion(versionNumber);
     if (headless) {
       // https://www.selenium.dev/blog/2023/headless-is-going-away/
       if (majorVersion >= 109)

package/src/edge.js

@@ -42,6 +42,14 @@ async function enableDeveloperMode(driver) {
       devModeToggle.click();
   });
 
+  await driver.wait(async() => {
+    const checked = await driver.executeScript(() => {
+      const devModeToggle = document.getElementById("developer-mode");
+      return devModeToggle.checked;
+    });
+    return checked;
+  }, 500);
+
   await driver.close();
   await driver.switchTo().window(currentHandle);
 }
@@ -214,9 +222,16 @@ export class Edge extends Browser {
         await Edge.getInstalledVersion(binary);
     }
 
-    let options = new edge.Options().addArguments("no-sandbox", ...extraArgs);
+    const majorVersion = getMajorVersion(versionNumber);
+    const edgeOptions = {};
+    // https://issues.chromium.org/issues/409441960
+    if (majorVersion >= 136)
+      edgeOptions.enableExtensionTargets = true;
+
+    const options = new edge.Options({"ms:edgeOptions": edgeOptions})
+      .addArguments("no-sandbox", ...extraArgs);
     if (headless) {
-      if (versionNumber && getMajorVersion(versionNumber) >= 114)
+      if (versionNumber && majorVersion >= 114)
         options.addArguments("headless=new");
       else
         options.addArguments("headless");
@@ -253,7 +268,7 @@ export class Edge extends Browser {
 
     // From Edge 134 on, developer mode needs to be enabled
     // for custom extensions to work properly
-    if (versionNumber >= 134)
+    if (majorVersion >= 134)
       await enableDeveloperMode(driver);
 
     return driver;

package/test/docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM registry.gitlab.com/eyeo/docker/get-browser-binary:node18
+FROM registry.gitlab.com/eyeo/docker/get-browser-binary:node22
 
 COPY package*.json get-browser-binary/
 RUN cd get-browser-binary && npm install