summaryrefslogtreecommitdiff
path: root/devtools/client/performance-new/panel/initializer.js
diff options
context:
space:
mode:
Diffstat (limited to 'devtools/client/performance-new/panel/initializer.js')
-rw-r--r--devtools/client/performance-new/panel/initializer.js189
1 files changed, 189 insertions, 0 deletions
diff --git a/devtools/client/performance-new/panel/initializer.js b/devtools/client/performance-new/panel/initializer.js
new file mode 100644
index 0000000000..26f57de344
--- /dev/null
+++ b/devtools/client/performance-new/panel/initializer.js
@@ -0,0 +1,189 @@
+/* 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/. */
+// @ts-check
+/* exported gInit, gDestroy, loader */
+
+/**
+ * @typedef {import("../@types/perf").PerfFront} PerfFront
+ * @typedef {import("../@types/perf").PreferenceFront} PreferenceFront
+ * @typedef {import("../@types/perf").RecordingSettings} RecordingSettings
+ * @typedef {import("../@types/perf").PageContext} PageContext
+ * @typedef {import("../@types/perf").PanelWindow} PanelWindow
+ * @typedef {import("../@types/perf").Store} Store
+ * @typedef {import("../@types/perf").MinimallyTypedGeckoProfile} MinimallyTypedGeckoProfile
+ * @typedef {import("../@types/perf").ProfileCaptureResult} ProfileCaptureResult
+ * @typedef {import("../@types/perf").ProfilerViewMode} ProfilerViewMode
+ * @typedef {import("../@types/perf").RootTraits} RootTraits
+ */
+"use strict";
+
+{
+ // Create the browser loader, but take care not to conflict with
+ // TypeScript. See devtools/client/performance-new/typescript.md and
+ // the section on "Do not overload require" for more information.
+
+ const { BrowserLoader } = ChromeUtils.import(
+ "resource://devtools/shared/loader/browser-loader.js"
+ );
+ const browserLoader = BrowserLoader({
+ baseURI: "resource://devtools/client/performance-new/",
+ window,
+ });
+
+ /**
+ * @type {any} - Coerce the current scope into an `any`, and assign the
+ * loaders to the scope. They can then be used freely below.
+ */
+ const scope = this;
+ scope.require = browserLoader.require;
+ scope.loader = browserLoader.loader;
+}
+
+const ReactDOM = require("resource://devtools/client/shared/vendor/react-dom.js");
+const React = require("resource://devtools/client/shared/vendor/react.js");
+const FluentReact = require("resource://devtools/client/shared/vendor/fluent-react.js");
+const {
+ FluentL10n,
+} = require("resource://devtools/client/shared/fluent-l10n/fluent-l10n.js");
+const Provider = React.createFactory(
+ require("resource://devtools/client/shared/vendor/react-redux.js").Provider
+);
+const LocalizationProvider = React.createFactory(
+ FluentReact.LocalizationProvider
+);
+const DevToolsPanel = React.createFactory(
+ require("resource://devtools/client/performance-new/components/panel/DevToolsPanel.js")
+);
+const ProfilerEventHandling = React.createFactory(
+ require("resource://devtools/client/performance-new/components/panel/ProfilerEventHandling.js")
+);
+const ProfilerPreferenceObserver = React.createFactory(
+ require("resource://devtools/client/performance-new/components/shared/ProfilerPreferenceObserver.js")
+);
+const createStore = require("resource://devtools/client/shared/redux/create-store.js");
+const selectors = require("resource://devtools/client/performance-new/store/selectors.js");
+const reducers = require("resource://devtools/client/performance-new/store/reducers.js");
+const actions = require("resource://devtools/client/performance-new/store/actions.js");
+const {
+ openProfilerTab,
+ sharedLibrariesFromProfile,
+} = require("resource://devtools/client/performance-new/shared/browser.js");
+const { createLocalSymbolicationService } = ChromeUtils.import(
+ "resource://devtools/client/performance-new/shared/symbolication.jsm.js"
+);
+const {
+ presets,
+ getProfilerViewModeForCurrentPreset,
+ registerProfileCaptureForBrowser,
+} = ChromeUtils.import(
+ "resource://devtools/client/performance-new/shared/background.jsm.js"
+);
+
+/**
+ * This file initializes the DevTools Panel UI. It is in charge of initializing
+ * the DevTools specific environment, and then passing those requirements into
+ * the UI.
+ */
+
+/**
+ * Initialize the panel by creating a redux store, and render the root component.
+ *
+ * @param {PerfFront} perfFront - The Perf actor's front. Used to start and stop recordings.
+ * @param {RootTraits} traits - The traits coming from the root actor. This
+ * makes it possible to change some code path
+ * depending on the server version.
+ * @param {PageContext} pageContext - The context that the UI is being loaded in under.
+ * @param {(() => void)} openAboutProfiling - Optional call to open about:profiling
+ */
+async function gInit(perfFront, traits, pageContext, openAboutProfiling) {
+ const store = createStore(reducers);
+ const isSupportedPlatform = await perfFront.isSupportedPlatform();
+ const supportedFeatures = await perfFront.getSupportedFeatures();
+
+ {
+ // Expose the store as a global, for testing.
+ const anyWindow = /** @type {any} */ (window);
+ const panelWindow = /** @type {PanelWindow} */ (anyWindow);
+ // The store variable is a `ReduxStore`, not our `Store` type, as defined
+ // in perf.d.ts. Coerce it into the `Store` type.
+ const anyStore = /** @type {any} */ (store);
+ panelWindow.gStore = anyStore;
+ }
+
+ const l10n = new FluentL10n();
+ await l10n.init([
+ "devtools/client/perftools.ftl",
+ // For -brand-shorter-name used in some profiler preset descriptions.
+ "branding/brand.ftl",
+ // Needed for the onboarding UI
+ "devtools/client/toolbox-options.ftl",
+ "toolkit/branding/brandings.ftl",
+ ]);
+
+ // Do some initialization, especially with privileged things that are part of the
+ // the browser.
+ store.dispatch(
+ actions.initializeStore({
+ isSupportedPlatform,
+ presets,
+ supportedFeatures,
+ pageContext,
+ })
+ );
+
+ /**
+ * @param {MinimallyTypedGeckoProfile} profile
+ */
+ const onProfileReceived = async profile => {
+ const objdirs = selectors.getObjdirs(store.getState());
+ const profilerViewMode = getProfilerViewModeForCurrentPreset(pageContext);
+ const sharedLibraries = sharedLibrariesFromProfile(profile);
+ const symbolicationService = createLocalSymbolicationService(
+ sharedLibraries,
+ objdirs,
+ perfFront
+ );
+ const browser = await openProfilerTab(profilerViewMode);
+
+ /**
+ * @type {ProfileCaptureResult}
+ */
+ const profileCaptureResult = { type: "SUCCESS", profile };
+
+ registerProfileCaptureForBrowser(
+ browser,
+ profileCaptureResult,
+ symbolicationService
+ );
+ };
+
+ const onEditSettingsLinkClicked = openAboutProfiling;
+
+ ReactDOM.render(
+ Provider(
+ { store },
+ LocalizationProvider(
+ { bundles: l10n.getBundles() },
+ React.createElement(
+ React.Fragment,
+ null,
+ ProfilerEventHandling({ perfFront, traits }),
+ ProfilerPreferenceObserver(),
+ DevToolsPanel({
+ perfFront,
+ onProfileReceived,
+ onEditSettingsLinkClicked,
+ })
+ )
+ )
+ ),
+ document.querySelector("#root")
+ );
+
+ window.addEventListener("unload", () => gDestroy(), { once: true });
+}
+
+function gDestroy() {
+ ReactDOM.unmountComponentAtNode(document.querySelector("#root"));
+}