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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/**
* This test ensures that recorded telemetry is consistent even with multiple
* tabs opened and closed.
*/
"use strict";
const { SearchSERPTelemetry, SearchSERPTelemetryUtils } =
ChromeUtils.importESModule("resource:///modules/SearchSERPTelemetry.sys.mjs");
const TEST_PROVIDER_INFO = [
{
telemetryId: "example",
searchPageRegexp:
/^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/searchTelemetryAd_/,
queryParamName: "s",
codeParamName: "abc",
taggedCodes: ["ff"],
adServerAttributes: ["mozAttr"],
nonAdsLinkRegexps: [
/^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/searchTelemetryAd_nonAdsLink_redirect/,
],
extraAdServersRegexps: [/^https:\/\/example\.com\/ad/],
components: [
{
type: SearchSERPTelemetryUtils.COMPONENTS.INCONTENT_SEARCHBOX,
included: {
parent: {
selector: "form",
},
children: [
{
// This isn't contained in any of the HTML examples but the
// presence of the entry ensures that if it is not found during
// a topDown examination, the next element in the array is
// inspected and found.
selector: "textarea",
},
{
selector: "input",
},
],
related: {
selector: "div",
},
},
topDown: true,
},
{
type: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
default: true,
},
],
},
];
// Deliberately make the web isolated process count as small as possible
// so that we don't have to create a ton of tabs to reuse a process.
const MAX_IPC = 1;
const TABS_TO_OPEN = 2;
function getSERPUrl(page, term) {
let url =
getRootDirectory(gTestPath).replace(
"chrome://mochitests/content",
"https://example.org"
) + page;
return `${url}?s=${term}`;
}
async function waitForIdle() {
for (let i = 0; i < 10; i++) {
await new Promise(resolve => Services.tm.idleDispatchToMainThread(resolve));
}
}
add_setup(async function () {
SearchSERPTelemetry.overrideSearchTelemetryForTests(TEST_PROVIDER_INFO);
await waitForIdle();
await SpecialPowers.pushPrefEnv({
set: [
["browser.search.log", true],
["browser.search.serpEventTelemetry.enabled", true],
["dom.ipc.processCount.webIsolated", MAX_IPC],
],
});
registerCleanupFunction(async () => {
SearchSERPTelemetry.overrideSearchTelemetryForTests();
resetTelemetry();
});
});
async function do_test(tab, impressionId, switchTab) {
if (switchTab) {
await BrowserTestUtils.switchTab(gBrowser, tab);
}
await BrowserTestUtils.synthesizeMouseAtCenter(
"input",
{},
tab.linkedBrowser
);
await BrowserTestUtils.synthesizeMouseAtCenter(
"a#images",
{},
tab.linkedBrowser
);
await BrowserTestUtils.browserLoaded(tab.linkedBrowser, true);
await Services.fog.testFlushAllChildren();
let engagements = Glean.serp.engagement.testGetValue() ?? [];
Assert.equal(engagements.length, 2, "Should have two events recorded.");
Assert.deepEqual(
engagements[0].extra,
{
action: SearchSERPTelemetryUtils.ACTIONS.CLICKED,
target: SearchSERPTelemetryUtils.COMPONENTS.INCONTENT_SEARCHBOX,
impression_id: impressionId,
},
"Search box engagement event should match."
);
Assert.deepEqual(
engagements[1].extra,
{
action: SearchSERPTelemetryUtils.ACTIONS.CLICKED,
target: SearchSERPTelemetryUtils.COMPONENTS.NON_ADS_LINK,
impression_id: impressionId,
},
"Non ads page engagement event should match."
);
resetTelemetry();
}
// This test deliberately opens a lot of tabs to ensure SERPs share the
// same process. It interacts with the page to ensure the engagement
// has the correct recording, especially the impression id which can be out of
// sync if data in the child process isn't cached properly.
add_task(async function test_multiple_tabs_forward() {
resetTelemetry();
let tabs = [];
let pid;
// Open multiple tabs.
for (let index = 0; index < TABS_TO_OPEN; ++index) {
let url = getSERPUrl(
"searchTelemetryAd_searchbox_with_content.html",
`hello+world+${index}`
);
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, url);
await waitForPageWithAdImpressions();
tabs.push(tab);
let currentPid = E10SUtils.getBrowserPids(tab.linkedBrowser).at(0);
if (pid == null) {
pid = currentPid;
} else {
Assert.ok(pid == currentPid, "The process ID should be the same.");
}
}
// Extract the impression IDs.
await Services.fog.testFlushAllChildren();
let recordedImpressions = Glean.serp.impression.testGetValue() ?? [];
let impressionIds = recordedImpressions.map(
impression => impression.extra.impression_id
);
// Reset telemetry because we're not concerned about inspecting every
// impression event.
resetTelemetry();
for (let index = 0; index < TABS_TO_OPEN; ++index) {
let tab = tabs[index];
let impressionId = impressionIds[index];
await do_test(tab, impressionId, true);
BrowserTestUtils.removeTab(tab);
}
});
add_task(async function test_multiple_tabs_backward() {
resetTelemetry();
let tabs = [];
let pid;
for (let index = 0; index < TABS_TO_OPEN; ++index) {
let url = getSERPUrl(
"searchTelemetryAd_searchbox_with_content.html",
`hello+world+${index}`
);
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, url);
await waitForPageWithAdImpressions();
tabs.push(tab);
let currentPid = E10SUtils.getBrowserPids(tab.linkedBrowser).at(0);
if (pid == null) {
pid = currentPid;
} else {
Assert.ok(pid == currentPid, "The process ID should be the same.");
}
}
// Extract the impression IDs.
await Services.fog.testFlushAllChildren();
let recordedImpressions = Glean.serp.impression.testGetValue() ?? [];
let impressionIds = recordedImpressions.map(
impression => impression.extra.impression_id
);
// Reset telemetry because we're not concerned about inspecting every
// impression event.
resetTelemetry();
for (let index = TABS_TO_OPEN - 1; index >= 0; --index) {
let tab = tabs[index];
let impressionId = impressionIds[index];
await do_test(tab, impressionId, false);
BrowserTestUtils.removeTab(tab);
}
});
|
