Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
/* Any copyright is dedicated to the Public Domain.
"use strict";
// Test edge cases for engagement.
add_setup(async function () {
await setup();
});
/**
* UrlbarProvider that does not add any result.
*/
class NoResponseTestProvider extends UrlbarTestUtils.TestProvider {
constructor() {
super({ name: "TestProviderNoResponse ", results: [] });
this.#deferred = Promise.withResolvers();
}
get type() {
return UrlbarUtils.PROVIDER_TYPE.HEURISTIC;
}
async startQuery(_context, _addCallback) {
await this.#deferred.promise;
}
done() {
this.#deferred.resolve();
}
#deferred = null;
}
const noResponseProvider = new NoResponseTestProvider();
/**
* UrlbarProvider that adds a heuristic result immediately as usual.
*/
class AnotherHeuristicProvider extends UrlbarTestUtils.TestProvider {
constructor({ results }) {
super({ name: "TestProviderAnotherHeuristic ", results });
this.#deferred = Promise.withResolvers();
}
get type() {
return UrlbarUtils.PROVIDER_TYPE.HEURISTIC;
}
async startQuery(context, addCallback) {
for (const result of this.results) {
addCallback(this, result);
}
this.#deferred.resolve(context);
}
onQueryStarted() {
return this.#deferred.promise;
}
#deferred = null;
}
const anotherHeuristicProvider = new AnotherHeuristicProvider({
results: [
new UrlbarResult({
type: UrlbarUtils.RESULT_TYPE.URL,
source: UrlbarUtils.RESULT_SOURCE.OTHER_LOCAL,
heuristic: true,
}),
],
});
add_task(async function engagement_before_showing_results() {
await SpecialPowers.pushPrefEnv({
// Avoid showing search tip.
set: [["browser.urlbar.tipShownCount.searchTip_onboard", 999]],
});
// Increase chunk delays to delay the call to notifyResults.
let originalChunkTimeout = ProvidersManager.chunkResultsDelayMs;
ProvidersManager.chunkResultsDelayMs = 1000000;
// Add a provider that waits forever in startQuery() to avoid fireing
// heuristicProviderTimer.
let providersManager = ProvidersManager.getInstanceForSap("urlbar");
providersManager.registerProvider(noResponseProvider);
// Add a provider that add a result immediately as usual.
providersManager.registerProvider(anotherHeuristicProvider);
const cleanup = () => {
providersManager.unregisterProvider(noResponseProvider);
providersManager.unregisterProvider(anotherHeuristicProvider);
ProvidersManager.chunkResultsDelayMs = originalChunkTimeout;
};
registerCleanupFunction(cleanup);
await doTest(async () => {
// Try to show the results.
await UrlbarTestUtils.inputIntoURLBar(window, "exam");
// Wait until starting the query and filling expected results.
const context = await anotherHeuristicProvider.onQueryStarted();
const query = providersManager.queries.get(context);
await BrowserTestUtils.waitForCondition(
() =>
query.unsortedResults.some(
r => r.providerName === "UrlbarProviderHeuristicFallback"
) &&
query.unsortedResults.some(
r => r.providerName === anotherHeuristicProvider.name
)
);
// Type Enter key before showing any results.
await doEnter();
assertEngagementTelemetry([
{
selected_result: "input_field",
provider: undefined,
results: "",
groups: "",
},
]);
// Clear the pending query.
noResponseProvider.done();
});
cleanup();
await SpecialPowers.popPrefEnv();
});
add_task(async function engagement_after_closing_results() {
const TRIGGERS = [
() => EventUtils.synthesizeKey("KEY_Escape"),
() => {
// We intentionally turn off this a11y check, because the following click
// is sent to test the telemetry behavior using an alternative way of the
// urlbar dismissal, where other ways are accessible (and tested above),
// therefore this test can be ignored.
AccessibilityUtils.setEnv({
mustHaveAccessibleRule: false,
});
EventUtils.synthesizeMouseAtCenter(
document.getElementById("customizableui-special-spring2"),
{}
);
AccessibilityUtils.resetEnv();
},
];
for (const trigger of TRIGGERS) {
await doTest(async () => {
await openPopup("test");
await UrlbarTestUtils.promisePopupClose(window, () => {
trigger();
});
Assert.equal(
gURLBar.value,
"test",
"The inputted text remains even if closing the results"
);
// The tested trigger should not record abandonment event.
assertAbandonmentTelemetry([]);
// Endgagement.
await doEnter();
assertEngagementTelemetry([
{
selected_result: "search_engine",
provider: "UrlbarProviderHeuristicFallback",
results: "search_engine",
groups: "heuristic",
},
]);
});
}
});
add_task(async function enter_to_reload_current_url() {
await doTest(async () => {
// Open a URL once.
await doEnter();
// Focus the urlbar.
EventUtils.synthesizeMouseAtCenter(gURLBar.inputField, {});
await BrowserTestUtils.waitForCondition(
() => window.document.activeElement === gURLBar.inputField
);
// Press Enter key to reload the page without selecting any suggestions.
await doEnter();
assertEngagementTelemetry([
{
selected_result: "url",
provider: "UrlbarProviderHeuristicFallback",
results: "url",
groups: "heuristic",
},
{
selected_result: "input_field",
provider: undefined,
results: "",
groups: "",
},
]);
});
});