1 files changed, 209 insertions, 0 deletions
diff --git a/testing/marionette/actors/MarionetteReftestChild.jsm b/testing/marionette/actors/MarionetteReftestChild.jsm
new file mode 100644
index 0000000000..dd1743d62c
--- /dev/null
+++ b/testing/marionette/actors/MarionetteReftestChild.jsm
@@ -0,0 +1,209 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+const EXPORTED_SYMBOLS = ["MarionetteReftestChild"];
+
+const { XPCOMUtils } = ChromeUtils.import(
+  "resource://gre/modules/XPCOMUtils.jsm"
+);
+
+XPCOMUtils.defineLazyModuleGetters(this, {
+  Log: "chrome://marionette/content/log.js",
+});
+
+XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+
+/**
+ * Child JSWindowActor to handle navigation for reftests relying on marionette.
+ */
+class MarionetteReftestChild extends JSWindowActorChild {
+  constructor() {
+    super();
+
+    // This promise will resolve with the URL recorded in the "load" event
+    // handler. This URL will not be impacted by any hash modification that
+    // might be performed by the test script.
+    // The harness should be loaded before loading any test page, so the actors
+    // should be registered before the "load" event is received for a test page.
+    this._loadedURLPromise = new Promise(
+      r => (this._resolveLoadedURLPromise = r)
+    );
+  }
+
+  handleEvent(event) {
+    if (event.type == "load") {
+      const url = event.target.location.href;
+      logger.debug(`Handle load event with URL ${url}`);
+      this._resolveLoadedURLPromise(url);
+    }
+  }
+
+  actorCreated() {
+    logger.trace(
+      `[${this.browsingContext.id}] Reftest actor created ` +
+        `for window id ${this.manager.innerWindowId}`
+    );
+  }
+
+  async receiveMessage(msg) {
+    const { name, data } = msg;
+
+    let result;
+    switch (name) {
+      case "MarionetteReftestParent:reftestWait":
+        result = await this.reftestWait(data);
+        break;
+    }
+    return result;
+  }
+
+  /**
+   * Wait for a reftest page to be ready for screenshots:
+   * - wait for the loadedURL to be available (see handleEvent)
+   * - check if the URL matches the expected URL
+   * - if present, wait for the "reftest-wait" classname to be removed from the
+   *   document element
+   *
+   * @param {Object} options
+   * @param {String} options.url
+   *        The expected test page URL
+   * @param {Boolean} options.useRemote
+   *        True when using e10s
+   * @return {Boolean}
+   *         Returns true when the correct page is loaded and ready for
+   *         screenshots. Returns false if the page loaded bug does not have the
+   *         expected URL.
+   */
+  async reftestWait(options = {}) {
+    const { url, useRemote } = options;
+    const loadedURL = await this._loadedURLPromise;
+    if (loadedURL !== url) {
+      logger.debug(
+        `Window URL does not match the expected URL "${loadedURL}" !== "${url}"`
+      );
+      return false;
+    }
+
+    const documentElement = this.document.documentElement;
+    const hasReftestWait = documentElement.classList.contains("reftest-wait");
+
+    logger.debug("Waiting for event loop to spin");
+    await new Promise(resolve =>
+      this.document.defaultView.setTimeout(resolve, 0)
+    );
+
+    await this.paintComplete(useRemote);
+
+    if (hasReftestWait) {
+      const event = new Event("TestRendered", { bubbles: true });
+      documentElement.dispatchEvent(event);
+      logger.info("Emitted TestRendered event");
+      await this.reftestWaitRemoved();
+      await this.paintComplete(useRemote);
+    }
+    if (
+      this.document.defaultView.innerWidth < documentElement.scrollWidth ||
+      this.document.defaultView.innerHeight < documentElement.scrollHeight
+    ) {
+      logger.warn(
+        `${url} overflows viewport (width: ${documentElement.scrollWidth}, height: ${documentElement.scrollHeight})`
+      );
+    }
+    return true;
+  }
+
+  paintComplete(useRemote) {
+    logger.debug("Waiting for rendering");
+    let windowUtils = this.document.defaultView.windowUtils;
+    return new Promise(resolve => {
+      let maybeResolve = () => {
+        this.flushRendering();
+        if (useRemote) {
+          // Flush display (paint)
+          logger.debug("Force update of layer tree");
+          windowUtils.updateLayerTree();
+        }
+
+        if (windowUtils.isMozAfterPaintPending) {
+          logger.debug("isMozAfterPaintPending: true");
+          this.document.defaultView.addEventListener(
+            "MozAfterPaint",
+            maybeResolve,
+            {
+              once: true,
+            }
+          );
+        } else {
+          // resolve at the start of the next frame in case of leftover paints
+          logger.debug("isMozAfterPaintPending: false");
+          this.document.defaultView.requestAnimationFrame(() => {
+            this.document.defaultView.requestAnimationFrame(resolve);
+          });
+        }
+      };
+      maybeResolve();
+    });
+  }
+
+  reftestWaitRemoved() {
+    logger.debug("Waiting for reftest-wait removal");
+    return new Promise(resolve => {
+      const documentElement = this.document.documentElement;
+      let observer = new this.document.defaultView.MutationObserver(() => {
+        if (!documentElement.classList.contains("reftest-wait")) {
+          observer.disconnect();
+          logger.debug("reftest-wait removed");
+          this.document.defaultView.setTimeout(resolve, 0);
+        }
+      });
+      if (documentElement.classList.contains("reftest-wait")) {
+        observer.observe(documentElement, { attributes: true });
+      } else {
+        this.document.defaultView.setTimeout(resolve, 0);
+      }
+    });
+  }
+
+  flushRendering() {
+    let anyPendingPaintsGeneratedInDescendants = false;
+
+    let windowUtils = this.document.defaultView.windowUtils;
+
+    function flushWindow(win) {
+      let utils = win.windowUtils;
+      let afterPaintWasPending = utils.isMozAfterPaintPending;
+
+      let root = win.document.documentElement;
+      if (root) {
+        try {
+          // Flush pending restyles and reflows for this window (layout)
+          root.getBoundingClientRect();
+        } catch (e) {
+          logger.error("flushWindow failed", e);
+        }
+      }
+
+      if (!afterPaintWasPending && utils.isMozAfterPaintPending) {
+        anyPendingPaintsGeneratedInDescendants = true;
+      }
+
+      for (let i = 0; i < win.frames.length; ++i) {
+        flushWindow(win.frames[i]);
+      }
+    }
+    flushWindow(this.document.defaultView);
+
+    if (
+      anyPendingPaintsGeneratedInDescendants &&
+      !windowUtils.isMozAfterPaintPending
+    ) {
+      logger.error(
+        "Descendant frame generated a MozAfterPaint event, " +
+          "but the root document doesn't have one!"
+      );
+    }
+  }
+}