@eyeo/get-browser-binary 0.16.0 → 0.17.0

package/.gitlab-ci.yml

@@ -27,42 +27,50 @@ test:basic:
     - npm run lint
     - npm test -- --grep "Utils"
 
-test:browsers:linux:
+.linux:
   stage: test
   image: docker:24.0.5
   services:
     - docker:24.0.5-dind
   before_script:
     - docker build -f test/docker/Dockerfile -t browsers .
+
+test:browsers:linux:
+  extends: .linux
   script:
-    - docker run --shm-size=512m -t browsers
+    - docker run --shm-size=512m -t -e TEST_ARGS="--grep ^.*Browser((?!Version:.dev).)*\$" browsers
 
-test:browsers:windows:
+test:browsers:linux:dev:
+  extends: .linux
+  script:
+    - docker run --shm-size=512m -t -e TEST_ARGS="--grep Version:.dev" browsers
+  allow_failure: true
+
+.windows:
   stage: test
-  variables:
-    CI_PROJECT_ID_MAINSTREAM: 36688302
   before_script:
-    - Invoke-WebRequest
-        -Uri "${Env:CI_API_V4_URL}/projects/${Env:CI_PROJECT_ID_MAINSTREAM}/packages/generic/microsoft-edge/79.0.309/MicrosoftEdgeEnterpriseX64.msi"
-        -Headers @{'JOB-TOKEN' = $Env:CI_JOB_TOKEN}
-        -OutFile 'MicrosoftEdgeEnterpriseX64.msi'
-    - Start-Process msiexec
-        -ArgumentList "/i MicrosoftEdgeEnterpriseX64.msi /norestart /qn" -Wait
-    - choco upgrade -y --no-progress nodejs --version 18.17.1
+    - choco install -y microsoft-edge
     - npm install
+  tags:
+    - saas-windows-medium-amd64
+  cache: {}
+
+test:browsers:windows:
+  extends: .windows
   script:
     # Running Edge tests only on the preinstalled version
     # https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/29
     - npm test -- --grep "edge.*latest"
-    - npm test -- --grep "chromium"
+    - npm test -- --grep "^.*chromium((?!Version:.dev).)*$"
     # Running only a subset of Firefox tests to avoid low OS resources error
     # https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/2
     - npm test -- --grep "firefox.*installs"
-  tags:
-    - shared-windows
-    - windows
-    - windows-1809
-  cache: {}
+
+test:browsers:windows:dev:
+  extends: .windows
+  script:
+    - npm test -- --grep "chromium.*Version:.dev"
+  allow_failure: true
 
 docs:
   stage: docs

package/README.md

@@ -43,6 +43,22 @@ Edge version is supported.
 Set the `VERBOSE` environment variable to `"true"` to get verbose logging on
 download requests.
 
+### Offline execution
+
+It is possible to run browsers offline as long as they have been previously
+installed. Example:
+
+```javascript
+// Online
+let {binary} = await BROWSERS[browser].installBrowser(version);
+console.log(binary); // keep the browser binary location to use it offline
+let driver = await BROWSERS[browser].getDriver(version); // let the driver binary download
+
+// Offline
+let customBrowserBinary = "<browser binary location>";
+let driver = await BROWSERS[browser].getDriver(version, {customBrowserBinary});
+```
+
 ## Development
 
 ### Prerequisites

package/RELEASE_NOTES.md

@@ -1,6 +1,16 @@
+# Unreleased 
+
+# 0.17.0
+
+- Stops calling `driver.close()` in `enableExtensionInIncognito()`
+on non-Windows platforms (!114)
+- Add instructions for offline execution (!110)
+- Adds option to setup proxy through PAC file for Firefox (!115)
+
 # 0.16.0
 
-- Starts using selenium's automated driver management (#67)
+- Starts using selenium's automated driver management. That means additional
+`chromedriver` and `msedgedriver` packages are no longer needed (#67)
 - Loads the extension in Firefox by local path instead of being copied to a
 temporary folder (!104)
 - Checks if extensions can be loaded beforehand, by ensuring they contain a
@@ -18,7 +28,9 @@ include parenthesis (#69)
 ### Notes for integrators
 
 - Please make sure that your selenium-webdriver package version is at least
-4.15.0 (the one used in this release) (#67)
+4.15.0 (the one used in this release). Also make sure that you are not using the
+`chromedriver` nor `msedgedriver` packages, otherwise the automated driver
+management may not work as expected (#67)
 - If you experience chromedriver issues, try deleting the `/browser-snapshots`
 cache folder.
 

package/package.json

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

package/src/browser.js

@@ -95,6 +95,8 @@ export class Browser {
    *   certificates, or not.
    * @property {Array.<string>} [extraArgs=[]] Additional arguments to start
    *   the browser with.
+   * @property {string} [proxy] Only for Firefox, path to network
+   *   proxy autoconfig url (PAC file).
    * @property {string} [customBrowserBinary] Path to the browser binary to be
    *   used, instead of the browser installed by installBrowser(). This option
    *   overrides the version parameter in getDriver().

package/src/chromium.js

@@ -265,8 +265,9 @@ export class Chromium extends Browser {
         setTimeout(() => resolve(enable()), 100);
       });
     }, extensionTitle, errMsg.extensionNotFound);
-    if (version >= 115)
-      // Closing the previously opened new window
+    if (version >= 115 && process.platform == "win32")
+      // Closing the previously opened new window. Needed on Windows to avoid a
+      // further `WebDriverError: disconnected` error
       await driver.close();
 
     await driver.switchTo().window(handle);

package/src/firefox.js

@@ -140,9 +140,14 @@ export class Firefox extends Browser {
   }
 
   /** @see Browser.getDriver */
+  /** In Firefox you can define url to proxy autoconfig file.
+  * Proxy Autoconfig file determine whether web requests should go through
+  * a proxy server or connect directly. This allow to use localhost mapped
+  * to any url (f.ex testpages.adblockplus.org)
+  */
   static async getDriver(version = "latest", {
     headless = true, extensionPaths = [], incognito = false, insecure = false,
-    extraArgs = [], customBrowserBinary
+    extraArgs = [], customBrowserBinary, proxy
   } = {}, downloadTimeout = 0) {
     let binary;
     let versionNumber;
@@ -163,6 +168,10 @@ export class Firefox extends Browser {
     // Enabled by default on Firefox > 68
     if (versionNumber && getMajorVersion(versionNumber) == 68)
       options.setPreference("dom.promise_rejection_events.enabled", true);
+    if (proxy) {
+      options.setPreference("network.proxy.type", 2);
+      options.setPreference("network.proxy.autoconfig_url", proxy);
+    }
 
     options.setBinary(customBrowserBinary || binary);
 

package/test/browsers.js

@@ -31,6 +31,7 @@ const VERSIONS = {
   edge: ["latest", "95.0.1020.40", "beta", "dev"]
 };
 const TEST_URL_BASIC = `${TEST_SERVER_URL}/basic.html`;
+const PROXY_URL_BASIC = "http://testpages.adblockplus.org/basic.html";
 const TEST_URL_LONG = `${TEST_SERVER_URL}/long.html`;
 
 async function switchToHandle(driver, testFn) {
@@ -106,7 +107,8 @@ function getExtension(browser, version) {
 
 async function getInstallFileCTime(browser) {
   // Browsers installed at OS level are not tested
-  if (browser == "edge" && process.platform == "win32")
+  if (browser == "edge" && (process.platform == "win32" ||
+                            process.platform == "darwin"))
     return null;
 
   const installTypes = [".zip", ".dmg", ".bz2", ".deb", ".exe"];
@@ -141,6 +143,14 @@ function addVersionToTitle(ctx, version) {
   ctx.test.title = `${ctx.test.title} [v${version}]`;
 }
 
+function isOldHeadlessMode(browser, version) {
+  // Chromium's old headless mode doesn't support loading extensions
+  return browser != "firefox" && (
+    !["latest", "beta", "dev"].includes(version) ||
+    // Edge on the Windows CI is v79, that is old headless
+    (browser == "edge" && process.platform == "win32"));
+}
+
 for (let browser of Object.keys(BROWSERS)) {
   describe(`Browser: ${browser}`, () => {
     before(async() => {
@@ -168,6 +178,12 @@ for (let browser of Object.keys(BROWSERS)) {
             await killDriverProcess("chromedriver");
           else if (browser == "firefox")
             await killDriverProcess("geckodriver");
+
+          // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/77
+          if (process.platform == "win32" && browser == "chromium")
+            await killDriverProcess("chrome");
+          else if (process.platform == "win32" && browser == "edge")
+            await killDriverProcess("msedge");
         }
 
         beforeEach(function() {
@@ -258,6 +274,22 @@ for (let browser of Object.keys(BROWSERS)) {
           expect(sizeSmall).toMeasureLessThan(sizeDefault);
         });
 
+        it("supports proxy", async function() {
+          if (browser != "firefox")
+            this.skip();
+
+          let headless = true;
+          let proxy = "http://localhost:3000/proxy-config.pac";
+          let extraArgs = [];
+          driver = await BROWSERS[browser].getDriver(
+            version, {headless, extraArgs, proxy});
+          await driver.navigate().to(PROXY_URL_BASIC);
+
+          let text = await driver.findElement(By.id("basic")).getText();
+          expect(text).toEqual("Test server basic page");
+          await quitDriver();
+        });
+
         it("takes a full page screenshot", async() => {
           driver = await BROWSERS[browser].getDriver(version);
           await driver.navigate().to(TEST_URL_LONG);
@@ -277,9 +309,7 @@ for (let browser of Object.keys(BROWSERS)) {
         // Selenium's automated driver download should be able to manage it.
         // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/44
         it("loads an extension", async() => {
-          // Chromium's old headless mode doesn't support loading extensions
-          let headless = browser == "firefox" || (browser == "chromium" &&
-            ["latest", "beta", "dev"].includes(version));
+          let headless = !isOldHeadlessMode(browser, version);
           let {extensionPaths} = getExtension(browser, version);
 
           driver = await BROWSERS[browser].getDriver(
@@ -299,6 +329,29 @@ for (let browser of Object.keys(BROWSERS)) {
           );
           await getHandle(driver, "/index.html");
         });
+
+        it("updates an extension", async() => {
+          let headless = !isOldHeadlessMode(browser, version);
+          let {extensionPaths, manifest} = getExtension(browser, version);
+
+          let tmpExtensionDir = path.join(snapshotsBaseDir, "extension");
+          await fs.promises.rm(tmpExtensionDir, {recursive: true, force: true});
+          await fs.promises.cp(extensionPaths[0], tmpExtensionDir,
+                               {recursive: true});
+
+          driver = await BROWSERS[browser].getDriver(
+            version, {headless, extensionPaths: [tmpExtensionDir]});
+          await getHandle(driver, "/index.html");
+          let text = await driver.findElement(By.id("title")).getText();
+          expect(text).toEqual(`Browser test extension - ${manifest}`);
+
+          // The page is modified and reloaded to emulate an extension update
+          await fs.promises.cp(path.join(tmpExtensionDir, "update.html"),
+                               path.join(tmpExtensionDir, "index.html"));
+          await driver.navigate().refresh();
+          text = await driver.findElement(By.id("title")).getText();
+          expect(text).toEqual(`Updated test extension - ${manifest}`);
+        });
       });
     }
 

package/test/extension/mv2/index.html

@@ -1 +1 @@
-<h1>Browser test extension - mv2</h1>
+<h1 id="title">Browser test extension - mv2</h1>

package/test/extension/mv2/update.html

@@ -0,0 +1 @@
+<h1 id="title">Updated test extension - mv2</h1>

package/test/extension/mv3/index.html

@@ -1 +1 @@
-<h1>Browser test extension - mv3</h1>
+<h1 id="title">Browser test extension - mv3</h1>

package/test/extension/mv3/update.html

@@ -0,0 +1 @@
+<h1 id="title">Updated test extension - mv3</h1>

package/test/pages/proxy-config.pac

@@ -0,0 +1,7 @@
+
+function FindProxyForURL(url, host) {
+  if (host === "testpages.adblockplus.org")
+    return "PROXY http://localhost:3000";
+
+  return "DIRECT";
+}