b4b5799a9f
When attempting to send commands on a very early browsing context, the command might fail due to a missing currentWindowGlobal. This patch adds a helper to wait for the currentWindowGlobal property to be set and uses it from RootTransport in order to avoid this issue. A browser mochitest is added to cover this scenario. Differential Revision: https://phabricator.services.mozilla.com/D225281
130 lines
4.1 KiB
JavaScript
130 lines
4.1 KiB
JavaScript
/* 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/. */
|
|
|
|
const lazy = {};
|
|
|
|
ChromeUtils.defineESModuleGetters(lazy, {
|
|
PollPromise: "chrome://remote/content/shared/Sync.sys.mjs",
|
|
});
|
|
|
|
function isExtensionContext(browsingContext) {
|
|
let principal;
|
|
try {
|
|
if (CanonicalBrowsingContext.isInstance(browsingContext)) {
|
|
principal = browsingContext.currentWindowGlobal.documentPrincipal;
|
|
} else {
|
|
principal = browsingContext.window.document.nodePrincipal;
|
|
}
|
|
} catch (e) {
|
|
throw new Error(
|
|
`Could not retrieve principal for browsingContext (${e.message})`
|
|
);
|
|
}
|
|
|
|
// In practice, note that the principal will never be an expanded principal.
|
|
// The are only used for content scripts executed in a Sandbox, and do not
|
|
// have a browsing context on their own.
|
|
// But we still use this flag because there is no isAddonPrincipal flag.
|
|
return principal.isAddonOrExpandedAddonPrincipal;
|
|
}
|
|
|
|
function isParentProcess(browsingContext) {
|
|
if (CanonicalBrowsingContext.isInstance(browsingContext)) {
|
|
return browsingContext.currentWindowGlobal.osPid === -1;
|
|
}
|
|
|
|
// If `browsingContext` is not a `CanonicalBrowsingContext`, then we are
|
|
// necessarily in a content process page.
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if the provided browsing context is currently displaying its initial
|
|
* document. For top level browsing contexts, this is usually the initial
|
|
* about:blank which will be replaced soon.
|
|
*
|
|
* @param {BrowsingContext} browsingContext
|
|
* The browsing context to check.
|
|
*
|
|
* @returns {boolean}
|
|
* True if the browsing context is on the initial document, false otherwise.
|
|
*/
|
|
export function isInitialDocument(browsingContext) {
|
|
if (!browsingContext.currentWindowGlobal) {
|
|
// Right after a browsing context has been attached it could happen that
|
|
// no window global has been set yet. Consider this as nothing has been
|
|
// loaded yet.
|
|
return true;
|
|
}
|
|
|
|
return browsingContext.currentWindowGlobal.isInitialDocument;
|
|
}
|
|
|
|
/**
|
|
* Check if the given browsing context is valid for the message handler
|
|
* to use.
|
|
*
|
|
* @param {BrowsingContext} browsingContext
|
|
* The browsing context to check.
|
|
* @param {object=} options
|
|
* @param {string=} options.browserId
|
|
* The id of the browser to filter the browsing contexts by (optional).
|
|
*
|
|
* @returns {boolean}
|
|
* True if the browsing context is valid, false otherwise.
|
|
*/
|
|
export function isBrowsingContextCompatible(browsingContext, options = {}) {
|
|
const { browserId } = options;
|
|
|
|
// If a browserId was provided, skip browsing contexts which are not
|
|
// associated with this browserId.
|
|
if (browserId !== undefined && browsingContext.browserId !== browserId) {
|
|
return false;
|
|
}
|
|
|
|
// If this is a CanonicalBrowsingContext but the currentWindowGlobal is not
|
|
// attached yet, skip it.
|
|
if (
|
|
CanonicalBrowsingContext.isInstance(browsingContext) &&
|
|
!browsingContext.currentWindowGlobal
|
|
) {
|
|
return false;
|
|
}
|
|
|
|
// Skip:
|
|
// - extension contexts until we support debugging webextensions, see Bug 1755014.
|
|
// - privileged contexts until we support debugging Chrome context, see Bug 1713440.
|
|
return (
|
|
!isExtensionContext(browsingContext) && !isParentProcess(browsingContext)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Wait until `currentWindowGlobal` is available on a browsing context. When a
|
|
* browsing context has just been created, the `currentWindowGlobal` might not
|
|
* be attached yet.
|
|
*
|
|
* @param {CanonicalBrowsingContext} browsingContext
|
|
* The browsing context to wait for.
|
|
*
|
|
* @returns {Promise}
|
|
* Promise which resolves when `currentWindowGlobal` is set on the browsing
|
|
* context or throws after 100ms.
|
|
*/
|
|
export async function waitForCurrentWindowGlobal(browsingContext) {
|
|
await lazy.PollPromise(
|
|
(resolve, reject) => {
|
|
if (browsingContext.currentWindowGlobal) {
|
|
resolve();
|
|
} else {
|
|
reject();
|
|
}
|
|
},
|
|
{
|
|
errorMessage: `currentWindowGlobal was not available for Browsing Context with id: ${browsingContext.id}`,
|
|
timeout: 100,
|
|
}
|
|
);
|
|
}
|