Files
tubestation/browser/components/firefoxview/firefoxview-next.mjs
Jonathan Sudiaman b28fc62832 Bug 1851197 - Add more context for telemetry when selecting options in the context menu when right clicking a tab in Firefox View r=fxview-reviewers,Gijs,sclements
Adds an additional event under the `firefoxview_next` category whenever a link is opened in a new tab, window, etc.

Not being able to access the "trigger node" is a somewhat limiting factor. I raised [[ https://bugzilla.mozilla.org/show_bug.cgi?id=1855743 | Bug 1855743 ]] to address this. Because of this, I could not exactly capture "what type of tab data you're dealing with (Recently closed tabs, Open tabs, Synced tabs, etc)". So I opted to capture the page hash instead as a workaround.

Differential Revision: https://phabricator.services.mozilla.com/D189520
2023-10-10 19:07:57 +00:00

133 lines
3.7 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/. */
let pageList = [];
const { topChromeWindow } = window.browsingContext;
function onHashChange() {
changePage(document.location.hash.substring(1));
}
function changePage(page) {
let navigation = document.querySelector("fxview-category-navigation");
if (page && !pageList.includes(page)) {
page = "recentbrowsing";
document.location.hash = "recentbrowsing";
}
document.querySelector("named-deck").selectedViewName = page || pageList[0];
navigation.currentCategory = page || pageList[0];
if (navigation.categoryButtons.includes(document.activeElement)) {
let currentCategoryButton = navigation.categoryButtons.find(
categoryButton => categoryButton.name === page
);
(currentCategoryButton || navigation.categoryButtons[0]).focus();
}
}
function recordNavigationTelemetry(source, eventTarget) {
let page = "recentbrowsing";
if (source === "category-navigation") {
page = eventTarget.parentNode.currentCategory;
} else if (source === "view-all") {
page = eventTarget.shortPageName;
}
// Record telemetry
Services.telemetry.recordEvent(
"firefoxview_next",
"change_page",
"navigation",
null,
{
page,
source,
}
);
}
window.addEventListener("DOMContentLoaded", async () => {
recordEnteredTelemetry();
let navigation = document.querySelector("fxview-category-navigation");
for (const item of navigation.categoryButtons) {
pageList.push(item.getAttribute("name"));
}
window.addEventListener("hashchange", onHashChange);
window.addEventListener("change-category", function (event) {
location.hash = event.target.getAttribute("name");
recordNavigationTelemetry("category-navigation", event.target);
});
window.addEventListener("card-container-view-all", function (event) {
recordNavigationTelemetry("view-all", event.originalTarget);
});
if (document.location.hash) {
changePage(document.location.hash.substring(1));
}
if (Cu.isInAutomation) {
Services.obs.notifyObservers(null, "firefoxview-entered");
}
});
document
.querySelector("named-deck")
.addEventListener("view-changed", async event => {
for (const child of event.target.children) {
if (child.getAttribute("name") == event.target.selectedViewName) {
child.enter();
} else {
child.exit();
}
}
});
document.addEventListener("visibilitychange", () => {
if (document.visibilityState === "visible") {
recordEnteredTelemetry();
if (Cu.isInAutomation) {
Services.obs.notifyObservers(null, "firefoxview-entered");
}
}
});
function recordEnteredTelemetry() {
Services.telemetry.recordEvent(
"firefoxview_next",
"entered",
"firefoxview",
null,
{
page: document.location?.hash?.substring(1) || "recentbrowsing",
}
);
}
window.addEventListener(
"unload",
() => {
// Clear out the document so the disconnectedCallback will trigger
// properly and all of the custom elements can cleanup.
document.body.textContent = "";
topChromeWindow.removeEventListener("command", onCommand);
},
{ once: true }
);
topChromeWindow.addEventListener("command", onCommand);
function onCommand(e) {
if (document.hidden || !e.target.closest("#contentAreaContextMenu")) {
return;
}
const item =
e.target.closest("#context-openlinkinusercontext-menu") || e.target;
Services.telemetry.recordEvent(
"firefoxview_next",
"browser_context_menu",
"tabs",
null,
{
menu_action: item.id,
page: location.hash.substring(1) || "recentbrowsing",
}
);
}