@eyeo/get-browser-binary 0.1.1 → 0.2.0

package/RELEASE_NOTES.md

@@ -1,3 +1,7 @@
+# 0.2.0
+
+Change `Browser.getDriver` signature to use `driverOptions` parameter.
+
 # 0.1.1
 
 Change project name to `get-browser-binary`.

package/package.json

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

package/src/browsers.js

@@ -67,22 +67,30 @@ class Browser {
    * @see https://www.selenium.dev/selenium/docs/api/javascript/index.html
    */
 
+  /**
+   * @typedef {Object} driverOptions
+   * @property {boolean} headless=true - Run the browser in headless mode,
+   *   or not.
+   * @property {Array.<string>} [extensionPaths=[]] - Loads extensions to the
+   *   browser.
+   * @property {boolean} incognito=false - Runs the browser in incognito mode,
+   *   or not.
+   * @property {boolean} insecure=false - Forces the browser to accept insecure
+   *   certificates, or not.
+   * @property {Array.<string>} [extraArgs=[]] - Additional arguments to start
+   *   the browser with.
+   */
+
   /**
    * Installs the webdriver matching the browser version and runs the
    * browser. If needed, the browser binary is also installed.
    * @param {string} version - Either full version number or channel/release.
    *   Please find examples on the subclasses. On Edge this parameter has
    *   no effect.
-   * @param {boolean?} headless - Run the browser in headless mode, or not.
-   * @param {Array.<string>?} extensionPaths - Loads extensions to the running
-   *   browser.
-   * @param {boolean?} incognito - Runs the browser in incognito mode, or not.
-   * @param {boolean?} insecure - Forces the browser to accept insecure
-       certificates, or not.
+   * @param {driverOptions?} options - Options to start the browser with.
    * @return {webdriver}
    */
-  static async getDriver(version, headless = true, extensionPaths = [],
-                         incognito = false, insecure = false) {
+  static async getDriver(version, options = {}) {
     // to be implemented by the subclass
   }
 
@@ -252,8 +260,9 @@ class Chromium extends Browser {
   }
 
   /** @see Browser.getDriver */
-  static async getDriver(version, headless = true, extensionPaths = [],
-                         incognito = false, insecure = false) {
+  static async getDriver(version, {headless = true, extensionPaths = [],
+                                   incognito = false, insecure = false,
+                                   extraArgs = []} = {}) {
     if (incognito)
       throw new Error(ERROR_INCOGNITO_NOT_SUPPORTED);
 
@@ -261,7 +270,7 @@ class Chromium extends Browser {
       await Chromium.downloadBinary(version);
     await Chromium.#installDriver(revision, downloadedVersion);
 
-    let options = new chrome.Options().addArguments("no-sandbox");
+    let options = new chrome.Options().addArguments("no-sandbox", ...extraArgs);
     if (extensionPaths.length > 0)
       options.addArguments(`load-extension=${extensionPaths.join(",")}`);
     if (headless)
@@ -367,8 +376,9 @@ class Firefox {
   }
 
   /** @see Browser.getDriver */
-  static async getDriver(version, headless = true, extensionPaths = [],
-                         incognito = false, insecure = false) {
+  static async getDriver(version, {headless = true, extensionPaths = [],
+                                   incognito = false, insecure = false,
+                                   extraArgs = []} = {}) {
     let {binary} = await Firefox.downloadBinary(version);
 
     let options = new firefox.Options();
@@ -378,6 +388,8 @@ class Firefox {
       options.addArguments("--private");
     if (insecure)
       options.set("acceptInsecureCerts", true);
+    if (extraArgs.length > 0)
+      options.addArguments(...extraArgs);
     options.setBinary(binary);
 
     let driver = await new webdriver.Builder()
@@ -501,14 +513,15 @@ class Edge {
   }
 
   /** @see Browser.getDriver */
-  static async getDriver(version, headless = true, extensionPaths = [],
-                         incognito = false, insecure = false) {
+  static async getDriver(version, {headless = true, extensionPaths = [],
+                                   incognito = false, insecure = false,
+                                   extraArgs = []} = {}) {
     if (incognito)
       throw new Error(ERROR_INCOGNITO_NOT_SUPPORTED);
 
     await Edge.#installDriver();
 
-    let args = ["no-sandbox"];
+    let args = ["no-sandbox", ...extraArgs];
     if (headless)
       args.push("headless");
     if (extensionPaths.length > 0)

package/test/runner.js

@@ -148,11 +148,17 @@ for (let browser of Object.keys(BROWSERS)) {
           .toEqual(expect.stringMatching(names[browser]));
       });
 
+      it("supports extra args", async() => {
+        driver = await BROWSERS[browser].getDriver(
+          version, {extraArgs: ["auto-open-devtools-for-tabs"]});
+        await driver.navigate().to("about:blank");
+      });
+
       it("loads an extension", async() => {
         let headless = browser == "firefox";
 
-        driver = await BROWSERS[browser].getDriver(version, headless,
-                                                   extensionPaths);
+        driver = await BROWSERS[browser].getDriver(
+          version, {headless, extensionPaths});
         await getHandle(driver, "/index.html");
       });
 
@@ -160,8 +166,8 @@ for (let browser of Object.keys(BROWSERS)) {
         if (browser != "firefox" || version == "68.0")
           this.skip();
 
-        driver = await BROWSERS[browser].getDriver(version, false,
-                                                   extensionPaths, true);
+        driver = await BROWSERS[browser].getDriver(
+          version, {headless: false, extensionPaths, incognito: true});
         await BROWSERS[browser].enableExtensionInIncognito(
           driver, "Browser download test extension"
         );