Source code
Revision control
Copy as Markdown
Other Tools
/* 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
/**
* Parent JSWindowActor to handle navigation for reftests relying on marionette.
*/
export class MarionetteReftestParent extends JSWindowActorParent {
/**
* Wait for the expected URL to be loaded.
*
* @param {string} url
* The expected url.
* @param {boolean} useRemote
* True if tests are running with e10s.
* @param {boolean} warnOnOverflow
* True if we should check the content fits in the viewport.
* This isn't necessary for print reftests where we will render the full
* size of the paginated content.
* @returns {boolean} true if the page is fully loaded with the expected url,
* false otherwise.
*/
async reftestWait(url, useRemote, warnOnOverflow) {
try {
const isCorrectUrl = await this.sendQuery(
"MarionetteReftestParent:reftestWait",
{
url,
useRemote,
warnOnOverflow,
}
);
if (isCorrectUrl) {
// Trigger flush rendering for all remote frames.
await this._flushRenderingInSubtree({
ignoreThrottledAnimations: false,
});
}
return isCorrectUrl;
} catch (e) {
if (e.name === "AbortError") {
// If the query is aborted, the window global is being destroyed, most
// likely because a navigation happened.
return false;
}
// Other errors should not be swallowed.
throw e;
}
}
/**
* Call flushRendering on all browsing contexts in the subtree.
* Each actor will flush rendering in all the same process frames.
*/
async _flushRenderingInSubtree({ ignoreThrottledAnimations }) {
const browsingContext = this.manager.browsingContext;
const contexts = browsingContext.getAllBrowsingContextsInSubtree();
await Promise.all(
contexts.map(async context => {
if (context === browsingContext) {
// Skip the top browsing context, for which flushRendering is
// already performed via the initial reftestWait call.
return;
}
const windowGlobal = context.currentWindowGlobal;
if (!windowGlobal) {
// Bail out if there is no window attached to the current context.
return;
}
if (!windowGlobal.isProcessRoot) {
// Bail out if this window global is not a process root.
// MarionetteReftestChild::flushRendering will flush all same process
// frames, so we only need to call flushRendering on process roots.
return;
}
const reftestActor = windowGlobal.getActor("MarionetteReftest");
await reftestActor.sendQuery("MarionetteReftestParent:flushRendering", {
ignoreThrottledAnimations,
});
})
);
}
}