firefox-main/browser/components/urlbar/tests/quicksuggest/browser/browser_quicksuggest_ping_amp.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info:

/* Any copyright is dedicated to the Public Domain.
// Tests the `quick-suggest` ping, which is used for for AMP suggestions.
"use strict";
const SUGGESTION = QuickSuggestTestUtils.ampRemoteSettings();
const index = 1;
const position = index + 1;
// Trying to avoid timeouts in TV mode.
requestLongerTimeout(3);
add_setup(async function () {
GleanPings.quickSuggest.setEnabled(true); // bug 1957150
await SpecialPowers.pushPrefEnv({
set: [["browser.urlbar.suggest.quickactions", false]],
});
await initQuickSuggestPingTest({
remoteSettingsRecords: [
{
collection: QuickSuggestTestUtils.RS_COLLECTION.AMP,
type: QuickSuggestTestUtils.RS_TYPE.AMP,
attachment: [SUGGESTION],
},
],
});
});
add_task(async function amp() {
let matchType = "firefox-suggest";
let advertiser = SUGGESTION.advertiser.toLowerCase();
let source = "rust";
// Make sure `improveSuggestExperience` is recorded correctly.
for (let onlineAvailable of [false, true]) {
for (let onlineEnabled of [false, true]) {
await SpecialPowers.pushPrefEnv({
set: [
["browser.urlbar.quicksuggest.online.available", onlineAvailable],
["browser.urlbar.quicksuggest.online.enabled", onlineEnabled],
],
});
let improveSuggestExperience = onlineAvailable && onlineEnabled;
await doQuickSuggestPingTest({
index,
suggestion: SUGGESTION,
impressionOnly: {
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience,
position,
suggestedIndex: "-1",
suggestedIndexRelativeToGroup: true,
requestId: undefined,
source,
contextId: "",
isClicked: false,
reportingUrl: SUGGESTION.impression_url,
},
click: [
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience,
position,
suggestedIndex: "-1",
suggestedIndexRelativeToGroup: true,
requestId: undefined,
source,
contextId: "",
isClicked: true,
reportingUrl: SUGGESTION.impression_url,
},
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_SELECTION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience,
position,
suggestedIndex: "-1",
suggestedIndexRelativeToGroup: true,
requestId: undefined,
source,
contextId: "",
reportingUrl: SUGGESTION.click_url,
},
],
commands: [
{
command: "dismiss",
pings: [
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience,
position,
suggestedIndex: "-1",
suggestedIndexRelativeToGroup: true,
requestId: undefined,
source,
contextId: "",
isClicked: false,
reportingUrl: SUGGESTION.impression_url,
},
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_BLOCK,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience,
position,
suggestedIndex: "-1",
suggestedIndexRelativeToGroup: true,
requestId: undefined,
source,
contextId: "",
iabCategory: SUGGESTION.iab_category,
},
],
},
{
command: "manage",
pings: [
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience,
position,
suggestedIndex: "-1",
suggestedIndexRelativeToGroup: true,
requestId: undefined,
source,
contextId: "",
isClicked: false,
reportingUrl: SUGGESTION.impression_url,
},
],
},
],
});
await SpecialPowers.popPrefEnv();
}
}
});
// higher-placement sponsored, a.k.a sponsored priority, sponsored best match
add_task(async function sponsoredBestMatch() {
let matchType = "best-match";
let advertiser = SUGGESTION.advertiser.toLowerCase();
let source = "rust";
await SpecialPowers.pushPrefEnv({
set: [["browser.urlbar.quicksuggest.sponsoredPriority", true]],
});
await doQuickSuggestPingTest({
index,
suggestion: SUGGESTION,
impressionOnly: {
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience: false,
position,
suggestedIndex: "1",
suggestedIndexRelativeToGroup: false,
requestId: undefined,
source,
contextId: "",
isClicked: false,
reportingUrl: SUGGESTION.impression_url,
},
click: [
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience: false,
position,
suggestedIndex: "1",
suggestedIndexRelativeToGroup: false,
requestId: undefined,
source,
contextId: "",
isClicked: true,
reportingUrl: SUGGESTION.impression_url,
},
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_SELECTION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience: false,
position,
suggestedIndex: "1",
suggestedIndexRelativeToGroup: false,
requestId: undefined,
source,
contextId: "",
reportingUrl: SUGGESTION.click_url,
},
],
commands: [
{
command: "dismiss",
pings: [
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience: false,
position,
suggestedIndex: "1",
suggestedIndexRelativeToGroup: false,
requestId: undefined,
source,
contextId: "",
isClicked: false,
reportingUrl: SUGGESTION.impression_url,
},
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_BLOCK,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience: false,
position,
suggestedIndex: "1",
suggestedIndexRelativeToGroup: false,
requestId: undefined,
source,
contextId: "",
iabCategory: SUGGESTION.iab_category,
},
],
},
{
command: "manage",
pings: [
{
pingType: CONTEXTUAL_SERVICES_PING_TYPES.QS_IMPRESSION,
matchType,
advertiser,
blockId: SUGGESTION.id.toString(),
improveSuggestExperience: false,
position,
suggestedIndex: "1",
suggestedIndexRelativeToGroup: false,
requestId: undefined,
source,
contextId: "",
isClicked: false,
reportingUrl: SUGGESTION.impression_url,
},
],
},
],
});
await SpecialPowers.popPrefEnv();
});