summaryrefslogtreecommitdiffstats
path: root/devtools/client/framework/enable-devtools-popup.js
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /devtools/client/framework/enable-devtools-popup.js
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devtools/client/framework/enable-devtools-popup.js')
-rw-r--r--devtools/client/framework/enable-devtools-popup.js63
1 files changed, 63 insertions, 0 deletions
diff --git a/devtools/client/framework/enable-devtools-popup.js b/devtools/client/framework/enable-devtools-popup.js
new file mode 100644
index 0000000000..f8be5a7cd5
--- /dev/null
+++ b/devtools/client/framework/enable-devtools-popup.js
@@ -0,0 +1,63 @@
+/* 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";
+
+loader.lazyGetter(this, "telemetry", () => {
+ const Telemetry = require("devtools/client/shared/telemetry");
+ return new Telemetry();
+});
+
+// This session id will be initialized the first time the popup is displayed.
+let telemetrySessionId = null;
+
+/**
+ * Helper dedicated to toggle a popup triggered by pressing F12 if DevTools have
+ * never been opened by the user.
+ *
+ * This popup should be anchored below the main hamburger menu of Firefox,
+ * which contains the Web Developer menu.
+ *
+ * This is part of the OFF12 experiment which tries to disable F12 by default to
+ * reduce accidental usage of DevTools and increase retention of non DevTools
+ * users.
+ */
+exports.toggleEnableDevToolsPopup = function(doc) {
+ // The popup is initially wrapped in a template tag to avoid loading
+ // resources on startup. Unwrap it the first time we show the notification.
+ const panelWrapper = doc.getElementById("wrapper-enable-devtools-popup");
+ if (panelWrapper) {
+ panelWrapper.replaceWith(panelWrapper.content);
+ }
+
+ const popup = doc.getElementById("enable-devtools-popup");
+
+ // Use the icon of the Firefox menu in order to be aligned with the
+ // position of the hamburger menu.
+ const anchor = doc
+ .getElementById("PanelUI-menu-button")
+ .querySelector(".toolbarbutton-icon");
+
+ const isVisible = popup.state === "open";
+ if (isVisible) {
+ popup.hidePopup();
+ } else {
+ if (!telemetrySessionId) {
+ telemetrySessionId = parseInt(telemetry.msSinceProcessStart(), 10);
+ }
+
+ popup.openPopup(anchor, "bottomcenter topright");
+ telemetry.recordEvent("f12_popup_displayed", "tools", null, {
+ session_id: telemetrySessionId,
+ });
+ }
+};
+
+/**
+ * If a session id was already generated here for telemetry, expose it so that
+ * the toolbox can use it as its own session id.
+ */
+exports.getF12SessionId = function() {
+ return telemetrySessionId;
+};