mozilla-central/browser/components/urlbar/tests/quicksuggest/unit/test_quicksuggest_positionInSuggestions.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

/* Any copyright is dedicated to the Public Domain.
"use strict";
/**
* Tests for quick suggest result position specified in suggestions.
*/
ChromeUtils.defineESModuleGetters(this, {
UrlbarProviderHeuristicFallback:
"resource:///modules/UrlbarProviderHeuristicFallback.sys.mjs",
UrlbarProviderPlaces: "resource:///modules/UrlbarProviderPlaces.sys.mjs",
UrlbarProviderTabToSearch:
"resource:///modules/UrlbarProviderTabToSearch.sys.mjs",
});
const SPONSORED_SECOND_POSITION_RESULT = {
id: 1,
title: "sponsored second",
keywords: ["s-s"],
advertiser: "TestAdvertiser",
iab_category: "22 - Shopping",
position: 1,
};
const SPONSORED_NORMAL_POSITION_RESULT = {
id: 2,
title: "sponsored normal",
keywords: ["s-n"],
advertiser: "TestAdvertiser",
iab_category: "22 - Shopping",
};
const NONSPONSORED_SECOND_POSITION_RESULT = {
id: 3,
title: "nonsponsored second",
keywords: ["n-s"],
advertiser: "TestAdvertiserNonSponsored",
iab_category: "5 - Education",
position: 1,
};
const NONSPONSORED_NORMAL_POSITION_RESULT = {
id: 4,
title: "nonsponsored normal",
keywords: ["n-n"],
advertiser: "TestAdvertiserNonSponsored",
iab_category: "5 - Education",
};
const FIRST_POSITION_RESULT = {
id: 5,
title: "first position suggest",
keywords: ["first-position"],
advertiser: "TestAdvertiserFirstPositionQuickSuggest",
iab_category: "22 - Shopping",
position: 0,
};
const SECOND_POSITION_RESULT = {
id: 6,
title: "second position suggest",
keywords: ["second-position"],
advertiser: "TestAdvertiserSecondPositionQuickSuggest",
iab_category: "22 - Shopping",
position: 1,
};
const THIRD_POSITION_RESULT = {
id: 7,
title: "third position suggest",
keywords: ["third-position"],
advertiser: "TestAdvertiserThirdPositionQuickSuggest",
iab_category: "22 - Shopping",
position: 2,
};
const TABTOSEARCH_ENGINE_DOMAIN_FOR_FIRST_POSITION_TEST =
"first-position.example.com";
const TABTOSEARCH_ENGINE_DOMAIN_FOR_SECOND_POSITION_TEST =
"second-position.example.com";
const SECOND_POSITION_INTERVENTION_RESULT = new UrlbarResult(
UrlbarUtils.RESULT_TYPE.URL,
UrlbarUtils.RESULT_SOURCE.HISTORY,
);
SECOND_POSITION_INTERVENTION_RESULT.suggestedIndex = 1;
const SECOND_POSITION_INTERVENTION_RESULT_PROVIDER =
new UrlbarTestUtils.TestProvider({
results: [SECOND_POSITION_INTERVENTION_RESULT],
priority: 0,
name: "second_position_intervention_provider",
});
const EXPECTED_GENERAL_HEURISTIC_RESULT = {
providerName: UrlbarProviderHeuristicFallback.name,
type: UrlbarUtils.RESULT_TYPE.SEARCH,
source: UrlbarUtils.RESULT_SOURCE.SEARCH,
heuristic: true,
};
const EXPECTED_GENERAL_PLACES_RESULT = {
providerName: UrlbarProviderPlaces.name,
type: UrlbarUtils.RESULT_TYPE.URL,
source: UrlbarUtils.RESULT_SOURCE.HISTORY,
heuristic: false,
};
const EXPECTED_GENERAL_TABTOSEARCH_RESULT = {
providerName: UrlbarProviderTabToSearch.name,
type: UrlbarUtils.RESULT_TYPE.DYNAMIC,
source: UrlbarUtils.RESULT_SOURCE.SEARCH,
heuristic: false,
};
const EXPECTED_GENERAL_INTERVENTION_RESULT = {
providerName: SECOND_POSITION_INTERVENTION_RESULT_PROVIDER.name,
type: UrlbarUtils.RESULT_TYPE.URL,
source: UrlbarUtils.RESULT_SOURCE.HISTORY,
heuristic: false,
};
function createExpectedQuickSuggestResult(suggest) {
let isSponsored = suggest.iab_category !== "5 - Education";
return {
providerName: UrlbarProviderQuickSuggest.name,
type: UrlbarUtils.RESULT_TYPE.URL,
source: UrlbarUtils.RESULT_SOURCE.SEARCH,
heuristic: false,
payload: {
telemetryType: isSponsored ? "adm_sponsored" : "adm_nonsponsored",
qsSuggestion: suggest.keywords[0],
title: suggest.title,
url: suggest.url,
originalUrl: suggest.url,
icon: null,
sponsoredImpressionUrl: suggest.impression_url,
sponsoredClickUrl: suggest.click_url,
sponsoredBlockId: suggest.id,
sponsoredAdvertiser: suggest.advertiser,
sponsoredIabCategory: suggest.iab_category,
isSponsored,
descriptionL10n: isSponsored
? { id: "urlbar-result-action-sponsored" }
: undefined,
helpUrl: QuickSuggest.HELP_URL,
helpL10n: {
id: "urlbar-result-menu-learn-more-about-firefox-suggest",
},
isBlockable: true,
blockL10n: {
id: "urlbar-result-menu-dismiss-firefox-suggest",
},
displayUrl: suggest.url,
source: "remote-settings",
provider: "AdmWikipedia",
},
};
}
const TEST_CASES = [
{
description: "Test for second placable sponsored suggest",
input: SPONSORED_SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderQuickSuggest.name,
UrlbarProviderPlaces.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
createExpectedQuickSuggestResult(SPONSORED_SECOND_POSITION_RESULT),
EXPECTED_GENERAL_PLACES_RESULT,
],
},
{
description: "Test for normal sponsored suggest",
input: SPONSORED_NORMAL_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderQuickSuggest.name,
UrlbarProviderPlaces.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
EXPECTED_GENERAL_PLACES_RESULT,
createExpectedQuickSuggestResult(SPONSORED_NORMAL_POSITION_RESULT),
],
},
{
description: "Test for second placable nonsponsored suggest",
input: NONSPONSORED_SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderQuickSuggest.name,
UrlbarProviderPlaces.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
createExpectedQuickSuggestResult(NONSPONSORED_SECOND_POSITION_RESULT),
EXPECTED_GENERAL_PLACES_RESULT,
],
},
{
description: "Test for normal nonsponsored suggest",
input: NONSPONSORED_NORMAL_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderQuickSuggest.name,
UrlbarProviderPlaces.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
EXPECTED_GENERAL_PLACES_RESULT,
createExpectedQuickSuggestResult(NONSPONSORED_NORMAL_POSITION_RESULT),
],
},
{
description:
"Test for second placable sponsored suggest but secondPosition pref is disabled",
input: SPONSORED_SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": false,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderQuickSuggest.name,
UrlbarProviderPlaces.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
EXPECTED_GENERAL_PLACES_RESULT,
createExpectedQuickSuggestResult(SPONSORED_SECOND_POSITION_RESULT),
],
},
{
description: "Test the results with multi providers having same index",
input: SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderQuickSuggest.name,
UrlbarProviderTabToSearch.name,
SECOND_POSITION_INTERVENTION_RESULT_PROVIDER.name,
],
expected: [
EXPECTED_GENERAL_TABTOSEARCH_RESULT,
createExpectedQuickSuggestResult(SECOND_POSITION_RESULT),
EXPECTED_GENERAL_INTERVENTION_RESULT,
],
},
{
description: "Test the results with tab-to-search",
input: SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderTabToSearch.name,
UrlbarProviderQuickSuggest.name,
],
expected: [
EXPECTED_GENERAL_TABTOSEARCH_RESULT,
createExpectedQuickSuggestResult(SECOND_POSITION_RESULT),
],
},
{
description: "Test the results with another intervention",
input: SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderQuickSuggest.name,
SECOND_POSITION_INTERVENTION_RESULT_PROVIDER.name,
],
expected: [
createExpectedQuickSuggestResult(SECOND_POSITION_RESULT),
EXPECTED_GENERAL_INTERVENTION_RESULT,
],
},
{
description: "Test the results with heuristic and tab-to-search",
input: SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderTabToSearch.name,
UrlbarProviderQuickSuggest.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
EXPECTED_GENERAL_TABTOSEARCH_RESULT,
createExpectedQuickSuggestResult(SECOND_POSITION_RESULT),
],
},
{
description: "Test the results with heuristic tab-to-search and places",
input: SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderTabToSearch.name,
UrlbarProviderQuickSuggest.name,
UrlbarProviderPlaces.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
EXPECTED_GENERAL_TABTOSEARCH_RESULT,
createExpectedQuickSuggestResult(SECOND_POSITION_RESULT),
EXPECTED_GENERAL_PLACES_RESULT,
],
},
{
description: "Test the results with heuristic and another intervention",
input: SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderQuickSuggest.name,
SECOND_POSITION_INTERVENTION_RESULT_PROVIDER.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
createExpectedQuickSuggestResult(SECOND_POSITION_RESULT),
EXPECTED_GENERAL_INTERVENTION_RESULT,
],
},
{
description:
"Test the results with heuristic, another intervention and places",
input: SECOND_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderHeuristicFallback.name,
UrlbarProviderQuickSuggest.name,
SECOND_POSITION_INTERVENTION_RESULT_PROVIDER.name,
UrlbarProviderPlaces.name,
],
expected: [
EXPECTED_GENERAL_HEURISTIC_RESULT,
createExpectedQuickSuggestResult(SECOND_POSITION_RESULT),
EXPECTED_GENERAL_INTERVENTION_RESULT,
EXPECTED_GENERAL_PLACES_RESULT,
],
},
{
description: "Test for 0 indexed quick suggest",
input: FIRST_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderTabToSearch.name,
UrlbarProviderQuickSuggest.name,
],
expected: [
createExpectedQuickSuggestResult(FIRST_POSITION_RESULT),
EXPECTED_GENERAL_TABTOSEARCH_RESULT,
],
},
{
description: "Test for 2 indexed quick suggest",
input: THIRD_POSITION_RESULT.keywords[0],
prefs: {
"quicksuggest.allowPositionInSuggestions": true,
},
providers: [
UrlbarProviderQuickSuggest.name,
SECOND_POSITION_INTERVENTION_RESULT_PROVIDER.name,
],
expected: [
EXPECTED_GENERAL_INTERVENTION_RESULT,
createExpectedQuickSuggestResult(THIRD_POSITION_RESULT),
],
},
];
add_setup(async function () {
// Setup for quick suggest result.
await QuickSuggestTestUtils.ensureQuickSuggestInit({
remoteSettingsRecords: [
{
type: "data",
attachment: [
SPONSORED_SECOND_POSITION_RESULT,
SPONSORED_NORMAL_POSITION_RESULT,
NONSPONSORED_SECOND_POSITION_RESULT,
NONSPONSORED_NORMAL_POSITION_RESULT,
FIRST_POSITION_RESULT,
SECOND_POSITION_RESULT,
THIRD_POSITION_RESULT,
],
},
],
prefs: [
["suggest.quicksuggest.sponsored", true],
["suggest.quicksuggest.nonsponsored", true],
],
});
// Setup for places result.
await PlacesUtils.history.clear();
await PlacesTestUtils.addVisits([
"http://example.com/" + SPONSORED_SECOND_POSITION_RESULT.keywords[0],
"http://example.com/" + SPONSORED_NORMAL_POSITION_RESULT.keywords[0],
"http://example.com/" + NONSPONSORED_SECOND_POSITION_RESULT.keywords[0],
"http://example.com/" + NONSPONSORED_NORMAL_POSITION_RESULT.keywords[0],
"http://example.com/" + SECOND_POSITION_RESULT.keywords[0],
]);
// Setup for tab-to-search result.
await SearchTestUtils.installSearchExtension({
name: "first",
search_url: `https://${TABTOSEARCH_ENGINE_DOMAIN_FOR_FIRST_POSITION_TEST}/`,
});
await SearchTestUtils.installSearchExtension({
name: "second",
search_url: `https://${TABTOSEARCH_ENGINE_DOMAIN_FOR_SECOND_POSITION_TEST}/`,
});
/// Setup for another intervention result.
UrlbarProvidersManager.registerProvider(
SECOND_POSITION_INTERVENTION_RESULT_PROVIDER
);
});
add_task(async function basic() {
for (const { description, input, prefs, providers, expected } of TEST_CASES) {
info(description);
for (let name in prefs) {
UrlbarPrefs.set(name, prefs[name]);
}
const context = createContext(input, {
providers,
isPrivate: false,
});
await check_results({
context,
matches: expected,
});
for (let name in prefs) {
UrlbarPrefs.clear(name);
}
}
});