@eyeo/get-browser-binary 0.12.0 → 0.13.0

package/README.md

@@ -83,6 +83,14 @@ Increasing the timeout may be useful on slow connection environments:
 npm test -- --timeout <ms>
 ```
 
+By default, tests delete the `./browser-snapshots` before each `Browser` suite
+runs. To change that behavior you may set the `TEST_KEEP_SNAPSHOTS` environment
+variable to `true`. Example:
+
+```shell
+TEST_KEEP_SNAPSHOTS=true npm test
+```
+
 ### Running tests on Docker
 
 Useful to reproduce the CI environment of the `test:browsers:linux` job.
@@ -101,14 +109,6 @@ parameter:
 docker run --shm-size=512m -e TEST_ARGS="--grep chromium.*latest --timeout 100000" -it browsers
 ```
 
-By default, tests delete the `./browser-snapshots` before each `Browser` suite
-runs. To change that behavior you may set the `TEST_KEEP_SNAPSHOTS` environment
-variable to `true`. Example:
-
-```shell
-TEST_KEEP_SNAPSHOTS=true npm test
-```
-
 #### ARM architecture (M1/M2 Apple Silicon)
 
 Chromium (ARM native):

package/RELEASE_NOTES.md

@@ -1,3 +1,17 @@
+# 0.13.0
+
+- Fixes an issue that prevented the webdriver from locating the Edge binary on
+Linux (#60)
+- Uses headless new mode on Edge >= 116 (!74)
+- Replaces omahaproxy API (deprecated) with chromiumdash (!73)
+- Throws a `browser not installed` error when `customBinaryPath` doesn't exist
+(!72)
+
+### Testing
+
+- Changes the test extension in incognito mode from spanning to split (#59)
+- Runs Linux Edge tests in a different browser version order (!71)
+
 # 0.12.0
 
 - Adds a new field `customBrowserBinary` to `getDriver()` options parameter that

package/package.json

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

package/src/browsers.js

@@ -102,23 +102,29 @@ class Browser {
    * Gets the installed version returned by the browser binary.
    * @param {string} binary The path to the browser binary.
    * @return {string} Installed browser version.
+   * @throws {Error} Browser is not installed.
    */
   static async getInstalledVersion(binary) {
-    let stdout;
     try {
+      let stdout;
+      let stderr;
       if (platform == "win32") {
-        ({stdout} = await promisify(exec)(
+        ({stdout, stderr} = await promisify(exec)(
           `(Get-ItemProperty ${binary}).VersionInfo.ProductVersion`,
           {shell: "powershell.exe"})
         );
       }
       else {
-        ({stdout} = await promisify(execFile)(binary, ["--version"]));
+        ({stdout, stderr} = await promisify(execFile)(binary, ["--version"]));
       }
+      if (stderr)
+        throw new Error(stderr);
+
       return stdout.trim();
     }
-    catch (e) {}
-    return "";
+    catch (err) {
+      throw new Error(`${BROWSER_NOT_INSTALLED_ERROR}.\nBinary path: ${binary}\n${err}`);
+    }
   }
 
   /**
@@ -201,7 +207,8 @@ class Chromium extends Browser {
       "darwin-x64": "mac",
       "darwin-arm64": "mac_arm64"
     }[platformArch];
-    let url = `https://omahaproxy.appspot.com/all.json?os=${os}`;
+    let url = `https://versionhistory.googleapis.com/v1/chrome/platforms/${os}/channels/${channel}/versions/all/releases`;
+
     let data;
     try {
       data = await got(url).json();
@@ -209,13 +216,7 @@ class Chromium extends Browser {
     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;
-
-    if (release.true_branch && release.true_branch.includes("_"))
-      // A wrong base may be caused by a mini-branch (patched) release
-      // In that case, the base is taken from the unpatched version
-      version = [...version.split(".").slice(0, 3), "0"].join(".");
+    let {version} = data.releases[0];
 
     return version;
   }
@@ -231,10 +232,18 @@ class Chromium extends Browser {
   }
 
   static async #getBase(chromiumVersion) {
-    let url = `https://omahaproxy.appspot.com/deps.json?version=${chromiumVersion}`;
+    let url;
     let chromiumBase;
     try {
-      ({chromium_base_position: chromiumBase} = await got(url).json());
+      // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/55
+      if (getMajorVersion(chromiumVersion) < 91) {
+        url = `https://omahaproxy.appspot.com/deps.json?version=${chromiumVersion}`;
+        ({chromium_base_position: chromiumBase} = await got(url).json());
+      }
+      else {
+        url = `https://chromiumdash.appspot.com/fetch_version?version=${chromiumVersion}`;
+        ({chromium_main_branch_position: chromiumBase} = await got(url).json());
+      }
     }
     catch (err) {
       throw new Error(`${BROWSER_VERSION_CHECK_ERROR}: ${url}\n${err}`);
@@ -797,9 +806,6 @@ class Edge extends Browser {
 
     let binaryPath = binary || Edge.#getBinaryPath();
     let versionNumber = await Edge.#getInstalledVersionNumber(binaryPath);
-    if (!versionNumber)
-      throw new Error(`${BROWSER_NOT_INSTALLED_ERROR}. Binary path: ${binaryPath}`);
-
     let [zip, driverBinary] = {
       "win32-ia32": ["edgedriver_win32.zip", "msedgedriver.exe"],
       "win32-x64": ["edgedriver_win64.zip", "msedgedriver.exe"],
@@ -844,21 +850,35 @@ class Edge extends Browser {
     extraArgs = [], customBrowserBinary
   } = {}, downloadTimeout = 0) {
     let binary;
-    if (!customBrowserBinary && (platform == "linux" || platform == "darwin"))
-      ({binary} = await Edge.installBrowser(version, downloadTimeout));
+    let versionNumber;
+    if (!customBrowserBinary && (platform == "linux" || platform == "darwin")) {
+      ({binary, versionNumber} =
+        await Edge.installBrowser(version, downloadTimeout));
+    }
+    else {
+      binary = customBrowserBinary || Edge.#getBinaryPath();
+      versionNumber =
+        await Edge.#getInstalledVersionNumber(binary);
+    }
 
-    let driverPath = await Edge.#installDriver(customBrowserBinary || binary);
+    let driverPath = await Edge.#installDriver(binary);
     let serviceBuilder = new edge.ServiceBuilder(driverPath);
 
     let options = new edge.Options().addArguments("no-sandbox", ...extraArgs);
-    if (headless)
-      options.headless();
+    if (headless) {
+      if (versionNumber && getMajorVersion(versionNumber) >= 114)
+        options.addArguments("headless=new");
+      else
+        options.headless();
+    }
     if (extensionPaths.length > 0)
       options.addArguments(`load-extension=${extensionPaths.join(",")}`);
     if (incognito)
       options.addArguments("inprivate");
     if (insecure)
       options.addArguments("ignore-certificate-errors");
+    if (platform == "linux")
+      options.setEdgeChromiumBinaryPath(`/usr/bin/${binary}`);
 
     let builder = new webdriver.Builder();
     builder.forBrowser("MicrosoftEdge");

package/test/browsers.js

@@ -28,7 +28,8 @@ 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: ["dev", "latest", "beta", "95.0.1020.40"]
+  // Unusual ordering: https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/57
+  edge: ["dev", "beta", "latest", "95.0.1020.40"]
 };
 const TEST_URL = "https://abptestpages.org/en/exceptions/iframe_subdomains";
 const TEST_URL_LONG_PAGE = "https://abptestpages.org/";
@@ -300,5 +301,11 @@ for (let browser of Object.keys(BROWSERS)) {
           .rejects.toThrow(`Unsupported browser version: ${unsupported}`);
       }
     });
+
+    it("does not run not installed custom browsers", async() => {
+      let customBrowserBinary = "not-installed";
+      await expect(BROWSERS[browser].getDriver("latest", {customBrowserBinary}))
+        .rejects.toThrow(/(Browser is not installed|binary is not a Firefox executable)/);
+    });
   });
 }

package/test/extension/mv3/manifest.json

@@ -4,5 +4,6 @@
   "manifest_version": 3,
   "background": {
     "service_worker": "background.js"
-  }
+  },
+  "incognito": "split"
 }