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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/*
* Tests for the Glean SERP abandonment event
*/
"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\/searchTelemetry(?:Ad)?.html/,
queryParamName: "s",
codeParamName: "abc",
taggedCodes: ["ff"],
followOnParamNames: ["a"],
extraAdServersRegexps: [/^https:\/\/example\.com\/ad2?/],
components: [
{
type: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
default: true,
},
],
},
];
function getSERPUrl(page, organic = false) {
let url =
getRootDirectory(gTestPath).replace(
"chrome://mochitests/content",
"https://example.org"
) + page;
return `${url}?s=test${organic ? "" : "&abc=ff"}`;
}
// sharedData messages are only passed to the child on idle. Therefore
// we wait for a few idles to try and ensure the messages have been able
// to be passed across and handled.
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();
// Enable local telemetry recording for the duration of the tests.
let oldCanRecord = Services.telemetry.canRecordExtended;
Services.telemetry.canRecordExtended = true;
await SpecialPowers.pushPrefEnv({
set: [
["browser.search.log", true],
["browser.search.serpEventTelemetry.enabled", true],
],
});
registerCleanupFunction(async () => {
SearchSERPTelemetry.overrideSearchTelemetryForTests();
Services.telemetry.canRecordExtended = oldCanRecord;
resetTelemetry();
});
});
add_task(async function test_tab_close() {
resetTelemetry();
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
getSERPUrl("searchTelemetry.html")
);
BrowserTestUtils.removeTab(tab);
assertAbandonmentEvent({
abandonment: {
reason: SearchSERPTelemetryUtils.ABANDONMENTS.TAB_CLOSE,
},
});
});
add_task(async function test_window_close() {
resetTelemetry();
let serpUrl = getSERPUrl("searchTelemetry.html");
let otherWindow = await BrowserTestUtils.openNewBrowserWindow();
let browserLoadedPromise = BrowserTestUtils.browserLoaded(
otherWindow.gBrowser,
false,
serpUrl
);
BrowserTestUtils.loadURIString(otherWindow.gBrowser, serpUrl);
await browserLoadedPromise;
await BrowserTestUtils.closeWindow(otherWindow);
assertAbandonmentEvent({
abandonment: {
reason: SearchSERPTelemetryUtils.ABANDONMENTS.WINDOW_CLOSE,
},
});
});
add_task(async function test_navigation_via_urlbar() {
resetTelemetry();
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
getSERPUrl("searchTelemetry.html")
);
let browserLoadedPromise = BrowserTestUtils.browserLoaded(
gBrowser,
false,
"https://www.example.com/"
);
BrowserTestUtils.loadURIString(gBrowser, "https://www.example.com");
await browserLoadedPromise;
assertAbandonmentEvent({
abandonment: {
reason: SearchSERPTelemetryUtils.ABANDONMENTS.NAVIGATION,
},
});
BrowserTestUtils.removeTab(tab);
});
add_task(async function test_navigation_via_back_button() {
resetTelemetry();
let exampleUrl = "https://example.com/";
let serpUrl = getSERPUrl("searchTelemetry.html");
await BrowserTestUtils.withNewTab(exampleUrl, async browser => {
info("example.com is now loaded.");
let pageLoadPromise = BrowserTestUtils.browserLoaded(
browser,
false,
serpUrl
);
BrowserTestUtils.loadURIString(browser, serpUrl);
await pageLoadPromise;
info("Serp is now loaded.");
let pageShowPromise = BrowserTestUtils.waitForContentEvent(
browser,
"pageshow"
);
browser.goBack();
await pageShowPromise;
info("Previous page (example.com) is now loaded after back navigation.");
});
assertAbandonmentEvent({
abandonment: {
reason: SearchSERPTelemetryUtils.ABANDONMENTS.NAVIGATION,
},
});
});
add_task(async function test_click_ad() {
resetTelemetry();
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
getSERPUrl("searchTelemetryAd.html")
);
await TestUtils.waitForCondition(() => {
let adImpressions = Glean.serp.adImpression.testGetValue() ?? [];
return adImpressions.length;
}, "Should have received an ad impression.");
let browserLoadedPromise = BrowserTestUtils.browserLoaded(gBrowser);
await BrowserTestUtils.synthesizeMouseAtCenter(
"a",
{},
gBrowser.selectedBrowser
);
await browserLoadedPromise;
Assert.equal(
!!Glean.serp.abandonment.testGetValue(),
false,
"Should not have any abandonment events."
);
BrowserTestUtils.removeTab(tab);
});
add_task(async function test_without_components() {
// Mock a provider that doesn't have components.
let providerInfo = [
{
...TEST_PROVIDER_INFO[0],
components: [],
},
];
SearchSERPTelemetry.overrideSearchTelemetryForTests(providerInfo);
await waitForIdle();
resetTelemetry();
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
getSERPUrl("searchTelemetryAd.html")
);
// We shouldn't expect a SERP impression, so instead wait roughly
// around how long it would usually take to receive an impression following
// a page load.
await promiseWaitForAdLinkCheck();
Assert.equal(
!!Glean.serp.impression.testGetValue(),
false,
"Should not have any impression events."
);
let browserLoadedPromise = BrowserTestUtils.browserLoaded(
gBrowser,
false,
"https://www.example.com/"
);
BrowserTestUtils.loadURIString(gBrowser, "https://www.example.com");
await browserLoadedPromise;
Assert.equal(
!!Glean.serp.abandonment.testGetValue(),
false,
"Should not have any abandonment events."
);
BrowserTestUtils.removeTab(tab);
// Allow subsequent tests to use the default provider.
SearchSERPTelemetry.overrideSearchTelemetryForTests(TEST_PROVIDER_INFO);
await waitForIdle();
});
|
