Add har inspector for pages

package.json

@@ -1,6 +1,6 @@
 {
   "name": "testarmada-magellan",
-  "version": "11.0.15",
+  "version": "11.0.16",
   "description": "Massively parallel automated testing",
   "main": "src/main",
   "directories": {
@@ -33,9 +33,11 @@
   },
   "dependencies": {
     "async": "^2.1.4",
+    "chrome-har-capturer": "^0.13.8",
     "cli-color": "^1.1.0",
     "co": "^4.6.0",
     "fs-extra": "^7.0.1",
+    "get-port": "^5.1.1",
     "glob": "^7.1.1",
     "http-proxy": "^1.18.1",
     "lodash": "^4.6.1",

src/cli.js

@@ -29,6 +29,9 @@ const logger = require("./logger");
 const BailStrategy = require("./strategies/bail");
 const ResourceStrategy = require("./strategies/resource");
 
+const PageReporter = require("./reporters/page/reporter");
+const SerialReporter = require("./reporters/stdout/reporter");
+
 module.exports = {
 
   initialize() {
@@ -304,10 +307,16 @@ module.exports = {
     // Serial Mode Reporter (enabled with --serial)
     //
     if (opts.argv.serial) {
-      const SerialReporter = require("./reporters/stdout/reporter");
       listeners.push(new SerialReporter());
     }
 
+    //
+    // Page Reporter to help find pages with errors (enabled with --pageDebugger)
+    //
+    if (opts.argv.pageDebugger) {
+      listeners.push(new PageReporter());
+    }
+
     // intiialize listeners
     return new Promise((resolve, reject) => {
       async.each(listeners, (listener, done) => {

src/reporters/page/HarCaptureEngine.js

@@ -0,0 +1,105 @@
+"use strict";
+
+const getPort = require("get-port");
+const {spawn} = require("child_process");
+const CHC = require("chrome-har-capturer");
+const logger = require("../../logger");
+
+const CHROME_CMD = {
+  MAC: "\"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome\"",
+  LINUX: "google-chrome"
+};
+
+const CAPTURE_TIMEOUT = 10000; // 10 seconds
+
+class HarCaptureEngine {
+
+  async start() {
+    if (!this.chromeProcess) {
+      const portRange = [];
+      const maxPort = 9999;
+      let i = 9223;
+      while (i <= maxPort) {
+        portRange.push(i++);
+      }
+      this.port = await getPort({port: portRange});
+      const args = [
+        "--headless",
+        "--crash-dumps-dir=/tmp",
+        "--disable-gpu",
+        `--remote-debugging-port=${this.port}`
+      ];
+      const isMac = process.platform === "darwin";
+      const cmd = isMac ? CHROME_CMD.MAC : CHROME_CMD.LINUX;
+      this.chromeProcess = spawn(cmd, args, {shell: true});
+      this.chromeProcess.stdout.on("data", (data) => {
+        data = data.toString().trim();
+        if (data.length) {
+          logger.log(`HarCaptureEngine.chromeProcess.stdout: ${data}`);
+        }
+      });
+      this.chromeProcess.stderr.on("data", (data) => {
+        data = data.toString().trim();
+        if (data.length) {
+          logger.log(`HarCaptureEngine.chromeProcess.stderr: ${data}`);
+        }
+      });
+      this.chromeProcess.on("error", err => {
+        logger.err(`HarCaptureEngine.chromeProcess.error: ${err}`);
+      });
+      this.cache = {};
+    }
+  }
+
+  getCacheKey(url) {
+    return url.toString("base64")
+      .split("=").join("_")
+      .split("+").join("-")
+      .split("/").join("$");
+  }
+
+  async capture(url, onHar, onFail) {
+    const cacheKey = this.getCacheKey(url);
+    if (this.cache[cacheKey]) {
+      onHar(this.cache[cacheKey]);
+    }
+    CHC.run([url], {
+      port: this.port,
+      timeout: CAPTURE_TIMEOUT
+    })
+    .on("fail", onFail) // onFail(url, err)
+    .on("har", har => {
+      this.cache[cacheKey] = har;
+      onHar(this.cache[cacheKey]);
+    });
+  }
+
+  stop() {
+    return new Promise((resolve, reject) => {
+      if (this.chromeProcess) {
+        this.chromeProcess.on("exit", (code, signal) => {
+          // eslint-disable-next-line no-sequences
+          logger.log(`HarCaptureEngine.chromeProcess.exit: ${code, signal}`);
+          resolve();
+        });
+        this.chromeProcess.on("close", (code, signal) => {
+          // eslint-disable-next-line no-sequences
+          logger.log(`HarCaptureEngine.chromeProcess.close: ${code, signal}`);
+          resolve();
+        });
+        this.chromeProcess.on("disconnect", () => {
+          logger.err("HarCaptureEngine.chromeProcess.disconnect");
+          resolve();
+        });
+        this.chromeProcess.on("error", (err) => reject(err));
+        this.chromeProcess.kill("SIGINT");
+        this.chromeProcess = undefined;
+      } else {
+        resolve();
+      }
+    });
+  }
+
+}
+
+module.exports = HarCaptureEngine;