@eyeo/get-browser-binary 0.7.0 → 0.8.0

package/RELEASE_NOTES.md

@@ -1,3 +1,17 @@
+# 0.8.0
+
+- Move `takeFullPageScreenshot` to the utils module (#38)
+- Add keywords to package.json (#36)
+
+### Testing
+
+- Log the running browser version on test suites (#37)
+
+### Notes for integrators
+
+- `takeFullPageScreenshot()` has been moved from the browsers module to the
+utils module (!46).
+
 # 0.7.0
 
 - Implement takeFullPageScreenshot (#32)

package/index.js

@@ -16,4 +16,4 @@
  */
 
 export * from "./src/browsers.js";
-export {download} from "./src/utils.js";
+export {download, takeFullPageScreenshot} from "./src/utils.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Install browser binaries and matching webdrivers",
   "repository": {
     "type": "git",
@@ -14,6 +14,19 @@
   },
   "type": "module",
   "main": "index.js",
+  "keywords": [
+    "browser",
+    "chromium",
+    "chrome",
+    "firefox",
+    "msedge",
+    "chromedriver",
+    "geckodriver",
+    "msedgedriver",
+    "selenium",
+    "webdriver",
+    "selenium-webdriver"
+  ],
   "dependencies": {
     "dmg": "^0.1.0",
     "extract-zip": "^2.0.1",

package/src/browsers.js

@@ -27,7 +27,6 @@ import firefox from "selenium-webdriver/firefox.js";
 import edge from "selenium-webdriver/edge.js";
 import command from "selenium-webdriver/lib/command.js";
 import extractZip from "extract-zip";
-import Jimp from "jimp";
 
 import {download, extractTar, extractDmg, killDriverProcess, wait}
   from "./utils.js";
@@ -158,66 +157,6 @@ class Browser {
     // https://bugzilla.mozilla.org/show_bug.cgi?id=1729315
     // That is done through the UI, to be implemented by the subclass
   }
-
-  /**
-   * @typedef {Object} Jimp
-   * @see https://github.com/oliver-moran/jimp/tree/master/packages/jimp
-   */
-
-  /**
-   * Takes a screenshot of the full page by scrolling from top to bottom.
-   * @param {webdriver} driver - The driver controlling the browser.
-   * @property {boolean} hideScrollbars=true - Hides any scrollbars before
-   *   taking the screenshot, or not.
-   * @return {Jimp} A Jimp image object containing the screenshot.
-   * @example
-   * // Getting a base-64 encoded PNG from the returned screenshot
-   * let image = await Browser.takeFullPageScreenshot(driver);
-   * let encodedPNG = await image.getBase64Async("image/png");
-   */
-  static async takeFullPageScreenshot(driver, hideScrollbars = true) {
-    // On macOS scrollbars appear and disappear overlapping the content as
-    // scrolling occurs. Hiding the scrollbars helps getting reproducible
-    // screenshots.
-    if (hideScrollbars) {
-      await driver.executeScript(() => {
-        if (!document.head)
-          return;
-
-        let style = document.createElement("style");
-        style.textContent = "html { overflow-y: scroll; }";
-        document.head.appendChild(style);
-        if (document.documentElement.clientWidth == window.innerWidth)
-          style.textContent = "html::-webkit-scrollbar { display: none; }";
-        else
-          document.head.removeChild(style);
-      });
-    }
-
-    let fullScreenshot = new Jimp(0, 0);
-    while (true) {
-      let [width, height, offset] = await driver.executeScript((...args) => {
-        window.scrollTo(0, args[0]);
-        // Math.ceil rounds up potential decimal values on window.scrollY,
-        // ensuring the loop will not hang due to never reaching enough
-        // fullScreenshot's height.
-        return [document.documentElement.clientWidth,
-                document.documentElement.scrollHeight,
-                Math.ceil(window.scrollY)];
-      }, fullScreenshot.bitmap.height);
-      let data = await driver.takeScreenshot();
-      let partialScreenshot = await Jimp.read(Buffer.from(data, "base64"));
-      let combinedScreenshot =
-        new Jimp(width, offset + partialScreenshot.bitmap.height);
-      combinedScreenshot.composite(fullScreenshot, 0, 0);
-      combinedScreenshot.composite(partialScreenshot, 0, offset);
-      fullScreenshot = combinedScreenshot;
-
-      if (fullScreenshot.bitmap.height >= height)
-        break;
-    }
-    return fullScreenshot;
-  }
 }
 
 /**

package/src/utils.js

@@ -23,6 +23,7 @@ import {exec} from "child_process";
 
 import got from "got";
 import dmg from "dmg";
+import Jimp from "jimp";
 
 /**
  * Downloads url resources.
@@ -143,3 +144,62 @@ export function wait(condition, timeout = 0, message, pollTimeout = 100) {
 
   return result;
 }
+
+/**
+ * @typedef {Object} Jimp
+ * @see https://github.com/oliver-moran/jimp/tree/master/packages/jimp
+ */
+
+/**
+ * Takes a screenshot of the full page by scrolling from top to bottom.
+ * @param {webdriver} driver - The driver controlling the browser.
+ * @property {boolean} hideScrollbars=true - Hides any scrollbars before
+ *   taking the screenshot, or not.
+ * @return {Jimp} A Jimp image object containing the screenshot.
+ * @example
+ * // Getting a base-64 encoded PNG from the returned Jimp image
+ * let image = await takeFullPageScreenshot(driver);
+ * let encodedPNG = await image.getBase64Async("image/png");
+ */
+export async function takeFullPageScreenshot(driver, hideScrollbars = true) {
+  // On macOS scrollbars appear and disappear overlapping the content as
+  // scrolling occurs. Hiding the scrollbars helps getting reproducible
+  // screenshots.
+  if (hideScrollbars) {
+    await driver.executeScript(() => {
+      if (!document.head)
+        return;
+      let style = document.createElement("style");
+      style.textContent = "html { overflow-y: scroll; }";
+      document.head.appendChild(style);
+      if (document.documentElement.clientWidth == window.innerWidth)
+        style.textContent = "html::-webkit-scrollbar { display: none; }";
+      else
+        document.head.removeChild(style);
+    });
+  }
+
+  let fullScreenshot = new Jimp(0, 0);
+  while (true) {
+    let [width, height, offset] = await driver.executeScript((...args) => {
+      window.scrollTo(0, args[0]);
+      // Math.ceil rounds up potential decimal values on window.scrollY,
+      // ensuring the loop will not hang due to never reaching enough
+      // fullScreenshot's height.
+      return [document.documentElement.clientWidth,
+              document.documentElement.scrollHeight,
+              Math.ceil(window.scrollY)];
+    }, fullScreenshot.bitmap.height);
+    let data = await driver.takeScreenshot();
+    let partialScreenshot = await Jimp.read(Buffer.from(data, "base64"));
+    let combinedScreenshot =
+      new Jimp(width, offset + partialScreenshot.bitmap.height);
+    combinedScreenshot.composite(fullScreenshot, 0, 0);
+    combinedScreenshot.composite(partialScreenshot, 0, offset);
+    fullScreenshot = combinedScreenshot;
+    if (fullScreenshot.bitmap.height >= height)
+      break;
+  }
+
+  return fullScreenshot;
+}

package/test/browsers.js

@@ -19,7 +19,7 @@ import fs from "fs";
 import expect from "expect";
 import path from "path";
 
-import {BROWSERS, snapshotsBaseDir} from "../index.js";
+import {BROWSERS, snapshotsBaseDir, takeFullPageScreenshot} from "../index.js";
 import {killDriverProcess} from "../src/utils.js";
 import Jimp from "jimp";
 
@@ -148,6 +148,9 @@ for (let browser of Object.keys(BROWSERS)) {
             await BROWSERS[browser].getInstalledVersion(binary);
           expect(installedVersion).toEqual(
             expect.stringContaining(normalize(versionNumber)));
+
+          // Adding the version number to the test title for logging purposes
+          this.test.title = `${this.test.title} [v${versionNumber}]`;
         });
 
         it("runs", async() => {
@@ -186,7 +189,7 @@ for (let browser of Object.keys(BROWSERS)) {
           driver = await BROWSERS[browser].getDriver(version);
           await driver.navigate().to(TEST_URL_LONG_PAGE);
 
-          let fullImg = await BROWSERS[browser].takeFullPageScreenshot(driver);
+          let fullImg = await takeFullPageScreenshot(driver);
           // Taking a regular webdriver screenshot, which should be shorter
           let data = await driver.takeScreenshot();
           let partImg = await Jimp.read(Buffer.from(data, "base64"));