@eyeo/get-browser-binary 0.5.0 → 0.6.0

package/.gitlab-ci.yml

@@ -53,14 +53,12 @@ test:browsers:windows:
     - choco upgrade -y nodejs --version 16.10.0
     - npm install
   script:
-    # Running only a subset of Firefox and Opera tests to avoid low OS resources error
+    # Running only a subset of Firefox tests to avoid low OS resources error
     # https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/2
-    # Regarding grep, running npm v8 on powershell has issues when the grep
-    # value contains the pipe (|) literal. Storing that string as a verbatim
-    # string (single quotes) and then sorrounding it with four double quotes
-    # does the trick.
-    - $subset_tests = '(firefox|opera).*latest.*downloads'
-    - npm test -- --grep """"$subset_tests""""
+    - npm test -- --grep "firefox.*latest.*downloads"
+    # Running npm v8 on powershell has issues when the grep value contains the
+    # pipe (|) literal. Storing that string as a verbatim string (single quotes)
+    # and then sorrounding it with four double quotes does the trick.
     - $full_tests = '(chromium|edge.*latest)'
     - npm test -- --grep """"$full_tests""""
   tags:

package/README.md

@@ -1,7 +1,7 @@
 # get-browser-binary
 
-Download specific browser versions for Chromium, Firefox, Edge and Opera, and
-their matching [selenium webdriver](https://www.selenium.dev/selenium/docs/api/javascript/index.html).
+Download specific browser versions for Chromium, Firefox and Edge, and their
+matching [selenium webdriver](https://www.selenium.dev/selenium/docs/api/javascript/index.html).
 
 ## Getting started
 
@@ -33,13 +33,10 @@ the right side.
 - Chromium >= 75
 - Firefox >= 60
 - Edge >= 95
-- Opera >= 62
 
 Note: Edge download is not supported on Windows. It is assumed to be installed
 because it is the default browser on that platform.
 
-Note: Using the `operadriver` on Windows is not supported.
-
 ## Development
 
 ### Prerequisites
@@ -93,9 +90,6 @@ The `grep` option can also be used on Docker via the `TEST_ARGS` parameter:
 docker run --shm-size=256m -e TEST_ARGS="--grep chromium.*latest" -it browsers
 ```
 
-Note: For a full automated run, `opera` tests should not use the interactive
-tty `-it` flag.
-
 ## Building the documentation
 
 ```shell

package/RELEASE_NOTES.md

@@ -1,3 +1,10 @@
+# 0.6.0
+
+- Removes Opera support (#26)
+- Improves error handling when the downloaded browser version doesn't match
+known channels (#25)
+- Fixes an Edge running issue on Windows (32-bit) (#23)
+
 # 0.5.0
 
 - Enables Edge binary downloads on MacOS (!25)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Download browser binaries and matching webdrivers",
   "repository": {
     "type": "git",
@@ -18,10 +18,9 @@
     "chromedriver": "^90.0.1",
     "dmg": "^0.1.0",
     "extract-zip": "^2.0.1",
-    "fs-extra": "^10.0.0",
     "geckodriver": "^3.0.2",
     "got": "^11.8.2",
-    "selenium-webdriver": "^4.2.0"
+    "selenium-webdriver": "^4.6.1"
   },
   "devDependencies": {
     "eslint": "^8.17.0",

package/src/browsers.js

@@ -16,10 +16,9 @@
  */
 
 import path from "path";
-import {exec, execFile, spawn} from "child_process";
+import {exec, execFile} from "child_process";
 import {promisify} from "util";
 import fs from "fs";
-import fsExtra from "fs-extra";
 
 import got from "got";
 import webdriver from "selenium-webdriver";
@@ -46,7 +45,7 @@ function checkVersion(version, minVersion, channels) {
     return;
 
   let mainVersion = parseInt(version && version.split(".")[0], 10);
-  if (mainVersion < minVersion)
+  if (isNaN(mainVersion) || mainVersion < minVersion)
     throw new Error(`Unsupported browser version: ${version}`);
 }
 
@@ -542,8 +541,9 @@ class Edge extends Browser {
   static #getBinaryPath(channel = "stable") {
     switch (process.platform) {
       case "win32":
-        return "${Env:ProgramFiles(x86)}\\Microsoft\\Edge\\Application\\" +
-          "msedge.exe";
+        let programFiles = process.env["ProgramFiles(x86)"] ?
+          "${Env:ProgramFiles(x86)}" : "${Env:ProgramFiles}";
+        return `${programFiles}\\Microsoft\\Edge\\Application\\msedge.exe`;
       case "linux":
         return channel == "stable" ?
           "microsoft-edge" : `microsoft-edge-${channel}`;
@@ -603,7 +603,7 @@ class Edge extends Browser {
       await download(downloadUrl, archive);
     }
     catch (err) {
-      throw new Error(`Edge download failed: ${err}`);
+      throw new Error(`Edge download failed at ${downloadUrl}\n${err}`);
     }
 
     if (process.platform == "linux") {
@@ -724,242 +724,6 @@ class Edge extends Browser {
   }
 }
 
-/**
- * Download functionality for Opera. This class can be used statically.
- * @hideconstructor
- * @extends Browser
- */
-class Opera extends Browser {
-  static async #getVersionForChannel(version, platformDir) {
-    let channelPath = "opera/desktop";
-    let filePrefix = "Opera";
-    if (version != "latest")
-      return {versionNumber: version, channelPath, filePrefix};
-
-    let {body} = await got(`https://ftp.opera.com/pub/${channelPath}`);
-    let regex = /href="(\d.*)\/"/gm;
-    let matches = body.match(regex);
-    let versionNumber;
-    while (matches.length > 0) {
-      let result = regex.exec(matches.pop());
-      if (!result)
-        continue;
-
-      versionNumber = result[1];
-      try {
-        await got(`https://ftp.opera.com/pub/${channelPath}/${versionNumber}/${platformDir}`);
-        break;
-      }
-      catch (e) {}
-    }
-
-    return {versionNumber, channelPath, filePrefix};
-  }
-
-  static #getBinaryPath(dir) {
-    switch (process.platform) {
-      case "win32":
-        return path.join(dir, "launcher.exe");
-      case "linux":
-        return path.join("/", "usr", "bin", "opera");
-      case "darwin":
-        return path.join(dir, "Opera.app", "Contents", "MacOS", "Opera");
-      default:
-        throw new Error(`Unexpected platform: ${process.platform}`);
-    }
-  }
-
-  static async #extractDeb(archive) {
-    let child = spawn("dpkg", ["-i", archive]);
-
-    child.stdout.on("data", data => {
-      if (data.toString().includes("Do you want to update Opera")) {
-        process.stdin.pipe(child.stdin);
-        child.stdin.write("no\r\n");
-      }
-    });
-
-    child.stderr.on("data", data => {
-      let expectedWarnings = [
-        "debconf: unable to initialize frontend",
-        "dpkg: warning: downgrading opera-stable",
-        "update-alternatives",
-        "using /usr/bin/opera",
-        "skip creation of",
-        "\r\n"
-      ];
-      if (!expectedWarnings.find(err => data.toString().includes(err.trim())))
-        console.error(`stderr: ${data.toString()}`);
-    });
-
-    await new Promise((resolve, reject) => child.on("close", code => {
-      if (code != 0)
-        reject(`dpkg process exited with code ${code}`);
-
-      resolve();
-    }));
-  }
-
-  static async #installOnWindows(archive, dir, filename) {
-    let archiveCopy = path.join(dir, filename);
-    await fsExtra.copy(archive, archiveCopy);
-    await promisify(exec)(`"${archiveCopy}"`);
-  }
-
-  static #extractOperaArchive(archive, dir, filename) {
-    switch (process.platform) {
-      case "win32":
-        return Opera.#installOnWindows(archive, dir, filename);
-      case "linux":
-        return Opera.#extractDeb(archive, dir);
-      case "darwin":
-        return extractTar(archive, dir);
-      default:
-        throw new Error(`Unexpected platform: ${process.platform}`);
-    }
-  }
-
-  /**
-   * Downloads the browser binary file.
-   * @param {string} version - Either "latest" or a full version number
-   *   (i.e. "64.0.3417.92"). Defaults to "latest".
-   * @return {BrowserBinary}
-   */
-  static async downloadBinary(version = "latest") {
-    const MIN_VERSION = 62;
-    const CHANNELS = ["latest"];
-
-    checkVersion(version, MIN_VERSION, CHANNELS);
-
-    let [platformDir, fileSuffix] = {
-      "win32-ia32": ["win", "Autoupdate.exe"],
-      "win32-x64": ["win", "Autoupdate_x64.exe"],
-      "linux-x64": ["linux", "amd64.deb"],
-      "darwin-x64": ["mac", "Autoupdate.tar.xz"],
-      "dawrin-arm64": ["mac", "Autoupdate_arm64.tar.xz"]
-    }[platform];
-
-    let {versionNumber, channelPath, filePrefix} =
-      await Opera.#getVersionForChannel(version, platformDir);
-
-    let snapshotsDir = path.join(snapshotsBaseDir, "opera");
-    let browserDir = path.join(snapshotsDir, `opera-${platform}-${versionNumber}`);
-    let filename = `${filePrefix}_${versionNumber}_${fileSuffix}`;
-    let archive = path.join(snapshotsDir, "cache", filename);
-
-    let binary = Opera.#getBinaryPath(browserDir);
-    try {
-      if (process.platform == "linux" &&
-          await Opera.getInstalledVersion("opera") == versionNumber)
-        return {binary, versionNumber};
-
-      await fs.promises.access(browserDir);
-      return {binary, versionNumber};
-    }
-    catch (e) {}
-
-    await fs.promises.mkdir(path.dirname(browserDir), {recursive: true});
-    try {
-      await fs.promises.access(archive);
-    }
-    catch (e) {
-      let url = `https://ftp.opera.com/pub/${channelPath}/${versionNumber}/${platformDir}/${filename}`;
-      try {
-        await download(url, archive);
-      }
-      catch (err) {
-        throw new Error(`Browser download unavailable at ${url}\n${err}`);
-      }
-    }
-
-    await Opera.#extractOperaArchive(archive, browserDir, filename);
-    return {binary, versionNumber};
-  }
-
-  static async #installDriver(version, originalVersion) {
-    let [zip, driver] = {
-      "win32-ia32": ["operadriver_win32.zip", "operadriver.exe"],
-      "win32-x64": ["operadriver_win64.zip", "operadriver.exe"],
-      "linux-x64": ["operadriver_linux64.zip", "operadriver"],
-      "darwin-x64": ["operadriver_mac64.zip", "operadriver"],
-      "darwin-arm64": ["operadriver_mac64.zip", "operadriver"]
-    }[platform];
-
-    let {versionNumber} = await Opera.#getVersionForChannel(version);
-    versionNumber = versionNumber.split(".")[0];
-
-    let cacheDir = path.join(snapshotsBaseDir, "opera", "cache",
-                             `operadriver-${versionNumber}`);
-    let archive = path.join(cacheDir, zip);
-
-    let {body} = await got(`https://github.com/operasoftware/operachromiumdriver/releases?q=Opera+${versionNumber}&expanded=true`);
-    let regex = /release-card[\s\S]*Link--primary.*>(.*)<\/a/gm;
-    let matches = body.match(regex);
-    if (!matches || matches.length == 0)
-      throw new Error(`Driver for Opera ${version} was not found`);
-    let driverVersion = regex.exec(matches[matches.length - 1])[1];
-
-    try {
-      await download(`https://github.com/operasoftware/operachromiumdriver/releases/download/v.${driverVersion}/${zip}`,
-                     archive);
-    }
-    catch (err) {
-      throw new Error(`Downloading operadriver failed: ${err}`);
-    }
-
-    await killDriverProcess("operadriver");
-    let driverPath = path.join(cacheDir, zip.split(".")[0], driver);
-    try {
-      await fs.promises.rm(driverPath, {recursive: true});
-    }
-    catch (e) {} // file does not exist
-    await extractZip(archive, {dir: cacheDir});
-    await fs.promises.chmod(driverPath, 577);
-
-    return driverPath;
-  }
-
-  /** @see Browser.getDriver */
-  static async getDriver(version = "latest", {
-    headless = true, extensionPaths = [], incognito = false, insecure = false,
-    extraArgs = []
-  } = {}) {
-    let {binary, versionNumber} = await Opera.downloadBinary(version);
-    let driverPath = await Opera.#installDriver(versionNumber, version);
-    // operadriver uses chrome as a service builder:
-    // https://github.com/operasoftware/operachromiumdriver/blob/master/docs/desktop.md
-    let serviceBuilder = new chrome.ServiceBuilder(driverPath);
-    let service = serviceBuilder.build();
-    await service.start();
-
-    let options = new chrome.Options().addArguments("no-sandbox", ...extraArgs);
-    if (extensionPaths.length > 0)
-      options.addArguments(`load-extension=${extensionPaths.join(",")}`);
-    if (headless)
-      options.headless();
-    if (insecure)
-      options.addArguments("ignore-certificate-errors");
-    if (incognito)
-      options.addArguments("incognito");
-    options.setChromeBinaryPath(binary);
-    // https://github.com/operasoftware/operachromiumdriver/issues/61#issuecomment-579331657
-    options.addArguments("remote-debugging-port=9222");
-
-    let builder = new webdriver.Builder();
-    builder.forBrowser("chrome");
-    builder.setChromeOptions(options);
-    builder.setChromeService(serviceBuilder);
-
-    return builder.build();
-  }
-
-  /** @see Browser.enableExtensionInIncognito */
-  static async enableExtensionInIncognito(driver, extensionTitle) {
-    // Extensions page in Opera has the same web elements as Chromium
-    await Chromium.enableExtensionInIncognito(driver, extensionTitle);
-  }
-}
-
 /**
  * @type {Object}
  * @property {Chromium} chromium - Download functionality for Chromium.
@@ -969,6 +733,5 @@ class Opera extends Browser {
 export const BROWSERS = {
   chromium: Chromium,
   firefox: Firefox,
-  edge: Edge,
-  opera: Opera
+  edge: Edge
 };

package/src/utils.js

@@ -22,7 +22,6 @@ import {promisify} from "util";
 import {exec} from "child_process";
 
 import got from "got";
-import fsExtra from "fs-extra";
 import dmg from "dmg";
 
 /**
@@ -66,7 +65,7 @@ export async function extractDmg(archive, dir) {
   let source = path.join(mpath, target);
   await fs.promises.mkdir(dir);
   try {
-    await fsExtra.copy(source, path.join(dir, target));
+    await fs.promises.cp(source, path.join(dir, target), {recursive: true});
   }
   finally {
     try {

package/test/browsers.js

@@ -29,8 +29,7 @@ import "geckodriver";
 const VERSIONS = {
   chromium: ["latest", "75.0.3770.0", "beta", "dev"],
   firefox: ["latest", "60.0", "beta"],
-  edge: ["latest", "95.0.1020.53", "beta", "dev"],
-  opera: ["latest", "62.0.3331.66"]
+  edge: ["latest", "95.0.1020.40", "beta", "dev"]
 };
 const TEST_URL = "https://gitlab.com/eyeo/developer-experience/get-browser-binary";
 let extensionPaths = [path.resolve(process.cwd(), "test", "extension")];
@@ -127,10 +126,7 @@ for (let browser of Object.keys(BROWSERS)) {
 
           let {binary, versionNumber} =
             await BROWSERS[browser].downloadBinary(version);
-          let browserName =
-            browser == "opera" ? /(opera|Opera)/ :
-            browser == "edge" ? /(edge|Edge)/ :
-            browser;
+          let browserName = browser == "edge" ? /(edge|Edge)/ : browser;
           expect(binary).toEqual(expect.stringMatching(browserName));
 
           let installedVersion =
@@ -143,8 +139,7 @@ for (let browser of Object.keys(BROWSERS)) {
           let names = {
             chromium: "chrome",
             firefox: "firefox",
-            edge: /(MicrosoftEdge|msedge)/,
-            opera: /(opera|chrome)/
+            edge: /(MicrosoftEdge|msedge)/
           };
 
           driver = await BROWSERS[browser].getDriver(version);
@@ -198,10 +193,10 @@ for (let browser of Object.keys(BROWSERS)) {
       if (browser == "edge" && process.platform == "win32")
         this.skip();
 
-      const UNSUPPORTED = "0.0";
-
-      await expect(BROWSERS[browser].downloadBinary(UNSUPPORTED))
-        .rejects.toThrow(`Unsupported browser version: ${UNSUPPORTED}`);
+      for (let unsupported of ["0.0", "invalid"]) {
+        await expect(BROWSERS[browser].downloadBinary(unsupported))
+          .rejects.toThrow(`Unsupported browser version: ${unsupported}`);
+      }
     });
   });
 }