mozilla-central/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_tip.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

/* Any copyright is dedicated to the Public Domain.
*/
/**
* This file tests urlbar telemetry for tip results.
*/
"use strict";
ChromeUtils.defineESModuleGetters(this, {
});
function snapshotHistograms() {
Services.telemetry.clearScalars();
Services.telemetry.clearEvents();
return {
resultMethodHist: TelemetryTestUtils.getAndClearHistogram(
"FX_URLBAR_SELECTED_RESULT_METHOD"
),
search_hist: TelemetryTestUtils.getAndClearKeyedHistogram("SEARCH_COUNTS"),
};
}
function assertTelemetryResults(histograms, type, index, method) {
TelemetryTestUtils.assertHistogram(histograms.resultMethodHist, method, 1);
TelemetryTestUtils.assertKeyedScalar(
TelemetryTestUtils.getProcessScalars("parent", true, true),
`urlbar.picked.${type}`,
index,
1
);
}
add_setup(async function () {
await SpecialPowers.pushPrefEnv({
set: [
// Disable search suggestions in the urlbar.
["browser.urlbar.suggest.searches", false],
// Turn autofill off.
["browser.urlbar.autoFill", false],
],
});
await PlacesUtils.history.clear();
await PlacesUtils.bookmarks.eraseEverything();
});
add_task(async function test() {
// Add a restricting provider that returns a preselected heuristic tip result.
let provider = new TipProvider([
Object.assign(
new UrlbarResult(
UrlbarUtils.RESULT_TYPE.TIP,
UrlbarUtils.RESULT_SOURCE.OTHER_LOCAL,
{
helpUrl: "https://example.com/",
type: "test",
titleL10n: { id: "urlbar-search-tips-confirm" },
buttons: [
{
l10n: { id: "urlbar-search-tips-confirm" },
},
],
}
),
{ heuristic: true }
),
]);
UrlbarProvidersManager.registerProvider(provider);
const histograms = snapshotHistograms();
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
"about:blank"
);
// Show the view and press enter to select the tip.
await UrlbarTestUtils.promiseAutocompleteResultPopup({
window,
waitForFocus,
value: "test",
fireInputEvent: true,
});
EventUtils.synthesizeKey("KEY_Enter");
assertTelemetryResults(
histograms,
"tip",
0,
UrlbarTestUtils.SELECTED_RESULT_METHODS.enter
);
UrlbarProvidersManager.unregisterProvider(provider);
BrowserTestUtils.removeTab(tab);
});
/**
* A test URLBar provider.
*/
class TipProvider extends UrlbarProvider {
constructor(results) {
super();
this.results = results;
}
get name() {
return "TestProviderTip";
}
get type() {
return UrlbarUtils.PROVIDER_TYPE.PROFILE;
}
isActive(_context) {
return true;
}
getPriority(_context) {
return 1;
}
async startQuery(context, addCallback) {
context.preselected = true;
for (const result of this.results) {
addCallback(this, result);
}
}
}