1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
ChromeUtils.defineESModuleGetters(this, {
QuickSuggest: "resource:///modules/QuickSuggest.sys.mjs",
UrlbarProviderQuickSuggest:
"resource:///modules/UrlbarProviderQuickSuggest.sys.mjs",
});
// Tests that registering an exposureResults pref and triggering a match causes
// the exposure event to be recorded on the UrlbarResults.
const REMOTE_SETTINGS_RESULTS = [
QuickSuggestTestUtils.ampRemoteSettings({
keywords: ["test"],
}),
QuickSuggestTestUtils.wikipediaRemoteSettings({
keywords: ["non_sponsored"],
}),
];
const EXPECTED_REMOTE_SETTINGS_URLBAR_RESULT = makeAmpResult({
keyword: "test",
});
const EXPECTED_NON_SPONSORED_REMOTE_SETTINGS_RESULT = makeWikipediaResult({
keyword: "non_sponsored",
});
add_setup(async function test_setup() {
// FOG needs a profile directory to put its data in.
do_get_profile();
// FOG needs to be initialized in order for data to flow.
Services.fog.initializeFOG();
// Set up the remote settings client with the test data.
await QuickSuggestTestUtils.ensureQuickSuggestInit({
remoteSettingsRecords: [
{
type: "data",
attachment: REMOTE_SETTINGS_RESULTS,
},
],
prefs: [
["suggest.quicksuggest.nonsponsored", true],
["suggest.quicksuggest.sponsored", true],
],
});
});
add_task(async function testExposureCheck() {
UrlbarPrefs.set("exposureResults", suggestResultType("adm_sponsored"));
UrlbarPrefs.set("showExposureResults", true);
let context = createContext("test", {
providers: [UrlbarProviderQuickSuggest.name],
isPrivate: false,
});
await check_results({
context,
matches: [EXPECTED_REMOTE_SETTINGS_URLBAR_RESULT],
});
Assert.equal(
context.results[0].exposureResultType,
suggestResultType("adm_sponsored")
);
Assert.equal(context.results[0].exposureResultHidden, false);
});
add_task(async function testExposureCheckMultiple() {
UrlbarPrefs.set(
"exposureResults",
[
suggestResultType("adm_sponsored"),
suggestResultType("adm_nonsponsored"),
].join(",")
);
UrlbarPrefs.set("showExposureResults", true);
let context = createContext("test", {
providers: [UrlbarProviderQuickSuggest.name],
isPrivate: false,
});
await check_results({
context,
matches: [EXPECTED_REMOTE_SETTINGS_URLBAR_RESULT],
});
Assert.equal(
context.results[0].exposureResultType,
suggestResultType("adm_sponsored")
);
Assert.equal(context.results[0].exposureResultHidden, false);
context = createContext("non_sponsored", {
providers: [UrlbarProviderQuickSuggest.name],
isPrivate: false,
});
await check_results({
context,
matches: [EXPECTED_NON_SPONSORED_REMOTE_SETTINGS_RESULT],
});
Assert.equal(
context.results[0].exposureResultType,
suggestResultType("adm_nonsponsored")
);
Assert.equal(context.results[0].exposureResultHidden, false);
});
add_task(async function exposureDisplayFiltering() {
UrlbarPrefs.set("exposureResults", suggestResultType("adm_sponsored"));
UrlbarPrefs.set("showExposureResults", false);
let context = createContext("test", {
providers: [UrlbarProviderQuickSuggest.name],
isPrivate: false,
});
await check_results({
context,
matches: [EXPECTED_REMOTE_SETTINGS_URLBAR_RESULT],
});
Assert.equal(
context.results[0].exposureResultType,
suggestResultType("adm_sponsored")
);
Assert.equal(context.results[0].exposureResultHidden, true);
});
function suggestResultType(typeWithoutSource) {
let source = UrlbarPrefs.get("quickSuggestRustEnabled") ? "rust" : "rs";
return `${source}_${typeWithoutSource}`;
}
// Copied from quicksuggest/unit/head.js
function makeAmpResult({
source,
provider,
keyword = "amp",
title = "Amp Suggestion",
url = "http://example.com/amp",
originalUrl = "http://example.com/amp",
icon = null,
iconBlob = new Blob([new Uint8Array([])]),
impressionUrl = "http://example.com/amp-impression",
clickUrl = "http://example.com/amp-click",
blockId = 1,
advertiser = "Amp",
iabCategory = "22 - Shopping",
suggestedIndex = -1,
isSuggestedIndexRelativeToGroup = true,
requestId = undefined,
} = {}) {
let result = {
suggestedIndex,
isSuggestedIndexRelativeToGroup,
type: UrlbarUtils.RESULT_TYPE.URL,
source: UrlbarUtils.RESULT_SOURCE.SEARCH,
heuristic: false,
payload: {
title,
url,
originalUrl,
requestId,
displayUrl: url.replace(/^https:\/\//, ""),
isSponsored: true,
qsSuggestion: keyword,
sponsoredImpressionUrl: impressionUrl,
sponsoredClickUrl: clickUrl,
sponsoredBlockId: blockId,
sponsoredAdvertiser: advertiser,
sponsoredIabCategory: iabCategory,
helpUrl: QuickSuggest.HELP_URL,
helpL10n: {
id: "urlbar-result-menu-learn-more-about-firefox-suggest",
},
isBlockable: true,
blockL10n: {
id: "urlbar-result-menu-dismiss-firefox-suggest",
},
telemetryType: "adm_sponsored",
descriptionL10n: { id: "urlbar-result-action-sponsored" },
},
};
if (UrlbarPrefs.get("quickSuggestRustEnabled")) {
result.payload.source = source || "rust";
result.payload.provider = provider || "Amp";
if (result.payload.source == "rust") {
result.payload.iconBlob = iconBlob;
} else {
result.payload.icon = icon;
}
} else {
result.payload.source = source || "remote-settings";
result.payload.provider = provider || "AdmWikipedia";
result.payload.icon = icon;
}
return result;
}
// Copied from quicksuggest/unit/head.js
function makeWikipediaResult({
source,
provider,
keyword = "wikipedia",
title = "Wikipedia Suggestion",
url = "http://example.com/wikipedia",
originalUrl = "http://example.com/wikipedia",
icon = null,
iconBlob = new Blob([new Uint8Array([])]),
impressionUrl = "http://example.com/wikipedia-impression",
clickUrl = "http://example.com/wikipedia-click",
blockId = 1,
advertiser = "Wikipedia",
iabCategory = "5 - Education",
suggestedIndex = -1,
isSuggestedIndexRelativeToGroup = true,
}) {
let result = {
suggestedIndex,
isSuggestedIndexRelativeToGroup,
type: UrlbarUtils.RESULT_TYPE.URL,
source: UrlbarUtils.RESULT_SOURCE.SEARCH,
heuristic: false,
payload: {
title,
url,
originalUrl,
displayUrl: url.replace(/^https:\/\//, ""),
isSponsored: false,
qsSuggestion: keyword,
sponsoredAdvertiser: "Wikipedia",
sponsoredIabCategory: "5 - Education",
helpUrl: QuickSuggest.HELP_URL,
helpL10n: {
id: "urlbar-result-menu-learn-more-about-firefox-suggest",
},
isBlockable: true,
blockL10n: {
id: "urlbar-result-menu-dismiss-firefox-suggest",
},
telemetryType: "adm_nonsponsored",
},
};
if (UrlbarPrefs.get("quickSuggestRustEnabled")) {
result.payload.source = source || "rust";
result.payload.provider = provider || "Wikipedia";
result.payload.iconBlob = iconBlob;
} else {
result.payload.source = source || "remote-settings";
result.payload.provider = provider || "AdmWikipedia";
result.payload.icon = icon;
result.payload.sponsoredImpressionUrl = impressionUrl;
result.payload.sponsoredClickUrl = clickUrl;
result.payload.sponsoredBlockId = blockId;
result.payload.sponsoredAdvertiser = advertiser;
result.payload.sponsoredIabCategory = iabCategory;
}
return result;
}
|
