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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/**
* These tests load ads and organic links in new windows.
*/
"use strict";
const TEST_PROVIDER_INFO = [
{
telemetryId: "example",
searchPageRegexp:
/^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry/,
queryParamNames: ["s"],
codeParamName: "abc",
taggedCodes: ["ff"],
adServerAttributes: ["mozAttr"],
nonAdsLinkRegexps: [],
extraAdServersRegexps: [/^https:\/\/example\.com\/ad/],
components: [
{
type: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
default: true,
},
],
},
];
add_setup(async function () {
SearchSERPTelemetry.overrideSearchTelemetryForTests(TEST_PROVIDER_INFO);
await waitForIdle();
// Enable local telemetry recording for the duration of the tests.
await SpecialPowers.pushPrefEnv({
set: [["browser.search.serpEventTelemetry.enabled", true]],
});
registerCleanupFunction(async () => {
SearchSERPTelemetry.overrideSearchTelemetryForTests();
resetTelemetry();
});
});
add_task(async function load_serp_in_new_window_with_pref_and_click_ad() {
info("Set browser.link.open_newwindow to open _blank in new window.");
await SpecialPowers.pushPrefEnv({
set: [["browser.link.open_newwindow", 2]],
});
info("Load SERP in a new tab.");
let url = getSERPUrl("searchTelemetryAd.html");
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, url);
info("Wait for page impression.");
await waitForPageWithAdImpressions();
info("Open ad link in a new window.");
await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
content.document.getElementById("ad1").setAttribute("target", "_blank");
});
let newWindowPromise = BrowserTestUtils.waitForNewWindow({
url: "https://example.com/ad",
});
await BrowserTestUtils.synthesizeMouseAtCenter("#ad1", {}, tab.linkedBrowser);
let newWindow = await newWindowPromise;
await assertSearchSourcesTelemetry(
{},
{
"browser.search.content.unknown": { "example:tagged:ff": 1 },
"browser.search.withads.unknown": { "example:tagged": 1 },
"browser.search.adclicks.unknown": { "example:tagged": 1 },
}
);
assertSERPTelemetry([
{
impression: {
provider: "example",
tagged: "true",
partner_code: "ff",
source: "unknown",
is_shopping_page: "false",
is_private: "false",
shopping_tab_displayed: "false",
},
engagements: [
{
action: SearchSERPTelemetryUtils.ACTIONS.CLICKED,
target: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
},
],
adImpressions: [
{
component: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
ads_loaded: "2",
ads_visible: "2",
ads_hidden: "0",
},
],
},
]);
// Clean-up.
await SpecialPowers.popPrefEnv();
BrowserTestUtils.removeTab(tab);
await BrowserTestUtils.closeWindow(newWindow);
resetTelemetry();
});
add_task(async function load_serp_in_new_window_with_pref_and_click_organic() {
info("Set browser.link.open_newwindow to open _blank in new window.");
await SpecialPowers.pushPrefEnv({
set: [["browser.link.open_newwindow", 2]],
});
info("Load SERP in a new tab.");
let url = getSERPUrl("searchTelemetry.html");
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, url);
info("Wait for page impression.");
await waitForPageWithAdImpressions();
info("Open organic link in a new window.");
await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
content.document.querySelector("a").setAttribute("target", "_blank");
});
let newWindowPromise = BrowserTestUtils.waitForNewWindow({
url: "https://example.com/otherpage",
});
await BrowserTestUtils.synthesizeMouseAtCenter("a", {}, tab.linkedBrowser);
let newWindow = await newWindowPromise;
await assertSearchSourcesTelemetry(
{},
{
"browser.search.content.unknown": { "example:tagged:ff": 1 },
}
);
assertSERPTelemetry([
{
impression: {
provider: "example",
tagged: "true",
partner_code: "ff",
source: "unknown",
is_shopping_page: "false",
is_private: "false",
shopping_tab_displayed: "false",
},
engagements: [
{
action: SearchSERPTelemetryUtils.ACTIONS.CLICKED,
target: SearchSERPTelemetryUtils.COMPONENTS.NON_ADS_LINK,
},
],
adImpressions: [],
},
]);
// Clean-up.
await SpecialPowers.popPrefEnv();
BrowserTestUtils.removeTab(tab);
await BrowserTestUtils.closeWindow(newWindow);
resetTelemetry();
});
add_task(async function load_serp_in_new_window_with_context_menu() {
info("Load SERP in a new tab.");
let url = getSERPUrl("searchTelemetryAd.html");
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, url);
info("Wait for page impression.");
await waitForPageWithAdImpressions();
info("Open context menu.");
let contextMenu = document.getElementById("contentAreaContextMenu");
let contextMenuPromise = BrowserTestUtils.waitForEvent(
contextMenu,
"popupshown"
);
await BrowserTestUtils.synthesizeMouseAtCenter(
"#ad1",
{ type: "contextmenu", button: 2 },
tab.linkedBrowser
);
await contextMenuPromise;
info("Click on Open Link in New Window");
let newWindowPromise = BrowserTestUtils.waitForNewWindow({
url: "https://example.com/ad",
});
let openLinkInNewWindow = contextMenu.querySelector("#context-openlink");
contextMenu.activateItem(openLinkInNewWindow);
let newWindow = await newWindowPromise;
await assertSearchSourcesTelemetry(
{},
{
"browser.search.content.unknown": { "example:tagged:ff": 1 },
"browser.search.withads.unknown": { "example:tagged": 1 },
"browser.search.adclicks.unknown": { "example:tagged": 1 },
}
);
assertSERPTelemetry([
{
impression: {
provider: "example",
tagged: "true",
partner_code: "ff",
source: "unknown",
is_shopping_page: "false",
is_private: "false",
shopping_tab_displayed: "false",
},
engagements: [
{
action: SearchSERPTelemetryUtils.ACTIONS.CLICKED,
target: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
},
],
adImpressions: [
{
component: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
ads_loaded: "2",
ads_visible: "2",
ads_hidden: "0",
},
],
},
]);
// Clean-up.
BrowserTestUtils.removeTab(tab);
await BrowserTestUtils.closeWindow(newWindow);
resetTelemetry();
});
add_task(
async function load_multiple_serps_with_different_search_terms_and_click_ad() {
info("Set browser.link.open_newwindow to open _blank in new window.");
await SpecialPowers.pushPrefEnv({
set: [["browser.link.open_newwindow", 2]],
});
info("Load SERP in a new tab.");
let url = getSERPUrl("searchTelemetryAd.html");
let formattedUrl1 = new URL(url);
formattedUrl1.searchParams.set("s", "test1");
let tab1 = await BrowserTestUtils.openNewForegroundTab(gBrowser, url);
info("Wait for page impression.");
await waitForPageWithAdImpressions();
info("Load SERP in a new tab with a different search term.");
url = getSERPUrl("searchTelemetryAd.html");
let formattedUrl2 = new URL(url);
formattedUrl2.searchParams.set("s", "test2");
let tab2 = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
formattedUrl2.href
);
info("Wait for page impression of tab 2.");
await waitForPageWithAdImpressions();
Assert.notEqual(
formattedUrl1.searchParams.get("s"),
formattedUrl2.searchParams.get("s"),
"The search query param in both tabs are different."
);
info("Open ad link of tab 2 in a new window.");
await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
content.document.getElementById("ad1").setAttribute("target", "_blank");
});
let newWindowPromise = BrowserTestUtils.waitForNewWindow({
url: "https://example.com/ad",
});
await BrowserTestUtils.synthesizeMouseAtCenter(
"#ad1",
{},
tab2.linkedBrowser
);
let newWindow = await newWindowPromise;
await assertSearchSourcesTelemetry(
{},
{
"browser.search.content.unknown": { "example:tagged:ff": 2 },
"browser.search.withads.unknown": { "example:tagged": 2 },
"browser.search.adclicks.unknown": { "example:tagged": 1 },
}
);
assertSERPTelemetry([
{
impression: {
provider: "example",
tagged: "true",
partner_code: "ff",
source: "unknown",
is_shopping_page: "false",
is_private: "false",
shopping_tab_displayed: "false",
},
adImpressions: [
{
component: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
ads_loaded: "2",
ads_visible: "2",
ads_hidden: "0",
},
],
},
{
impression: {
provider: "example",
tagged: "true",
partner_code: "ff",
source: "unknown",
is_shopping_page: "false",
is_private: "false",
shopping_tab_displayed: "false",
},
engagements: [
{
action: SearchSERPTelemetryUtils.ACTIONS.CLICKED,
target: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
},
],
adImpressions: [
{
component: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
ads_loaded: "2",
ads_visible: "2",
ads_hidden: "0",
},
],
},
]);
// Clean-up.
await SpecialPowers.popPrefEnv();
BrowserTestUtils.removeTab(tab1);
BrowserTestUtils.removeTab(tab2);
await BrowserTestUtils.closeWindow(newWindow);
resetTelemetry();
}
);
|
