diff options
Diffstat (limited to 'devtools/client/framework/toolbox-init.js')
| -rw-r--r-- | devtools/client/framework/toolbox-init.js | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/devtools/client/framework/toolbox-init.js b/devtools/client/framework/toolbox-init.js new file mode 100644 index 0000000000..b1dabcdfd7 --- /dev/null +++ b/devtools/client/framework/toolbox-init.js @@ -0,0 +1,165 @@ +/* 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/. */ + +/* eslint-env browser */ +/* global XPCNativeWrapper */ + +"use strict"; + +const { require } = ChromeUtils.import("resource://devtools/shared/Loader.jsm"); + +// URL constructor doesn't support about: scheme +const href = window.location.href.replace("about:", "http://"); +const url = new window.URL(href); + +// `host` is the frame element loading the toolbox. +let host = window.browsingContext.embedderElement; + +// If there's no containerElement (which happens when loading about:devtools-toolbox as +// a top level document), use the current window. +if (!host) { + host = { + contentWindow: window, + contentDocument: document, + // toolbox-host-manager.js wants to set attributes on the frame that contains it, + // but that is fine to skip and doesn't make sense when using the current window. + setAttribute() {}, + ownerDocument: document, + // toolbox-host-manager.js wants to listen for unload events from outside the frame, + // but this is fine to skip since the toolbox code listens inside the frame as well, + // and there is no outer document in this case. + addEventListener() {}, + }; +} + +const onLoad = new Promise(r => { + host.contentWindow.addEventListener("DOMContentLoaded", r, { once: true }); +}); + +async function showErrorPage(doc, errorMessage) { + const win = doc.defaultView; + const { BrowserLoader } = ChromeUtils.import( + "resource://devtools/client/shared/browser-loader.js" + ); + const browserRequire = BrowserLoader({ + window: win, + useOnlyShared: true, + }).require; + + const React = browserRequire("devtools/client/shared/vendor/react"); + const ReactDOM = browserRequire("devtools/client/shared/vendor/react-dom"); + const DebugTargetErrorPage = React.createFactory( + require("devtools/client/framework/components/DebugTargetErrorPage") + ); + const { LocalizationHelper } = browserRequire("devtools/shared/l10n"); + const L10N = new LocalizationHelper( + "devtools/client/locales/toolbox.properties" + ); + + // mount the React component into our XUL container once the DOM is ready + await onLoad; + + // Update the tab title. + document.title = L10N.getStr("toolbox.debugTargetInfo.tabTitleError"); + + const mountEl = doc.querySelector("#toolbox-error-mount"); + const element = DebugTargetErrorPage({ + errorMessage, + L10N, + }); + ReactDOM.render(element, mountEl); + + // make sure we unmount the component when the page is destroyed + win.addEventListener( + "unload", + () => { + ReactDOM.unmountComponentAtNode(mountEl); + }, + { once: true } + ); +} + +async function initToolbox(url, host) { + const { gDevTools } = require("devtools/client/framework/devtools"); + const { + targetFromURL, + } = require("devtools/client/framework/target-from-url"); + const { Toolbox } = require("devtools/client/framework/toolbox"); + const { DevToolsServer } = require("devtools/server/devtools-server"); + const { DevToolsClient } = require("devtools/client/devtools-client"); + + // Specify the default tool to open + const tool = url.searchParams.get("tool"); + + try { + let target; + if (url.searchParams.has("target")) { + // Attach toolbox to a given browser iframe (<xul:browser> or <html:iframe + // mozbrowser>) whose reference is set on the host iframe. + // Note that so far, this is no real usage of it. It is only used by a test. + + // `iframe` is the targeted document to debug + let iframe = host.wrappedJSObject + ? host.wrappedJSObject.target + : host.target; + if (!iframe) { + throw new Error("Unable to find the targeted iframe to debug"); + } + + // Need to use a xray to have attributes and behavior expected by + // devtools codebase + iframe = XPCNativeWrapper(iframe); + + // Fake a xul:tab object as we don't have one. + // linkedBrowser is the only one attribute being queried by client.getTab + const tab = { linkedBrowser: iframe }; + + DevToolsServer.init(); + DevToolsServer.registerAllActors(); + const client = new DevToolsClient(DevToolsServer.connectPipe()); + + await client.connect(); + // Creates a target for a given browser iframe. + const tabDescriptor = await client.mainRoot.getTab({ tab }); + target = await tabDescriptor.getTarget(); + // Instruct the Target to automatically close the client on destruction. + target.shouldCloseClient = true; + } else { + target = await targetFromURL(url); + const toolbox = gDevTools.getToolbox(target); + if (toolbox && toolbox.isDestroying()) { + // If a toolbox already exists for the target, wait for current toolbox destroy to + // be finished and retrieve a new valid target. The ongoing toolbox destroy will + // destroy the target, so it can not be reused. + await toolbox.destroy(); + target = await targetFromURL(url); + } + } + + // Display an error page if we are connected to a remote target and we lose it + const onTargetDestroyed = function() { + target.off("close", onTargetDestroyed); + // Prevent trying to display the error page if the toolbox tab is being destroyed + if (host.contentDocument) { + const error = new Error("Debug target was disconnected"); + showErrorPage(host.contentDocument, `${error}`); + } + }; + target.on("close", onTargetDestroyed); + + const options = { customIframe: host }; + await gDevTools.showToolbox(target, tool, Toolbox.HostType.PAGE, options); + } catch (error) { + // When an error occurs, show error page with message. + console.error("Exception while loading the toolbox", error); + showErrorPage(host.contentDocument, `${error}`); + } +} + +// Only use this method to attach the toolbox if some query parameters are given +if (url.search.length > 1) { + initToolbox(url, host); +} +// TODO: handle no params in about:devtool-toolbox +// https://bugzilla.mozilla.org/show_bug.cgi?id=1526996 |