@eyeo/get-browser-binary 0.14.0 → 0.15.0

package/.gitlab-ci.yml

@@ -29,9 +29,9 @@ test:basic:
 
 test:browsers:linux:
   stage: test
-  image: docker:20.10.16
+  image: docker:24.0.5
   services:
-    - docker:20.10.16-dind
+    - docker:24.0.5-dind
   before_script:
     - docker build -f test/docker/Dockerfile -t browsers .
   script:

package/README.md

@@ -133,20 +133,16 @@ docker run --shm-size=512m -e TEST_ARGS="--grep chromium.*latest --timeout 10000
 
 #### ARM architecture (M1/M2 Apple Silicon)
 
-```shell
-docker build -f test/docker/arm64.Dockerfile -t browsers-arm .
-docker run --shm-size=512m -e TEST_ARGS="--grep (chromium|firefox).*latest" -it browsers-arm
-```
+The run is done emulating the AMD architecture. Requirements:
 
-Only latest Chromium and latest Firefox ESR versions are supported. Edge is not
-supported.
+- macOS >= 13 (Ventura)
+- Rosetta
+- The feature "Use Rosetta for x86/amd64 emulation on Apple Silicon" enabled in Docker
 
-Regarding Firefox, it may be possible to run other versions using AMD emulation
-(unstable results):
+The `--platform` option should be used when running the image:
 
 ```shell
-docker build -f test/docker/Dockerfile -t browsers-amd .
-docker run --platform linux/amd64 --shm-size=512m -e TEST_ARGS="--grep firefox.*68.0" -it browsers-amd
+docker run --platform linux/amd64 --shm-size=512m -e TEST_ARGS="--grep chromium.*latest" -it browsers
 ```
 
 ## Building the documentation

package/RELEASE_NOTES.md

@@ -1,3 +1,13 @@
+# 0.15.0
+
+- Fixes the downloads of Chromium versions < 91 by replacing the remaining
+usages of omahaproxy API (now removed) with chromiumdash (#55)
+- Updates to selenium webdriver 4.15.0 (#66)
+
+### Testing
+
+- Uses AMD emulation on ARM docker test runs (!93)
+
 # 0.14.0
 
 - Increases minimum supported browser versions (#64)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Install browser binaries and matching webdrivers",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     "geckodriver": "3.1.0",
     "got": "^12.5.3",
     "jimp": "^0.22.4",
-    "selenium-webdriver": "^4.8.0"
+    "selenium-webdriver": "^4.15.0"
   },
   "devDependencies": {
     "eslint": "^8.33.0",

package/src/chromium.js

@@ -85,10 +85,20 @@ export class Chromium extends Browser {
     let url;
     let chromiumBase;
     try {
-      // 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());
+      let majorVersion = getMajorVersion(chromiumVersion);
+      if (majorVersion < 91) {
+        // Below v91, base branch position only exists once per milestone in
+        // the /fetch_milestones endpoint
+        url = "https://chromiumdash.appspot.com/fetch_milestones?only_branched=true";
+        let data = await got(url).json();
+        for (let {milestone, chromium_main_branch_position: base} of data) {
+          if (milestone == majorVersion) {
+            chromiumBase = base;
+            break;
+          }
+        }
+        if (!chromiumBase)
+          throw new Error(`${errMsg.browserVersionCheck}: ${url}`);
       }
       else {
         url = `https://chromiumdash.appspot.com/fetch_version?version=${chromiumVersion}`;
@@ -128,10 +138,6 @@ export class Chromium extends Browser {
     let versionNumber;
     let base;
 
-    // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
-    if (platformArch == "linux-arm64")
-      return await Chromium.#getInstalledBrowserInfo("/usr/bin/chromium");
-
     checkVersion(version, MIN_VERSION, Chromium.#CHANNELS);
     versionNumber = await Chromium.#getVersionForChannel(version);
 
@@ -194,7 +200,6 @@ export class Chromium extends Browser {
       "win32-ia32": ["Win", "chromedriver_win32.zip", "chromedriver.exe"],
       "win32-x64": ["Win_x64", "chromedriver_win32.zip", "chromedriver.exe"],
       "linux-x64": ["Linux_x64", "chromedriver_linux64.zip", "chromedriver"],
-      "linux-arm64": ["", "", "chromedriver"],
       "darwin-x64": ["Mac", "chromedriver_mac64.zip", "chromedriver"],
       "darwin-arm64": ["Mac_Arm", "chromedriver_mac64.zip", "chromedriver"]
     }[platformArch];
@@ -207,37 +212,22 @@ export class Chromium extends Browser {
       await extractZip(archive, {dir: cacheDir});
     }
     catch (e) { // zip file is either not cached or corrupted
-      if (platformArch == "linux-arm64") {
-        // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
-        // It's unclear how electron releases match Chromium versions. Once that
-        // is figured out, the link below will depend on the Chromium version.
-        // https://stackoverflow.com/questions/38732822/compile-chromedriver-on-arm
-        let url = "https://github.com/electron/electron/releases/download/v26.2.0/chromedriver-v26.2.0-linux-arm64.zip";
+      let base = startBase;
+      while (true) {
+        let url = `https://commondatastorage.googleapis.com/chromium-browser-snapshots/${dir}/${base}/${zip}`;
         try {
           await download(url, archive);
+          break;
         }
         catch (err) {
-          throw new Error(`${errMsg.driverDownload}: ${url}\n${err}`);
-        }
-      }
-      else {
-        let base = startBase;
-        while (true) {
-          let url = `https://commondatastorage.googleapis.com/chromium-browser-snapshots/${dir}/${base}/${zip}`;
-          try {
-            await download(url, archive);
-            break;
+          if (err.name == "HTTPError") {
+            base--;
+            archive = path.join(cacheDir, `${base}-${zip}`);
+            if (base <= startBase - Chromium.#MAX_VERSION_DECREMENTS)
+              throw new Error(`${errMsg.driverDownload}: Chromium base ${startBase}`);
           }
-          catch (err) {
-            if (err.name == "HTTPError") {
-              base--;
-              archive = path.join(cacheDir, `${base}-${zip}`);
-              if (base <= startBase - Chromium.#MAX_VERSION_DECREMENTS)
-                throw new Error(`${errMsg.driverDownload}: Chromium base ${startBase}`);
-            }
-            else {
-              throw new Error(`${errMsg.driverDownload}: ${url}\n${err}`);
-            }
+          else {
+            throw new Error(`${errMsg.driverDownload}: ${url}\n${err}`);
           }
         }
       }
@@ -246,8 +236,6 @@ export class Chromium extends Browser {
 
     await killDriverProcess("chromedriver");
     let driverPath = path.join(cacheDir, zip.split(".")[0], driverBinary);
-    if (platformArch == "linux-arm64")
-      driverPath = path.join(cacheDir, driverBinary);
     await fs.promises.rm(driverPath, {force: true});
     await extractZip(archive, {dir: cacheDir});
 

package/src/firefox.js

@@ -98,10 +98,6 @@ export class Firefox extends Browser {
   static async installBrowser(version = "latest", downloadTimeout = 0) {
     const MIN_VERSION = 68;
 
-    // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
-    if (platformArch == "linux-arm64")
-      return await Firefox.#getInstalledBrowserInfo("/usr/bin/firefox");
-
     checkVersion(version, MIN_VERSION, Firefox.#CHANNELS);
     let versionNumber = await Firefox.#getVersionForChannel(version);
 

package/test/browsers.js

@@ -107,20 +107,12 @@ function getExtension(browser, version) {
 }
 
 async function getCachedTimes(browser) {
-  let armLinux = process.platform == "linux" && process.arch == "arm64";
   let cacheDir = path.join(snapshotsBaseDir, browser, "cache");
-  let cacheFiles;
-  try {
-    cacheFiles = await fs.promises.readdir(cacheDir);
-  }
-  catch (err) {
-    if (!armLinux)
-      throw err;
-  }
+  let cacheFiles = await fs.promises.readdir(cacheDir);
 
   let browserCacheTime = null;
   // Browsers installed at OS level are not tested
-  if (browser != "edge" && !armLinux) {
+  if (browser != "edge") {
     let installTypes = [".zip", ".dmg", ".bz2"];
     let browserZip =
       cacheFiles.find(elem => installTypes.some(type => elem.includes(type)));
@@ -130,8 +122,7 @@ async function getCachedTimes(browser) {
 
   let driverCacheTime = null;
   // geckodriver is installed by npm, that's why Firefox is not tested here
-  // for chromiumdriver on arm linux, see https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
-  if (browser != "firefox" && !armLinux) {
+  if (browser != "firefox") {
     let driverDir = cacheFiles.find(
       elem => !elem.endsWith(".zip") && !elem.endsWith(".pkg"));
     let driverFiles = await fs.promises.readdir(path.join(cacheDir, driverDir));
@@ -323,11 +314,5 @@ 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/docker/arm64.Dockerfile

@@ -1,27 +0,0 @@
-# Duplicated from registry.gitlab.com/eyeo/docker/get-browser-binary:node18
-# https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
-FROM node:18-bullseye-slim
-# General packages
-RUN apt-get update && apt-get install -y git procps wget unzip bzip2 gnupg
-# xvfb (headful browser run)
-RUN apt-get install -y libgtk-3-0 libxt6 xvfb libnss3 libxss1
-# General browser dependencies
-RUN apt-get install -y libgconf-2-4 libasound2 libgbm1
-# Edge dependencies
-RUN apt-get install -y fonts-liberation libatomic1 xdg-utils libu2f-udev
-
-# Chromium ARM
-RUN apt-get install -y chromium
-# https://askubuntu.com/questions/1360864/google-chrome-not-launching
-RUN mkdir -p "/root/.config/chromium/Crash Reports/pending/"
-
-# Firefox ARM
-RUN apt-get install -y firefox-esr
-
-COPY package*.json get-browser-binary/
-RUN cd get-browser-binary && npm install
-
-COPY . get-browser-binary/
-
-ENV TEST_ARGS="--grep Browser"
-ENTRYPOINT get-browser-binary/test/docker/entrypoint.sh