Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-26 22:32:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1790020 - Hook up urlbar result menu with telementry. r=mak

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D168688
This commit is contained in:
Dão Gottwald 2023-03-09 09:54:20 +00:00
parent 066cab5965
commit b288401947
7 changed files with 92 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
browser/components/urlbar/UrlbarController.sys.mjs
View File

@ -844,7 +844,7 @@ class TelemetryEvent {
* for "blur".
* @param {string} [details.selType] type of the selected element, undefined
* for "blur". One of "unknown", "autofill", "visiturl", "bookmark",
* "history", "keyword", "searchengine", "searchsuggestion",
* "help", "history", "keyword", "searchengine", "searchsuggestion",
* "switchtab", "remotetab", "extension", "oneoff", "dismiss".
* @param {string} [details.provider] The name of the provider for the selected
* result.
@ -980,7 +980,7 @@ class TelemetryEvent {
);
if (details.selType === "dismiss") {
// The conventional telemetry dones't support "dismiss" event.
// The conventional telemetry doesn't support "dismiss" event.
return;
}
@ -1306,29 +1306,36 @@ class TelemetryEvent {
}
/**
* Extracts a telemetry type from an element for event telemetry.
* Extracts a telemetry type from a result and the element being interacted
* with for event telemetry.
*
* @param {object} result The element to analyze.
* @param {Element} element The element to analyze.
* @returns {string} a string type for the telemetry event.
*/
typeFromElement(element) {
typeFromElement(result, element) {
if (!element) {
return "none";
}
let row = element.closest(".urlbarView-row");
if (row.result && row.result.providerName != "UrlbarProviderTopSites") {
if (result?.providerName != "UrlbarProviderTopSites") {
// Element handlers go here.
if (element.classList.contains("urlbarView-button-help")) {
return row.result.type == lazy.UrlbarUtils.RESULT_TYPE.TIP
if (
element.classList.contains("urlbarView-button-help") ||
element.dataset.command == "help"
) {
return result?.type == lazy.UrlbarUtils.RESULT_TYPE.TIP
? "tiphelp"
: "help";
}
if (element.classList.contains("urlbarView-button-block")) {
if (
element.classList.contains("urlbarView-button-block") ||
element.dataset.command == "dismiss"
) {
return "block";
}
}
// Now handle the result.
return lazy.UrlbarUtils.telemetryTypeFromResult(row.result);
return lazy.UrlbarUtils.telemetryTypeFromResult(result);
}
/**

31
browser/components/urlbar/UrlbarInput.sys.mjs
View File

@ -619,7 +619,10 @@ export class UrlbarInput {
}
let url;
let selType = this.controller.engagementEvent.typeFromElement(element);
let selType = this.controller.engagementEvent.typeFromElement(
result,
element
);
let typedValue = this.value;
if (oneOffParams?.engine) {
selType = "oneoff";
@ -837,7 +840,10 @@ export class UrlbarInput {
return;
}
if (element?.classList.contains("urlbarView-button-block")) {
if (
element?.classList.contains("urlbarView-button-block") ||
element?.dataset.command == "dismiss"
) {
this.controller.handleDeleteEntry(event, result);
return;
}
@ -1041,7 +1047,8 @@ export class UrlbarInput {
}
case lazy.UrlbarUtils.RESULT_TYPE.TIP: {
let scalarName =
element.dataset.name == "help"
element.classList.contains("urlbarView-button-help") ||
element.dataset.command == "help"
? `${result.payload.type}-help`
: `${result.payload.type}-picked`;
Services.telemetry.keyedScalarAdd("urlbar.tips", scalarName, 1);
@ -1088,7 +1095,10 @@ export class UrlbarInput {
selIndex,
searchString: this._lastSearchString,
searchMode,
selType: this.controller.engagementEvent.typeFromElement(element),
selType: this.controller.engagementEvent.typeFromElement(
result,
element
),
provider: result.providerName,
element,
startEventInfo,
@ -1146,7 +1156,7 @@ export class UrlbarInput {
this.controller.engagementEvent.record(event, {
searchString: this._lastSearchString,
selIndex,
selType: this.controller.engagementEvent.typeFromElement(element),
selType: this.controller.engagementEvent.typeFromElement(result, element),
provider: result.providerName,
searchSource: this.getSearchSource(event),
});
@ -2994,12 +3004,13 @@ export class UrlbarInput {
_on_command(event) {
// Something is executing a command, likely causing a focus change. This
// should not be recorded as an abandonment. If the user is entering search
// mode from a one-off, then they are in the same engagement and we should
// not discard.
// should not be recorded as an abandonment. If the user is selecting a
// result menu item or entering search mode from a one-off, then they are
// in the same engagement and we should not discard.
if (
!event.target.classList.contains("searchbar-engine-one-off-item") ||
this.searchMode?.entry != "oneoff"
!event.target.classList.contains("urlbarView-result-menuitem") &&
(!event.target.classList.contains("searchbar-engine-one-off-item") ||
this.searchMode?.entry != "oneoff")
) {
this.controller.engagementEvent.discard();
}

31
browser/components/urlbar/UrlbarView.sys.mjs
View File

@ -40,8 +40,8 @@ const ZERO_PREFIX_SCALAR_ENGAGEMENT = "urlbar.zeroprefix.engagement";
const ZERO_PREFIX_SCALAR_EXPOSURE = "urlbar.zeroprefix.exposure";
const RESULT_MENU_COMMANDS = {
BLOCK: "block",
LEARN_MORE: "learn-more",
DISMISS: "dismiss",
HELP: "help",
};
const getBoundsWithoutFlushing = element =>
@ -258,7 +258,9 @@ export class UrlbarView {
* The result of the element's row.
*/
getResultFromElement(element) {
return this.#getRowFromElement(element)?.result;
return element?.classList.contains("urlbarView-result-menuitem")
? this.#resultMenuResult
: this.#getRowFromElement(element)?.result;
}
/**
@ -2662,20 +2664,20 @@ export class UrlbarView {
result.source == lazy.UrlbarUtils.RESULT_SOURCE.HISTORY &&
!result.autofill
) {
commands.set(RESULT_MENU_COMMANDS.BLOCK, {
commands.set(RESULT_MENU_COMMANDS.DISMISS, {
l10n: { id: "urlbar-result-menu-remove-from-history" },
});
commands.set(RESULT_MENU_COMMANDS.LEARN_MORE, {
commands.set(RESULT_MENU_COMMANDS.HELP, {
l10n: { id: "urlbar-result-menu-learn-more" },
});
}
if (result.payload.isBlockable) {
commands.set(RESULT_MENU_COMMANDS.BLOCK, {
commands.set(RESULT_MENU_COMMANDS.DISMISS, {
l10n: result.payload.blockL10n,
});
}
if (result.payload.helpUrl) {
commands.set(RESULT_MENU_COMMANDS.LEARN_MORE, {
commands.set(RESULT_MENU_COMMANDS.HELP, {
l10n: result.payload.helpL10n,
});
}
@ -2694,6 +2696,7 @@ export class UrlbarView {
"menuitem"
);
menuitem.dataset.command = command;
menuitem.classList.add("urlbarView-result-menuitem");
this.#setElementL10n(menuitem, data.l10n);
this.resultMenu.appendChild(menuitem);
}
@ -2971,18 +2974,14 @@ export class UrlbarView {
this.#resultMenuResult = null;
let menuitem = event.target;
switch (menuitem.dataset.command) {
case RESULT_MENU_COMMANDS.BLOCK:
this.controller.handleDeleteEntry(null, result);
break;
case RESULT_MENU_COMMANDS.LEARN_MORE:
this.window.openTrustedLinkIn(
case RESULT_MENU_COMMANDS.HELP:
menuitem.dataset.url =
result.payload.helpUrl ||
Services.urlFormatter.formatURLPref("app.support.baseURL") +
"awesome-bar-result-menu",
"tab"
);
Services.urlFormatter.formatURLPref("app.support.baseURL") +
"awesome-bar-result-menu";
break;
}
this.input.pickResult(result, event, menuitem);
}
}

17
browser/components/urlbar/tests/browser-tips/browser_interventions.js
View File

@ -273,17 +273,17 @@ add_task(async function pickHelpButton() {
);
if (UrlbarPrefs.get("resultMenu")) {
let tabOpenPromise = BrowserTestUtils.waitForNewTab(
gBrowser,
let loadPromise = BrowserTestUtils.browserLoaded(
gBrowser.selectedBrowser,
false,
"http://example.com/"
);
await UrlbarTestUtils.openResultMenuAndPressAccesskey(window, "h", {
openByMouse: true,
resultIndex: 1,
});
info("Waiting for help URL to load in a new tab");
await tabOpenPromise;
gBrowser.removeCurrentTab();
info("Waiting for help URL to load in the current tab");
await loadPromise;
} else {
let helpButton = element._buttons.get("help");
Assert.ok(helpButton, "Help button exists");
@ -297,13 +297,6 @@ add_task(async function pickHelpButton() {
await BrowserTestUtils.browserLoaded(gBrowser.selectedBrowser);
}
if (UrlbarPrefs.get("resultMenu")) {
todo(
false,
"help telemetry for the result menu to be implemented in bug 1790020"
);
return;
}
const scalars = TelemetryTestUtils.getProcessScalars("parent", true, true);
TelemetryTestUtils.assertKeyedScalar(
scalars,

35
browser/components/urlbar/tests/browser-tips/browser_picks.js
View File

@ -28,7 +28,7 @@ add_task(async function enter_mainButton_noURL() {
await doTest({ click: false });
});
add_task(async function enter_helpButton() {
add_task(async function enter_help() {
await doTest({ click: false, helpUrl: HELP_URL });
});
@ -40,7 +40,7 @@ add_task(async function mouse_mainButton_noURL() {
await doTest({ click: true });
});
add_task(async function mouse_helpButton() {
add_task(async function mouse_help() {
await doTest({ click: true, helpUrl: HELP_URL });
});
@ -105,14 +105,6 @@ add_task(async function mouse_insideTipButNotOnButtons() {
* to pick the main button instead.
*/
async function doTest({ click, buttonUrl = undefined, helpUrl = undefined }) {
if (UrlbarPrefs.get("resultMenu") && helpUrl) {
todo(
false,
"help telemetry for the result menu to be implemented in bug 1790020"
);
return;
}
// Open a new tab for the test if we expect to load a URL.
let tab;
if (buttonUrl || helpUrl) {
@ -144,8 +136,9 @@ async function doTest({ click, buttonUrl = undefined, helpUrl = undefined }) {
});
let row = await UrlbarTestUtils.waitForAutocompleteResultAt(window, 0);
let mainButton = row._buttons.get("0");
let helpButton = row._buttons.get("help");
let target = helpUrl ? helpButton : mainButton;
let target = helpUrl
? row._buttons.get(UrlbarPrefs.get("resultMenu") ? "menu" : "help")
: mainButton;
// If we're picking the tip with the keyboard, TAB to select the proper
// target.
@ -163,7 +156,12 @@ async function doTest({ click, buttonUrl = undefined, helpUrl = undefined }) {
await Promise.all([
pickedPromise || BrowserTestUtils.browserLoaded(gBrowser.selectedBrowser),
UrlbarTestUtils.promisePopupClose(window, () => {
if (click) {
if (helpUrl && UrlbarPrefs.get("resultMenu")) {
UrlbarTestUtils.openResultMenuAndPressAccesskey(window, "h", {
openByMouse: click,
resultIndex: 0,
});
} else if (click) {
EventUtils.synthesizeMouseAtCenter(target, {});
} else {
EventUtils.synthesizeKey("KEY_Enter");
@ -184,7 +182,10 @@ async function doTest({ click, buttonUrl = undefined, helpUrl = undefined }) {
{
category: "urlbar",
method: "engagement",
object: click ? "click" : "enter",
object:
click && !(helpUrl && UrlbarPrefs.get("resultMenu"))
? "click"
: "enter",
value: "typed",
},
],
@ -212,7 +213,11 @@ function makeTipResult({ buttonUrl, helpUrl }) {
},
],
helpUrl,
helpL10n: { id: "urlbar-search-tips-confirm" },
helpL10n: {
id: UrlbarPrefs.get("resultMenu")
? "urlbar-result-menu-tip-get-help"
: "urlbar-tip-help-icon",
},
}
);
}

22
browser/components/urlbar/tests/browser/browser_urlbar_event_telemetry_engagement.js
View File

@ -257,22 +257,19 @@ const tests = [
},
async function(win) {
if (UrlbarPrefs.get("resultMenu")) {
todo(
false,
"telemetry for the result menu to be implemented in bug 1790020"
);
return null;
}
let tipProvider = registerTipProvider();
info("Selecting a tip's help button, enter.");
info("Selecting a tip's help option.");
let promise = BrowserTestUtils.browserLoaded(win.gBrowser.selectedBrowser);
win.gURLBar.search("x");
await UrlbarTestUtils.promiseSearchComplete(win);
EventUtils.synthesizeKey("KEY_ArrowDown", {}, win);
EventUtils.synthesizeKey("KEY_ArrowDown", {}, win);
EventUtils.synthesizeKey("KEY_Tab", {}, win);
EventUtils.synthesizeKey("VK_RETURN", {}, win);
if (UrlbarPrefs.get("resultMenu")) {
await UrlbarTestUtils.openResultMenuAndPressAccesskey(win, "h");
} else {
EventUtils.synthesizeKey("KEY_Tab", {}, win);
EventUtils.synthesizeKey("VK_RETURN", {}, win);
}
await promise;
unregisterTipProvider(tipProvider);
return {
@ -1279,6 +1276,11 @@ let tipMatches = [
UrlbarUtils.RESULT_SOURCE.OTHER_LOCAL,
{
helpUrl: "http://example.com/",
helpL10n: {
id: UrlbarPrefs.get("resultMenu")
? "urlbar-result-menu-tip-get-help"
: "urlbar-tip-help-icon",
},
type: "test",
titleL10n: { id: "urlbar-search-tips-confirm" },
buttons: [

18
browser/components/urlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_engagement_type.js
View File

@ -87,14 +87,7 @@ add_task(async function engagement_type_dismiss() {
() => originalResultCount != UrlbarTestUtils.getResultCount(window)
);
if (UrlbarPrefs.get("resultMenu")) {
todo(
false,
"telemetry for the result menu to be implemented in bug 1790020"
);
} else {
assertEngagementTelemetry([{ engagement_type: "dismiss" }]);
}
assertEngagementTelemetry([{ engagement_type: "dismiss" }]);
});
await doTest(async browser => {
@ -136,14 +129,7 @@ add_task(async function engagement_type_help() {
const tab = await onTabOpened;
BrowserTestUtils.removeTab(tab);
if (UrlbarPrefs.get("resultMenu")) {
todo(
false,
"telemetry for the result menu to be implemented in bug 1790020"
);
} else {
assertEngagementTelemetry([{ engagement_type: "help" }]);
}
assertEngagementTelemetry([{ engagement_type: "help" }]);
});
await SpecialPowers.popPrefEnv();