@eyeo/get-browser-binary 0.10.0 → 0.11.0

package/README.md

@@ -84,7 +84,9 @@ npm test -- --timeout <ms>
 
 ### Running tests on Docker
 
-Useful to reproduce the CI environment of the `test:browsers:linux` job:
+Useful to reproduce the CI environment of the `test:browsers:linux` job.
+
+#### Intel/AMD architecture
 
 ```shell
 docker build -f test/docker/Dockerfile -t browsers .
@@ -106,6 +108,24 @@ variable to `true`. Example:
 TEST_KEEP_SNAPSHOTS=true npm test
 ```
 
+#### ARM architecture (M1/M2 Apple Silicon)
+
+Chromium (ARM native):
+
+```shell
+docker build -f test/docker/arm64.Dockerfile -t browsers-arm .
+docker run --shm-size=512m -e TEST_ARGS="--grep chromium.*latest" -it browsers-arm
+```
+
+Firefox (AMD emulation):
+
+```shell
+docker build -f test/docker/Dockerfile -t browsers-amd .
+docker run --platform linux/amd64 --shm-size=512m -e TEST_ARGS="--grep firefox.*latest" -it browsers-amd
+```
+
+Edge: Not supported
+
 ## Building the documentation
 
 ```shell

package/RELEASE_NOTES.md

@@ -1,3 +1,14 @@
+# 0.11.0
+
+- Fixes an issue on arm64 edgedriver links that prevented the driver to run on
+M1/M2 machines (!62)
+
+### Testing
+
+- Enables running docker tests on arm64 platforms on Chromium (partially) and
+Firefox (!61)
+- Changes `TEST_URL` to a specific testpages url (!62)
+
 # 0.10.0
 
 - Added handling of the new headless mode in Chromium (#45)

package/package.json

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

package/src/browsers.js

@@ -229,12 +229,30 @@ class Chromium extends Browser {
     const MIN_VERSION = 75;
     const MAX_VERSION_DECREMENTS = 200;
 
+    let binary;
+    let versionNumber;
+    let base;
+
+    async function getBase(chromiumVersion) {
+      let {chromium_base_position: chromiumBase} =
+        await got(`https://omahaproxy.appspot.com/deps.json?version=${chromiumVersion}`).json();
+      return parseInt(chromiumBase, 10);
+    }
+
+    // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
+    if (platformArch == "linux-arm64") {
+      binary = "/usr/bin/chromium";
+      let installedVersion = await Chromium.getInstalledVersion(binary);
+      // installedVersion example: "Chromium 112.0.5615.49 built on Debian 11.6"
+      versionNumber = installedVersion.split(" ")[1];
+      base = await getBase(versionNumber);
+      return {binary, versionNumber, base};
+    }
+
     checkVersion(version, MIN_VERSION, Chromium.#CHANNELS);
-    let versionNumber = await Chromium.#getVersionForChannel(version);
+    versionNumber = await Chromium.#getVersionForChannel(version);
 
-    let {chromium_base_position: chromiumBase} =
-      await got(`https://omahaproxy.appspot.com/deps.json?version=${versionNumber}`).json();
-    let base = parseInt(chromiumBase, 10);
+    base = await getBase(versionNumber);
     let startBase = base;
     let [platformDir, fileName] = {
       "win32-ia32": ["Win", "chrome-win.zip"],
@@ -246,7 +264,6 @@ class Chromium extends Browser {
     let archive;
     let browserDir;
     let snapshotsDir = path.join(snapshotsBaseDir, "chromium");
-    let binary;
 
     while (true) {
       browserDir = path.join(snapshotsDir, `chromium-${platformArch}-${base}`);
@@ -294,6 +311,7 @@ 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];
@@ -308,6 +326,13 @@ class Chromium extends Browser {
     }
     catch (e) { // zip file is either not cached or corrupted
       let url = `https://commondatastorage.googleapis.com/chromium-browser-snapshots/${dir}/${base}/${zip}`;
+      // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
+      // It is 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
+      if (platformArch == "linux-arm64")
+        url = "https://github.com/electron/electron/releases/download/v24.1.2/chromedriver-v24.1.2-linux-arm64.zip";
+
       try {
         await download(url, archive);
       }
@@ -319,6 +344,8 @@ 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});
 
@@ -705,7 +732,7 @@ class Edge extends Browser {
       "win32-x64": ["edgedriver_win64.zip", "msedgedriver.exe"],
       "linux-x64": ["edgedriver_linux64.zip", "msedgedriver"],
       "darwin-x64": ["edgedriver_mac64.zip", "msedgedriver"],
-      "darwin-arm64": ["edgedriver_arm64.zip", "msedgedriver"]
+      "darwin-arm64": ["edgedriver_mac64_m1.zip", "msedgedriver"]
     }[platformArch];
     let cacheDir = path.join(snapshotsBaseDir, "edge", "cache",
                              `edgedriver-${versionNumber}`);

package/test/browsers.js

@@ -30,7 +30,7 @@ const VERSIONS = {
   firefox: ["latest", "60.0", "beta"],
   edge: ["latest", "95.0.1020.40", "beta", "dev"]
 };
-const TEST_URL = "https://gitlab.com/eyeo/developer-experience/get-browser-binary";
+const TEST_URL = "https://abptestpages.org/en/exceptions/iframe_subdomains";
 const TEST_URL_LONG_PAGE = "https://abptestpages.org/";
 
 async function switchToHandle(driver, testFn) {
@@ -105,12 +105,14 @@ function getExtension(browser, version) {
 }
 
 async function getCachedTimes(browser) {
+  let armLinuxChromium = browser == "chromium" &&
+    process.platform == "linux" && process.arch == "arm64";
   let cacheDir = path.join(snapshotsBaseDir, browser, "cache");
   let cacheFiles = await fs.promises.readdir(cacheDir);
 
   let browserCacheTime = null;
   // Edge gets installed at OS level, that's why it's not tested here
-  if (browser != "edge") {
+  if (browser != "edge" && !armLinuxChromium) {
     let installTypes = [".zip", ".dmg", ".bz2"];
     let browserZip =
       cacheFiles.find(elem => installTypes.some(type => elem.includes(type)));
@@ -120,7 +122,7 @@ async function getCachedTimes(browser) {
 
   let driverCacheTime = null;
   // Firefox install file includes the driver, that's why it's not tested here
-  if (browser != "firefox") {
+  if (browser != "firefox" && !armLinuxChromium) {
     let driverDir = cacheFiles.find(elem => !elem.endsWith(".zip"));
     let driverFiles = await fs.promises.readdir(path.join(cacheDir, driverDir));
     let driverZip = driverFiles.find(elem => elem.endsWith(".zip"));
@@ -210,7 +212,13 @@ for (let browser of Object.keys(BROWSERS)) {
           expect(existingCacheTimes).toEqual(emptyCacheTimes);
         });
 
-        it("supports extra args", async() => {
+        it("supports extra args", async function() {
+          // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/48
+          // To be removed when Edge latest version > 112
+          if (browser == "edge" && version == "latest" &&
+              process.platform == "linux")
+            this.skip();
+
           let headless = false;
           let extraArgs = browser == "firefox" ?
             ["--devtools"] : ["auto-open-devtools-for-tabs"];

package/test/docker/arm64.Dockerfile

@@ -0,0 +1,22 @@
+# Duplicated from registry.gitlab.com/eyeo/docker/get-browser-binary:node16
+# https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/46
+FROM node:16-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
+
+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